Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IntensityGridSeries <CursorPointInterface >

Index

Properties

axisX

axisX: Axis

axisY

axisY: Axis

chart

chart: ChartXY

scale

scale: Vec2<Scale>

Methods

addColumn

  • addColumn(columns: number, type: "color", colors: Matrix<Color>): this
  • addColumn(columns: number, type: "value", values: Matrix<number>): this
  • Parameters

    Returns this

    Object itself for fluent interface.

  • Parameters

    • columns: number
    • type: "value"
    • values: Matrix<number>

    Returns this

    Object itself for fluent interface.

addMarker

  • addMarker(cursorBuilder: StaticCursorXYBuilder<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>): SeriesMarkerXY<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>

addRow

  • addRow(rows: number, type: "color", colors: Matrix<Color>): this
  • addRow(rows: number, type: "value", values: Matrix<number>): this
  • Parameters

    Returns this

    Object itself for fluent interface.

  • Parameters

    • rows: number
    • type: "value"
    • values: Matrix<number>

    Returns this

    Object itself for fluent interface.

attach

  • Parameters

    Returns this

    Series itself for fluent interface

dispose

  • dispose(): this
  • Returns this

    Object itself for fluent interface

getBoundaries

  • getBoundaries(): Interval<Point>
  • Returns Interval<Point>

getCursorEnabled

  • getCursorEnabled(): boolean
  • Returns boolean

    Whether Cursor is enabled or not

getHighlightOnHover

  • getHighlightOnHover(): boolean
  • Returns boolean

    Boolean for if object should highlight on mouse hover or not.

getHighlighted

  • getHighlighted(): boolean
  • Returns boolean

    the state of highlighted flag

getIsUnderMouse

  • getIsUnderMouse(): boolean
  • Returns boolean

    Boolean for is object under mouse currently

getMouseInteractions

  • getMouseInteractions(): boolean
  • Returns boolean

    Mouse interactions state

getName

  • getName(): string
  • Returns string

    The name of the Component.

getXMax

  • getXMax(): number | undefined
  • Returns number | undefined

    Max X value of the series

getXMin

  • getXMin(): number | undefined
  • Returns number | undefined

    Min X value of the series

getYMax

  • getYMax(): number | undefined
  • Returns number | undefined

    Max Y value of the series

getYMin

  • getYMin(): number | undefined
  • Returns number | undefined

    Min Y value of the series

invalidateColorsOnly

invalidateValuesOnly

isDisposed

  • isDisposed(): boolean
  • Returns boolean

    TODO: True for enabled and false for disabled

offHover

  • offHover(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseClick

  • offMouseClick(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDoubleClick

  • offMouseDoubleClick(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDown

  • offMouseDown(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDrag

  • offMouseDrag(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDragStart

  • offMouseDragStart(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDragStop

  • offMouseDragStop(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseEnter

  • offMouseEnter(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseLeave

  • offMouseLeave(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseMove

  • offMouseMove(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseUp

  • offMouseUp(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseWheel

  • offMouseWheel(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offTouchEnd

  • offTouchEnd(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offTouchMove

  • offTouchMove(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offTouchStart

  • offTouchStart(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

onHover

  • onHover(clbk: function): Token
  • Parameters

    • clbk: function
        • Parameters

          • series: this
          • cursorPoint: CursorPointInterface | undefined

          Returns void

    Returns Token

    Token of the event listener

onMouseClick

onMouseDoubleClick

onMouseDown

onMouseDrag

onMouseDragStart

onMouseDragStop

onMouseEnter

onMouseLeave

onMouseMove

onMouseUp

onMouseWheel

onTouchEnd

onTouchMove

onTouchStart

reset

  • Parameters

    Returns this

    Series itself for fluent interface.

restore

  • restore(): this
  • Returns this

    Object itself.

setCursorEnabled

  • setCursorEnabled(state: boolean): this
  • Parameters

    • state: boolean

    Returns this

setFillStyle

setHighlightOnHover

  • setHighlightOnHover(state: boolean): this
  • Parameters

    • state: boolean

    Returns this

    Object itself for fluent interface.

setHighlighted

  • setHighlighted(highLight: boolean): this
  • Parameters

    • highLight: boolean

    Returns this

    component itself for fluent interface

setMouseInteractions

  • setMouseInteractions(state: boolean): this
  • Parameters

    • state: boolean

    Returns this

    Object itself for fluent interface

setName

  • setName(name: string): this
  • Parameters

    • name: string

    Returns this

    Object itself

solveNearestFromScreen

solveNearestFromSegment

  • solveNearestFromSegment(location: Point, segment: Intensity): undefined | CursorPoint