Options
All
  • Public
  • Public/Protected
  • All
Menu

Options to pass to the UniformHeatmapSeries constructor

Hierarchy

Index

Properties

Optional dataSeriesName

dataSeriesName: string

The DataSeries name, used in legends, tooltips to identify the chart series

Optional id

id: string

A unique Id for the IDataSeries

Optional metadata

metadata: IPointMetadata[][] | IPointMetadata | { data?: any; type: string }

The Metadata values of type IPointMetadata to pre-populate the BaseHeatmapDataSeries If a single metadata value is supplied, this will be used as a template for all data values. If type AND data is specified, then the registered function should take the data and return a IPointData array. If only type is specified, the registered function will be set as the metadataGenerator and used to construct new metadata for each data value.

xStart

xStart: number

xStart defines the Start point on the XAxis where this heatmap will be drawn

xStep

xStep: number

xStep defines Step on the XAxis for each cell in the heatmap

yStart

yStart: number

yStart defines the Start point on the YAxis where this heatmap will be drawn

yStep

yStep: number

yStep defines Step on the YAxis for each cell in the heatmap

Optional zValues

zValues: number[][]

The 2-Dimensional array of cells which can be passed to populate the BaseHeatmapDataSeries at construct time

Generated using TypeDoc