Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IntensityGridSeries <CursorPointInterface >

IntensityGridSeries for visualization of magnitude in two dimensions.

IntensityGridSeries are created with ChartXY.addHeatmapSeries with IntensitySeriesType of IntensitySeriesTypes.Grid

Index

Properties

Methods

Properties

axisX

axisX: Axis

Axis X

axisY

axisY: Axis

Axis Y

chart

chart: ChartXY

scale

scale: Vec2<Scale>

Scale of the series

Methods

addColumn

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

  • Append new columns of data to the end of the Intensity. Update color data of new columns. Example:

    // scroll two columns and update colors
heatmap.addColumn(2, 'color', [
 [ColorHEX( '0xFF0000' ), ColorHEX( '0x00FF00' )],
 [ColorHEX( '0xFF00FF' ), ColorHEX( '0x00FF00' )]
])

    Parameters

    • columns: number

      Amount of columns to add and update.

    • type: "color"

      Type of the callback.

    • colors: Matrix<Color>

    Returns this

    Object itself for fluent interface.

  • Append new columns of data to the end of the Intensity. Update intensity data of new columns. Example:

    // scroll two columns and update values
heatmap.addColumn(2, 'value', [
 [10, 20],
 [50, 68]
])

    Parameters

    • columns: number

      Amount of columns to add and update.

    • type: "value"

      Type of the callback.

    • values: Matrix<number>

    Returns this

    Object itself for fluent interface.

addMarker

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

  • Add Marker to the Series.

    Type parameters

    Parameters

    • Default value cursorBuilder: StaticCursorXYBuilder<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>

      StaticCursorBuilderXY object for customized look of marker. MarkerBuilders.XY can be used to build a custom one from scratch.

    Returns SeriesMarkerXY<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>

    SeriesMarkerXY

addRow

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

  • Append new rows of data to the end of the Intensity. Update color data of the rows. Example:

    // scroll two rows and update colors
heatmap.addRow(2, 'color', [
 [ColorHEX( '0xFF0000' ), ColorHEX( '0x00FF00' )],
 [ColorHEX( '0xFF00FF' ), ColorHEX( '0x00FF00' )]
])

    Parameters

    • rows: number

      Amount of rows to add and update.

    • type: "color"

      Type of the callback.

    • colors: Matrix<Color>

    Returns this

    Object itself for fluent interface.

  • Append new rows of data to the end of the Intensity. Update intensity data of new rows. Example:

    // scroll two rows and update values
heatmap.addColumn(2, 'value', [
 [10, 20],
 [50, 68]
])

    Parameters

    • rows: number

      Amount of rows to add and update.

    • type: "value"

      Type of the callback.

    • values: Matrix<number>

    Returns this

    Object itself for fluent interface.

attach

  • Attach object to an legendBox entry

    Parameters

    • entry: LegendBoxEntry

      Object which has to be attached

    • Default value disposeOnClick: boolean

      Flag that indicates whether the Attachable should be disposed/restored, when its respective Entry is clicked.

    Returns this

    Series itself for fluent interface

dispose

  • dispose(): this

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

    Returns this

    Object itself for fluent interface

getCursorEnabled

  • getCursorEnabled(): boolean

  • Returns boolean

    Whether Cursor is enabled or not

getHighlighted

  • getHighlighted(): boolean

  • Returns boolean

    the state of highlighted flag

getIsUnderMouse

  • getIsUnderMouse(): boolean

  • Get boolean flag for whether object is currently under mouse or not

    Returns boolean

    Boolean for is object under mouse currently

getMouseInteractions

  • getMouseInteractions(): boolean

  • Get mouse interactions enabled or disabled. Disabled mouse-interactions will naturally prevent mouse-driven highlighting from ever happening.

    Returns boolean

    Mouse interactions state

getName

  • getName(): string

  • Get the name of the Component.

    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

  • Treat the data of the matrix as ColorValue-based type of points. ColorValue-based data is represented in format { ...color: Color } for IndividualPointFill style.

    Invalidates only the color without update the geometry data, providing significantly faster rendering of dynamically changed colors.

    Parameters

    • colors: Matrix<Color>

      Matrix of new colors. The resolution of the IntensityShape should be valid.

    • Optional range: GridRangeOptions

      Optional configuration object to specify the range of the grid to be invalidated.

    Returns this

    Series itself for fluent interface.

  • Treat the data of the matrix as ColorValue-based type of points. ColorValue-based date is represented in format { ...color: Color } for IndividualPointFill style.

    Invalidates only the color without update the geometry data, providing significantly faster rendering of dynamically changed colors.

    Parameters

    • callback: UpdateColorCallback

      Callback function to map through the input to modify the matrix colors. The resolution of the IntensityShape should be valid.

    • Optional range: GridRangeOptions

      Optional configuration object to specify the range of the grid to be invalidated.

    Returns this

    Series itself for fluent interface.

invalidateValuesOnly

  • Treat the data of the matrix as IntensityValue-based type of points. IntensityValue-based data is represented in format { ...intensity: number } for PalettedFill style.

    Invalidates only the intensity values without update the geometry data, providing significantly faster rendering of dynamically changed intensity.

    Parameters

    • values: Matrix<number>

      Matrix of new intensity values.

    • Optional range: GridRangeOptions

      Optional configuration object to specify the range of the grid to be invalidated.

    Returns this

    Series itself for fluent interface.

  • Treat the data of the matrix as IntensityValue-based type of points. IntensityValue-based data is represented in format { ...intensity: number } for PalettedFill style.

    Invalidates only the intensity values without update the geometry data, providing significantly faster rendering of dynamically changed intensity.

    Parameters

    • callback: UpdateValueCallback

      Callback function to map through the input to modify the matrix of intensity values. The resolution of the IntensityShape should be valid.

    • Optional range: GridRangeOptions

      Optional configuration object to specify the range of the grid to be invalidated.

    Returns this

    Series itself for fluent interface.

