ESM: import TimeSlider from "@arcgis/core/widgets/TimeSlider.js";
CDN: const TimeSlider = await $arcgis.import("@arcgis/core/widgets/TimeSlider.js");
Class: @arcgis/core/widgets/TimeSlider
Since: ArcGIS Maps SDK for JavaScript 4.12
The TimeSlider widget simplifies visualization of temporal data in your application. Before adding the TimeSlider to your application, you first should understand how it can be configured to correctly display your temporal data.
The fullTimeExtent property defines the entire time period within which you can visualize your time aware data using the TimeSlider widget. You can visualize temporal data up to a point in time, from a point in time, at an instant of time, or from data that falls within a time range by setting the mode property. The stops property defines specific locations on the TimeSlider where thumbs will snap to when manipulated. You can set this property to be either an array of dates, a number of evenly spaced stops or a specific time interval (e.g. days). The timeExtent property defines the current location of the thumbs.
If the time slider widget settings are invalid, the current time segment and thumbs will be drawn in a red color with a message indicating the issue.
Configuring your time aware dataThe TimeSlider widget can be configured to manipulate your time aware data in two different ways as outlined below:
Update the view's timeExtentThe TimeSlider widget can be configured to update the view's timeExtent when the view property is set on the widget. Use this approach if your service has been published with timeInfo information. This approach requires less code.
With this approach, whenever a TimeSlider's timeExtent is updated, the assigned view's timeExtent will also be updated. All time-aware layers will automatically update to conform to the view's timeExtent. Check out the Set time properties on data (ArcGIS Pro) and Configure time settings on a layer (ArcGIS Online) documents to learn how to enable time on your service.
// Create a TimeSlider for the first decade of the 21st century.
// set the TimeSlider's view property.
// Only show content for the 1st year of the decade for all
// time aware layers in the view.
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
view: view,
// show data within a given time range
// in this case data within one year
mode: "time-window",
fullTimeExtent: { // entire extent of the timeSlider
start: new Date(2000, 0, 1),
end: new Date(2010, 0, 1)
},
timeExtent: { // location of timeSlider thumbs
start: new Date(2000, 0, 1),
end: new Date(2001, 1, 1)
}
});
view.ui.add(timeSlider, "manual");
The TimeSlider widget can also be configured to apply a custom logic whenever the TimeSlider's timeExtent property changes. This approach can be used if your service has a date field but does not have time enabled. You can also use this approach if you want to have a complete control over the logic whenever the timeSlider's timeExtent updates.
For example, when the TimeSlider's timeExtent is updated, you may want to update the timeExtent property of client-side filters and effects on a FeatureLayerView, CSVLayerView, GeoJSONLayerView or OGCFeatureLayerView. A FeatureFilter can be used to filter out data that is not included in the current timeExtent, and a FeatureEffect can be used to apply a visual effect to features that are included in or excluded from the current timeExtent. The FeatureEffect can only be used in a 2D MapView.
Warning: When watching the timeExtent property, the view should not be set on the TimeSlider widget instance. Setting both the TimeSlider's view property (explained above) and applying a timeExtent to a client-side effect may result in excluded features not being rendered to the view. This is because excluded features have been filtered out by the view's timeExtent, so the effect will not show.
// Create a time slider to update layerView filter
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
mode: "cumulative-from-start",
});
view.ui.add(timeSlider, "manual");
// wait until the layer view is loaded
let timeLayerView;
view.whenLayerView(layer).then((layerView) => {
timeLayerView = layerView;
const fullTimeExtent = layer.timeInfo.fullTimeExtent;
const end = fullTimeExtent.start;
// set up time slider properties based on layer timeInfo
timeSlider.fullTimeExtent = fullTimeExtent;
timeSlider.timeExtent = {
start: null,
end: end
};
timeSlider.stops = {
interval: layer.timeInfo.interval
};
});
reactiveUtils.watch(
() => timeSlider.timeExtent,
(value) => {
// update layer view filter to reflect current timeExtent
timeLayerView.filter = {
timeExtent: value
};
}
);
The TimeSlider settings can be imported from a WebMap and applied to the TimeSlider widget by calling the getTimeSliderSettingsFromWebDocument utility method.
For example, the following snippet shows how a WebMap with TimeSlider settings can be loaded into a view.
// this webmap is saved with TimeSlider settings
const webmap = new WebMap({
portalItem: {
id: "your-webmap-id"
}
});
// set the TimeSlider widget to honor the TimeSlider settings from the webmap.
timeUtils.getTimeSliderSettingsFromWebDocument(webmap).then((timeSliderSettings) => {
const timeSlider = new TimeSlider({
...timeSliderSettings,
view
});
const { unit, value } = timeSlider.stops.interval;
console.log(`The stop interval is every ${value} ${unit}.`); // output: "This stop interval is every 3 weeks."
});
In the example above, the timeSlider definition in the webmap has a play rate (or thumbMovingRate) of 2 seconds. The following snippet overrides this setting.
const timeSlider = new TimeSlider({
...timeSliderSettings,
view,
playRate: 1000
});
console.log(`The playback rate is ${timeSlider.playRate} ms.`); // output: "The playback rate is 1000 ms."
It may be necessary to examine or adjust settings after they have been imported from a webmap. To determine when the import has completed you can watch for the ready state of the viewModel. The snippet expands or snaps the fullTimeExtent after the property has been computed from an associated webmap.
await reactiveUtils.whenOnce(() => timeSlider.viewModel.state === "ready");
timeSlider.fullTimeExtent = timeSlider.fullTimeExtent.expandTo("years");
new TimeSlider(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsSince: ArcGIS Maps SDK for JavaScript 4.21 TimeSlider since 4.12, actions added at 4.21.
Defines actions that will appear in a menu when the user clicks the ellipsis button in the widget. The ellipsis button will not display if this property is null or if the collection is empty. Each action is defined with a unique id, a title, and an icon.
The trigger-action event fires each time an action in the menu is clicked. This event can be used to execute custom code such as setting the timeExtent to a specific date or copying the timeExtent to the browser's clipboard.
Example
// Create a TimeSlider with two actions to snap the thumb to
// two specific time extents.
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
fullTimeExtent: {
start: new Date(2011, 0, 1),
end: new Date(2012, 0, 1)
},
mode: "instant",
actions: [
{
id: "quake",
icon: "exclamation-mark-triangle",
title: "Jump to Earthquake"
},
{
id: "quake-plus-one-month",
icon: "organization",
title: "One month later"
}
]
});
// listen to timeSlider's trigger-action event
// check what action user clicked on and respond accordingly.
timeSlider.on("trigger-action", (event) => {
const quake = new Date(Date.UTC(2011, 3, 11, 8, 16, 12));
const oneMonthLater = new Date(quake.getTime()).setMonth(quake.getMonth() + 1);
switch(event.action.id) {
case "quake":
timeSlider.timeExtent = {
start: quake,
end: quake
};
break;
case "quake-plus-one-month":
timeSlider.timeExtent = {
start: oneMonthLater,
end: oneMonthLater
};
break;
}
});The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.
Examples
// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
view: view,
container: document.createElement("div")
});
// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
position: "top-right"
});// Specify an already-defined HTML div element in the widget's container
const basemapGallery = new BasemapGallery({
view: view,
container: basemapGalleryDiv
});
// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
position: "top-right"
});
// HTML markup
<body>
<div id="viewDiv"></div>
<div id="basemapGalleryDiv"></div>
</body>// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
view: view
});
// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
position: "top-right"
});Inherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className.
Since: ArcGIS Maps SDK for JavaScript 4.16 TimeSlider since 4.12, disabled added at 4.16.
When true, sets the widget to a disabled state so the user cannot interact with it.
Example
// Create a timeslider widget that is initially disabled.
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
fullTimeExtent: {
start: new Date(2000, 5, 1),
end: new Date(2010, 0, 1)
},
disabled: true
});Lists the specific locations on the timeline where handle(s) will snap to when manipulated.
Example
timeSlider.effectiveStops.forEach((stop) => {
console.log(stop);
});The temporal extent of the entire slider. It defines the entire time period within which you can visualize your time aware data using the time slider widget.
Example
// Create a new TimeSlider with set dates
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
view: view
});
// wait for the time-aware layer to load
layer.when(() => {
// set up time slider properties based on layer timeInfo
timeSlider.fullTimeExtent = layer.timeInfo.fullTimeExtent;
timeSlider.stops = {
interval: layer.timeInfo.interval
};
});Since: ArcGIS Maps SDK for JavaScript 4.27 TimeSlider since 4.12, icon added at 4.27.
Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).
Inherited
Property id String
The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.
The widget's default label.
Since: ArcGIS Maps SDK for JavaScript 4.17 TimeSlider since 4.12, labelFormatFunction added at 4.17.
A function used to specify custom formatting and styling of the min, max, and extent labels of the TimeSlider. Please refer to DateLabelFormatter for more detailed information on how to configure the style and format of the labels.
The image below demonstrates how the date format, color, size, and font family of the label can be customized. The code for this specific configuration is shown in the following example.
Example
// The following example customizes the text and styling of the min, max and extent labels.
// Specifically:
// 1) min/max labels
// - short date format with en-us locale (e.g. "9/1/2020", "9/2/2020", "9/3/2020" etc)
// - use 'Orbitron' font, magenta color and 16pt size
// 2) extent label
// - display accumulated days (e.g. "Day 0", "Day 1", "Day 2" etc)
// - use 'Orbitron' font, red color and 22pt size
// The labelFormatFunction must wait until the time slider's properties are set.
// In this case, the function must wait until the time slider's fullTimeExtent is set.
const timeSlider = new TimeSlider({
container: "timeSlider",
view,
timeVisible: true,
loop: true,
labelFormatFunction: (value, type, element, layout) => {
if (!timeSlider.fullTimeExtent) {
element.setAttribute(
"style",
"font-family: 'Orbitron', sans-serif; font-size: 11px; color: black;"
);
element.innerText = "loading..."
return;
const normal = new Intl.DateTimeFormat("en-us");
switch (type) {
case "min":
case "max":
element.setAttribute(
"style",
"font-family: 'Orbitron', sans-serif; font-size: 16px; color: magenta;"
);
element.innerText = normal.format(value);
break;
case "extent":
const start = timeSlider.fullTimeExtent.start;
const days = (value[0].getTime() - start.getTime()) / 1000 / 3600 / 24;
element.setAttribute(
"style",
"font-family: 'Orbitron', sans-serif; font-size: 18px; color: red;"
);
element.innerText = `Day ${days}`;
break;
}
}
});Since: ArcGIS Maps SDK for JavaScript 4.16 TimeSlider since 4.12, layout added at 4.16.
Determines the layout used by the TimeSlider widget.
Possible values are listed below:
Value Description auto Automatically uses the "compact" layout when the widget width is less than 858 pixels. Otherwise the "wide" layout it used. compact Widget elements are oriented vertically. This layout is better suited to narrower widths. wide Widget elements are oriented laterally. This thinner design is better suited to wide applications.Possible Values:"auto" |"compact" |"wide"
Example
timeSlider.layout = "compact";When true, the time slider will play its animation in a loop.
Example
// Start a time slider animation that advances every second
// and restarts when it reaches the end.
timeSlider.set({
loop: true,
playRate: 1000
});
timeSlider.play();The time slider mode. This property is used for defining if the temporal data will be displayed cumulatively up to a point in time, a single instant in time, or within a time range. See the following table for possible values.
Possible Values:"instant" |"time-window" |"cumulative-from-start" |"cumulative-from-end"
Example
// Create a single thumbed time slider that includes all historic content.
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
view: view,
mode: "cumulative-from-start",
fullTimeExtent: {
start: new Date(2000, 0, 1),
end: new Date(2010, 0, 1)
},
timeExtent: {
start: null,
end: new Date(2001, 0, 1) //end date
}
}); playRate Number
The time (in milliseconds) between animation steps.
When a View is associated with a TimeSlider and the TimeSlider is playing, the playback will pause before advancing if the View is still updating. For example, if the playRate is set to 1,000 (one second) and the View takes 1.5 seconds to render then the TimeSlider thumb(s) will advance every 1.5 seconds rather than every second.
Example
// Start a time slider animation that advances
// ten times a second and stops when it reaches the end.
timeSlider.set({
loop: false,
playRate: 100
});
timeSlider.play();Defines specific locations on the time slider where thumbs will snap to when manipulated. If unspecified, ten evenly spaced stops will be added.
For continuous sliding, set stops to null:
timeSlider.stops = null;
To define regularly spaced stops, parse an object with interval and timeExtent properties with types TimeInterval and TimeExtent respectively. The timeExtent property is optional and used to confine stops to a certain date range. This property is useful to commence stops on a specific day of the week or month. If a stop definition by interval results in excess of 10,000 stops, then the view model will default to ten evenly spaced stops.
// Add yearly intervals starting from the beginning of the TimeSlider.
timeSlider.stops = {
interval: {
value: 1,
unit: "years"
}
};
Rather than setting the stops as time intervals, the TimeSlider can be divided into evenly spaced stops using the count property. Similar to the previous method, divisions can be confined to a specific date range using the optional timeExtent property.
// Add stops at 15 evenly spaced intervals.
timeSlider.stops = {
count: 15
};
For irregularly spaced stops, simply assign an array of dates as demonstrated below.
// Add nine irregular stops.
timeSlider.stops = {
dates: [
new Date(2000, 0, 1), new Date(2001, 3, 8), new Date(2002, 0, 10),
new Date(2003, 12, 8), new Date(2004, 2, 19), new Date(2005, 7, 5),
new Date(2006, 9, 11), new Date(2007, 11, 21), new Date(2008, 1, 10)
]
};
Lastly, to constrain or offset division by count or interval use the optional timeExtent property.
// Add yearly stops from Christmas 2019 to Christmas 2029 only
timeSlider.stops = {
interval: {
value: 1,
unit: "years"
},
timeExtent: {
start: new Date(2019, 11, 25),
end: new Date(2029, 11, 25)
}
};
// Likewise, add stops that represent quarters of 2019 only.
timeSlider.stops = {
count: 4,
timeExtent: {
start: new Date(2019, 0, 1),
end: new Date(2020, 0, 1)
}
};
Default Value:{ count : 10 }
Since: ArcGIS Maps SDK for JavaScript 4.16 TimeSlider since 4.12, tickConfigs added at 4.16.
When set, overrides the default TimeSlider ticks labelling system. Please refer to TickConfig for detailed documentation on how to configure tick placement, style, and behavior.
Examples
// By default in "en-US" the TimeSlider will display ticks with "2010, 2011, 2012, etc".
// Overwrite TimeSlider tick configuration so that labels display "'10, '12, '14, etc" in red.
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
fullTimeExtent: {
start: new Date(2010, 0, 1),
end: new Date(2020, 0, 1)
},
tickConfigs: [{
mode: "position",
values: [
new Date(2010, 0, 1), new Date(2012, 0, 1), new Date(2014, 0, 1),
new Date(2016, 0, 1), new Date(2018, 0, 1), new Date(2020, 0, 1)
].map((date) => date.getTime()),
labelsVisible: true,
labelFormatFunction: (value) => {
const date = new Date(value);
return `'${date.getUTCFullYear() - 2000}`;
},
tickCreatedFunction: (value, tickElement, labelElement) => {
tickElement.classList.add("custom-ticks");
labelElement.classList.add("custom-labels");
}
}]
};// this CSS goes with the snippet above.
#timeSlider .custom-ticks {
background-color: red;
width: 1px;
height: 8px;
}
#timeSlider .custom-labels {
font-family: Georgia, 'Times New Roman', Times, serif;
font-size: 15px;
color: red;
}The current time extent of the time slider. This property can be watched for updates and used to update the time extent property in queries and/or the layer filters and effects. The following table shows the timeExtent values returned for each mode.
time-window {start: startDate, end: endDate} instant {start: sameDate, end: sameDate} cumulative-from-start {start: null, end: endDate} cumulative-from-end {start: startDate, end: null}
Example
// Display the time extent to the console whenever it changes.
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
mode: "time-window",
fullTimeExtent: {
start: new Date(2019, 2, 3),
end: new Date(2019, 2, 5)
},
timeExtent: {
start: new Date(2019, 2, 1),
end: new Date(2019, 2, 28)
}
});
reactiveUtils.watch(
() => timeSlider.timeExtent,
(timeExtent) => {
console.log("Time extent now starts at", timeExtent.start, "and finishes at:", timeExtent.end);
}
); timeVisible Boolean
Shows/hides time in the display.
Example
// For time sliders with a small time extent it may be useful to display times as shown below.
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
mode: "time-window",
timeVisible: true,
fullTimeExtent: {
start: new Date(2019, 2, 3),
end: new Date(2019, 2, 5)
},
timeExtent: {
start: new Date(2019, 2, 1),
end: new Date(2019, 2, 28)
}
}); timeZone String
Since: ArcGIS Maps SDK for JavaScript 4.28 TimeSlider since 4.12, timeZone added at 4.28.
Dates and times displayed in the widget will be displayed in this time zone. By default this time zone is inherited from MapView.timeZone. When a MapView is not associated with the widget then the property will fallback to the system time zone.
Possible Values
Value Description system Dates and times will be displayed in the timezone of the device or browser. unknown Dates and time are not adjusted for any timezone. TimeSlider will be disabled. Specified IANA timezone Dates and times will be displayed in the specified IANA time zone. See wikipedia - List of tz database time zones.A reference to the MapView or SceneView. If this property is set, the TimeSlider widget will update the view's timeExtent property whenever the time slider is manipulated or updated programmatically. This property will affect any time-aware layer in the view.
Example
// Create and then add a TimeSlider widget and then listen to changes in the View's time extent.
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
view: view,
mode: "instant",
fullTimeExtent: {
start: new Date(2000, 0, 1),
end: new Date(2010, 0, 1)
},
timeExtent: {
start: new Date(2000, 0, 1),
end: new Date(2000, 0, 1)
}
});
view.ui.add(timeSlider, "top-left");
reactiveUtils.watch(
() => view.timeExtent,
(timeExtent) => {
console.log("New view time is: ", timeExtent.start);
}
);The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the TimeSliderViewModel class to access all properties and methods on the widget.
Example
// Below is an example of initializing a TimeSlider widget using properties
// on the viewModel instead of the widget.
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
viewModel: {
view: view,
mode: "instant",
fullTimeExtent: {
start: new Date(2000, 0, 1),
end: new Date(2010, 0, 1)
},
timeExtent: {
start: new Date(2000, 0, 1),
end: new Date(2000, 0, 1)
}
});Inherited
Property visible Boolean
Indicates whether the widget is visible.
If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of "none".
Example
// Hides the widget in the view
widget.visible = false;Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.
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
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.
Inherited
Method classes(classNames){String}
A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.
Returns
Type Description String The computed class name.Example
// .tsx syntax showing how to set css classes while rendering the widget
render() {
const dynamicClasses = {
[css.flip]: this.flip,
[css.primary]: this.primary
};
return (
<div class={classes(css.root, css.mixin, dynamicClasses)} />
);
}Inherited
Method destroy()
Destroys the widget instance.
Inherited
Method emit(type, event){Boolean}
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameters
The name of the event.
optionalThe event payload.
Returns
Type Description Booleantrue if a listener was notified
Inherited
Method hasEventListener(type){Boolean}
Indicates whether there is an event listener on the instance that matches the provided event name.
Returns
Type Description Boolean Returns true if the class supports the input event.Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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
Method isFulfilled(){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isFulfilled added at 4.19.
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).Inherited
Method isRejected(){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isRejected added at 4.19.
isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been rejected.Inherited
Method isResolved(){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isResolved added at 4.19.
isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been resolved.Incrementally moves the time extent forward one stop.
Example
// Advance the slider's time extent.
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
mode: "instant",
fullTimeExtent: {
start: new Date(2000, 0, 1),
end: new Date(2010, 0, 1)
},
timeExtent: {
start: new Date(2000, 0, 1),
end: new Date(2000, 0, 1)
}
});
timeSlider.next();Inherited
Method on(type, listener){Object}
Registers an event handler on the instance. Call this method to hook an event with a listener.
Returns
Type Description Object Returns an event handler with aremove() method that should be called to stop listening for the event(s). Property Type Description remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){
// event is the event handle returned after the event fires.
console.log(event.mapPoint);
});Initiates the time slider's temporal playback.
Example
// Start a TimeSlider animation if not already playing.
if (timeSlider.state === "ready") {
timeSlider.play();
}Inherited
Method postInitialize()
Executes after widget is ready for rendering.
previous()
Incrementally moves the time extent back one stop.
Example
Inherited
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA 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");Inherited
Method render(){Object}
This method is implemented by subclasses for rendering.
Returns
Type Description Object The rendered virtual node.Inherited
Method renderNow()
Renders widget to the DOM immediately.
Inherited
Method scheduleRender()
Schedules widget rendering. This method is useful for changes affecting the UI.
Stops the time slider's temporal playback.
Example
// Stop the current TimeSlider animation.
if (timeSlider.viewModel.state === "playing") {
timeSlider.stop();
} updateWebDocument(document)
Since: ArcGIS Maps SDK for JavaScript 4.18 TimeSlider since 4.12, updateWebDocument added at 4.18.
Updates the time slider widget definition in the provided WebMap or WebScene.
Example
// Load a webmap containing a timeslider widget into a MapView. Once loaded, advance the current time
// extent by one stop and then update the original webmap.
const webmap = new WebMap({
portalItem: {
id: "acea555a4b6f412dae98994bcfdbc002"
}
});
const view = new MapView({
container: "viewDiv",
map: webmap
});
await view.when();
const timeSlider = new TimeSlider({
view
});
// Advance to thumb to next time extent
timeSlider.next();
timeSlider.updateWebDocument(webmap);
webmap.save();Inherited
Method when(callback, errback){Promise}
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, when added at 4.19.
when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.
Parameters
optionalThe function to call when the promise resolves.
optionalThe function to execute when the promise fails.
Returns
Type Description Promise Returns a new Promise for the result ofcallback.
Example
// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
// This function will execute once the promise is resolved
}, function(error){
// This function will execute if the promise is rejected due to an error
}); DateLabelFormatter(value, type, element, layout)
This function is used by the labelFormatFunction property to specify custom formatting and styling of the min, max and extent labels of the time slider widget.
Parameters
The date(s) that correspond to labels. When the label type is min or max a single date value will be parsed. When the type is extent value will be a date array with two values. The first and second date in the array correspond the time extent's start and end values.
The label type that you want to format.
Possible Values:"min"|"max"|"extent"
The HTML element corresponding to the label type. You can add or modify the default style of individual labels by adding CSS classes to this element. You can also add custom behavior to labels by attaching event listeners to individual elements.
The TimeSlider layout.
Possible Values:"compact"|"wide"
StopsByCount Object
Divides the time slider's fullTimeExtent into equal parts. A stop will be placed at the start and end of each division resulting in count + 1 effectiveStops.
Number of evenly spaced divisions.
optionalThe time period to divide. If unspecified, the time slider's fullTimeExtent will be used.
Example
// Add ten evenly spaced stops.
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
fullTimeExtent: {
start: new Date(2000, 0, 1),
end: new Date(2004, 2, 19)
},
timeExtent: {
start: new Date(2000, 0, 1),
end: new Date(2000, 3, 8)
},
stops: {
count: 10
}
}); StopsByDates Object
Specifies an array of dates for the time slider widget. Can be used to create irregularly spaced stops.
Example
// Explicitly define 5 stops.
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
fullTimeExtent: {
start: new Date(2000, 0, 1),
end: new Date(2004, 2, 19)
},
timeExtent: {
start: new Date(2000, 0, 1),
end: new Date(2001, 3, 8)
},
stops: {
dates: [
new Date(2000, 0, 1),
new Date(2001, 3, 8),
new Date(2002, 0, 10),
new Date(2003, 12, 8),
new Date(2004, 2, 19)
]
}
}); StopsByInterval Object
Defines regularly spaced stops on the time slider from a TimeInterval. The optional TimeExtent can confine the subdivision to a specific time frame. StopByInterval is useful when the spacing is in terms of months and years, which cannot be reliably expressed in milliseconds.
Specifies a granularity of temporal data and allows you to visualize the data at specified intervals. It can be set at regular interval such as every hour or every day.
optionalA period of time with definitive start and end dates. The time slider widget's fullTimeExtent will be used if this property is not specified.
Example
// Add yearly intervals starting from the beginning of the TimeSlider.
const timeSlider = new TimeSlider({
container: "timeSliderDiv",
fullTimeExtent: {
start: new Date(2000, 0, 1),
end: new Date(2015, 2, 19)
},
timeExtent: {
start: new Date(2000, 0, 1),
end: new Date(2001, 0, 1)
},
stops: {
interval: {
value: 1,
unit: "years"
}
}
}); trigger-action
Since: ArcGIS Maps SDK for JavaScript 4.21 TimeSlider since 4.12, trigger-action added at 4.21.
Fires when a user clicks on an action in the actions menu.
Example
// Add an action to reset the time extent to the full time extent.
timeSlider.actions.add({
id: "full-extent",
icon: "content-full",
title: "Full Extent"
});
timeSlider.on("trigger-action", (event) => {
if (event.action.id === "full-extent") {
timeSlider.timeExtent = timeSlider.fullTimeExtent;
}
});RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4