charturbo - v0.1.0
    Preparing search index...

    Interface CalendarHeatmapOptions

    interface CalendarHeatmapOptions {
        cellGap?: number;
        cellSize?: number;
        center?: number;
        color?: ColorInput;
        colorbar?: boolean | HeatmapColorbarOptions;
        colorScale?: HeatmapColorScale;
        dayLabels?: boolean | CalendarLabelOptions;
        description?: string;
        emptyColor?: ColorInput;
        firstDay?: number;
        format?: ChartValueFormat;
        max?: number;
        min?: number;
        monthLabels?: boolean | CalendarLabelOptions;
        orient?: "vertical" | "horizontal";
        padding?: ChartPaddingOptions;
        range?: CalendarRange;
        ranges?: CalendarRange[];
        reverse?: boolean;
        splitLine?: boolean | CalendarSplitLineOptions;
        timeZone?: CharturboTimeZone;
        title?: string;
        valueLabel?: string;
        yearLabel?: boolean;
    }
    Index
    cellGap? cellSize? center? color? colorbar? colorScale? dayLabels? description? emptyColor? firstDay? format? max? min? monthLabels? orient? padding? range? ranges? reverse? splitLine? timeZone? title? valueLabel? yearLabel?
    cellGap?: number

    Gap between cells in CSS px (default 2)

    cellSize?: number

    Largest cell side in CSS px (default: fit the plot, at most 64)

    center?: number
    color?: ColorInput
    colorbar?: boolean | HeatmapColorbarOptions
    colorScale?: HeatmapColorScale

    Colormap as in renderHeatmap (default 'sequential')

    dayLabels?: boolean | CalendarLabelOptions

    Weekday labels beside the grid (default: true)

    description?: string

    Accessible name of the canvas

    emptyColor?: ColorInput

    Color of days without data (default: the theme grid tone)

    firstDay?: number

    First day of the week: 0 = Sunday (default) to 6 = Saturday

    format?: ChartValueFormat

    Value text of tooltip and a11y (spec, Intl options or function; default: locale number)

    max?: number
    min?: number

    Value domain (default: data extent)

    monthLabels?: boolean | CalendarLabelOptions

    Month labels above / beside the grid (default: true)

    orient?: "vertical" | "horizontal"

    'horizontal' (default: weeks run left to right) or 'vertical' (weeks run down)

    padding?: ChartPaddingOptions
    range?: CalendarRange

    One calendar (default: one per year of the data)

    ranges?: CalendarRange[]

    Several calendars, stacked (horizontal) or side by side (vertical); wins over range

    reverse?: boolean
    splitLine?: boolean | CalendarSplitLineOptions

    Month boundary lines (default: true)

    timeZone?: CharturboTimeZone

    Zone that turns epoch ms / Date into days (default: the SDK zone, setTimeZone)

    title?: string
    valueLabel?: string

    Tooltip / table / colorbar name of the values (default: 'Value' in the chart locale)

    yearLabel?: boolean

    Year label of each calendar (default: true)

    Settings
    Member Visibility

    On This Page
    Properties