DiscreteAnimation Client Reference
The DiscreteAnimation inherits from
and sets the value of the property to the elements in a provided array of values.
DiscreteAnimation Client Properties
| Name | Description |
|---|
| duration | Length of the animation in seconds. The default is 1. |
| events | The 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. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| property | Property of the target element to set when animating |
| propertyKey | Optional 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). |
| target | |
| values | Array of possible values of the property that will be iterated over as the animation is played |
DiscreteAnimation Client Methods
| Name | Description |
|---|
| beginUpdate | |
| dispose |
Dispose the animation
|
| endUpdate | |
| getAnimatedValue |
Assign the value whose index corresponds to the current percentage
|
| getValue |
Get the current value from the property
|
| initialize | |
| 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 |
The onStart method is called just before the animation is played each time.
|
| 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
|
| raisePropertyChanged | Raises 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.
|
| updated | |
DiscreteAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|