Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ImageAnimationOptions

A data type that represents the configuration options for an image-based animation.

Hierarchy

Index

Properties

Optional alwaysShow

alwaysShow: boolean

Whether to always show this animation, meaning it will also be visible if the animation is not a future animation and the current playhead is in the future, or the animation is a future animation and the playhead is in the past.

Optional autoplay

autoplay: boolean

Whether to begin playing the animation as soon as it's initialized. Default value is false.

Optional autosize

autosize: boolean

Whether animation images should be sized based on the size given by the provider.

Optional bufferIntervals

bufferIntervals: number

Total number of intervals to load before animation playback begins. Setting this value to a number lower than the value for intervals will allow playback to begin before all intervals have loaded for the animation. A value of 0 will start playing the animation immediately even if no intervals have fully loaded and may result in blank frames initially.

Set this value to -1 to disable this feature and require the animation to load all intervals before playback can begin.

Default value is -1.

Optional duration

duration: number

Duration of the animation in seconds.

Optional enabled

enabled: boolean

Whether the animation is enabled.

Optional endDelay

endDelay: number

End delay in seconds, which is the duration of the hold time on the last frame before restarting playback at the beginning.

Optional from

from: number | string

Start time offset in seconds relative to the current time, e.g. -5 * 3600 for five hours ago.

Optional future

future: boolean

Whether this animation is considered a future animation.

Optional intervals

intervals: number

Total number of intervals to request data for, specifically for image-related animations.

Optional key

key: string

Animation identifier.

Optional refresh

refresh: number

Refresh duration in seconds. This is typically only used for data-related animations that may need to reload stale data after a determined length of time.

Optional reverseLoadOrder

reverseLoadOrder: boolean

A Boolean that indicates whether animation intervals should be loaded in reversed order, which only applies if bufferIntervals is less than the value defined for intervals. Setting this to true will load the intervals at the end of the animation range first.

Default value is false.

Optional showLoadingIntervals

showLoadingIntervals: boolean

A Boolean indicating whether intervals should appear during an animation while still loading. If false, then only fully loaded intervals will appearing during animation playback when bufferIntervals is less than the total intervals in the animation.

Default is false.

Optional showWhenLoading

showWhenLoading: boolean

Whether the animation should remain visible while loading animation intervals.

Default value is true.

Optional showWhenStopped

showWhenStopped: boolean

Whether the animation should remain visible when playback has stopped.

Optional times

times: Date[]

An array of Date instances to use for the animation intervals. If not provided, then the animation interval times will be evenly calculated across the time range based on the total number of intervals to use for the animation.

Optional to

to: number | string

End time offset in seconds relative to the current time, e.g. 2 * 3600 for two hours from now.

Generated using TypeDoc