Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CursorXY<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>

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

Index

Properties

dispose

dispose : function

Remove everything related to the object from all collections associated with rendering cycle and allows the object to be collected by GC

returns

Object itself for fluent interface

    • Returns this

disposeResultTable

disposeResultTable : function

Dispose ResultTable

returns

Object itself for fluent interface

    • Returns this

getGridStrokeXCut

getGridStrokeXCut : function

Get is GridStrokeX cut at cursor location.

returns

Boolean flag

    • Returns boolean

getGridStrokeXStyle

getGridStrokeXStyle : function

Get style of x gridstroke

returns

LineStyle of gridstroke

    • Returns LineStyle

getGridStrokeYCut

getGridStrokeYCut : function

Get is GridStrokeY cut at cursor location.

returns

Boolean flag

    • Returns boolean

getGridStrokeYStyle

getGridStrokeYStyle : function

Get style of y gridstroke

returns

LineStyle of gridstroke

    • Returns LineStyle

getPointMarker

getPointMarker : function

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

returns

PointMarker object

    • Returns PointMarkerType

getPosition

getPosition : function

Get current position of Cursor on its scale

returns

Position on Cursors scale

getResultTable

getResultTable : function

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

returns

ResultTable object

isDisposeResultTable

isDisposeResultTable : function
returns

Weather ResultTable is disposed

    • Returns boolean

isDisposed

isDisposed : function
returns

True if object and all of its sub-objects/elements have been disposed, false if not.

    • Returns boolean

isDisposedPointMarker

isDisposedPointMarker : function
returns

Weather PointMarker is disposed

    • Returns boolean

pointAt

pointAt : function

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

restore

restore : function

Restore everything required for correct life cycle of the object

returns

Object itself for fluent interface

    • Returns this

restoreResultTable

restoreResultTable : function

Restore ResultTable

returns

Object itself for fluent interface

    • Returns this

setGridStrokeXCut

setGridStrokeXCut : function

Set is GridStrokeX cut at cursor location.

param

Boolean flag

returns

Object itself for fluent interface

    • Parameters

      • cut: boolean

      Returns this

setGridStrokeXStyle

setGridStrokeXStyle : function

Set style of x gridstroke

param

LineStyle object

returns

Object itself for fluent interface

setGridStrokeYCut

setGridStrokeYCut : function

Set is GridStrokeY cut at cursor location.

param

Boolean flag

returns

Object itself for fluent interface

    • Parameters

      • cut: boolean

      Returns this

setGridStrokeYStyle

setGridStrokeYStyle : function

Set style of y gridstroke

param

LineStyle object

returns

Object itself for fluent interface

setPointMarker

setPointMarker : function

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

param

Mutator function for PointMarker

returns

Object itself for fluent interface

    • Parameters

      • mutator: Mutator<PointMarkerType>

      Returns this

setResultTable

setResultTable : function

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

param

Mutator function for ResultTable

returns

Object itself for fluent interface

setTickMarkerX

setTickMarkerX : function

Set TickMarkerX.

param

Mutator function for cursors X tickMarker

returns

Object itself for fluent interface

setTickMarkerY

setTickMarkerY : function

Set TickMarkerY.

param

Mutator function for cursors Y tickMarker

returns

Object itself for fluent interface

Methods

disposePointMarker

  • disposePointMarker(): this
  • Restore PointMarker

    Returns this

    Object itself for fluent interface

disposeTickMarkerX

  • disposeTickMarkerX(): this
  • Dispose TickMarker part of X CustomTick

    Returns this

    Object itself for fluent interface

disposeTickMarkerY

  • disposeTickMarkerY(): this
  • Dispose TickMarker part of Y CustomTick

    Returns this

    Object itself for fluent interface

getAutoFitStrategy

  • getAutoFitStrategy(): boolean
  • Get is AutoFitStrategy enabled. Customizable logic which attempts to fit ResultTable to view.

    Returns boolean

    Boolean flag whether auto-fit is enabled

isDisposedTickMarkerX

  • isDisposedTickMarkerX(): boolean
  • Returns boolean

    Whether TickMarker part of X CustomTick is disposed

isDisposedTickMarkerY

  • isDisposedTickMarkerY(): boolean
  • Returns boolean

    Whether TickMarker part of Y CustomTick is disposed

restorePointMarker

  • restorePointMarker(): this
  • Dispose PointMarker

    Returns this

    Object itself for fluent interface

restoreTickMarkerX

  • restoreTickMarkerX(): this
  • Restore TickMarker part of X CustomTick

    Returns this

    Object itself for fluent interface

restoreTickMarkerY

  • restoreTickMarkerY(): this
  • Restore TickMarker part of Y CustomTick

    Returns this

    Object itself for fluent interface

setAutoFitStrategy

  • setAutoFitStrategy(autoFitStrategy?: AutoFitStrategyFactory<ResultTableBackgroundType>): this
  • Set AutoFitStrategy of Cursor. Customizable logic which attempts to fit ResultTable to view.

    See AutoFitStrategies for available options.

    Parameters

    • autoFitStrategy: AutoFitStrategyFactory<ResultTableBackgroundType>

      AutoFitStrategy or undefined to disable auto-fitting

    Returns this

    Object itself for fluent interface