Class ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

Simple XY Marker that is basically a static cursor. Like CursorXYs its built of four parts: PointMarker shows the location of the Marker, ResultTable displays information of the point and X&Y tickMarkers to show gridstroke on its axes.

Type Parameters

Hierarchy

  • InternalChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

Properties

axisX axisY renderingScale scale

Methods

dispose getAutoFitStrategy getDraggingMode getGridStrokeXCut getGridStrokeXStyle getGridStrokeXVisibility getGridStrokeYCut getGridStrokeYStyle getGridStrokeYVisibility getMouseInteractions getPointMarker getPointMarkerVisibility getPosition getResultTable getResultTableVisibility getTickMarkerX getTickMarkerXVisibility getTickMarkerY getTickMarkerYVisibility getVisible isAttached offDispose offPositionChange offVisibleStateChanged onDispose onPositionChange onVisibleStateChanged pointAt setAutoFitStrategy setDraggingMode setGridStrokeXCut setGridStrokeXStyle setGridStrokeXVisibility setGridStrokeYCut setGridStrokeYStyle setGridStrokeYVisibility setMouseInteractions setPointMarker setPointMarkerVisibility setPosition setResultTable setResultTableVisibility setTickMarkerX setTickMarkerXVisibility setTickMarkerY setTickMarkerYVisibility setVisible

Properties

Readonly axisX

axisX: Axis

Readonly axisY

axisY: Axis

Readonly renderingScale

renderingScale: LinearScaleXY

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 ChartMarkerXY<PointMarkerType, 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

getDraggingMode

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

    Returns

    Object itself

    Returns UIDraggingModes

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

getGridStrokeXVisibility

  • Get visibility mode for gridstroke X.

    Returns

    VisibilityMode

    Returns UIVisibilityModes

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

getGridStrokeYVisibility

  • Get visibility mode for gridstroke Y.

    Returns

    VisibilityMode

    Returns UIVisibilityModes

getMouseInteractions

  • Returns

    Mouse interactions state

    Returns boolean

getPointMarker

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

    Returns

    PointMarker object

    Returns PointMarkerType

getPointMarkerVisibility

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

    Returns

    VisibilityMode

    Returns UIVisibilityModes

getPosition

  • Get current position of Annotation

    Returns

    Position on Annotations scale

    Returns Point

getResultTable

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

    Returns

    ResultTable object

    Returns ResultTable<ResultTableBackgroundType>

getResultTableVisibility

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

    Returns

    VisibilityMode

    Returns UIVisibilityModes

getTickMarkerX

  • Get x tick marker

    Returns

    X customTick of cursor

    Returns TickMarker

getTickMarkerXVisibility

  • Get visibility mode for tickMarker X.

    Returns

    VisibilityMode

    Returns UIVisibilityModes

getTickMarkerY

  • Get y tick marker

    Returns

    Y customTick of cursor

    Returns TickMarker

getTickMarkerYVisibility

  • Get visibility mode for tickMarker Y.

    Returns

    VisibilityMode

    Returns UIVisibilityModes

getVisible

  • Get element visibility.

    Returns

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

    Returns boolean

isAttached

  • Returns

    True if object is attached or not attachable, false if it is not attached and attachable

    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

offPositionChange

  • This event is called whenever the position of the Marker is changed

    Returns

    True if unsubscription was successful.

    Parameters

    • token: Token

      Token that was received when the subscription was created.

    Returns boolean

offVisibleStateChanged

  • Remove event listener from visibleStateChanged

    Parameters

    • token: Token

    Returns boolean

onDispose

  • This event is called whenever the Marker is disposed

    Returns

    Token that can be used to unsubscribe from the event.

    Parameters

    • handler: (() => unknown)

      Function that is called when event is triggered.

        • (): unknown

        • Returns unknown

    Returns Token

onPositionChange

  • This event is called whenever the position of the Marker is changed

    Returns

    Token that can be used to unsubscribe from the event.

    Parameters

    • handler: ((marker: ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>, position: Point) => void)

      Function that is called when event is triggered.

        • (marker: ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>, position: Point): void

        • Parameters

          Returns void

    Returns Token

onVisibleStateChanged

  • Register new event listener to visibleStateChanged event.

    Parameters

    • listener: VisibleStateChangedHandler<ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>>

      Event listener for visibleStateChanged

    Returns Token

pointAt

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

    Parameters

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

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 ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setDraggingMode

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

    See UIDraggingModes collection for options.

    Returns

    Object itself

    Parameters

    • draggingMode: UIDraggingModes = UIDraggingModes.notDraggable

      DraggingMode or undefined to disable dragging

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setGridStrokeXCut

  • Set is GridStrokeX cut at cursor location.

    Returns

    Object itself for fluent interface

    Parameters

    • cut: boolean

      Boolean flag

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setGridStrokeXStyle

setGridStrokeXVisibility

  • Set visibility mode for gridstroke X.

    Returns

    Object itself

    Parameters

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setGridStrokeYCut

  • Set is GridStrokeY cut at cursor location.

    Returns

    Object itself for fluent interface

    Parameters

    • cut: boolean

      Boolean flag

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setGridStrokeYStyle

setGridStrokeYVisibility

  • Set visibility mode for gridstroke Y.

    Returns

    Object itself

    Parameters

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setMouseInteractions

  • Set mouse interactions enabled or disabled

    Returns

    Object itself for fluent interface

    Parameters

    • state: boolean

      Specifies state of mouse interactions

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setPointMarker

  • 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 ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setPointMarkerVisibility

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

    Returns

    Object itself

    Parameters

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setPosition

  • Set the position of Annotation on its scale.

    Parameters

    • position: Point

      Position on Annotations scale.

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setResultTable

  • 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 ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setResultTableVisibility

  • Set visibility mode for ResultTable. ResultTable is a visual that displays currently pointed data next to its location. NOTE: ResultTable is only visible when it has displayable content, regardless of its VisibilityMode!

    Returns

    Object itself

    Parameters

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setTickMarkerX

  • Mutator function for x tick marker

    Returns

    Object itself for fluent interface

    Parameters

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setTickMarkerXVisibility

  • Set visibility mode for tickMarker X.

    Returns

    Object itself

    Parameters

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setTickMarkerY

  • Mutator function for y tick marker

    Returns

    Object itself for fluent interface

    Parameters

    Returns ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

setTickMarkerYVisibility

  • Set visibility mode for tickMarker Y.

    Returns

    Object itself

    Parameters

    Returns ChartMarkerXY<PointMarkerType, 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 ChartMarkerXY<PointMarkerType, ResultTableBackgroundType>

Settings

Member Visibility

Theme