isDisposed

  • isDisposed(): boolean

  • Returns boolean

    TODO: True for enabled and false for disabled

offHover

  • offHover(token: Token): boolean

  • Remove event listener from Series Hover Event.

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseClick

  • offMouseClick(token: Token): boolean

  • Remove event listener from Mouse Click Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDoubleClick

  • offMouseDoubleClick(token: Token): boolean

  • Remove event listener from Mouse Double Click Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDown

  • offMouseDown(token: Token): boolean

  • Remove event listener from Mouse Down Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDrag

  • offMouseDrag(token: Token): boolean

  • Remove event listener from Mouse Drag Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDragStart

  • offMouseDragStart(token: Token): boolean

  • Remove event listener from Mouse Drag Start Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDragStop

  • offMouseDragStop(token: Token): boolean

  • Remove event listener from Mouse Drag Stop Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseEnter

  • offMouseEnter(token: Token): boolean

  • Remove event listener from Mouse Enter Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseLeave

  • offMouseLeave(token: Token): boolean

  • Remove event listener from Mouse Leave Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseMove

  • offMouseMove(token: Token): boolean

  • Remove event listener from Mouse Move Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseUp

  • offMouseUp(token: Token): boolean

  • Remove event listener from Mouse Up Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseWheel

  • offMouseWheel(token: Token): boolean

  • Remove event listener from Mouse Wheel Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offTouchEnd

  • offTouchEnd(token: Token): boolean

  • Remove event listener from Touch End Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offTouchMove

  • offTouchMove(token: Token): boolean

  • Remove event listener from Touch Move Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offTouchStart

  • offTouchStart(token: Token): boolean

  • Remove event listener from Touch Start Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

onHover

  • onHover(clbk: function): Token

  • Add event listener to Series Hover Event. Hover event is a custom mouse-event designed for Series that is the main link between Cursors and Series.

    Parameters

    • clbk: function

      Callback function that is called whenever mouse enters / moves or leaves the Series

        • Parameters

          • series: this
          • cursorPoint: CursorPointInterface | undefined

          Returns void

    Returns Token

    Token of the event listener

onMouseClick

  • Add event listener to Mouse Click Event

    Parameters

    Returns Token

    Token of the event listener

onMouseDoubleClick

  • Add event listener to Mouse Double Click Event

    Parameters

    Returns Token

    Token of the event listener

onMouseDown

  • Add event listener to Mouse Down Event

    Parameters

    Returns Token

    Token of the event listener

onMouseDrag

onMouseDragStart

onMouseDragStop

onMouseEnter

  • Add event listener to Enter Event

    Parameters

    Returns Token

    Token of the event listener

onMouseLeave

  • Add event listener to Mouse Leave Event

    Parameters

    Returns Token

    Token of the event listener

onMouseMove

  • Add event listener to Mouse Move Event

    Parameters

    Returns Token

    Token of the event listener

onMouseUp

  • Add event listener to Mouse Up Event

    Parameters

    Returns Token

    Token of the event listener

onMouseWheel

  • Subscribe to Mouse Wheel event

    Parameters

    Returns Token

    Token of subscription

onTouchEnd

  • Subscribe to Touch End event

    Parameters

    Returns Token

    Token of subscription

onTouchMove

  • Subscribe to Touch Move event

    Parameters

    Returns Token

    Token of subscription

onTouchStart

  • Subscribe to Touch Start event

    Parameters

    Returns Token

    Token of subscription

reset

  • Reset the existing intensity shape and apply new settings. The following method removes all the existing data. The shape would be reset to the default state:

    • Old Geometry transformations do not valid. The Intensity is a uniform grid.
    • Old IntensityValues and/or ColorValues do not valid and exist anymore.

    Parameters

    Returns this

    Series itself for fluent interface.

restore

  • restore(): this

  • Tell the owning chart to restore this series.

    Returns this

    Object itself.

setCursorEnabled

  • setCursorEnabled(state: boolean): this

  • Set whether Cursor is enabled or not

    Parameters

    • state: boolean

    Returns this

setFillStyle

  • Set fill style of Intensity Heatmap Series.

    • SolidFill: apply single solid color.
    • IndividualPointFill: apply individual color per data-point.
    • PalettedFill: apply palette using LUT lookup table of colors.
    • emptyFill: no color, empty rendering.

    Parameters

    Returns this

    Series itself for fluent interface.

setHighlighted

  • setHighlighted(highLight: boolean): this

  • Enable or disable forced highlighting of component

    Parameters

    • highLight: boolean

      True for enabled and false for disabled

    Returns this

    component itself for fluent interface

setMouseInteractions

  • setMouseInteractions(state: boolean): this

  • Set mouse interactions enabled or disabled. Disabling mouse-interactions will naturally prevent mouse-driven highlighting from ever happening.

    Parameters

    • state: boolean

      Specifies state of mouse interactions

    Returns this

    Object itself for fluent interface

setName

  • setName(name: string): this

  • Sets the name of the Component updating attached LegendBox entries

    Parameters

    • name: string

      Name of the Component

    Returns this

    Object itself

solveNearestFromScreen

solveNearestFromSegment

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