new AnimationViewModel(clockViewModel)
The view model for the
Animation widget.
| Name | Type | Description |
|---|---|---|
clockViewModel |
ClockViewModel | The ClockViewModel instance to use. |
See:
Members
-
staticAnimationViewModel.defaultDateFormatter :AnimationViewModel~DateFormatter
-
Gets or sets the default date formatter used by new instances.
-
staticAnimationViewModel.defaultTicks
-
Gets or sets the default array of known clock multipliers associated with new instances of the shuttle ring.
-
staticAnimationViewModel.defaultTimeFormatter :AnimationViewModel~TimeFormatter
-
Gets or sets the default time formatter used by new instances.
-
clockViewModel :ClockViewModel
-
Gets the clock view model.
-
dateFormatter :AnimationViewModel~DateFormatter
-
Gets or sets the function which formats a date for display.
-
Default Value:
AnimationViewModel.defaultDateFormatter -
dateLabel :String
-
Gets the string representation of the current date. This property is observable.
-
faster :Command
-
Gets a command that increases the speed of animation.
-
multiplierLabel :String
-
Gets the string representation of the current multiplier. This property is observable.
-
pauseViewModel :ToggleButtonViewModel
-
Gets the pause toggle button view model.
-
playForwardViewModel :ToggleButtonViewModel
-
Gets the play toggle button view model.
-
playRealtimeViewModel :ToggleButtonViewModel
-
Gets the realtime toggle button view model.
-
playReverseViewModel :ToggleButtonViewModel
-
Gets the reverse toggle button view model.
-
shuttleRingAngle :Number
-
Gets or sets the current shuttle ring angle. This property is observable.
-
shuttleRingDragging :Boolean
-
Gets or sets whether the shuttle ring is currently being dragged. This property is observable.
-
Default Value:
false -
slower :Command
-
Gets a command that decreases the speed of animation.
-
snapToTicks :Boolean
-
Gets or sets whether dragging the shuttle ring should cause the multiplier to snap to the defined tick values rather than interpolating between them. This property is observable.
-
Default Value:
false -
timeFormatter :AnimationViewModel~TimeFormatter
-
Gets or sets the function which formats a time for display.
-
Default Value:
AnimationViewModel.defaultTimeFormatter -
timeLabel :String
-
Gets the string representation of the current time. This property is observable.
Methods
-
getShuttleRingTicks()
-
Gets a copy of the array of positive known clock multipliers to associate with the shuttle ring.
Returns:
The array of known clock multipliers associated with the shuttle ring. -
setShuttleRingTicks(positiveTicks)
-
Sets the array of positive known clock multipliers to associate with the shuttle ring. These values will have negative equivalents created for them and sets both the minimum and maximum range of values for the shuttle ring as well as the values that are snapped to when a single click is made. The values need not be in order, as they will be sorted automatically, and duplicate values will be removed.
Name Type Description positiveTicksArray.<Number> The list of known positive clock multipliers to associate with the shuttle ring.
Type Definitions
-
DateFormatter(date, viewModel) → String
-
A function that formats a date for display.
Name Type Description dateJulianDate The date to be formatted viewModelAnimationViewModel The AnimationViewModel instance requesting formatting. Returns:
The string representation of the calendar date portion of the provided date. -
TimeFormatter(date, viewModel) → String
-
A function that formats a time for display.
Name Type Description dateJulianDate The date to be formatted viewModelAnimationViewModel The AnimationViewModel instance requesting formatting. Returns:
The string representation of the time portion of the provided date.