Interface
HeatmapOptions
Options of addHeatmap.
Properties
| Name | Type | Description |
|---|---|---|
tickSize | number | |
columnMs | number | Column length, ms (e.g. 1000; may be finer than the candles). |
source | 'depth' | 'trades' | Order book snapshots ( |
rowSize? | number | |
scale? | 'log' | 'linear' | Default |
range? | {
percentile: number;
} | {
lo: number;
hi: number;
} | Default |
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
];
}