Protected _isActive state of Cursor
Readonly axisXReadonly axisYReadonly chartReadonly scaleScale of the series
Add Marker to the Series.
SeriesMarkerXY
StaticCursorBuilderXY object for customized look of marker. MarkerBuilders.XY can be used to build a custom one from scratch.
Attach object to an legendBox entry
Series itself for fluent interface
Object which has to be attached
Optional toggleVisibilityOnClick: booleanFlag that indicates whether the Attachable should be hidden or not, when its respective Entry is clicked.
Clear all previous data pushed to the series.
Object itself for fluent interface.
Permanently destroy the component.
To fully allow Garbage-Collection to free the resources used by the component, make sure to remove any references to the component and its children in application code.
let chart = ...ChartXY()
let axisX = chart.getDefaultAxisX()
// Dispose Chart, and remove all references so that they can be garbage-collected.
chart.dispose()
chart = undefined
axisX = undefined
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.
Get ResultTable Formatter.
Function which builds ResultTable content for this series type.
Get theme effect enabled on component or disabled.
A theme can specify an Effect to add extra visual oomph to chart applications, like Glow effects around data or other components.
Whether this effect is drawn above a particular component can be configured using the setEffect method.
// Example, disable theme effect from a particular component.
Component.setEffect(false)
For the most part, theme effects are enabled by default on most components.
Theme effect is configured with effect property.
Boolean that describes whether drawing the theme effect is enabled around the component or not.
Get heatmap intensity interpolation mode.
Heatmap intensity interpolation mode selection.
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 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 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 warnings.
Object itself for fluent interface.
Matrix containing intensity values for each data slot of the grid.
Invalidate a partial range of heatmap intensity values, updating coloring if a Color look up table (LUT) has been attached to the series (see 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 warnings.
Object itself for fluent interface.
Partial invalidation information, where values is an intensity value matrix, iColumn the first affected column and iRow the first affected row.
Subscribe onDispose event.
This event is triggered whenever the ChartComponent is disposed.
// Example usage
lineSeries.onDispose(() => {
console.log('lineSeries was disposed')
})
lineSeries.dispose()
Token of subscription
Event handler function
Subscribe to highlight object event. This is called whenever an object is highlighted.
Token that can be used to unsubscribe from the event.
Function that is called when event is triggered.
Add event listener to Mouse Click Event
Token of the event listener
Event listener for Mouse Click Event
Add event listener to Mouse Double Click Event
Token of the event listener
Event listener for Mouse Double Click Event
Add event listener to Mouse Down Event
Token of the event listener
Event listener for Mouse Down Event
Subscribe to Mouse Drag event
Subscribe to Mouse Drag Start event
Subscribe to Mouse Drag Stop event
Add event listener to Enter Event
Token of the event listener
Event listener for Mouse Enter Event
Add event listener to Mouse Leave Event
Token of the event listener
Event listener for Mouse Leave Event
Add event listener to Mouse Move Event
Token of the event listener
Event listener for Mouse Move Event
Add event listener to Mouse Up Event
Token of the event listener
Event listener for Mouse Up Event
Subscribe to Mouse Wheel event
Token of subscription
Event handler function
Subscribe to Touch End event
Token of subscription
Event handler function
Subscribe to Touch Move event
Token of subscription
Event handler function
Subscribe to Touch Start event
Token of subscription
Event handler function
Register new event listener to visibleStateChanged event.
Event listener for visibleStateChanged
Set component highlight animations enabled or not. For most components this is enabled by default.
// Example usage, disable highlight animations.
component.setAnimationHighlight(false)
Object itself
Animation enabled?
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)
Object itself for fluent interface.
true default, axes will take series into account in scrolling and fitting operations.
false, axes will ignore series boundaries.
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:
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.
Object itself for fluent interface
Boolean flag
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 formatValue method.
Object itself
Function which builds ResultTable content. See definition of HeatmapSeriesFormatterIntensity for supplied formatting information.
Configure draw order of the series.
The drawing order of series inside same chart can be configured by configuring their seriesDrawOrderIndex.
This is a simple number that indicates which series is drawn first, and which last.
The values can be any JS number, even a decimal. Higher number results in series being drawn closer to the top.
By default, each series is assigned a running counter starting from 0 and increasing by 1 for each series.
// Example, create 2 series and configure them to be drawn in reverse order.
const series1 = ChartXY.addLineSeries()
.setDrawOrder({ seriesDrawOrderIndex: 1 })
const series2 = ChartXY.addLineSeries()
.setDrawOrder({ seriesDrawOrderIndex: 0 })
// Example, ensure a series is drawn above other series.
SeriesXY.setDrawOrder({ seriesDrawOrderIndex: 1000 })
Object itself.
Object with seriesDrawOrderIndex property.
Set theme effect enabled on component or disabled.
A theme can specify an Effect to add extra visual oomph to chart applications, like Glow effects around data or other components.
Whether this effect is drawn above a particular component can be configured using the setEffect method.
// Example, disable theme effect from a particular component.
Component.setEffect(false)
For the most part, theme effects are enabled by default on most components.
Theme effect is configured with effect property.
Object itself.
Theme effect enabled
Set fill style of heatmap series.
Supported fill styles:
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.
Solid color for all heatmap cells. Supported for debugging purposes mainly.
Disables heatmap fill.
// Example, hide heatmap fill and show wireframe.
heatmapSeries
.setFillStyle(emptyFill)
.setWireframeStyle(new SolidFill({ color: ColorRGBA(255, 0, 0) }))
Object itself for fluent interface.
FillStyle object or function which modifies current value.
Set state of component highlighting.
// Example usage
component.setHighlight(true)
component.setHighlight(0.5)
If highlight animations are enabled (which is true by default), the transition will be animated. As long as the component is highlighted, the active highlight intensity will be animated continuously between 0 and the configured value. Highlight animations can be disabled with setAnimationHighlight
Object itself
Boolean or number between 0 and 1, where 1 is fully highlighted.
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.
Object itself for fluent interface.
True if highlighting on mouse hover, false if no highlight on mouse hover
Set heatmap intensity interpolation mode.
'disabled' or undefined: Interpolation disabled; draw data exactly as it is.
'bilinear': Each PIXEL is colored based on an Bi-linearly interpolated intensity value based on the 4 closest real intensity values.
Object itself for fluent interface.
Heatmap intensity interpolation mode selection.
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:
Object itself for fluent interface
Specifies state of mouse interactions
Sets the name of the Component updating attached LegendBox entries
Object itself
Name of the Component
Set element visibility.
Object itself.
true when element should be visible and false when element should be hidden.
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.
Series itself for fluent interface.
Either a LineStyle object or a function, which will be used to create a new LineStyle based on current value.
Series for visualizing a Intensity Heatmap Grid with a static column and grid count. Has API for fast modification of cell values.
HeatmapGridSeriesIntensityValuesis optimized for massive amounts of data - here are some reference specs on average PC to give an idea:1000x1000) is cold started in ~0.3 seconds.1000x1000) is re-populated (change data set) in ~0.050 seconds.4000x4000) is cold started in ~2.0 seconds.4000x4000) is re-populated (change data set) in ~0.5 seconds.HeatmapGridSeriesIntensityValuesmax 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 ofcolumnsandrowsyou encounter suddenly weak performance, it is likely that there is not enough RAM memory available.Created with addHeatmapGridSeries.
Frequently used API: