Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MapAnimationOptions

A data type that represents the configuration options for a map view's 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 alwaysShowFuture

alwaysShowFuture: boolean

Whether the map view should display future data layers for both past and future time periods. Default value is false.

Optional alwaysShowPast

alwaysShowPast: boolean

Whether the map view should display past data layers for both past and future time periods. Default value is false.

Optional autoplay

autoplay: boolean

Whether the animation should begin playing immediately when the map view is first rendered. Default value is false.

Optional duration

duration: number

Duration of the animation in seconds.

Optional enabled

enabled: boolean

Whether animation should be enabled for the map view. Default value is true.

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 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