PulseAnimation Client Reference
The PulseAnimation fades an element in and our repeatedly to create a pulsating
effect. The iterations determines how many pulses there will be (which defaults
to three, but it will repeat infinitely if given zero or less). The duration
property defines the duration of each fade in or fade out, not the duration of
the animation as a whole.
PulseAnimation Client Properties
| Name | Description |
|---|
| animations | Array of child animations to be played (there are no assumptions placed on order because it will matter for some
derived animations like , but not for
others like ). To manipulate the child
animations, use the functions add, clear, remove, and removeAt. |
| 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. |
| forceLayoutInIE | Whether or not we should force a layout to be created for Internet Explorer by giving it a width and setting its
background color (the latter is required in case the user has ClearType enabled). The default value is true.
This is obviously ignored when working in other browsers. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInfinite | true if this animation will repeat forever, false otherwise. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| iterations | Number of times to repeatedly play the sequence. If zero or less iterations are specified, the sequence
will repeat forever. The default value is 1 iteration. |
| maximumOpacity | Maximum opacity to use when fading in or out. Its value can range from between 0 to 1. The default value is 1. |
| minimumOpacity | Minimum opacity to use when fading in or out. Its value can range from between 0 to 1. The default value is 0. |
| percentComplete | Percentage of the animation already played. |
| target | |
PulseAnimation Client Methods
| Name | Description |
|---|
| add |
Add an animation as a child of this animation.
|
| beginUpdate | |
| clear |
Clear the array of child animations.
|
| dispose |
Dispose the animation
|
| endUpdate | |
| getAnimatedValue |
Determine the state of the animation after the given percentage of its duration has elapsed
|
| initialize |
Initialize the parent along with any child animations that have not yet been initialized themselves
|
| 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 |
Raises an invalid operation exception because this will only be called if a SequenceAnimation
has been nested inside an (or a derived type).
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the sequence of animations 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
|
| remove |
Remove the animation from the array of child animations.
|
| removeAt |
Remove the animation at a given index from the array of child animations.
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current state of the animation
|
| stop |
Stop playing the entire sequence of animations
|
| updated | |
PulseAnimation 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.
|