HeatmapSpec

@elastic/charts • Exports

---

@elastic/charts / HeatmapSpec

Interface: HeatmapSpec<D>

Contents

• Extends
• Type parameters
• Properties
  • chartType
  • colorScale
  • data
  • highlightedData?
  • id
  • name?
  • specType
  • timeZone
  • valueAccessor
  • valueFormatter
  • xAccessor
  • xAxisLabelFormatter
  • xAxisLabelName
  • xAxisTitle
  • xScale
  • xSortPredicate
  • yAccessor
  • yAxisLabelFormatter
  • yAxisLabelName
  • yAxisTitle
  • ySortPredicate

Extends

• Spec

Type parameters

• D extends BaseDatum = Datum

Properties

chartType

chartType: "heatmap"

Chart type define the type of chart that use this spec

Overrides

Spec.chartType

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:86

---

colorScale

colorScale: HeatmapBandsColorScale

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:88

---

data

data: D[]

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:87

---

highlightedData?

highlightedData?: HeatmapHighlightedData

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:96

---

id

id: string

unique Spec identifier

Inherited from

Spec.id

Source

packages/charts/src/specs/spec_type.ts:29

---

name?

name?: string

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:97

---

specType

specType: "series"

The type of spec, can be series, axis, annotation, settings etc

Overrides

Spec.specType

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:85

---

timeZone

timeZone: string

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:98

---

valueAccessor

valueAccessor: Accessor<never> | AccessorFn

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:91

---

valueFormatter

valueFormatter: ValueFormatter

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:92

---

xAccessor

xAccessor: Accessor<D> | AccessorFn<D>

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:89

---

xAxisLabelFormatter

xAxisLabelFormatter: LabelAccessor<string | number>

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:101

---

xAxisLabelName

xAxisLabelName: string

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:100

---

xAxisTitle

xAxisTitle: string

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:99

---

xScale

xScale: RasterTimeScale | LinearScale | OrdinalScale

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:95

---

xSortPredicate

xSortPredicate: Predicate

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:93

---

yAccessor

yAccessor: Accessor<D> | AccessorFn<D>

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:90

---

yAxisLabelFormatter

yAxisLabelFormatter: LabelAccessor<string | number>

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:104

---

yAxisLabelName

yAxisLabelName: string

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:103

---

yAxisTitle

yAxisTitle: string

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:102

---

ySortPredicate

ySortPredicate: Predicate

Source

packages/charts/src/chart_types/heatmap/specs/heatmap.ts:94

---

Generated using typedoc-plugin-markdown and TypeDoc