Interface StackedTrackOptions

interface StackedTrackOptions {
    abbr?: string;
    data?: any;
    horizontal?: boolean;
    label?: string;
    labelRotation?: number;
    legendConfig?: LegendConfig;
    loader?: Element;
    maxWidth?: number;
    showLabels?: boolean;
    showLines?: boolean;
    tooltip?: string;
    width?: number;
    onError?(error, track): void;
    onMount?(event, track): void;
    onRescale?(event, track): void;
    onUnmount?(event, track): void;
    onUpdate?(event, track): void;
}

Hierarchy

  • TrackOptions
    • StackedTrackOptions

Properties

abbr? data? horizontal? label? labelRotation? legendConfig? loader? maxWidth? showLabels? showLines? tooltip? width?

Methods

onError? onMount? onRescale? onUnmount? onUpdate?

Properties

Optional abbr

abbr?: string

Short label to use in title if used with TrackGroup

Optional data

data?: any

Brief

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 horizontal

horizontal?: boolean

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

Optional label

label?: string

Label to use in title if used with TrackGroup

Optional labelRotation

labelRotation?: number

Brief

Rotation angle for the labels.

The angle is computed clockwise from the track central line. (i.e. The vertical line if the track is vertical and the horizontal line if the track is horizontal.)

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 showLabels

showLabels?: boolean

Brief

Option to show labels on the track.

Optional showLines

showLines?: boolean

Brief

Option to show lines on the track.

Optional tooltip

tooltip?: string

Tooltip to show when mouse hovers over track title if used with TrackGroup

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.

Methods

Optional onError

  • onError(error, track): void

  • Hook if a track is set in an error state

    Parameters

    • error: string | Error
    • track: Track<TrackOptions>

      track instance reference

    Returns void

Optional onMount

  • onMount(event, track): void

  • Hook when track is mounted to the DOM

    Parameters

    • event: OnMountEvent

      event data

    • track: Track<TrackOptions>

      track instance reference

    Returns void

Optional onRescale

  • onRescale(event, track): void

  • Hook when track is being rescaled, for example from user interaction if used with a LogController.

    Parameters

    • event: OnRescaleEvent

      event data

    • track: Track<TrackOptions>

      track instance reference

    Returns void

Optional onUnmount

  • onUnmount(event, track): void

  • Hook when track is unmounted from the DOM

    Parameters

    • event: OnUnmountEvent

      event data

    • track: Track<TrackOptions>

      track instance reference

    Returns void

Optional onUpdate

  • onUpdate(event, track): void

  • Hook when track is updated in the DOM model.

    Parameters

    • event: OnUpdateEvent

      event data

    • track: Track<TrackOptions>

      track instance reference

    Returns void

Settings

Member Visibility

Theme

On This Page

abbrdatahorizontallabellabelRotationlegendConfigloadermaxWidthshowLabelsshowLinestooltipwidthonErroronMountonRescaleonUnmountonUpdate

Generated using TypeDoc