API Reference › appui-react› Timeline › ScheduleAnimationTimelineDataProvider

ScheduleAnimationTimelineDataProvider Class

ScheduleAnimation Timeline Data Provider - allows a TimelineComponent to animate the data found in a ScheduleScript in a ViewState.

Extends

  • BaseTimelineDataProvider

Methods

Name Description
constructor(viewState: ViewState, viewport?: ScreenViewport): ScheduleAnimationTimelineDataProvider    
loadTimelineData(): Promise<boolean>    
onAnimationFractionChanged(animationFraction: number): void    
onPlaybackSettingChanged(settings: PlaybackSettings): void    

Inherited methods

Name Inherited from Description
getSettings(): PlaybackSettings BaseTimelineDataProvider  
updateSettings(settings: PlaybackSettings): void BaseTimelineDataProvider  

Inherited properties

Name Type Inherited from Description
_settings Protected PlaybackSettings BaseTimelineDataProvider  
_viewport Protected undefined | ScreenViewport BaseTimelineDataProvider  
animationFraction number BaseTimelineDataProvider  
duration Accessor ReadOnly number BaseTimelineDataProvider Called to get playback duration
end undefined | Date BaseTimelineDataProvider  
id Readonly "TestTimelineDataProvider" BaseTimelineDataProvider  
initialDuration Accessor ReadOnly number BaseTimelineDataProvider Called to get the initial scrubber location
loop Accessor ReadOnly boolean BaseTimelineDataProvider  
start undefined | Date BaseTimelineDataProvider  
supportsTimelineAnimation boolean BaseTimelineDataProvider  
viewId string BaseTimelineDataProvider  
viewport Accessor undefined | ScreenViewport BaseTimelineDataProvider  

Defined in

Last Updated: 14 November, 2024