Class GraphTrack

An extension to CanvasTrack for rendering plots

See ./readme.md in source code for more info

Hierarchy (view full)

Constructors

constructor

Properties

_data _isLoading _mounted _transformCondition? _transformedData? ctx debounce elm error id legendUpdate? loader options order plots scale trackScale transform

Accessors

data isLoading isMounted

Methods

clearData createRange getCurrentCondition init loadData onDataLoaded onError onMount onRescale onUnmount onUpdate plot prepareData refresh scheduleUpdateTransform setPadding setPlotData setPlotOption updateDynamicScales updateRange updateTransform

Constructors

constructor

Properties

Protected _data

_data: any

Protected _isLoading

_isLoading: boolean

Protected _mounted

_mounted: boolean

Private Optional _transformCondition

_transformCondition?: number = null

Private Optional _transformedData

_transformedData?: any

ctx

ctx: CanvasRenderingContext2D

debounce

debounce: DebounceFunction

elm

elm: HTMLElement

error

error: string | Error

id

id: string | number

Optional legendUpdate

legendUpdate?: LegendTriggerFunction

loader

loader: any

options

options: GraphTrackOptions

order

order: number

plots

plots: Plot<PlotOptions>[]

scale

scale: Scale

trackScale

trackScale: Scale

transform

transform: Transform

Accessors

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

Methods

clearData

createRange

getCurrentCondition

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

onError

  • onError(error): void

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

    Parameters

    • error: string | Error

    Returns void

onMount

onRescale

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

onUpdate

plot

prepareData

refresh

scheduleUpdateTransform

setPadding

setPlotData

  • setPlotData(data): void

  • Updates all plots with data by triggering each plot's data accessor function.

    Parameters

    • data: any

    Returns void

setPlotOption

updateDynamicScales

updateRange

updateTransform

Settings

Member Visibility

Theme

On This Page

constructor_data_isLoading_mounted_transformCondition_transformedDatactxdebounceelmerroridlegendUpdateloaderoptionsorderplotsscaletrackScaletransformdataisLoadingisMountedclearDatacreateRangegetCurrentConditioninitloadDataonDataLoadedonErroronMountonRescaleonUnmountonUpdateplotprepareDatarefreshscheduleUpdateTransformsetPaddingsetPlotDatasetPlotOptionupdateDynamicScalesupdateRangeupdateTransform

Generated using TypeDoc