Skip to main content

Options

Customize the UI and content of the calendar

The calendar can be customized by passing an Options object to the paint() method on the calendar instance.

Usage
const cal = new CalHeatmap();
cal.paint(options?: Options): Promise<unknown>;
Type Signature
type Options = {
itemSelector: Element | string,
range: number,
domain: DomainOptions,
subDomain: SubDomainOptions,
verticalOrientation: boolean,
date: DateOptions,
data: DataOptions,
label: LabelOptions,
animationDuration: number,
scale: ScaleOptions,
theme: 'light' | 'dark',
};
tip

Throughout the documentation, you will see block like the following

http://localhost:3000
Live Editor
Result
Loading...

These are live editor: you can edit the code inline, and see the result in live.

Use them to test settings, and see what happen.