@equinor/videx-wellog
    Preparing search index...

    Interface StackedTrackOptions

    interface StackedTrackOptions {
        abbr?: string;
        data?: any;
        horizontal?: boolean;
        label?: string;
        labelOptions?: StackedTrackLabelOptions;
        legendConfig?: LegendConfig;
        loader?: Element;
        maxWidth?: number;
        showLabels?: boolean;
        showLines?: boolean;
        tooltip?: string;
        width?: number;
        onError?(error: string | Error, track: Track): void;
        onMount?(event: OnMountEvent, track: Track): void;
        onRescale?(event: OnRescaleEvent, track: Track): void;
        onUnmount?(event: OnUnmountEvent, track: Track): void;
        onUpdate?(event: OnUpdateEvent, track: Track): void;
    }

    Hierarchy

    • TrackOptions
      • StackedTrackOptions
    Index

    Properties

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

    Methods

    onError? onMount? onRescale? onUnmount? onUpdate?

    Properties

    abbr?: string

    Short label to use in title if used with TrackGroup

    data?: 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.

    horizontal?: boolean

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

    label?: string

    Label to use in title if used with TrackGroup

    labelOptions?: StackedTrackLabelOptions

    Option for the label logic.

    legendConfig?: LegendConfig

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

    loader?: Element

    An optional loader element that will be made visible during loading

    maxWidth?: number

    Max width of track in pixels

    showLabels?: boolean

    Option to show labels on the track.

    showLines?: boolean

    Option to show lines on the track.

    tooltip?: string

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

    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

    • Hook if a track is set in an error state

      Parameters

      • error: string | Error
      • track: Track

        track instance reference

      Returns void

    • Hook when track is mounted to the DOM

      Parameters

      • event: OnMountEvent

        event data

      • track: Track

        track instance reference

      Returns void

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

      Parameters

      • event: OnRescaleEvent

        event data

      • track: Track

        track instance reference

      Returns void

    • Hook when track is unmounted from the DOM

      Parameters

      • event: OnUnmountEvent

        event data

      • track: Track

        track instance reference

      Returns void

    • Hook when track is updated in the DOM model.

      Parameters

      • event: OnUpdateEvent

        event data

      • track: Track

        track instance reference

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods