Skip to main content Link Menu Expand (external link) Document Search Copy Copied

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.

const cal = new CalHeatmap();
cal.paint(options?: Options);

Options signature

type Options = {
  itemSelector: Element | string,
  range: number,
  domain: DomainOptions,
  subDomain: SubDomainOptions,
  verticalOrientation: boolean,
  date: DateOptions,
  data: DataOptions,
  label: LabelOptions,
  animationDuration: number,
  tooltip: TooltipOptions,
  legend: LegendOptions,
  scale: ScaleOptions,
};

Table of contents