Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HeatmapGridSeriesIntensityValues

Series for visualizing a Intensity Heatmap Grid with a static column and grid count. Has API for fast modification of cell values.

HeatmapGridSeriesIntensityValues is optimized for massive amounts of data - here are some reference specs on average PC to give an idea:

  • Heatmap Chart with 1 million data points (1000x1000) is cold started in ~0.3 seconds.
  • Heatmap Chart with 1 million data points (1000x1000) is re-populated (change data set) in ~0.050 seconds.
  • Heatmap Chart with 16 million data points (4000x4000) is cold started in ~2.0 seconds.
  • Heatmap Chart with 16 million data points (4000x4000) is re-populated (change data set) in ~0.5 seconds.

HeatmapGridSeriesIntensityValues max data amount is entirely restricted by the client hardware RAM and more specifically amount of RAM usable by the context running LightningChart JS. If by increasing the amount of columns and rows you encounter suddenly weak performance, it is likely that there is not enough RAM memory available.

Created with ChartXY.addHeatmapGridSeries.

Frequently used API:

Index

Properties

Readonly axisX

axisX : Axis

Axis X

Readonly axisY

axisY : Axis

Axis Y

Readonly chart

chart : ChartXY

Readonly scale

scale : LinearScaleXY

Scale of the series

Methods

addMarker

  • Add Marker to the Series.

    Type parameters

    Parameters

    • cursorBuilder: StaticCursorXYBuilder<PointMarkerType, ResultTableBackgroundType>

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

    Returns SeriesMarkerXY<PointMarkerType, ResultTableBackgroundType>

    SeriesMarkerXY

attach

  • attach(entry: LegendBoxEntry, disposeOnClick?: undefined | false | true): this
  • Attach object to an legendBox entry

    Parameters

    • entry: LegendBoxEntry

      Object which has to be attached

    • disposeOnClick: undefined | false | true

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

    Returns this

    Series itself for fluent interface

clear

  • clear(): this
  • Clear all previous data pushed to the series.

    Returns this

    Object 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

getAutoScrollingEnabled

  • getAutoScrollingEnabled(): boolean
  • Get whether series is taken into account with automatic scrolling and fitting of attached axes.

    By default, this is true for all series.

    Returns boolean

    true default, axes will take series into account in scrolling and fitting operations. false, axes will ignore series boundaries.

getBoundaries

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

getCursorEnabled

  • getCursorEnabled(): boolean
  • Returns boolean

    Whether Cursor is enabled or not

getCursorInterpolationEnabled

  • getCursorInterpolationEnabled(): boolean
  • Get if cursor interpolates solved data-points along series by default.

    Returns boolean

    Boolean flag

getCursorResultTableFormatter

getFillStyle

  • Get fill style of series.

    Returns FillStyle

    FillStyle.

getHighlightOnHover

  • getHighlightOnHover(): boolean
  • Get boolean flag for whether object should highlight on mouse hover

    Returns boolean

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

getHighlighted

  • getHighlighted(): boolean

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.

getPixelInterpolationMode

  • getPixelInterpolationMode(): "disabled" | "bilinear"
  • Get heatmap fill pixel interpolation mode.

    Returns "disabled" | "bilinear"

    Heatmap fill pixel interpolation mode selection.

getWireframeStyle

  • Get style of wireframe.

    Wireframe is a line grid that highlights the edges of each cell of the heatmap.

    Returns LineStyle

    LineStyle.

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

