Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TimeSlider

Hierarchy

Index

Properties

container

container: string | HTMLElement

The ID or node representing the DOM element containing the widget.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

disabled

disabled: boolean

When true, sets the widget to a disabled state so the user cannot interact with it.

Read more...

Readonly effectiveStops

effectiveStops: Date[]

Lists the specific locations on the timeline where handle(s) will snap to when manipulated.

Read more...

fullTimeExtent

fullTimeExtent: TimeExtent

The temporal extent of the entire slider.

Read more...

Readonly iconClass

iconClass: string

The widget's default CSS icon class.

Read more...

id

id: string

The unique ID assigned to the widget when the widget is created.

Read more...

initialized

initialized: boolean

label

label: string

The widget's label.

Read more...

labelFormatFunction

labelFormatFunction: DateLabelFormatter

A function used to specify custom formatting and styling of the min, max, and extent labels of the TimeSlider.

Read more...

layout

layout: "auto" | "compact" | "wide"

Determines the layout used by the TimeSlider widget.

Read more...

loop

loop: boolean

When true, the time slider will play its animation in a loop.

Read more...

mode

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

The time slider mode.

Read more...

playRate

playRate: number

The time (in milliseconds) between animation steps.

Read more...

stops

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

Read more...

tickConfigs

tickConfigs: TickConfig[]

When set, overrides the default TimeSlider ticks labelling system.

Read more...

timeExtent

timeExtent: TimeExtent

The current time extent of the time slider.

Read more...

timeVisible

timeVisible: boolean

Shows/hides time in the display.

Read more...

values

values: Date[]

The user defined time extent.

Read more...

view

A reference to the MapView or SceneView.

Read more...

viewModel

The view model for this widget.

Read more...

visible

visible: boolean

Indicates whether the widget is visible.

Read more...

Methods

Protected _get

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

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): TimeSlider
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns TimeSlider

classes

  • classes(...classNames: any[]): string
  • A utility method used for building the value for a widget's class property.

    Read more...

    Parameters

    • Rest ...classNames: any[]

    Returns string

destroy

  • destroy(): void
  • Destroys the widget instance.

    Read more...

    Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

hasEventListener

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

isFulfilled

  • isFulfilled(): boolean
  • isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

    Read more...

    Returns boolean

isRejected

  • isRejected(): boolean
  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

isResolved

  • isResolved(): boolean
  • isResolved() may be used to verify if creating an instance of the class is resolved.

    Read more...

    Returns boolean

next

  • next(): void
  • Incrementally moves the time extent forward one stop.

    Read more...

    Returns void

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

  • Registers an event handler on the instance.

    Read more...

    Parameters

    Returns IHandle

own

  • Widget teardown helper.

    Read more...

    Parameters

    Returns void

play

  • play(): void
  • Initiates the time slider's temporal playback.

    Read more...

    Returns void

postInitialize

  • postInitialize(): void
  • This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

    Read more...

    Returns void

previous

  • previous(): void
  • Incrementally moves the time extent back one stop.

    Read more...

    Returns void

render

  • render(): any
  • This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

    Read more...

    Returns any

renderNow

  • renderNow(): void
  • Renders widget to the DOM immediately.

    Read more...

    Returns void

scheduleRender

  • scheduleRender(): void
  • This method is primarily used by developers when implementing custom widgets. Schedules widget rendering.

    Read more...

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns TimeSlider

  • Parameters

    Returns TimeSlider

stop

  • stop(): void
  • Stops the time slider's temporal playback.

    Read more...

    Returns void

updateWebDocument

  • updateWebDocument(webmap: WebMap): void
  • Updates the time slider widget definition in the provided WebMap.

    Read more...

    Parameters

    Returns void

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

Generated using TypeDoc