Interface: CalendarHeatmapOptions

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:28

Options for creating a CalendarHeatmap.

Properties

cellGap?

optional cellGap: number

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:38

Gap between cells. Default: 0.06

---

cellSize?

optional cellSize: number

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:36

Side length of a day cell. Default: 0.3

---

data

data: CalendarDatum[]

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:30

The dated values.

---

domain?

optional domain: [number, number]

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:42

Value domain [min, max] mapped across the palette. Auto-computed if omitted.

---

emptyColor?

optional emptyColor: string

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:48

Color for days with no datum. Default: '#ebedf0'

---

endDate?

optional endDate: string | Date

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:34

Last day shown. Default: the latest date in the data.

---

labelColor?

optional labelColor: string

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:54

Color for labels. Default: white

---

monthLabelFontSize?

optional monthLabelFontSize: number

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:52

Font size for month labels. Default: 16

---

palette?

optional palette: readonly string[]

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:40

Color palette mapped across the value domain. Default: GitHub greens

---

showMonthLabels?

optional showMonthLabels: boolean

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:50

Draw month labels above the grid. Default: true

---

startDate?

optional startDate: string | Date

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:32

First day shown. Default: the earliest date in the data.

---

useOklab?

optional useOklab: boolean

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:44

Blend the palette in perceptually-uniform Oklab space. Default: false

---

weekStartsOn?

optional weekStartsOn: 0 | 1

Defined in: src/mobjects/graphing/CalendarHeatmap.ts:46

First weekday of a column: 0 = Sunday (GitHub), 1 = Monday. Default: 0