ColorAnimation Reference

Modified on 2010/05/04 23:39 by Stephen Walther — Categorized as: Uncategorized

ColorAnimation Client Reference

The ColorAnimation transitions the value of the property between two colors (although it does ignore the alpha channel). The colors must be 7-character hex strings (like #246ACF).

ColorAnimation Client Properties

durationLength of the animation in seconds. The default is 1.
endValueEnd of the range of values
eventsThe collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code.
fpsNumber of steps per second. The default is 25.
isActivetrue if animation is active, false if not.
isPlayingtrue if animation is playing, false if not.
percentCompletePercentage of the animation already played.
propertyProperty of the target element to set when animating
propertyKeyOptional key of the property to be set (which indicates the value propertypropertyKey, like style'backgroundColor'). Note that for the style property, the key must be in a JavaScript friendly format (i.e. backgroundColor instead of background-color).
startValueStart of the range of values

ColorAnimation Client Methods

dispose Dispose the animation
getAnimatedValue Get the interpolated color values
getRGB Convert the color to an RGB triplet
getValue Get the current value from the property
interpolate The interpolate function is used to find the appropriate value between starting and ending values given the current percentage.
onEnd The onEnd method is called just after the animation is played each time.
onStart Determine which dimensions of color will be animated
onStep The onStep method is called repeatedly to progress the animation through each frame
pause Pause the animation if it is playing. Calling play will resume where the animation left off.
play Play the animation from the beginning or where it was left off when paused.
play Create an animation, play it immediately, and dispose it when finished.
raiseEnded Raise the ended event
raisePropertyChangedRaises a change notification event.
raiseStarted Raise the started event
raiseStep Raise the step event
setOwner Make this animation the child of another animation
setValue Set the current value of the property
stop Stop playing the animation.
toColor Convert an RBG triplet into a 7-character hex string (like #246ACF)

ColorAnimation Client Events

ended Adds an event handler for the ended event.
started Adds an event handler for the started event.
step Adds an event handler for the step event.