Class Track<TRACK_OPTIONS>Abstract

constructor

• new Track<TRACK_OPTIONS extends TrackOptions = TrackOptions>(
      id: string | number,
      options?: TRACK_OPTIONS,
  ): Track<TRACK_OPTIONS>

  Type Parameters

  • TRACK_OPTIONS extends TrackOptions = TrackOptions

  Parameters

  • id: string | number
  • options: TRACK_OPTIONS = ...

  Returns Track<TRACK_OPTIONS>

elm

error

id

OptionallegendUpdate

loader

options

order

scale

transform

data

• get data(): any

  Returns any

• set data(data: any): void

  Parameters

  • data: any

  Returns void

isLoading

• get isLoading(): boolean

  Returns boolean

• set isLoading(val: boolean): void

  Parameters

  • val: boolean

  Returns void

isMounted

• get isMounted(): boolean

  Returns boolean

clearData

• clearData(): void

  Returns void

init

• init(elm: HTMLElement, scale: Scale): void

  Calls OnMount and OnUpdate. Useful if track is stand-alone

  Parameters

  • elm: HTMLElement
  • scale: Scale

  Returns void

loadData

• loadData(data: any, showLoader?: boolean): void

  Initiate loading of data for track. Will set response to the track's data property. If showLoader is set to true, the current track will be hidden, and (if supplied) the loader element will be shown, until data is resolved. Calls onDataLoaded if implemented by track.

  Parameters

  • data: any
  • showLoader: boolean = true

  Returns void

onDataLoaded

• onDataLoaded(data?: any): void

  Parameters

  • Optionaldata: any

  Returns void

onError

• onError(error: string | Error): void

  Should be called from track implementation in case an unrecoverable error occurs.

  Parameters

  • error: string | Error

  Returns void

onMount

• onMount(trackEvent: OnMountEvent): void

  Handler for onMount event. Called by container when track DOM element is added to the DOM model.

  Parameters

  • trackEvent: OnMountEvent

  Returns void

onRescale

• onRescale(trackEvent: OnRescaleEvent): void

  Handler for onRescale event. Called by container when y-scale domain/transform is changed.

  Parameters

  • trackEvent: OnRescaleEvent

  Returns void

onUnmount

• onUnmount(trackEvent?: OnUnmountEvent): void

  Handler for onUnmount event. Called when track DOM-element is remove from the DOM model. Typically, trackEvent will be an empty object, but depends on container.

  Parameters

  • trackEvent: OnUnmountEvent = {}

  Returns void

onUpdate

• onUpdate(trackEvent: OnUpdateEvent): void

  Handler for onChange event. Called by container when track is resized.

  Parameters

  • trackEvent: OnUpdateEvent

  Returns void

refresh

• refresh(): void

  Allow triggering of update event without parameters

  Returns void