invalidateIntensityValues

  • invalidateIntensityValues(value: number[][]): this
  • invalidateIntensityValues(value: object): this
  • Invalidate range of heatmap intensity values starting from first column and row, updating coloring if a Color look up table (LUT) has been attached to the series (see HeatmapGridSeriesIntensityValues.setFillStyle).

     // Example, 3x3 grid full invalidation.
     const heatmapGridSeries = ChartXY.addHeatmapGridSeries({
         dataOrder: 'columns',
         columns: 3,
         rows: 3
     })
    
     heatmapGridSeries.invalidateIntensityValues([
         // Column 1 intensity values.
         [0, 0, 0],
         // Column 2 intensity values.
         [1, 1, 1],
         // Column 3 intensity values.
         [0, 2, 0],
     ])
    

    Data interpretation basis is defined by HeatmapGridSeriesOptions.dataOrder property from when the series was created. Can be either list of columns, or list of rows.

    invalidateIntensityValues can trigger warnings when used controversially. In production applications, these can be controlled with LightningChartOptions.warnings.

    Parameters

    • value: number[][]

      Matrix containing intensity values for each data slot of the grid.

    Returns this

    Object itself for fluent interface.

  • Invalidate a partial range of heatmap intensity values, updating coloring if a Color look up table (LUT) has been attached to the series (see HeatmapGridSeriesIntensityValues.setFillStyle).

     // Example, 100x10 grid invalidate partial section of grid.
    
     const heatmapGridSeries = ChartXY.addHeatmapGridSeries({
         dataOrder: 'columns',
         columns: 100,
         rows: 10
     })
    
     heatmapGridSeries.invalidateIntensityValues({
         // Index of first invalidated column.
         iColumn: 50,
         // Index of first invalidated row.
         iRow: 2,
         // Intensity values matrix. It's dimensions imply the amount of invalidated columns & rows.
         values: [
             // 1st invalidated column intensity values.
             [1, 1, 1, 1, 1],
             // 2nd invalidated column intensity values.
             [2, 2, 2, 2, 2],
             // 3rd invalidated column intensity values.
             [1, 0, 0, 0, 1],
             // 4th invalidated column intensity values.
             [0, 1, 0, 1, 0],
             // 5th invalidated column intensity values.
             [0, 0, 1, 0, 0],
         ],
     })
    

    invalidateIntensityValues can trigger warnings when used controversially. In production applications, these can be controlled with LightningChartOptions.warnings.

    Parameters

    • value: object

      Partial invalidation information, where values is an intensity value matrix, and iStartPrimary is the index of first invalidated coordinate along primary dimension.

      • iColumn: number
      • iRow: number
      • values: number[][]

    Returns this

    Object itself for fluent interface.

isDisposed

  • isDisposed(): boolean
  • Returns boolean

    TODO: True for enabled and false for disabled

offHighlight

  • offHighlight(token: Token): boolean
  • Unsubscribe from Highlight object event. This is called whenever an object is highlighted

    Parameters

    • token: Token

      Token that was received when subscribing to the event.

    Returns boolean

    True if the unsubscription was successful.

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

onHighlight

  • onHighlight(handler: function): Token
  • Subscribe to highlight object event. This is called whenever an object is highlighted.

    Parameters

    • handler: function

      Function that is called when event is triggered.

        • Parameters

          • isHighlighted: boolean

          Returns void

    Returns Token

    Token that can be used to unsubscribe from the event.

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

          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

onTouchEnd

  • Subscribe to Touch End event

    Parameters

    Returns Token

    Token of subscription

onTouchMove

onTouchStart

restore

  • restore(): this
  • Tell the owning chart to restore this series.

    Returns this

    Object itself.

setAutoScrollingEnabled

  • setAutoScrollingEnabled(enabled: boolean): this
  • Set whether series is taken into account with automatic scrolling and fitting of attached axes.

    By default, this is true for all series.

    By setting this to false, any series can be removed from axis scrolling/fitting.

     // Example syntax, remove series from automatic scrolling / fitting.
     LineSeries.setAutoScrollingEnabled(false)
    

    Parameters

    • enabled: boolean

      true default, axes will take series into account in scrolling and fitting operations. false, axes will ignore series boundaries.

    Returns this

    Object itself for fluent interface.

setCursorEnabled

  • setCursorEnabled(state: boolean): this
  • Configure whether cursors should pick on this particular series or not.

     // Example, prevent chart auto cursor from snapping to a series.
     LineSeries.setCursorEnabled(false)
    

    Related API:

    • setCursorResultTableFormatter | configure formatting of result table contents, when this series is pointed.
    • setCursorSolveBasis | configure basis of finding nearest data point for the series ('nearest-x', 'nearest', etc.). This method is not available for all series types (more support will be added in near future).
    • setCursorInterpolationEnabled | configure whether cursor should interpolate the displayed data point between the two closest data points, or snap to the nearest real data point. This method is not available for all series types.
    • ChartXY.setAutoCursorMode | configure behavior when auto cursor is visible.

    Parameters

    • state: boolean

    Returns this

