Interface HeatmapScrollingGridSeriesOptions<DataType>

Interface describing readonly configurations of a HeatmapScrollingGridSeries.

Required properties:

Optional properies:

Type Parameters

  • DataType extends "intensity" = "intensity"

Hierarchy

Properties

automaticColorIndex?: number

Optional index to use for automatic coloring of series.

Normally series are automatically colored differently when you create several series in the same chart. However, in some cases you might want to alter this order of automatic coloring, or use the automatic color palettes on series that belong to different charts.

In these scenarios you can use automaticColorIndex to tell each series individually what is its place in the default color palette.

 // Create series using the first color in default Theme palette.
const series1 = chart.addLineSeries({ automaticColorIndex: 0 })
// Create another series colored with the 3rd color.
const series2 = chart.addLineSeries({ automaticColorIndex: 2 })
heatmapDataType?: DataType

Selection of format in which heatmap values are supplied.

'intensity' | numeric value that can be colored with an associated color look up table.

Defaults to 'intensity'.

resolution: number

Static amount of columns (cells on X Axis) OR rows (cells on Y Axis).

This depends on value of scrollDimension:

scrollDimension: 'columns' -> amount of rows.

scrollDimension: 'rows' -> amount of columns.

scrollDimension?: "columns" | "rows"

Select scrolling dimension, as well as how to interpret grid matrix values supplied by user.

If columns is selected, then there will be no limit on how many columns can be pushed to the series, but rows amount will be static.

If rows is selected, then there will be no limit on how many rows can be pushed to the series, but columns amount will be static.

Data order:

'columns' -> Supply lists of "columns"

 const intensityValues = [
[
0, // Intensity value column = 0, row = 0
0, // Intensity value column = 0, row = 1
0, // Intensity value column = 0, row = n
],
[
0, // Intensity value column = 1, row = 0
0, // Intensity value column = 1, row = 1
0, // Intensity value column = 1, row = n
],
]

'rows' -> Supply lists of "rows"

 const intensityValues = [
[
0, // Intensity value row = 0, column = 0
0, // Intensity value row = 0, column = 1
0, // Intensity value row = 0, column = n
],
[
0, // Intensity value row = 1, column = 0
0, // Intensity value row = 1, column = 1
0, // Intensity value row = 1, column = n
],
]

Defaults to 'columns'.

start?: Point

Start coordinate of Heatmap on its X and Y Axes.

Defaults to { x: 0, y: 0 }

step?: Point

Step between each consecutive heatmap value on the X and Y Axes.

X = columns, Y = rows

Defaults to { x: 1, y: 1 }

xAxis?: Axis

Optional non-default X Axis to attach series to.

By default, series are attached to the same X Axis, that is returned by getDefaultAxisX.

yAxis?: Axis

Optional non-default Y Axis to attach series to.

By default, series are attached to the same Y Axis, that is returned by getDefaultAxisY.