Class DualScaleTrack

A scale track that supports interpolation between two scale domains. Requires container to supply a scale handler in the onMount event.

The dual scale has a master/slave mode, which can be toggled to change its behaviour (switch between domains), using the scale-handler's setMode-function.

Hierarchy (view full)

  • SvgTrack<DualScaleTrackOptions>
    • DualScaleTrack

Constructors

constructor

Properties

_data _isLoading _mounted elm error id labelBounds legendUpdate? loader options order plotGroup scale scaleHandler ticks transform viewMode xscale

Accessors

data extent isLoading isMaster isMounted

Methods

clearData createMeasures createRuler createTicks init loadData onDataLoaded onError onMount onRescale onUnmount onUpdate plot refresh

Constructors

constructor

Properties

Protected _data

_data: any

Protected _isLoading

_isLoading: boolean

Protected _mounted

_mounted: boolean

elm

elm: HTMLElement

error

error: string | Error

id

id: string | number

labelBounds

labelBounds: LabelBounds

Optional legendUpdate

legendUpdate?: LegendTriggerFunction

loader

loader: any

options

options: DualScaleTrackOptions

order

order: number

Protected plotGroup

plotGroup: any

scale

scale: Scale

scaleHandler

scaleHandler: InterpolatedScaleHandler

ticks

ticks: number[]

transform

transform: Transform

viewMode

viewMode: number

xscale

xscale: Scale

Accessors

data

  • get data(): any

  • Returns any

  • set data(data): void

  • Parameters

    • data: any

    Returns void

extent

isLoading

  • get isLoading(): boolean

  • Returns boolean

  • set isLoading(val): void

  • Parameters

    • val: boolean

    Returns void

isMaster

isMounted

  • get isMounted(): boolean

  • Returns boolean

Methods

clearData

createMeasures

createRuler

createTicks

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

refresh

Settings

Member Visibility

Theme

On This Page

constructor_data_isLoading_mountedelmerroridlabelBoundslegendUpdateloaderoptionsorderplotGroupscalescaleHandlertickstransformviewModexscaledataextentisLoadingisMasterisMountedclearDatacreateMeasurescreateRulercreateTicksinitloadDataonDataLoadedonErroronMountonRescaleonUnmountonUpdateplotrefresh

Generated using TypeDoc