setCursorInterpolationEnabled

  • setCursorInterpolationEnabled(state: boolean): this
  • Set cursor interpolation enabled.

    If enabled, cursors will display bilinearly interpolated intensity values from the four closest heatmap cells to the mouse pointer. Otherwise, cursor will display the nearest actual data point supplied by user.

    Parameters

    • state: boolean

      Boolean flag

    Returns this

    Object itself for fluent interface

setCursorResultTableFormatter

  • Method for customizing contents of ResultTables when pointing at this Series.

     HeatmapGridSeries.setCursorResultTableFormatter((builder, series, dataPoint) =>
         builder
             .addRow('Pointing at')
             .addRow(`${dataPoint.x.toFixed(1)}, ${dataPoint.y.toFixed(1)}`)
             .addRow(`= ${dataPoint.intensity.toFixed(1)}`),
     )
    

    Default Axis formatting can be referenced by using Axis.formatValue method.

    Parameters

    Returns this

    Object itself

setFillStyle

  • Set fill style of heatmap series.

    Supported fill styles:

    PalettedFill:

    Colors heatmap fill by looking color up from LUT based on heatmap intensity values.

     // Example, color look up by intensity values.
     heatmapSeries.setFillStyle(
         new PalettedFill({
             lut: new LUT({
                 steps: [
                     { value: 0, color: ColorCSS('red') },
                     { value: 20, color: ColorCSS('blue') },
                 ],
                 interpolate: true,
             }),
         }),
     )
    

    Assign intensity values with invalidateIntensityValues.

    SolidFill:

    Solid color for all heatmap cells. Supported for debugging purposes mainly.

    emptyFill:

    Disables heatmap fill.

     // Example, hide heatmap fill and show wireframe.
     heatmapSeries
         .setFillStyle(emptyFill)
         .setWireframeStyle(new SolidFill({ color: ColorRGBA(255, 0, 0) }))
    

    Parameters

    Returns this

    Object itself for fluent interface.

setHighlightOnHover

  • setHighlightOnHover(state: boolean): this
  • Set highlight on mouse hover enabled or disabled.

    Mouse interactions have to be enabled on the component for this to function as expected. See setMouseInteractions for more information.

    Parameters

    • state: boolean

      True if highlighting on mouse hover, false if no highlight on mouse hover

    Returns this

    Object 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 component mouse interactions enabled or disabled.

    Disabling mouse interactions means that the objects below this component can be interacted through it.

    Possible side-effects from disabling mouse interactions:

    • Mouse events are not triggered. For example, onMouseMove.
    • Mouse driven highlighting will not work.

    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

setPixelInterpolationMode

  • setPixelInterpolationMode(interpolationMode: "disabled" | "bilinear" | undefined): this
  • Set heatmap fill pixel interpolation mode.

    'disabled' or undefined: Interpolation disabled; all pixels within a grid cell share the same color.

    'bilinear': Each pixel is colored individually by bilinear interpolation.

    Parameters

    • interpolationMode: "disabled" | "bilinear" | undefined

      Heatmap fill pixel interpolation mode selection.

    Returns this

    Object itself for fluent interface.

setWireframeStyle

  • Set style of wireframe.

     // Example, disable wireframe.
     heatmapSeries.setWireframeStyle(emptyLine)
    
     // Example, set wireframe style.
     heatmapSeries.setWireframeStyle(new SolidLine({
         thickness: 1,
         fillStyle: new SolidFill({ color: ColorRGBA(255, 0, 0, 255) })
     }))
    

    Wireframe is a line grid that highlights the edges of each cell of the heatmap.

    Parameters

    Returns this

    Series itself for fluent interface.

solveNearestFromScreen

  • solveNearestFromScreen(location: Point, interpolate: boolean): undefined | CursorPoint
  • Parameters

    • location: Point
    • interpolate: boolean

    Returns undefined | CursorPoint

solveNearestFromSegment

  • solveNearestFromSegment(location: Point, segment: HeatmapGridStatic, interpolate: boolean): undefined | CursorPoint
  • Parameters

    • location: Point
    • segment: HeatmapGridStatic
    • interpolate: boolean

    Returns undefined | CursorPoint