Class CursorXY<ResultTableBackgroundType>

Type Parameters

Hierarchy

Properties

scale

Methods

dispose getAutoFitStrategy getGridStrokeXCut getGridStrokeXStyle getGridStrokeYCut getGridStrokeYStyle getPointMarkerVisible getResultTableVisible getTickMarkerXVisible getTickMarkerYVisible getTickMarkersAllocateAxisSpace getVisible isDisposed offDispose onDispose setAutoFitStrategy setGridStrokeXCut setGridStrokeXStyle setGridStrokeYCut setGridStrokeYStyle setPointMarker setPointMarkerVisible setPosition setResultTable setResultTableVisible setTickMarkerX setTickMarkerXVisible setTickMarkerY setTickMarkerYVisible setTickMarkersAllocateAxisSpace setVisible

Properties

Readonly scale

scale: ScaleXY<ViewportScale1D>

Methods

dispose

  • Permanently destroy the component.

    To fully allow Garbage-Collection to free the resources used by the component, make sure to remove any references to the component and its children in application code.

    let chart = ...ChartXY()
    let axisX = chart.getDefaultAxisX()
    // Dispose Chart, and remove all references so that they can be garbage-collected.
    chart.dispose()
    chart = undefined
    axisX = undefined

    Returns

    Object itself for fluent interface

    Returns CursorXY<ResultTableBackgroundType>

getAutoFitStrategy

  • Get is auto-fit enabled. Affects logic of automatic fitting of Cursors ResultTable to the screen.

    Returns

    Boolean flag whether auto-fit is enabled

    Returns boolean

getGridStrokeXCut

  • Get is GridStrokeX cut at cursor location.

    Returns

    Boolean flag

    Returns boolean

getGridStrokeXStyle

  • Get style of x gridstroke

    Returns

    LineStyle of gridstroke

    Returns LineStyle

getGridStrokeYCut

  • Get is GridStrokeY cut at cursor location.

    Returns

    Boolean flag

    Returns boolean

getGridStrokeYStyle

  • Get style of y gridstroke

    Returns

    LineStyle of gridstroke

    Returns LineStyle

getPointMarkerVisible

getResultTableVisible

getTickMarkerXVisible

  • Get tick marker X visible or not.

    Returns

    Boolean.

    Returns boolean

getTickMarkerYVisible

  • Get tick marker Y visible or not.

    Returns

    Boolean.

    Returns boolean

getTickMarkersAllocateAxisSpace

  • Configure whether tick markers allocate space on Axis or not. Defaults to false to prevent cursor visibility from changing chart layout.

    Returns

    Object itself.

    Returns boolean

getVisible

  • Get element visibility.

    Returns

    true when element is set to be visible and false otherwise.

    Returns boolean

isDisposed

  • Check whether the object is disposed. Disposed objects should not be used!

    Returns

    true if object is disposed.

    Returns boolean

offDispose

  • Remove event listener from dispose event.

    Returns

    True if the listener is successfully removed and false if it is not found

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

onDispose

  • Subscribe to onDispose event. This event is triggered whenever the object is disposed.

    A component can only be disposed by the end user, by calling the dispose method on the component or the component which owns it.

     // Example usage

    Dashboard.onDispose(() => {
      console.log('Dashboard was disposed')
    })

    Dashboard.dispose()

    Returns

    Token of subscription

    Parameters

    • handler: (() => unknown)

      Handler function for event

        • (): unknown

        • Returns unknown

    Returns Token

setAutoFitStrategy

  • Set auto-fit strategy of Cursor. Affects logic of automatic fitting of Cursors ResultTable to the screen.

    Returns

    Object itself for fluent interface

    Parameters

    • Optional autoFitStrategy: AutoFitStrategyFactory<ResultTableBackgroundType>

      AutoFitStrategy factory or undefined to disable auto-fitting

    Returns CursorXY<ResultTableBackgroundType>

setGridStrokeXCut

  • Set is GridStrokeX cut at cursor location.

    Returns

    Object itself for fluent interface

    Parameters

    • cut: boolean

      Boolean flag

    Returns CursorXY<ResultTableBackgroundType>

setGridStrokeXStyle

setGridStrokeYCut

  • Set is GridStrokeY cut at cursor location.

    Returns

    Object itself for fluent interface

    Parameters

    • cut: boolean

      Boolean flag

    Returns CursorXY<ResultTableBackgroundType>

setGridStrokeYStyle

setPointMarker

setPointMarkerVisible

  • Set point marker visible or not.

    Returns

    Object itself.

    Parameters

    • visible: boolean

      Point marker visible?

    Returns CursorXY<ResultTableBackgroundType>

setPosition

  • Set cursor position.

    Returns

    Object itself.

    Parameters

    • Rest ...cursorPositions: CursorPositionXY[]

      Cursor position.

    Returns CursorXY<ResultTableBackgroundType>

setResultTable

  • Mutator function for Cursors ResultTable. ResultTable is a visual that displays currently pointed data next to its location

    Returns

    Object itself for fluent interface

    Parameters

    • mutator: Mutator<ResultTable<ResultTableBackgroundType>>

      Mutator function for ResultTable

    Returns CursorXY<ResultTableBackgroundType>

setResultTableVisible

  • Set result table visible or not.

    Returns

    Object itself.

    Parameters

    • visible: boolean

      Result table visible?

    Returns CursorXY<ResultTableBackgroundType>

setTickMarkerX

  • Mutator function for x tick marker. Applies function to current tick marker if it exists and for any newly created tick marker in order of adding.

    Returns

    Object itself

    Remarks

    Method can't currently be implemented in a clean way so its usage currently will consume unneeded memory. It's repeating usage should be avoided for now.

    Parameters

    Returns CursorXY<ResultTableBackgroundType>

setTickMarkerXVisible

  • Set tick marker X visible or not.

    Returns

    Object itself

    Parameters

    • visible: boolean

      Tick marker X visible?

    Returns CursorXY<ResultTableBackgroundType>

setTickMarkerY

  • Mutator function for y tick marker. Applies function to current tick marker if it exists and for any newly created tick marker in order of adding.

    Returns

    Object itself

    Remarks

    Method can't currently be implemented in a clean way so its usage currently will consume unneeded memory. It's repeating usage should be avoided for now.

    Parameters

    Returns CursorXY<ResultTableBackgroundType>

setTickMarkerYVisible

  • Set tick marker Y visible or not.

    Returns

    Object itself

    Parameters

    • visible: boolean

      Tick marker Y visible?

    Returns CursorXY<ResultTableBackgroundType>

setTickMarkersAllocateAxisSpace

  • Configure whether tick markers allocate space on Axis or not. Defaults to false to prevent cursor visibility from changing chart layout.

    Returns

    Object itself.

    Parameters

    • state: boolean

      Boolean.

    Returns CursorXY<ResultTableBackgroundType>

setVisible

  • Set element visibility.

    Returns

    Object itself.

    Parameters

    • state: boolean

      true when element should be visible and false when element should be hidden.

    Returns CursorXY<ResultTableBackgroundType>

Settings

Member Visibility

Theme