Interface FootprintOptions

interface FootprintOptions {
    absorptionColor: string;
    absorptionMultiple: number;
    auctionHighColor?: string;
    auctionLowColor?: string;
    bigOrderColor: string;
    bigOrderMultiple: number;
    buyColor?: string;
    buyTextColor?: string;
    candleDownColor?: string;
    candleUpColor?: string;
    cellStyle: FootprintCellStyle;
    cellWidth?: number;
    compactNumbers: boolean;
    cvdOffset: number;
    cvdReset: "session" | "none";
    displayMode: FootprintDisplayMode;
    divergenceColor: string;
    flipBars: number;
    flipMinDeltaPct: number;
    font: number;
    formingLastBar: boolean;
    imbalanceBuyColor?: string;
    imbalanceRatio: number;
    imbalanceSellColor?: string;
    imbalanceThreshold: number;
    intensityScope: "bar" | "visible";
    lastPriceColor?: string;
    markDivergence: boolean;
    minTextHeight: number;
    multipleNodeBars: number;
    nearExtremeRows: number;
    nodeColor: string;
    pocColor: string;
    pocStyle: "marker" | "outline";
    profileAskColor?: string;
    profileBidColor?: string;
    profileWidth: number;
    radius: number;
    sellColor?: string;
    sellTextColor?: string;
    sessionColor?: string;
    sessionWindow?: SessionWindow;
    showCandle: boolean;
    showDeltaLabels: boolean;
    showEmptyRows: boolean;
    showPoc: boolean;
    showUnfinishedAuctions: boolean;
    showValueArea: boolean;
    showVisibleProfile: boolean;
    showZones: boolean;
    signalLookback: number;
    stackedImbalances: number;
    statsPosition: "bar" | "bottom";
    statsRowHeight: number;
    statsRows: readonly FootprintStatRow[];
    tableBackground?: string;
    tableLabelWidth: number;
    tableRows: readonly FootprintStatRow[];
    textColor?: string;
    textColorMode: FootprintTextColorMode;
    textFade: number;
    tickSize?: number;
    timezone?: string;
    tpoMinutes: number;
    valueAreaColor?: string;
    valueAreaPercent: number;
    volumeColor?: string;
    volumeDivisor: number;
    widthFactor: number;
    zoneActiveAfter: number;
    zoneEnd: FootprintZoneEnd;
    zoneKinds: readonly FootprintZoneGroup[];
    zoneLookback: number;
}

Properties

absorptionColor absorptionMultiple auctionHighColor? auctionLowColor? bigOrderColor bigOrderMultiple buyColor? buyTextColor? candleDownColor? candleUpColor? cellStyle cellWidth? compactNumbers cvdOffset cvdReset displayMode divergenceColor flipBars flipMinDeltaPct font formingLastBar imbalanceBuyColor? imbalanceRatio imbalanceSellColor? imbalanceThreshold intensityScope lastPriceColor? markDivergence minTextHeight multipleNodeBars nearExtremeRows nodeColor pocColor pocStyle profileAskColor? profileBidColor? profileWidth radius sellColor? sellTextColor? sessionColor? sessionWindow? showCandle showDeltaLabels showEmptyRows showPoc showUnfinishedAuctions showValueArea showVisibleProfile showZones signalLookback stackedImbalances statsPosition statsRowHeight statsRows tableBackground? tableLabelWidth tableRows textColor? textColorMode textFade tickSize? timezone? tpoMinutes valueAreaColor? valueAreaPercent volumeColor? volumeDivisor widthFactor zoneActiveAfter zoneEnd zoneKinds zoneLookback

Properties

absorptionColor

absorptionColor: string

absorptionMultiple

absorptionMultiple: number

Band rows where bid and ask both reach this many average cells. 0 (default) disables.

OptionalauctionHighColor

auctionHighColor?: string

OptionalauctionLowColor

auctionLowColor?: string

bigOrderColor

bigOrderColor: string

bigOrderMultiple

bigOrderMultiple: number

Outline a big limit order of at least this many average cells. 0 (default) disables.

OptionalbuyColor

buyColor?: string

OptionalbuyTextColor

buyTextColor?: string

OptionalcandleDownColor

candleDownColor?: string

OptionalcandleUpColor

candleUpColor?: string

The candle beside each column, and the body rows the imbalance mode shades.

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.

compactNumbers

compactNumbers: boolean

Abbreviate quantities to three significant figures (12.3K). False prints whole numbers. Default true.

cvdOffset

cvdOffset: number

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

cvdReset

cvdReset: "session" | "none"

'session' restarts cumulative delta and cumulative volume at each session open.

displayMode

displayMode: FootprintDisplayMode

divergenceColor

divergenceColor: string

flipBars

flipBars: number

Mark an aggressive delta flip after this many opposite bars. 0 (default) disables.

flipMinDeltaPct

flipMinDeltaPct: number

font

font: number

formingLastBar

formingLastBar: boolean

The newest bar is still forming, so it cannot close a zone or set an unfinished auction. Default true.

