Heatmap
@elastic/charts • Exports
@elastic/charts / Heatmap
Function: Heatmap()
Heatmap<
D
>(props
):null
Adds heatmap spec to chart specs
Type parameters
• D extends BaseDatum
= any
Parameters
• props: SFProps
<HeatmapSpec
<D
>, "chartType"
| "specType"
, "data"
| "timeZone"
| "xAccessor"
| "valueFormatter"
| "valueAccessor"
| "yAccessor"
| "xSortPredicate"
| "ySortPredicate"
| "xScale"
| "xAxisTitle"
| "xAxisLabelName"
| "xAxisLabelFormatter"
| "yAxisTitle"
| "yAxisLabelName"
| "yAxisLabelFormatter"
, SFOptionalKeys
<HeatmapSpec
<any
>, "chartType"
| "specType"
, "data"
| "timeZone"
| "xAccessor"
| "valueFormatter"
| "valueAccessor"
| "yAccessor"
| "xSortPredicate"
| "ySortPredicate"
| "xScale"
| "xAxisTitle"
| "xAxisLabelName"
| "xAxisLabelFormatter"
| "yAxisTitle"
| "yAxisLabelName"
| "yAxisLabelFormatter"
>, SFRequiredKeys
<HeatmapSpec
<any
>, "chartType"
| "specType"
, "data"
| "timeZone"
| "xAccessor"
| "valueFormatter"
| "valueAccessor"
| "yAccessor"
| "xSortPredicate"
| "ySortPredicate"
| "xScale"
| "xAxisTitle"
| "xAxisLabelName"
| "xAxisLabelFormatter"
| "yAxisTitle"
| "yAxisLabelName"
| "yAxisLabelFormatter"
, SFOptionalKeys
<HeatmapSpec
<any
>, "chartType"
| "specType"
, "data"
| "timeZone"
| "xAccessor"
| "valueFormatter"
| "valueAccessor"
| "yAccessor"
| "xSortPredicate"
| "ySortPredicate"
| "xScale"
| "xAxisTitle"
| "xAxisLabelName"
| "xAxisLabelFormatter"
| "yAxisTitle"
| "yAxisLabelName"
| "yAxisLabelFormatter"
>>>
Returns
null
Source
packages/charts/src/chart_types/heatmap/specs/heatmap.ts:134
Generated using typedoc-plugin-markdown and TypeDoc