Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AutoCursorXY<PointMarkerType, ResultTableBackgroundType>

A type of CursorXY that can be plotted dynamically between different axes.

Index

Properties

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

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.

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

dispose

  • dispose(): this
  • Remove the component from rendering.

    If the Component supports it, this can be reverted with restore() method.

    Returns this

    Object itself for fluent interface.

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

getResultTableAutoTextStyle

  • getResultTableAutoTextStyle(): boolean
  • Get is ResultTable auto text fill style enabled. When enabled, text of ResultTable will be automatically filled based on pointed data.

    Returns boolean

    Boolean flag

getTickMarkerXAutoTextStyle

  • getTickMarkerXAutoTextStyle(): boolean
  • Get is TickMarkerX auto text fill style enabled. When enabled, text of TickMarkerX will be automatically filled based on pointed data.

    Returns boolean

    Boolean flag

getTickMarkerYAutoTextStyle

  • getTickMarkerYAutoTextStyle(): boolean
  • Get is TickMarkerY auto text fill style enabled. When enabled, text of TickMarkerY will be automatically filled based on pointed data.

    Returns boolean

    Boolean flag

isDisposed

  • isDisposed(): boolean
  • Returns boolean

    True if the component is currently disposed, and thus not being rendered. If the Component supports it, this can be reverted with restore() method.

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

restore

  • restore(): this
  • After the Components dispose() method has been called, removing it from rendering, restore() can be used to return it back.

    Returns this

    Object itself for fluent interface.

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

setResultTableAutoTextStyle

  • setResultTableAutoTextStyle(enabled: boolean): this
  • Set is ResultTable auto text fill style enabled. When enabled, text of ResultTable will be automatically filled based on pointed data.

    sideeffect

    When enabled, any fill style set operation on ResultTable might get overridden

    Parameters

    • enabled: boolean

      Boolean flag

    Returns this

    Object itself

setTickMarkerXAutoTextStyle

  • setTickMarkerXAutoTextStyle(enabled: boolean): this
  • Set is TickMarkerX auto text fill style enabled. When enabled, text of TickMarkerX will be automatically filled based on pointed data.

    sideeffect

    When enabled, any fill style set operation on TickMarkerX might get overridden

    Parameters

    • enabled: boolean

      Boolean flag

    Returns this

    Object itself

setTickMarkerYAutoTextStyle

  • setTickMarkerYAutoTextStyle(enabled: boolean): this
  • Set is TickMarkerY auto text fill style enabled. When enabled, text of TickMarkerY will be automatically filled based on pointed data.

    sideeffect

    When enabled, any fill style set operation on TickMarkerY might get overridden

    Parameters

    • enabled: boolean

      Boolean flag

    Returns this

    Object itself