OptionalimbalanceBuyColor

imbalanceBuyColor?: string

Imbalanced cells, stacked imbalance brackets and stacked zones.

imbalanceRatio

imbalanceRatio: number

OptionalimbalanceSellColor

imbalanceSellColor?: string

imbalanceThreshold

imbalanceThreshold: number

intensityScope

intensityScope: "bar" | "visible"

Shade against each bar's busiest row, or against the busiest row on screen so clusters stand out.

OptionallastPriceColor

lastPriceColor?: string

Fill the newest bar's last-price row with this colour. Omitted draws nothing.

markDivergence

markDivergence: boolean

Box the delta label when it disagrees with the bar's direction. Default false.

minTextHeight

minTextHeight: number

multipleNodeBars

multipleNodeBars: number

Highlight the POC when this many consecutive bars share it. 0 (default) disables.

nearExtremeRows

nearExtremeRows: number

Rows from the high or low a big order or absorption must be within. Default 3.

nodeColor

nodeColor: string

pocColor

pocColor: string

pocStyle

pocStyle: "marker" | "outline"

OptionalprofileAskColor

profileAskColor?: string

Ask and bid bars of the visible-range profile.

OptionalprofileBidColor

profileBidColor?: string

profileWidth

profileWidth: number

radius

radius: number

OptionalsellColor

sellColor?: string

OptionalsellTextColor

sellTextColor?: string

OptionalsessionColor

sessionColor?: string

Session letters in the table and the statistics cards.

OptionalsessionWindow

sessionWindow?: SessionWindow

Session that letters and resets count from; omitted means local midnight.

showCandle

showCandle: boolean

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

showDeltaLabels

showDeltaLabels: boolean

Bar delta printed under each column. Default false.

showEmptyRows

showEmptyRows: boolean

Draw a 0 x 0 row at every row step a bar's trades skipped, so each column spans its whole range. Display only: imbalances, the POC, value area and signals still read the traded rows. Default true.

showPoc

showPoc: boolean

showUnfinishedAuctions

showUnfinishedAuctions: boolean

Dash-dot line at a high or low that traded on both bid and ask. Default false.

showValueArea

showValueArea: boolean

showVisibleProfile

showVisibleProfile: boolean

Volume at price of the visible bars against the left edge. Default false.

showZones

showZones: boolean

Extend stacked imbalances, multiple nodes and absorption to the right as zones. Default false.

signalLookback

signalLookback: number

Bars the average cell is taken over. Default 10.

stackedImbalances

stackedImbalances: number

Adjacent same-side imbalance run length. 0 disables brackets and stacked zones.

statsPosition

statsPosition: "bar" | "bottom"

Fixed pane footer or labeled cards beneath each bar.

statsRowHeight

statsRowHeight: number

statsRows

statsRows: readonly FootprintStatRow[]

OptionaltableBackground

tableBackground?: string

Background of the statistics table.

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.

Optionaltimezone

timezone?: string

IANA zone for the session calendar; defaults to Asia/Kolkata.

tpoMinutes

tpoMinutes: number

Length of one session-letter period in minutes. Default 30.

OptionalvalueAreaColor

valueAreaColor?: string

valueAreaPercent

valueAreaPercent: number

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

OptionalvolumeColor

volumeColor?: string

Cells in the volume display mode, which otherwise take the colour of the side that traded more.

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.

zoneActiveAfter

zoneActiveAfter: number

zoneEnd

zoneEnd: FootprintZoneEnd

zoneKinds

zoneKinds: readonly FootprintZoneGroup[]

Which of them showZones extends and alerts on (since 2.6.4). Default all three.

zoneLookback

zoneLookback: number

Zones start only in the newest this many bars (since 2.6.4). 0, the default, takes every bar.

Settings

Member Visibility

On This Page

Properties
absorptionColorabsorptionMultipleauctionHighColorauctionLowColorbigOrderColorbigOrderMultiplebuyColorbuyTextColorcandleDownColorcandleUpColorcellStylecellWidthcompactNumberscvdOffsetcvdResetdisplayModedivergenceColorflipBarsflipMinDeltaPctfontformingLastBarimbalanceBuyColorimbalanceRatioimbalanceSellColorimbalanceThresholdintensityScopelastPriceColormarkDivergenceminTextHeightmultipleNodeBarsnearExtremeRowsnodeColorpocColorpocStyleprofileAskColorprofileBidColorprofileWidthradiussellColorsellTextColorsessionColorsessionWindowshowCandleshowDeltaLabelsshowEmptyRowsshowPocshowUnfinishedAuctionsshowValueAreashowVisibleProfileshowZonessignalLookbackstackedImbalancesstatsPositionstatsRowHeightstatsRowstableBackgroundtableLabelWidthtableRowstextColortextColorModetextFadetickSizetimezonetpoMinutesvalueAreaColorvalueAreaPercentvolumeColorvolumeDivisorwidthFactorzoneActiveAfterzoneEndzoneKindszoneLookback