Interface FootprintOptions

interface FootprintOptions {
    buyColor?: string;
    buyTextColor?: string;
    cellStyle: FootprintCellStyle;
    cellWidth?: number;
    cvdOffset: number;
    displayMode: FootprintDisplayMode;
    font: number;
    imbalanceRatio: number;
    imbalanceThreshold: number;
    minTextHeight: number;
    pocColor: string;
    pocStyle: "marker" | "outline";
    radius: number;
    sellColor?: string;
    sellTextColor?: string;
    showCandle: boolean;
    showPoc: boolean;
    showValueArea: boolean;
    stackedImbalances: number;
    statsPosition: "bar" | "bottom";
    statsRowHeight: number;
    statsRows: readonly FootprintStatRow[];
    tableLabelWidth: number;
    tableRows: readonly FootprintStatRow[];
    textColor?: string;
    textColorMode: FootprintTextColorMode;
    textFade: number;
    tickSize?: number;
    valueAreaColor?: string;
    valueAreaPercent: number;
    volumeDivisor: number;
    widthFactor: number;
}

Properties

buyColor? buyTextColor? cellStyle cellWidth? cvdOffset displayMode font imbalanceRatio imbalanceThreshold minTextHeight pocColor pocStyle radius sellColor? sellTextColor? showCandle showPoc showValueArea stackedImbalances statsPosition statsRowHeight statsRows tableLabelWidth tableRows textColor? textColorMode textFade tickSize? valueAreaColor? valueAreaPercent volumeDivisor widthFactor

Properties

OptionalbuyColor

buyColor?: string

OptionalbuyTextColor

buyTextColor?: string

cellStyle

cellStyle: FootprintCellStyle

Intensity cells, volume-proportional bars, or square high-contrast cells.

OptionalcellWidth

cellWidth?: number

Preferred full column width in media px, capped to the available bar slot.

cvdOffset

cvdOffset: number

Cumulative delta preceding the supplied bars, for a rolling window.

displayMode

displayMode: FootprintDisplayMode

font

font: number

imbalanceRatio

imbalanceRatio: number

imbalanceThreshold

imbalanceThreshold: number

minTextHeight

minTextHeight: number

pocColor

pocColor: string

pocStyle

pocStyle: "marker" | "outline"

radius

radius: number

OptionalsellColor

sellColor?: string

OptionalsellTextColor

sellTextColor?: string

showCandle

showCandle: boolean

Draw real OHLC if supplied; legacy bars show a neutral range line.

showPoc

showPoc: boolean

showValueArea

showValueArea: boolean

stackedImbalances

stackedImbalances: number

Adjacent same-side imbalance run length. 0 disables brackets.

statsPosition

statsPosition: "bar" | "bottom"

Fixed pane footer or labeled cards beneath each bar.

statsRowHeight

statsRowHeight: number

statsRows

statsRows: readonly FootprintStatRow[]

tableLabelWidth

tableLabelWidth: number

Fixed table label column width in media px. Default 150.

tableRows

tableRows: readonly FootprintStatRow[]

Ordered rows for a separate table below the footprints. Empty disables it (default).

OptionaltextColor

textColor?: string

textColorMode

textColorMode: FootprintTextColorMode

Text comparisons are independent of the cell background.

textFade

textFade: number

OptionaltickSize

tickSize?: number

Effective price step (tickSize * rowTicks). Overrides bar.rowSize.

OptionalvalueAreaColor

valueAreaColor?: string

valueAreaPercent

valueAreaPercent: number

Fraction of volume in the contiguous value area around the POC.

volumeDivisor

volumeDivisor: number

Display quantities divided by this positive value; 1 shows raw units. Stats remain raw.

widthFactor

widthFactor: number

Fraction of the bar slot occupied by the column and candle. Default 0.9.

Settings

Member Visibility

On This Page

Properties