• Public
  • Public/Protected
  • All

Interface GraphTrackOptions

Available graph track options




Optional abbr

abbr: string

Short label to use in title if used with TrackGrouop

Optional alwaysTransform

alwaysTransform: boolean

Set to true to always run data transform function. By default (false), transforms will only run if the domain (zoom level) changes.

Optional data

data: Promise<any> | Function | any

Data for all plots in the track. May be of any type or a function or promise returning data. The plots will need to have a data accessor function defined, that can pick the data it needs from this value.

Optional domain

domain: Domain

Domain to use for the graph data range

Optional horizontal

horizontal: boolean

Orientation of track. Default is false or unset (vertical).

Optional label

label: string

Label to use in title if used with TrackGrouop

Optional legendConfig

legendConfig: LegendConfig

A config object used to display track legend if used with LogController

Optional loader

loader: Element

An optional loader element that will be made visible during loading

Optional maxWidth

maxWidth: number

Max width of track in pixels

Optional plotFactory

plotFactory: PlotFactory

Plot factory to use. If using custom plot types, you need to pass an extended/custom plot factory that knows how to create an instance of plot types which are not part of the libs standard plot types.

Optional plots

plots: PlotConfig[]

Collection of plot config objects

Optional scale

scale: string

Scale type to use. This scale applies to all plots unless the plot config has its own scale and domain set. Can be 'linear' or 'log'.

Optional showLoader

showLoader: boolean

Whether or not to show the loader or not (if configured)

Optional togglePlotFromLegend

togglePlotFromLegend: boolean

Determines if the legend should be clickable to toggle plots on/off when used within a LogController with graphLegendConfig enabled. Default is true.

Optional transform

transform: function

An optional function to transform the track data before being passed to the plots. This is typically used to downsample data at low zoom levels.

Type declaration

    • (data: any, scale: Scale): Promise<any>
    • Parameters

      Returns Promise<any>

Optional width

width: number

Relative track width when used in a LogController, i.e. a track with width set to 3 will be three times wider than tracks set to width 1.


Optional onError

  • onError(error: Error | string, track: Track): void

Optional onMount

Optional onRescale

Optional onUnmount

Optional onUpdate

Generated using TypeDoc