interface FootprintOptions {
    buyColor?: string;
    cellWidth?: number;
    displayMode: FootprintDisplayMode;
    font: number;
    imbalanceRatio: number;
    imbalanceThreshold: number;
    minTextHeight: number;
    pocColor: string;
    radius: number;
    sellColor?: string;
    showCandle: boolean;
    showPoc: boolean;
    stackedImbalances: number;
    statsRowHeight: number;
    statsRows: readonly FootprintStatRow[];
    textFade: number;
    tickSize?: number;
    widthFactor: number;
}

Properties

buyColor?: string

Colours. All default to the chart theme.

cellWidth?: number

Full column width (both halves) in media px. Omit to derive it from the chart's bar spacing, so cells stop colliding when you zoom out.

bidask two columns; delta or volume a single column.

font: number

Cell text size in media px. Default 10.

imbalanceRatio: number

Diagonal-imbalance ratio.

imbalanceThreshold: number

Ignore cells below this volume when flagging imbalances.

minTextHeight: number

Below this row height, numbers are dropped and cells render as a heatmap.

pocColor: string
radius: number

Cell corner radius in media px.

sellColor?: string
showCandle: boolean

Draw the bar's range line + body behind the cells.

showPoc: boolean

Mark the highest-volume row of each bar.

stackedImbalances: number

Bracket runs of ≥ N consecutive same-side imbalances. 0 disables.

statsRowHeight: number

Row height of the stats table in media px.

statsRows: readonly FootprintStatRow[]

Stats rows under the columns, in order. Empty hides the table.

textFade: number

Height (px) over which the cell numbers fade in around minTextHeight.

tickSize?: number

Price step → row height. Inferred from the cell spacing when omitted.

widthFactor: number

Fraction of the bar slot a column may occupy when auto-sizing. Default 0.9.