Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IntensityGridSeries

IntensityGridSeries for visualization of magnitude in two dimensions.

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

deprecated

Will be removed in v4.0 in favor of new optimized Heatmap Series.

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

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
    • type: "value"
    • values: Matrix<number>

    Returns this

    Object itself for fluent interface.

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

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
    • type: "value"
    • values: Matrix<number>

    Returns this

    Object itself for fluent interface.

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

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

  • Get ResultTable Formatter.

    Returns IntensitySeriesFormatter

    Function which builds ResultTable content for IntensitySeries.

getFillStyle

  • Get 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.

    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.

getWireframeStyle

  • Get style of wireframe.

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

    Returns FillStyle

    FillStyle.

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.

    • 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.

    • 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.

    • 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.

    • 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

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

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.

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 if cursor interpolates solved data-points along series by default.

     // Example, disable default interpolation of intensity grid series.
     IntensityGridSeries.setCursorInterpolationEnabled(false)
    

    Related API:

    Parameters

    • state: boolean

      Boolean flag

    Returns this

    Object itself for fluent interface

setCursorResultTableFormatter

  • Configure formatting of Cursor ResultTable when pointing at this series.

     // Example usage
     IntensityGridSeries.setCursorResultTableFormatter((tableBuilder, series, x, y, value) => {
         return tableBuilder
             .addRow(`Pointing at`, '', series.getName())
             .addRow(`X:`, '', x.toFixed(0))
             .addRow(`Y:`, '', y.toFixed(0))
             .addRow(`Value:`, '', value.toFixed(1))
     })
    

    The general syntax of configuring ResultTable formatting is shared between all series types; You specify a callback function, which receives a TableContentBuilder. The contents of the table are then set using methods of the table builder:

     // Using TableContentBuilder.
     IntensityGridSeries.setCursorResultTableFormatter((tableBuilder, series, x, y, value) => {
         // addRow adds a list of strings to a new row in the table. Empty strings ('') will allocate any extra horizontal space within the row.
         tableBuilder
             .addRow('Item 0:', '', 'Value 0')
             .addRow('Item 1:', '', 'Value 1')
             .addRow('Long row that highlights the idea of empty strings')
    
         // After configuration, the table builder must be returned!
         return tableBuilder
     })
    

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

    The additional values that are supplied to the callback function, vary per series, refer to the series documentation of setCursorResultTableFormatter to learn the exact available information. All Intensity Series receive four extra parameters:

    1. series | reference to the series itself.
    2. x | pointed data point X coordinate.
    3. y | pointed data point Y coordinate.
    4. value | pointed data point intensity value.

    Related API:

    Parameters

    Returns this

    Object itself

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.

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

setWireframeStyle

  • Set style of wireframe.

    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: Intensity, interpolate: boolean): undefined | CursorPoint
  • Parameters

    • location: Point
    • segment: Intensity
    • interpolate: boolean

    Returns undefined | CursorPoint