require(["esri/webdoc/widgets/TimeSlider"], (TimeSlider) => { /* code goes here */ });
import TimeSlider from "@arcgis/core/webdoc/widgets/TimeSlider.js";
esri/webdoc/widgets/TimeSlider
Time animation is controlled by a configurable time slider. Those configurations are saved to the web document as a timeSlider widget.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The current time extent of the time slider. | TimeSlider | ||
The name of the class. | Accessor | ||
The temporal extent for the entire slider. | TimeSlider | ||
When | TimeSlider | ||
The number of stops. | TimeSlider | ||
The thumb count. | TimeSlider | ||
The time rate in milliseconds between animation steps. | TimeSlider | ||
Defines regularly spaced stops on the time slider from a TimeInterval object. | TimeSlider | ||
An array of dates for the time slider widget. | TimeSlider |
Property Details
-
currentTimeExtent
currentTimeExtent TimeExtentautocast
-
The current time extent of the time slider. See the timeExtent property of the time slider widget for more information.
-
fullTimeExtent
fullTimeExtent TimeExtentautocast
-
The temporal extent for the entire slider. See the fullTimeExtent property of the time slider widget for more information.
-
loop
loop Boolean
-
When
true
, the time slider will play its animation in a loop.
-
numStops
numStops Number
-
The number of stops. It divides the time slider's fullTimeExtent into equal parts. See the time slider widget's stops and StopsByCount properties.
-
numThumbs
numThumbs Number
-
The thumb count. See the time slider widget's mode and timeExtent properties. This value defaults to 1.
-
stopInterval
stopInterval TimeIntervalautocast
-
Defines regularly spaced stops on the time slider from a TimeInterval object. See the time slider widget's stops and StopsByInterval properties.
-
An array of dates for the time slider widget. Can be used to create irregularly spaced stops. See the time slider widget's stops and StopsByDates properties.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | TimeSlider | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | TimeSlider |
Method Details
-
Inherited from Accessor
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.