grafit-charts

---

Interface: HeatmapSeriesOptions

Extends

• SeriesBaseOptions<HeatmapTooltipRendererParams>

Properties

colorField

colorField: string

Numeric value → cell color.

---

colorName?

optional colorName?: string

---

colorRange?

optional colorRange?: string[]

Color scale stops.

---

cornerRadius?

optional cornerRadius?: number

---

id?

optional id?: string

Inherited from

SeriesBaseOptions.id

---

itemPadding?

optional itemPadding?: number

---

label?

optional label?: Switchable & FontOptions & LabelOverlapOptions & object

Value labels in cells (disabled by default).

Type Declaration

format?

optional format?: string

Serializable format string (',.2f', '.0%'); formatter wins over it.

formatter?

optional formatter?: (params) => string

Parameters

params

HeatmapValueParams

Returns

string

placement?

optional placement?: "top" | "right" | "bottom" | "left" | "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"

Placement within the cell (center by default).

---

name?

optional name?: string

Inherited from

SeriesBaseOptions.name

---

showInLegend?

optional showInLegend?: boolean

Inherited from

SeriesBaseOptions.showInLegend

---

tooltip?

optional tooltip?: Switchable & object

Type Declaration

renderer?

optional renderer?: (params) => string | TooltipContentData

Parameters

params

HeatmapTooltipRendererParams

Returns

string | TooltipContentData

Inherited from

SeriesBaseOptions.tooltip

---

type

type: "heatmap"

---

visible?

optional visible?: boolean

Inherited from

SeriesBaseOptions.visible

---

xField

xField: string

Horizontal category.

Overrides

SeriesBaseOptions.xField

---

xName?

optional xName?: string

Inherited from

SeriesBaseOptions.xName

---

yField

yField: string

Vertical category.

Overrides

SeriesBaseOptions.yField