Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SeriesMarkerXY<PointMarkerType, ResultTableBackgroundType, TickMarkerXBackgroundType, TickMarkerYBackgroundType>

Marker that can be attached on a XY series. 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.

Index

Properties

Readonly axisX

axisX : Axis

X axis of Marker

Readonly axisY

axisY : Axis

Y axis of Marker

Readonly owningSeries

owningSeries : SeriesXY

Series that owns marker

Readonly scale

scale : Vec2<Scale>

Rendering scale

Methods

dispose

  • dispose(): this
  • Dispose this Marker from owner's collection.

    Returns this

getAutoFitStrategy

  • getAutoFitStrategy(): boolean
  • Get is auto-fit enabled. Affects logic of automatic fitting of Cursors ResultTable to the screen.

    Returns boolean

    Boolean flag whether auto-fit is enabled

getDraggingMode

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

    Returns UIDraggingModes

    Object itself

getGridStrokeXCut

  • getGridStrokeXCut(): boolean
  • Get is GridStrokeX cut at cursor location.

    Returns boolean

    Boolean flag

getGridStrokeXStyle

  • getGridStrokeXStyle(): LineStyle
  • Get style of x gridstroke

    Returns LineStyle

    LineStyle of gridstroke

getGridStrokeXVisibility

getGridStrokeYCut

  • getGridStrokeYCut(): boolean
  • Get is GridStrokeY cut at cursor location.

    Returns boolean

    Boolean flag

getGridStrokeYStyle

  • getGridStrokeYStyle(): LineStyle
  • Get style of y gridstroke

    Returns LineStyle

    LineStyle of gridstroke

getGridStrokeYVisibility

getMouseInteractions

  • getMouseInteractions(): boolean
  • Returns boolean

    Mouse interactions state

getPointMarker

  • getPointMarker(): PointMarkerType
  • Get PointMarker object. PointMarker is a visual that is displayed at the Cursors position

    Returns PointMarkerType

    PointMarker object

getPointMarkerVisibility

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

    Returns UIVisibilityModes

    VisibilityMode

getPosition

  • Get current position of Annotation

    Returns Point

    Position on Annotations scale

getResultTable

  • getResultTable(): ResultTable<ResultTableBackgroundType>
  • Get ResultTable object. ResultTable is a visual that displays currently pointed data next to its location

    Returns ResultTable<ResultTableBackgroundType>

    ResultTable object

getResultTableVisibility

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

    Returns UIVisibilityModes

    VisibilityMode

getTickMarkerX

  • getTickMarkerX(): TickMarker<TickMarkerXBackgroundType>
  • Get x tick marker

    Returns TickMarker<TickMarkerXBackgroundType>

    X customTick of cursor

getTickMarkerXVisibility

getTickMarkerY

  • getTickMarkerY(): TickMarker<TickMarkerYBackgroundType>
  • Get y tick marker

    Returns TickMarker<TickMarkerYBackgroundType>

    Y customTick of cursor

getTickMarkerYVisibility

isAttached

  • isAttached(): boolean
  • Returns boolean

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

isDisposed

  • isDisposed(): boolean
  • Returns boolean

    True if Cursor has been disposed, false if not.

offPositionChange

  • offPositionChange(token: Token): boolean
  • This event is called whenever the position of the Marker is changed

    Parameters

    • token: Token

      Token that was received when the subscription was created.

    Returns boolean

    True if unsubscription was successful.

onPositionChange

  • onPositionChange(handler: function): Token
  • This event is called whenever the position of the Marker is changed

    Parameters

    • handler: function

      Function that is called when event is triggered.

        • Parameters

          • marker: this
          • position: Point

          Returns void

    Returns Token

    Token that can be used to unsubscribe from the event.

pointAt

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

    Parameters

    Returns this

restore

  • restore(): this
  • Restore the marker to parent and the marker's cursor ( and its elements ).

    Returns this

    Marker itself.

setAutoFitStrategy

  • setAutoFitStrategy(autoFitStrategy?: AutoFitStrategyFactory<ResultTableBackgroundType>): this
  • Set auto-fit strategy of Cursor. Affects logic of automatic fitting of Cursors ResultTable to the screen.

    Parameters

    • autoFitStrategy: AutoFitStrategyFactory<ResultTableBackgroundType>

      AutoFitStrategy factory or undefined to disable auto-fitting

    Returns this

    Object itself for fluent interface

setDraggingMode

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

    See UIDraggingModes collection for options.

    Parameters

    • draggingMode: UIDraggingModes

      DraggingMode or undefined to disable dragging

    Returns this

    Object itself

setGridStrokeXCut

  • setGridStrokeXCut(cut: boolean): this
  • Set is GridStrokeX cut at cursor location.

    Parameters

    • cut: boolean

      Boolean flag

    Returns this

    Object itself for fluent interface

setGridStrokeXStyle

  • Set style of x gridstroke

    Parameters

    • value: LineStyle | ImmutableMutator<LineStyle>

      LineStyle object or mutator to modify existing one

    Returns this

    Object itself for fluent interface

setGridStrokeXVisibility

  • Set visibility mode for gridstroke X.

    Parameters

    Returns this

    Object itself

setGridStrokeYCut

  • setGridStrokeYCut(cut: boolean): this
  • Set is GridStrokeY cut at cursor location.

    Parameters

    • cut: boolean

      Boolean flag

    Returns this

    Object itself for fluent interface

setGridStrokeYStyle

  • Set style of y gridstroke

    Parameters

    • value: LineStyle | ImmutableMutator<LineStyle>

      LineStyle object or mutator to modify existing one

    Returns this

    Object itself for fluent interface

setGridStrokeYVisibility

  • Set visibility mode for gridstroke Y.

    Parameters

    Returns this

    Object itself

setMouseInteractions

  • setMouseInteractions(state: boolean): this
  • Set mouse interactions enabled or disabled

    Parameters

    • state: boolean

      Specifies state of mouse interactions

    Returns this

    Object itself for fluent interface

setPointMarker

  • setPointMarker(mutator: Mutator<PointMarkerType>): this
  • Mutator function for PointMarker. PointMarker is a visual that is displayed at the Cursors position

    Parameters

    • mutator: Mutator<PointMarkerType>

      Mutator function for PointMarker

    Returns this

    Object itself for fluent interface

setPointMarkerVisibility

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

    Parameters

    Returns this

    Object itself

setPosition

  • setPosition(position: Point): this
  • Set position of SeriesMarker.

    Parameters

    • position: Point

      Location on SeriesMarkers scale. Marker will be attached to closest datapoint on its series.

    Returns this

    Object itself

setResultTable

  • Mutator function for ResultTable. ResultTable is a visual that displays currently pointed data next to its location

    Parameters

    • mutator: Mutator<ResultTable<ResultTableBackgroundType>>

      Mutator function for ResultTable

    Returns this

    Object itself for fluent interface

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!

    Parameters

    Returns this

    Object itself

setTickMarkerX

  • Mutator function for x tick marker

    Parameters

    • mutator: Mutator<TickMarker<TickMarkerXBackgroundType>>

      TickMarker mutator function

    Returns this

    Object itself for fluent interface

setTickMarkerXVisibility

  • Set visibility mode for tickMarker X.

    Parameters

    Returns this

    Object itself

setTickMarkerY

  • Mutator function for y tick marker

    Parameters

    • mutator: Mutator<TickMarker<TickMarkerYBackgroundType>>

      TickMarker mutator function

    Returns this

    Object itself for fluent interface

setTickMarkerYVisibility

  • Set visibility mode for tickMarker Y.

    Parameters

    Returns this

    Object itself