Interface CursorXY<PointMarkerType, ResultTableBackgroundType>

A type of Cursor that is plotted along two axes. Adds customizable gridStrokes and tickMarkers

Type Parameters

Hierarchy

Properties

getGridStrokeXCut getGridStrokeXStyle getGridStrokeYCut getGridStrokeYStyle getPointMarker getPosition getResultTable getVisible pointAt setGridStrokeXCut setGridStrokeXStyle setGridStrokeYCut setGridStrokeYStyle setPointMarker setResultTable setTickMarkerX setTickMarkerY setVisible

Methods

dispose getAutoFitStrategy getPointMarkerVisible getResultTableVisible getTickMarkerXVisible getTickMarkerYVisible setAutoFitStrategy setPointMarkerVisible setResultTableVisible setTickMarkerXVisible setTickMarkerYVisible

Properties

getGridStrokeXCut

getGridStrokeXCut: (() => boolean)

Type declaration

    • (): boolean

    • Get is GridStrokeX cut at cursor location.

      Returns

      Boolean flag

      Returns boolean

getGridStrokeXStyle

getGridStrokeXStyle: (() => LineStyle)

Type declaration

getGridStrokeYCut

getGridStrokeYCut: (() => boolean)

Type declaration

    • (): boolean

    • Get is GridStrokeY cut at cursor location.

      Returns

      Boolean flag

      Returns boolean

getGridStrokeYStyle

getGridStrokeYStyle: (() => LineStyle)

Type declaration

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>>) => CursorXY<PointMarkerType, ResultTableBackgroundType>)

Type declaration

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

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

      Parameters

      Returns CursorXY<PointMarkerType, ResultTableBackgroundType>

setGridStrokeXCut

setGridStrokeXCut: ((cut: boolean) => CursorXY<PointMarkerType, ResultTableBackgroundType>)

Type declaration

    • (cut: boolean): CursorXY<PointMarkerType, ResultTableBackgroundType>

    • Set is GridStrokeX cut at cursor location.

      Returns

      Object itself for fluent interface

      Parameters

      • cut: boolean

        Boolean flag

      Returns CursorXY<PointMarkerType, ResultTableBackgroundType>

setGridStrokeXStyle

setGridStrokeXStyle: ((value: LineStyle | ImmutableMutator<LineStyle, LineStyle>) => CursorXY<PointMarkerType, ResultTableBackgroundType>)

Type declaration

setGridStrokeYCut

setGridStrokeYCut: ((cut: boolean) => CursorXY<PointMarkerType, ResultTableBackgroundType>)

Type declaration

    • (cut: boolean): CursorXY<PointMarkerType, ResultTableBackgroundType>

    • Set is GridStrokeY cut at cursor location.

      Returns

      Object itself for fluent interface

      Parameters

      • cut: boolean

        Boolean flag

      Returns CursorXY<PointMarkerType, ResultTableBackgroundType>

setGridStrokeYStyle

setGridStrokeYStyle: ((value: LineStyle | ImmutableMutator<LineStyle, LineStyle>) => CursorXY<PointMarkerType, ResultTableBackgroundType>)

Type declaration

setPointMarker

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

Type declaration

    • (mutator: Mutator<PointMarkerType>): CursorXY<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 CursorXY<PointMarkerType, ResultTableBackgroundType>

setResultTable

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

Type declaration

    • (mutator: Mutator<ResultTable<ResultTableBackgroundType>>): CursorXY<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 CursorXY<PointMarkerType, ResultTableBackgroundType>

setTickMarkerX

setTickMarkerX: ((mutator: Mutator<TickMarker>) => CursorXY<PointMarkerType, ResultTableBackgroundType>)

Type declaration

    • (mutator: Mutator<TickMarker>): CursorXY<PointMarkerType, ResultTableBackgroundType>

    • Set TickMarkerX.

      Returns

      Object itself for fluent interface

      Parameters

      Returns CursorXY<PointMarkerType, ResultTableBackgroundType>

setTickMarkerY

setTickMarkerY: ((mutator: Mutator<TickMarker>) => CursorXY<PointMarkerType, ResultTableBackgroundType>)

Type declaration

    • (mutator: Mutator<TickMarker>): CursorXY<PointMarkerType, ResultTableBackgroundType>

    • Set TickMarkerY.

      Returns

      Object itself for fluent interface

      Parameters

      Returns CursorXY<PointMarkerType, ResultTableBackgroundType>

setVisible

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

Type declaration

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

    • Set element visibility.

      Parameters

      • state: boolean

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

      Returns CursorXY<PointMarkerType, ResultTableBackgroundType>

Methods

dispose

  • Permanently destroy the component.

    Returns

    Object itself for fluent interface.

    Returns CursorXY<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

getTickMarkerXVisible

  • Get tick marker X visible or not.

    Returns

    Boolean.

    Returns boolean

getTickMarkerYVisible

  • Get tick marker Y 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 CursorXY<PointMarkerType, ResultTableBackgroundType>

setPointMarkerVisible

  • Set point marker visible or not.

    Returns

    Object itself.

    Parameters

    • visible: boolean

      Point marker visible?

    Returns CursorXY<PointMarkerType, ResultTableBackgroundType>

setResultTableVisible

  • Set result table visible or not.

    Returns

    Object itself.

    Parameters

    • visible: boolean

      Result table visible?

    Returns CursorXY<PointMarkerType, ResultTableBackgroundType>

setTickMarkerXVisible

  • Set tick marker X visible or not.

    Returns

    Object itself.

    Parameters

    • visible: boolean

      Tick marker X visible?

    Returns CursorXY<PointMarkerType, ResultTableBackgroundType>

setTickMarkerYVisible

  • Set tick marker Y visible or not.

    Returns

    Object itself.

    Parameters

    • visible: boolean

      Tick marker Y visible?

    Returns CursorXY<PointMarkerType, ResultTableBackgroundType>

Settings

Member Visibility

Theme