TimeSliderProperties | @types/arcgis-js-api

Hierarchy

WidgetProperties
- TimeSliderProperties

Index

Properties

Optional container

container: string | HTMLElement

The ID or node representing the DOM element containing the widget.

Optional disabled

disabled: boolean

When true, sets the widget to a disabled state so the user cannot interact with it.

Optional fullTimeExtent

fullTimeExtent: TimeExtentProperties

The temporal extent of the entire slider.

Optional id

id: string

The unique ID assigned to the widget when the widget is created.

Optional label

label: string

The widget's label.

Optional labelFormatFunction

labelFormatFunction: DateLabelFormatter

A function used to specify custom formatting and styling of the min, max, and extent labels of the TimeSlider.

Optional layout

layout: "auto" | "compact" | "wide"

Determines the layout used by the TimeSlider widget.

Optional loop

loop: boolean

When true, the time slider will play its animation in a loop.

Optional mode

mode: "instant" | "time-window" | "cumulative-from-start" | "cumulative-from-end"

The time slider mode.

Optional playRate

playRate: number

The time (in milliseconds) between animation steps.

Optional stops

stops: StopsByDates | StopsByCount | StopsByInterval

Defines specific locations on the time slider where thumbs will snap to when manipulated.

Optional tickConfigs

tickConfigs: TickConfig[]

When set, overrides the default TimeSlider ticks labelling system.

Optional timeExtent

timeExtent: TimeExtentProperties

The current time extent of the time slider.

Optional timeVisible

timeVisible: boolean

Shows/hides time in the display.

Optional values

values: DateProperties[]

The user defined time extent.

Optional view

view: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" })

A reference to the MapView or SceneView.

Optional viewModel

viewModel: TimeSliderViewModelProperties

The view model for this widget.

Optional visible

visible: boolean

Indicates whether the widget is visible.