API Reference › imodel-components-react› Timeline › BaseTimelineDataProvider

BaseTimelineDataProvider Class

Base Timeline Data Provider

Implements

Methods

Name Description
constructor(viewport?: ScreenViewport): BaseTimelineDataProvider    
getSettings(): PlaybackSettings    
loadTimelineData(): Promise<boolean> Async call to load milestone and settings data  
onAnimationFractionChanged(_animationFraction: number): void    
onPlaybackSettingChanged(_settings: PlaybackSettings): void    
updateSettings(settings: PlaybackSettings): void Called to save the playback settings  

Properties

Name Type Description
_settings Protected PlaybackSettings    
_viewport Protected undefined | ScreenViewport    
animationFraction number Current animation fraction from 0.0 to 1.0  
duration Accessor ReadOnly number Called to get playback duration  
end undefined | Date End date for entire timeline  
id Readonly "TestTimelineDataProvider" uniqueId of provider  
initialDuration Accessor ReadOnly number Called to get the initial scrubber location  
loop Accessor ReadOnly boolean If true the playback will continuously loop.  
start undefined | Date Starting date for entire timeline  
supportsTimelineAnimation boolean returns true if the provider has timeline animation data available  
viewId string view id when viewport is initially assigned  
viewport Accessor undefined | ScreenViewport viewport to show animation  
viewport Setter viewport(viewport: ScreenViewport): void viewport to show animation  

Defined in

Last Updated: 24 June, 2025