import TimeSlider from "@arcgis/core/webdoc/widgets/TimeSlider.js";const TimeSlider = await $arcgis.import("@arcgis/core/webdoc/widgets/TimeSlider.js");- Inheritance:
- TimeSlider→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.30
Time animation is controlled by a configurable time slider. Those configurations are saved to the web document as a timeSlider widget.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
TimeExtent | null | undefined | | |
declaredClass readonly inherited | ||
TimeExtent | null | undefined | | |
| | ||
| | ||
| | ||
| | ||
| | ||
| |
currentTimeExtent
- Type
- TimeExtent | null | undefined
The current time extent of the time slider. See the TimeSlider.timeExtent property of the time slider widget for more information.
fullTimeExtent
- Type
- TimeExtent | null | undefined
The temporal extent for the entire slider. See the TimeSlider.fullTimeExtent property of the time slider widget for more information.
loop
- Type
- boolean
When true, the time slider will play its animation in a loop.
- Default value
- false
numStops
The number of stops. It divides the time slider's TimeSlider.fullTimeExtent into equal parts. See the time slider widget's TimeSlider.stops and StopsByCount properties.
numThumbs
- Type
- ThumbCountType
The thumb count. See the time slider widget's TimeSlider.mode and TimeSlider.timeExtent properties. This value defaults to 1.
stopDelay
- Type
- number
The time rate in milliseconds between animation steps. See the time slider widget's TimeSlider.playRate property. This value defaults to 1000.
stopInterval
- Type
- TimeInterval | null | undefined
Defines regularly spaced stops on the time slider from a TimeInterval object. See the time slider widget's TimeSlider.stops and StopsByInterval properties.
stops
An array of dates for the time slider widget. Can be used to create irregularly spaced stops. See the time slider widget's TimeSlider.stops and StopsByDates properties.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
Creates a new instance of this class and initializes it with values from a JSON object
generated from an ArcGIS product. The object passed into the input json
parameter often comes from a response to a query operation in the REST API or a
toJSON()
method from another ArcGIS product. See the Using fromJSON()
topic in the Guide for details and examples of when and how to use this function.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects. | |
- Returns
- any
Returns a new instance of this class.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.
Type definitions
ThumbCountType
The thumb count. See the time slider widget's TimeSlider.mode and TimeSlider.timeExtent properties. This value defaults to 1.
- See also
- Type
- 1 | 2