Interface describing readonly configurations of a PolarHeatmapSeries.

Required properties:

Optional properties:

Hierarchy

  • PolarHeatmapSeriesOptions

Properties

amplitudeEnd?: number

Amplitude value where Polar Heatmap ends at.

If both are defined, amplitudeEnd has priority over amplitudeStep.

amplitudeStart?: number

Amplitude value where Polar Heatmap originates at.

Defaults to 0.

amplitudeStep?: number

Amplitude step between each ring (annuli) of the Polar Heatmap.

Defaults to 0.

annuli: number

Amount of unique data samples along Amplitude Axis.

There is no hard cap on how much data you can put into a polar heatmap, the limit is the running device's GPU memory. Generally several million data points are no problem.

dataOrder?: "annuli" | "sectors"

Select order of data.

Determines whether new data is processed as list of "sectors" or "annuli".

'annuli' -> Supply lists of "annuli"

 const intensityValues = [
[
0, // 1st ring counting from inner most, sector (starting at 0 deg, rotating counter clockwise) = 0
0, // 1st ring counting from inner most, sector (starting at 0 deg, rotating counter clockwise) = 1
0, // 1st ring counting from inner most, sector (starting at 0 deg, rotating counter clockwise) = n
],
[
0, // 2nd ring counting from inner most, sector (starting at 0 deg, rotating counter clockwise)
0, // 2nd ring counting from inner most, sector (starting at 0 deg, rotating counter clockwise)
0, // 2nd ring counting from inner most, sector (starting at 0 deg, rotating counter clockwise)
],
]

'sectors' -> Supply lists of "sectors"

 const intensityValues = [
[
0, // 1st ring counting from inner most, sector 0 (starting at 0 deg, rotating counter clockwise)
0, // 2nd ring counting from inner most, sector 0 (starting at 0 deg, rotating counter clockwise)
0, // 3rd ring counting from inner most, sector 0 (starting at 0 deg, rotating counter clockwise)
],
[
0, // 1st ring counting from inner most, sector 1 (starting at 0 deg, rotating counter clockwise)
0, // 2nd ring counting from inner most, sector 1 (starting at 0 deg, rotating counter clockwise)
0, // 3rd ring counting from inner most, sector 1 (starting at 0 deg, rotating counter clockwise)
],
]

Defaults to annuli.

sectors: number

Amount of unique data samples along Radial Axis.

There is no hard cap on how much data you can put into a polar heatmap, the limit is the running device's GPU memory. Generally several million data points are no problem.