Axis X
Axis Y
Scale of the series
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' )]
])
Amount of columns to add and update.
Type of the callback.
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]
])
Object itself for fluent interface.
Add Marker to the Series.
StaticCursorBuilderXY object for customized look of marker. MarkerBuilders.XY can be used to build a custom one from scratch.
SeriesMarkerXY
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' )]
])
Amount of rows to add and update.
Type of the callback.
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]
])
Object itself for fluent interface.
Attach object to an legendBox entry
Object which has to be attached
Flag that indicates whether the Attachable should be disposed/restored, when its respective Entry is clicked.
Series itself for fluent interface
Remove everything related to the object from all collections associated with rendering cycle and allows the object to be collected by GC
Object itself for fluent interface
Get whether series is taken into account with automatic scrolling and fitting of attached axes.
By default, this is true for all series.
true
default, axes will take series into account in scrolling and fitting operations.
false
, axes will ignore series boundaries.
Whether Cursor is enabled or not
Get if cursor interpolates solved data-points along series by default.
Boolean flag
Get ResultTable Formatter.
Function which builds ResultTable content for IntensitySeries.
Get fill style of Intensity Heatmap Series.
FillStyle.
Get boolean flag for whether object should highlight on mouse hover
Boolean for if object should highlight on mouse hover or not.
the state of highlighted flag
Get boolean flag for whether object is currently under mouse or not
Boolean for is object under mouse currently
Get mouse interactions enabled or disabled. Disabled mouse-interactions will naturally prevent mouse-driven highlighting from ever happening.
Mouse interactions state
Get the name of the Component.
The name of the Component.
Get style of wireframe.
Wireframe is a line grid that highlights the edges of each cell of the heatmap.
FillStyle.
Max X value of the series
Min X value of the series
Max Y value of the series
Min Y value of the series
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.
Matrix of new colors. The resolution of the IntensityShape should be valid.
Optional configuration object to specify the range of the grid to be invalidated.
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.
Callback function to map through the input to modify the matrix colors. The resolution of the IntensityShape should be valid.
Optional configuration object to specify the range of the grid to be invalidated.
Series itself for fluent interface.
Treat the data of the matrix as any of the Point-based type of points. Point-based data is represented in format { x: number, y: number } to modify the geometry only.
Invalidates only the geometry coordinates without update the intensity or color data, providing significantly faster rendering of dynamically changed geometry.
Matrix of new vertices. The resolution of the IntensityMesh should be valid.
Optional configuration object to specify the range of the grid to be invalidated.
Series itself for fluent interface.
Treat the data of the matrix as any of the Point-based type of points. Point-based data is represented in format { x: number, y: number } to modify the geometry only.
Invalidates only the geometry coordinates without update the intensity or color data, providing significantly faster rendering of dynamically changed geometry.
Optional configuration object to specify the range of the grid to be invalidated.
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.
Matrix of new intensity values.
Optional configuration object to specify the range of the grid to be invalidated.
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.
Callback function to map through the input to modify the matrix of intensity values. The resolution of the IntensityShape should be valid.
Optional configuration object to specify the range of the grid to be invalidated.
Series itself for fluent interface.
TODO: True for enabled and false for disabled
Unsubscribe from Highlight object event. This is called whenever an object is highlighted
Token that was received when subscribing to the event.
True if the unsubscription was successful.
Remove event listener from Series Hover Event.
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Click Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Double Click Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Down Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Drag Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Drag Start Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Drag Stop Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Enter Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Leave Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Move Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Up Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Wheel Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Touch End Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Touch Move Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Touch Start Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Subscribe to highlight object event. This is called whenever an object is highlighted.
Function that is called when event is triggered.
Token that can be used to unsubscribe from the event.
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.
Callback function that is called whenever mouse enters / moves or leaves the Series
Token of the event listener
Add event listener to Mouse Click Event
Event listener for Mouse Click Event
Token of the event listener
Add event listener to Mouse Double Click Event
Event listener for Mouse Double Click Event
Token of the event listener
Add event listener to Mouse Down Event
Event listener for Mouse Down Event
Token of the event listener
Subscribe to Mouse Drag event
Subscribe to Mouse Drag Start event
Subscribe to Mouse Drag Stop event
Add event listener to Enter Event
Event listener for Mouse Enter Event
Token of the event listener
Add event listener to Mouse Leave Event
Event listener for Mouse Leave Event
Token of the event listener
Add event listener to Mouse Move Event
Event listener for Mouse Move Event
Token of the event listener
Add event listener to Mouse Up Event
Event listener for Mouse Up Event
Token of the event listener
Subscribe to Mouse Wheel event
Event handler function
Token of subscription
Subscribe to Touch End event
Event handler function
Token of subscription
Subscribe to Touch Move event
Event handler function
Token of subscription
Subscribe to Touch Start event
Event handler function
Token of subscription
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:
Major mandotary properties of Intensity.
Series itself for fluent interface.
Tell the owning chart to restore this series.
Object itself.
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)
true
default, axes will take series into account in scrolling and fitting operations.
false
, axes will ignore series boundaries.
Object itself for fluent interface.
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:
'nearest-x'
, 'nearest'
, etc.).
This method is not available for all series types (more support will be added in near future).Set if cursor interpolates solved data-points along series by default.
// Example, disable default interpolation of intensity grid series.
IntensityGridSeries.setCursorInterpolationEnabled(false)
Related API:
Boolean flag
Object itself for fluent interface
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:
series
| reference to the series itself.x
| pointed data point X coordinate.y
| pointed data point Y coordinate.value
| pointed data point intensity value.Related API:
Function which builds ResultTable content.
Object itself
Set fill style of Intensity Heatmap Series.
Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value.
Series itself for fluent interface.
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.
True if highlighting on mouse hover, false if no highlight on mouse hover
Object itself for fluent interface.
Enable or disable forced highlighting of component
True for enabled and false for disabled
component itself for fluent interface
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:
Specifies state of mouse interactions
Object itself for fluent interface
Sets the name of the Component updating attached LegendBox entries
Name of the Component
Object itself
Set style of wireframe.
Wireframe is a line grid that highlights the edges of each cell of the heatmap.
Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value.
Series itself for fluent interface.
IntensityMeshSeries for visualization of magnitude in two dimensions.
Mesh allows to edit the geometry of the displayed intensity series.
IntensityMeshSeries are created with ChartXY.addHeatmapSeries with IntensitySeriesType of IntensitySeriesTypes.Mesh
Will be removed in v4.0 in favor of new optimized
Heatmap Series
.