Class Cursor2D<ResultTableBackgroundType>

Type Parameters

Hierarchy

Properties

scale

Methods

dispose getAutoFitStrategy getPointMarkerVisible getResultTableVisible getVisible isDisposed offDispose onDispose setAutoFitStrategy setPointMarker setPointMarkerVisible setPosition setResultTable setResultTableVisible 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 Cursor2D<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

getPointMarkerVisible

getResultTableVisible

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 Cursor2D<ResultTableBackgroundType>

setPointMarker

setPointMarkerVisible

  • Set point marker visible or not.

    Returns

    Object itself.

    Parameters

    • visible: boolean

      Point marker visible?

    Returns Cursor2D<ResultTableBackgroundType>

setPosition

  • Set cursor position.

    Returns

    Object itself.

    Parameters

    • cursorPosition2D: CursorPosition2D

    Returns Cursor2D<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 Cursor2D<ResultTableBackgroundType>

setResultTableVisible

  • Set result table visible or not.

    Returns

    Object itself.

    Parameters

    • visible: boolean

      Result table visible?

    Returns Cursor2D<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 Cursor2D<ResultTableBackgroundType>

Settings

Member Visibility

Theme