grafit-charts

---

Interface: HeatmapSeriesOptions

Extends

• Omit<SeriesBaseOptions, "tooltip">

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

LineSeriesOptions.id

---

itemPadding?

optional itemPadding?: number

---

label?

optional label?: Switchable & FontOptions & object

Value labels in cells (disabled by default).

Type Declaration

formatter?

optional formatter?: (params) => string

Parameters

params

datum

Datum

value

number

Returns

string

placement?

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

Placement within the cell (center by default).

---

name?

optional name?: string

Inherited from

LineSeriesOptions.name

---

showInLegend?

optional showInLegend?: boolean

Inherited from

LineSeriesOptions.showInLegend

---

type

type: "heatmap"

---

visible?

optional visible?: boolean

Inherited from

Showable.visible

---

xField

xField: string

Horizontal category.

Overrides

LineSeriesOptions.xField

---

xName?

optional xName?: string

Inherited from

LineSeriesOptions.xName

---

yField

yField: string

Vertical category.

Overrides

LineSeriesOptions.yField