Interface Cursor<PointMarkerType, ResultTableBackgroundType>

Cursor is a hidable element that can be positioned on a point using a data-structure called 'DataPoint'. Cursors are formed from two distinct parts, PointMarker and ResultTable, first of which shows the location of the Cursor clearly and the second to display information about the pointed DataPoint.

Type Parameters

Hierarchy

Properties

getPointMarker getPosition getResultTable getVisible pointAt setPointMarker setResultTable setVisible

Methods

dispose getAutoFitStrategy getPointMarkerVisible getResultTableVisible setAutoFitStrategy setPointMarkerVisible setResultTableVisible

Properties

getPointMarker

getPointMarker: (() => PointMarkerType)

Type declaration

    • (): PointMarkerType

    • Get PointMarker object. PointMarker is a visual that is displayed at the Cursors position

      Returns

      PointMarker object

      Returns PointMarkerType

getPosition

getPosition: (() => Point)

Type declaration

    • (): Point

    • Get current position of Cursor on its scale

      Returns

      Position on Cursors scale

      Returns Point

getResultTable

getResultTable: (() => ResultTable<ResultTableBackgroundType>)

Type declaration

    • (): ResultTable<ResultTableBackgroundType>

    • Get ResultTable object. ResultTable is a visual that displays currently pointed data next to its location

      Returns

      ResultTable object

      Returns ResultTable<ResultTableBackgroundType>

getVisible

getVisible: (() => boolean)

Type declaration

    • (): boolean

    • Get element visibility.

      Returns

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

      Returns boolean

pointAt

pointAt: ((point: CursorPoint<Series2D<any>>) => Cursor<PointMarkerType, ResultTableBackgroundType>)

Type declaration

    • (point: CursorPoint<Series2D<any>>): Cursor<PointMarkerType, ResultTableBackgroundType>

    • Points the Cursor at a given CursorPoint. Updating its position and displayed data.

      Parameters

      Returns Cursor<PointMarkerType, ResultTableBackgroundType>

setPointMarker

setPointMarker: ((mutator: Mutator<PointMarkerType>) => Cursor<PointMarkerType, ResultTableBackgroundType>)

Type declaration

    • (mutator: Mutator<PointMarkerType>): Cursor<PointMarkerType, ResultTableBackgroundType>

    • Mutator function for PointMarker. PointMarker is a visual that is displayed at the Cursors position

      Returns

      Object itself for fluent interface

      Parameters

      • mutator: Mutator<PointMarkerType>

        Mutator function for PointMarker

      Returns Cursor<PointMarkerType, ResultTableBackgroundType>

setResultTable

setResultTable: ((mutator: Mutator<ResultTable<ResultTableBackgroundType>>) => Cursor<PointMarkerType, ResultTableBackgroundType>)

Type declaration

    • (mutator: Mutator<ResultTable<ResultTableBackgroundType>>): Cursor<PointMarkerType, ResultTableBackgroundType>

    • Mutator function for 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 Cursor<PointMarkerType, ResultTableBackgroundType>

setVisible

setVisible: ((state: boolean) => Cursor<PointMarkerType, ResultTableBackgroundType>)

Type declaration

    • (state: boolean): Cursor<PointMarkerType, ResultTableBackgroundType>

    • Set element visibility.

      Parameters

      • state: boolean

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

      Returns Cursor<PointMarkerType, ResultTableBackgroundType>

Methods

dispose

  • Permanently destroy the component.

    Returns

    Object itself for fluent interface.

    Returns Cursor<PointMarkerType, ResultTableBackgroundType>

getAutoFitStrategy

  • Get is AutoFitStrategy enabled. Customizable logic which attempts to fit ResultTable to view.

    Returns

    Boolean flag whether auto-fit is enabled

    Returns boolean

getPointMarkerVisible

  • Get point marker visible or not.

    Returns

    Boolean.

    Returns boolean

getResultTableVisible

  • Get result table visible or not.

    Returns

    Boolean.

    Returns boolean

setAutoFitStrategy

  • Set AutoFitStrategy of Cursor. Customizable logic which attempts to fit ResultTable to view.

    See AutoFitStrategies for available options.

    Returns

    Object itself for fluent interface

    Parameters

    • Optional autoFitStrategy: AutoFitStrategyFactory<ResultTableBackgroundType>

      AutoFitStrategy or undefined to disable auto-fitting

    Returns Cursor<PointMarkerType, ResultTableBackgroundType>

setPointMarkerVisible

  • Set point marker visible or not.

    Returns

    Object itself.

    Parameters

    • visible: boolean

      Point marker visible?

    Returns Cursor<PointMarkerType, ResultTableBackgroundType>

setResultTableVisible

  • Set result table visible or not.

    Returns

    Object itself.

    Parameters

    • visible: boolean

      Result table visible?

    Returns Cursor<PointMarkerType, ResultTableBackgroundType>

Settings

Member Visibility

Theme