Class CanvasTrack<TOptions>

constructor

• new CanvasTrack<TOptions>(id, options?): CanvasTrack<TOptions>

• Type Parameters

  • TOptions extends TrackOptions

  Parameters

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

  Returns CanvasTrack<TOptions>

elm

error

id

Optional legendUpdate

loader

options

order

scale

transform

data

• get data(): any

• Returns any

• set data(data): void

• Parameters

  • data: any

  Returns void

isLoading

• get isLoading(): boolean

• Returns boolean

• set isLoading(val): void

• Parameters

  • val: boolean

  Returns void

isMounted

• get isMounted(): boolean

• Returns boolean

clearData

• clearData(): void

• Returns void

init

• init(elm, scale): void

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

  Parameters

  • elm: HTMLElement
  • scale: Scale

  Returns void

loadData

• loadData(data, showLoader?): 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?): void

• Parameters

  • Optional data: any

  Returns void

onError

• onError(error): void

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

  Parameters

  • error: string | Error

  Returns void

onRescale

• onRescale(trackEvent): void

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

  Parameters

  • trackEvent: OnRescaleEvent

  Returns void

onUnmount

• onUnmount(trackEvent?): 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

refresh

• refresh(): void

• Allow triggering of update event without parameters

  Returns void