Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IntensitySeriesOptions<IntensityType>

Interface can be used to define:

  • X and Y Axes that a series should be attached to
  • Resolution (rows & columns)
  • Start and End points of boundary box
  • Pixelation mode to draw per cell or per point colouring
  • Type of intensity series

Index

Properties

Properties

columns

columns : number

Horizontal resolution of the Heatmap.

end

end : Point

End point position of the Heatmap.

pixelate

pixelate : boolean

Data definition per cell / per vertex of the Heatmap.

Value Desired result
pixelate: true Intensity / Color applies per cell
pixelate: false Intensity / Color applies per vertex

rows

rows : number

Vertical resolution of the Heatmap.

start

start : Point

Starting point position of the Heatmap.

Optional type

type : IntensityType

Defines the type of intensity series. The API can vary for each selected series type.

See IntensitySeriesTypes for a collection of options.

Optional xAxis

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 ChartXY.getDefaultAxisX.

Optional yAxis

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 ChartXY.getDefaultAxisY.