Documentation menu

Interface

FootprintOptions

Options of addFootprint (docs: order flow rules).

Properties

NameTypeDescription
tickSizenumber

Minimum price increment.

timeframeMsnumber

Candle period, ms: columns start at its multiples (UTC).

rowSize?number

Ticks per row. Default 1.

mode?'bidAsk' | 'delta' | 'volume'

Default 'bidAsk'.

imbalanceRatio?number | null

Diagonal imbalance ratio (≥ 1). Default 3; null turns imbalances off.

showPoc?boolean

Outline each column's point of control. Default true.

colors?{ buy?: string; sell?: string; volume?: string; text?: string; poc?: string; }

Default: the theme's candle and text colors.

Declaration

export interface FootprintOptions {
    tickSize: number;
    timeframeMs: number;
    rowSize?: number;
    mode?: 'bidAsk' | 'delta' | 'volume';
    imbalanceRatio?: number | null;
    showPoc?: boolean;
    colors?: {
        buy?: string;
        sell?: string;
        volume?: string;
        text?: string;
        poc?: string;
    };
}

Used by

FerroChart