▾
import type { Format, Mode, State, StopsByDates, StopsByInterval } from "@arcgis/map-components/components/arcgis-time-bar/types.js";- Since
- ArcGIS Maps SDK for JavaScript 5.2
Types used to configure the Time Bar and Time Bar Slider components.
Type definitions
Format
Determines the format of the date displayed in the minimum,
maximum, and time extent labels of the Time Bar component.
If "date" is specified, only the localized day, month, and year components will be displayed, for example, "6/21/2026" in the "en-US" locale.
If "date-time" is specified, the localized day, month, year, hour, minute, and second components will be displayed, for example,
"6/21/2026, 3:30:00 PM" in the "en-US" locale.
- Type
- "date-time" | "date"
Mode
Defines the different modes of the Time Bar component.
- Type
- "cumulative-from-end" | "cumulative-from-start" | "instant" | "time-window"
State
Defines the different states of the Time Bar component.
- Type
- "disabled" | "playing" | "ready"
StopsByDates
Stops are positioned at specific dates.
- See also
dates
- Type
- Date[]
StopsByInterval
Stops are positioned at regular intervals defined by a time interval.
- See also
timeExtent
- Type
- TimeExtent | undefined
The time extent over which the stops will be distributed.
StopsByCount
Stops are positioned at a specific number of evenly spaced locations for the Time Bar. The exact positions of the stops will be calculated based on the provided count and the time extent of the Time Bar.
- See also
timeExtent
- Type
- TimeExtent | undefined
The time extent over which the stops will be distributed.
Stops
Defines the different ways stops can be specified for the Time Bar component.
- See also
- Type
- StopsByCount | StopsByDates | StopsByInterval
PopoverDisplay
Defines how and when popovers are displayed for the Time Bar Slider's thumb or range.
- Type
- "always" | "auto" | "none"