Class TimeSlider

TimeSlider class - Receives input and forward it to App class

Hierarchy

  • TimeSlider

Constructors

  • Parameters

    • w: number

      Width

    • h: number

      Height

    • dateStart: string

      Start date

    • dateEnd: string

      End date

    • Optional theme: any

      Theme

    Returns TimeSlider

Accessors

  • get app(): App
  • Returns App

    Returns App

  • get chronosManager(): ChronosManager
  • Returns chronos manager

    Returns ChronosManager

  • get playbackControl(): PlaybackControl
  • Returns playbackcontrol object

    Returns PlaybackControl

  • get themeManager(): ThemeManager
  • Returns theme manager object

    Returns ThemeManager

  • get tooltip(): Tooltip
  • Returns Tooltip handler object

    Returns Tooltip

  • get zoomToSelectionPadding(): number
  • Padding between visible domain and selection boundaries in pixels

    Returns number

  • set zoomToSelectionPadding(padding: number): void
  • Parameters

    • padding: number

    Returns void

Methods

  • Beta

    Add highlighter

    Parameters

    Returns void

  • Creates a timeselection with specified time range and returns name of created timeselection (eg. addTimeSelection('2000-01-01T00:00:00.000Z','2019-12-31T23:59:59.999Z'))

    Parameters

    • startTime: string

      start time of selection

    • endTime: string

      end time of selection

    • Optional markerTime: string

    Returns string

  • Whether a redo operation is available

    Returns boolean

  • Whether an undo operation is available

    Returns boolean

  • Returns

    Speed of playback

    Returns number

  • Returns state of the given feature (eg. isFeatureEnabled('use_undoredo'))

    Parameters

    • featureName: string

      name of the feature (eg. use_undoredo)

    Returns boolean

  • Checks loop state of playback

    Returns boolean

  • Checks whether playback is in pause state

    Returns boolean

  • Checks whether playback is in play state

    Returns boolean

  • Checks whether playback is in stop state

    Returns boolean

  • Sets whether to map playback rate with real time

    Parameters

    • v: boolean

    Returns void

  • Removes callback function in chronos manager

    Parameters

    • eventName: string

      event name

    • Optional cb: ((properties: IEventData) => void)

      callback function

        • (properties: IEventData): void
        • Parameters

          • properties: IEventData

          Returns void

    Returns void

  • Registers callback function in chronos manager

    Parameters

    • eventName: string

      event name

    • cb: ((properties: IEventData) => void)

      callback function

        • (properties: IEventData): void
        • Parameters

          • properties: IEventData

          Returns void

    Returns void

  • Pauses current playback

    Returns void

  • Plays playback marker (eg. play('2018-01-01T00:00:00.000Z'))

    Parameters

    • Optional time: string

      time from where to begin playback

    Returns void

  • Redoes time selection changes

    Returns void

  • Refresh UI conponents

    Returns void

  • Beta

    Remove highlighter

    Parameters

    Returns void

  • Removes timeselection with specified name (eg. removeTimeSelection('ts_0'))

    Parameters

    • tsName: string

      name of the time selection to be removed

    Returns void

  • Resizes app on window resize

    Parameters

    • w: number

      width

    • h: number

      height

    Returns void

  • Sets playback speed level

    Parameters

    • speedLevel: number

      speedLevel value can be 1, 2, 4, 8, 16.

    Returns void

  • Sets playback time

    Parameters

    • time: number = 16000

      playback time (duration).

    Returns void

  • Wrapper for changing theme

    Parameters

    • themeId: string

      themeId

    • theme: any

      theme

    Returns void

  • Sets time indicator format to given format

    Parameters

    • format: TimeFormat

      time date format

    Returns void

  • Stops current playback and resets playback

    Returns void

  • Returns time format

    Returns string

  • Toggles the feature (eg. toggleFeature('use_undoredo',true))

    Parameters

    • featureName: string

      name of the feature (eg. use_undoredo)

    • state: boolean

      state of feature

    Returns void

  • Toggles loop state Set Toggles loop state (eg. toggleLoop(true))

    Parameters

    • Optional state: boolean

    Returns boolean

  • Undoes time selection changes

    Returns void

  • Sets state of user defined time format

    Parameters

    • v: boolean

    Returns void

  • Returns state of user defined time format

    Returns boolean

  • Return HTMLCanvasElement

    Returns HTMLCanvasElement

  • Zooms to new start and end time

    Parameters

    • startDateTime: string

      start time

    • endDateTime: string

      end time

    Returns void

  • Maximize time selection

    Parameters

    • padding: number = ...

    Returns void

Generated using TypeDoc