worldwind-ui API / react-worldwind / TimeSliderProps

Interface: TimeSliderProps

Defined in: react/src/ui/TimeSlider.tsx:21

Properties

className?

optional className?: string

Defined in: react/src/ui/TimeSlider.tsx:49

---

defaultValue?

optional defaultValue?: Date

Defined in: react/src/ui/TimeSlider.tsx:36

Initial value when uncontrolled. Defaults to the layers' default, else the end of the range.

---

end?

optional end?: string | Date

Defined in: react/src/ui/TimeSlider.tsx:28

---

format?

optional format?: (date, stepMs?) => string

Defined in: react/src/ui/TimeSlider.tsx:41

Formats the label.

Parameters

date

Date

stepMs?

number

Returns

string

---

heading?

optional heading?: string | null

Defined in: react/src/ui/TimeSlider.tsx:23

---

idleText?

optional idleText?: string

Defined in: react/src/ui/TimeSlider.tsx:48

Shown when no layer has a time dimension and no range is given.

---

layers?

optional layers?: readonly WWLayer[]

Defined in: react/src/ui/TimeSlider.tsx:25

Layers to drive. Defaults to every layer that declares a time dimension.

---

loop?

optional loop?: boolean

Defined in: react/src/ui/TimeSlider.tsx:45

Start over at the end while playing. Default true.

---

onChange?

optional onChange?: (date) => void

Defined in: react/src/ui/TimeSlider.tsx:37

Parameters

date

Date

Returns

void

---

playInterval?

optional playInterval?: number

Defined in: react/src/ui/TimeSlider.tsx:43

Milliseconds between steps while playing. Default 1000.

---

position?

optional position?: PanelPosition

Defined in: react/src/ui/TimeSlider.tsx:22

---

showPlay?

optional showPlay?: boolean

Defined in: react/src/ui/TimeSlider.tsx:46

---

start?

optional start?: string | Date

Defined in: react/src/ui/TimeSlider.tsx:27

Override the range the layers declare, or supply one when they declare none.

---

step?

optional step?: number

Defined in: react/src/ui/TimeSlider.tsx:30

Interval in milliseconds. Defaults to the finest step the layers declare, else one day.

---

timeFormat?

optional timeFormat?: TimeFormat

Defined in: react/src/ui/TimeSlider.tsx:39

How TIME is written in tile requests. Default auto.

---

value?

optional value?: Date

Defined in: react/src/ui/TimeSlider.tsx:34

Controlled value.

---

values?

optional values?: Date[]

Defined in: react/src/ui/TimeSlider.tsx:32

Explicit instants instead of a range.