Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Cursor <PointMarkerType, ResultTableBackgroundType >

Cursor is a hidable element that can be positioned on a point using a data-structure called 'DataPoint'. Cursors are formed from two distinct parts, PointMarker and ResultTable, first of which shows the location of the Cursor clearly and the second to display information about the pointed DataPoint.

Index

Properties

Methods

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

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

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

Methods

disposePointMarker

  • disposePointMarker(): this

  • Restore PointMarker

    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

restorePointMarker

  • restorePointMarker(): this

  • Dispose PointMarker

    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

    • Optional autoFitStrategy: AutoFitStrategyFactory<ResultTableBackgroundType>

      AutoFitStrategy or undefined to disable auto-fitting

    Returns this

    Object itself for fluent interface