Documentation menu

Interface

HeatmapOptions

Options of addHeatmap.

Properties

NameTypeDescription
tickSizenumber
columnMsnumber

Column length, ms (e.g. 1000; may be finer than the candles).

source'depth' | 'trades'

Order book snapshots (appendDepth) or trades (appendTrades).

rowSize?number
scale?'log' | 'linear'

Default 'log'.

range?{ percentile: number; } | { lo: number; hi: number; }

Default { percentile: 0.99 } of the visible cells.

autoScale?boolean

Whether the heatmap takes part in auto scaling. Default false.

colors?[ string, string, string, string, string ]

Five CSS colors from the smallest to the largest value.

Declaration

export interface HeatmapOptions {
    tickSize: number;
    columnMs: number;
    source: 'depth' | 'trades';
    rowSize?: number;
    scale?: 'log' | 'linear';
    range?: {
        percentile: number;
    } | {
        lo: number;
        hi: number;
    };
    autoScale?: boolean;
    colors?: [
        string,
        string,
        string,
        string,
        string
    ];
}

Used by

FerroChart