Interface Marker<PointMarkerType, ResultTableBackgroundType, CursorType>

Cursor-based visual that can be plotted on a Chart. Like Cursors its built of two parts: PointMarker and ResultTable, first of which shows the location of the Marker clearly and the second to display information about the pointed DataPoint.

Type Parameters

  • PointMarkerType extends PointMarker

  • ResultTableBackgroundType extends UIBackground

  • CursorType extends Cursor<PointMarkerType, ResultTableBackgroundType>

Hierarchy

Implemented by

Methods

getAutoFitStrategy getDraggingMode getMouseInteractions getPointMarkerVisibility getResultTableVisibility setAutoFitStrategy setDraggingMode setMouseInteractions setPointMarkerVisibility setResultTableVisibility

Methods

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

getDraggingMode

getMouseInteractions

  • Returns

    Mouse interactions state

    Returns boolean

getPointMarkerVisibility

  • Get visibility mode for PointMarker. PointMarker is a visual that is displayed at the Cursors position.

    Returns

    VisibilityMode

    Returns UIVisibilityModes

getResultTableVisibility

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

    Returns

    VisibilityMode

    Returns UIVisibilityModes

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 Marker<PointMarkerType, ResultTableBackgroundType, CursorType>

setDraggingMode

  • Set dragging mode of object. Defines how the object can be dragged by mouse.

    See UIDraggingModes collection for options.

    Returns

    Object itself

    Parameters

    • Optional draggingMode: UIDraggingModes

      DraggingMode or undefined to disable dragging

    Returns Marker<PointMarkerType, ResultTableBackgroundType, CursorType>

setMouseInteractions

  • Set mouse interactions enabled or disabled

    Returns

    Object itself for fluent interface

    Parameters

    • state: boolean

      Specifies state of mouse interactions

    Returns Marker<PointMarkerType, ResultTableBackgroundType, CursorType>

setPointMarkerVisibility

  • Set visibility mode for PointMarker. PointMarker is a visual that is displayed at the Cursors position.

    Returns

    Object itself

    Parameters

    Returns Marker<PointMarkerType, ResultTableBackgroundType, CursorType>

setResultTableVisibility

  • Set visibility mode for ResultTable. ResultTable is a visual that displays currently pointed data next to its location.

    Returns

    Object itself

    Parameters

    Returns Marker<PointMarkerType, ResultTableBackgroundType, CursorType>

Settings

Member Visibility

Theme