Fx. Base.js

Contains Fx.Base, the foundamentals of the MooTools Effects.

License

MIT-style license.

Summary
Fx. Base.jsContains Fx.Base, the foundamentals of the MooTools Effects.
Fx.BaseBase class for the Effects.
Properties
setImmediately sets the value with no transition.
startExecutes an effect from one position to the other.
stopStops the transition.

Fx.Base

Base class for the Effects.

Options

transitionthe equation to use for the effect see Fx.Transitions; default is <Fx.Transitions.Sine.easeInOut>
durationthe duration of the effect in ms; 500 is the default.
unitthe unit is ‘px’ by default (other values include things like ‘em’ for fonts or ‘%’).
waitboolean: to wait or not to wait for a current transition to end before running another of the same instance. defaults to true.
fpsthe frames per second for the transition; default is 50

Events

onStartthe function to execute as the effect begins; nothing (Class.empty) by default.
onCompletethe function to execute after the effect has processed; nothing (Class.empty) by default.
onCancelthe function to execute when you manually stop the effect.
Summary
Properties
setImmediately sets the value with no transition.
startExecutes an effect from one position to the other.
stopStops the transition.

Properties

set

Immediately sets the value with no transition.

Arguments

tothe point to jump to

Example

var myFx = new Fx.Style('myElement', 'opacity').set(0); //will make it immediately transparent

start

Executes an effect from one position to the other.

Arguments

frominteger: staring value
tointeger: the ending value

Examples

var myFx = new Fx.Style('myElement', 'opacity').start(0,1); //display a transition from transparent to opaque.

stop

Stops the transition.

Base class for the Effects.
A collection of tweening transitions for use with the Fx.Base classes.
Returns an empty function

Documentation by Aaron Newton & Mootools Developers, generated by NaturalDocs and GeSHi