Use dark colors for code blocks Copy
1
import "@arcgis/map-components/components/arcgis-time-slider";No specific import is needed for this component.
The Time Slider component simplifies visualization of temporal data in your application.
Demo Properties actionsProperty
Defines actions that will appear in a menu when the user clicks the ellipsis button in the widget.
Property
autoDestroyDisabled: boolean
If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy method when you are done to prevent memory leaks.
disabled: boolean
When true, sets the widget to a disabled state so the user cannot interact with it.
readonlyProperty
effectiveStops: Array<Date>
Lists the specific locations on the timeline where handle(s) will snap to when manipulated.
Property
The temporal extent of the entire slider.
Property
icon: string
Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
Property
label: string
The widget's default label.
Property
layout: "auto" | "compact" | "wide"
Determines the layout used by the TimeSlider widget.
Property
loop: boolean
When true, the time slider will play its animation in a loop.
Property
mode: "cumulative-from-end" | "cumulative-from-start" | "instant" | "time-window"
The time slider mode.
Property
playRate: number
The time (in milliseconds) between animation steps.
Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Property
By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
state: "disabled" | "playing" | "ready"
The current state of the component.
Property
Defines specific locations on the time slider where thumbs will snap to when manipulated.
Property
When set, overrides the default TimeSlider ticks labelling system.
Property
The current time extent of the time slider.
Property
timeVisible: boolean
Shows/hides time in the display.
Property
timeZone: string
Dates and times displayed in the widget will be displayed in this time zone.
No slots to display.
Events arcgisPropertyChangeEvent
arcgisPropertyChange: CustomEvent<{ name: "state" | "timeExtent" | "effectiveStops" | "fullTimeExtent"; }>
Emitted when the value of a property is changed. Use this to listen to changes to properties.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReadyEvent
arcgisReady: CustomEvent<void>
Emitted when the component associated with a map or scene view is is ready to be interacted with.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisTriggerActionEvent
arcgisTriggerAction: TimeSliderTriggerActionEvent
Emitted when an action is triggered on the component.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods Method SignatureapplyTimeSliderSettings
applyTimeSliderSettings(settings: Pick<__esri.TimeSliderProperties, "fullTimeExtent" | "loop" | "stops">): Promise<void>
componentOnReady
componentOnReady(): Promise<void>
destroy
destroy(): Promise<void>
next
next(): Promise<void>
play
play(): Promise<void>
previous
previous(): Promise<void>
stop
stop(): Promise<void>
updateWebDocument
updateWebDocument(webmap: __esri.WebMap): Promise<void>
Method
applyTimeSliderSettings(settings: Pick<__esri.TimeSliderProperties, "fullTimeExtent" | "loop" | "stops">): Promise<void>
settings
{ loop?: boolean | undefined; fullTimeExtent?: nullish | TimeExtentProperties; stops?: nullish | Array<Date>; }
Method
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
ExampleUse dark colors for code blocks Copy
1
2
3
4
const arcgisTimeSlider = document.querySelector("arcgis-time-slider");
document.body.append(arcgisTimeSlider);
await arcgisTimeSlider.componentOnReady();
console.log("arcgis-time-slider is ready to go!");Method
destroy(): Promise<void>
Permanently destroy the component.
Method
next(): Promise<void>
Method
play(): Promise<void>
Method
previous(): Promise<void>
Method
stop(): Promise<void>
Method
updateWebDocument(webmap: __esri.WebMap): Promise<void>
webmap
WebMap
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