TimeSliderViewModel | @types/arcgis-js-api

Hierarchy

Accessor
- TimeSliderViewModel

Index

Properties

Methods

Properties

declaredClass

declaredClass: string

destroyed

destroyed: boolean

Readonly effectiveStops

effectiveStops: Date[]

Defined specific locations on the timeline that the handles will snap to when manipulated.

fullTimeExtent

fullTimeExtent: TimeExtent

The temporal extent of the entire slider.

initialized

initialized: boolean

loop

loop: boolean

If animating, the time indicator(s) will restart if they reach the edge.

mode

mode: "instant" | "time-window" | "cumulative-from-start" | "cumulative-from-end"

The time slider mode.

playRate

playRate: number

The time (in milliseconds) between animation steps.

Readonly state

state: "disabled" | "ready" | "playing"

The view model's state.

stops

stops: StopsByDates | StopsByCount | StopsByInterval

Defines specific locations on the time slider where thumbs will snap to when manipulated.

timeExtent

timeExtent: TimeExtent

The current time extent of the time slider.

values

values: Date[]

The user defined time extent.

view

view: MapView | SceneView

A reference to the MapView or SceneView.

Methods

Protected _get

_get(propertyName: string): any
_get<T>(propertyName: string): T

Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:35
Parameters
- propertyName: string
Returns any
Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:36
Type parameters
- T
Parameters
- propertyName: string
Returns T

Protected _set

_set<T>(propertyName: string, value: T): TimeSliderViewModel

Inherited from Accessor._set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns TimeSliderViewModel

destroy

destroy(): void

Inherited from Accessor.destroy
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:26
Returns void

get

get<T>(propertyName: string): T
get(propertyName: string): any

Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:28
Type parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:29
Parameters
- propertyName: string
Returns any

next(): void

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:90858
Incrementally moves the time extent forward one stop

Read more...

Returns void

Protected notifyChange

notifyChange(propertyName: string): void

Inherited from Accessor.notifyChange
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:34
Parameters
- propertyName: string
Returns void

play

play(): void

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:90864
Initiates the time slider's temporal playback.

Read more...

Returns void

previous(): void

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:90870
Incrementally moves the time extent back one stop.

Read more...

Returns void

set

set<T>(propertyName: string, value: T): TimeSliderViewModel
set(props: HashMap<any>): TimeSliderViewModel

Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:30
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns TimeSliderViewModel
Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:31
Parameters
- props: HashMap<any>
Returns TimeSliderViewModel

stop

stop(): void

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:90876
Stops the time slider's temporal playback.

Read more...

Returns void

updateWebDocument

updateWebDocument(webmap: WebMap): void

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:90882
Updates the time slider widget definition in the provided WebMap.

Read more...

Parameters
- webmap: WebMap
Returns void

watch

watch(path: string | string[], callback: WatchCallback, sync?: boolean): WatchHandle

Inherited from Accessor.watch
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:32
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle

Hierarchy

Index

Properties

Methods

Properties

declaredClass

destroyed

Readonly effectiveStops

fullTimeExtent

initialized

loop

mode

playRate

Readonly state

stops

timeExtent

values

view

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type parameters

T

Parameters

propertyName: string

value: T

Returns TimeSliderViewModel

destroy

Returns void

get

Type parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

next

Returns void

Protected notifyChange

Parameters

propertyName: string

Returns void

play

Returns void

previous

Returns void

set

Type parameters

T

Parameters

propertyName: string

value: T

Returns TimeSliderViewModel

Parameters

props: HashMap<any>

Returns TimeSliderViewModel

stop

Returns void

updateWebDocument

Parameters

webmap: WebMap

Returns void

watch

Parameters

path: string | string[]

callback: WatchCallback

Optional sync: boolean

Returns WatchHandle