TimeSlider

AMD: require(["esri/webdoc/widgets/TimeSlider"], (TimeSlider) => { /* code goes here */ });
ESM: import TimeSlider from "@arcgis/core/webdoc/widgets/TimeSlider.js";
Class: esri/webdoc/widgets/TimeSlider
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.

See also

Constructors

TimeSlider

Constructor
new TimeSlider(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
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 true, the time slider will play its animation in a loop.

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

Property
currentTimeExtent TimeExtentautocast

The current time extent of the time slider. See the timeExtent property of the time slider widget for more information.

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

fullTimeExtent

Property
fullTimeExtent TimeExtentautocast

The temporal extent for the entire slider. See the fullTimeExtent property of the time slider widget for more information.

loop

Property
loop Boolean

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

numStops

Property
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

Property
numThumbs Number

The thumb count. See the time slider widget's mode and timeExtent properties. This value defaults to 1.

stopDelay

Property
stopDelay Number

The time rate in milliseconds between animation steps. See the time slider widget's playRate property. This value defaults to 1000.

stopInterval

Property
stopInterval TimeIntervalautocast

Defines regularly spaced stops on the time slider from a TimeInterval object. See the time slider widget's stops and StopsByInterval properties.

stops

Property
stops Date[]

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

Show inherited methods Hide inherited methods
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

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
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();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

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

fromJSON

Method
fromJSON(json){*}static

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.

Parameter
json Object

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
Type Description
* Returns a new instance of this class.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON

Method
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.