Vela, our next-generation charting platform, is live at vela.luxalgo.com.
LuxAlgo
Chart types

Footprint

Configure the Footprint chart type, connect a footprint data feed, and customize display modes, imbalances, visible-range profiles, and zoom behavior.

View as Markdown

The Footprint chart type renders traded volume at each price level inside every bar, split between buyer-initiated (ask) and seller-initiated (bid) volume. enableVelaPro() registers the chart type by default, and footprint cells render whenever the chart's data provider implements FootprintFeed.

import { VelaWorkspace } from '@luxalgo/vela/workspace';
import type { DataProvider } from '@luxalgo/vela/plugin';
import { enableVelaPro, type FootprintFeed } from '@luxalgo/vela-pro';

// Custom provider implementing both the core DataProvider interface and FootprintFeed.
declare const MyProvider: new () => DataProvider & FootprintFeed;

enableVelaPro();

const workspace = new VelaWorkspace('#chart', {
    layout: false,
    symbol: 'BTCUSDT',
    timeframe: '15',
    priceStyle: 'footprint',
    live: true,
    providers: { mydata: () => new MyProvider() },
});

Setting priceStyle: 'footprint' initializes the chart directly in Footprint mode; without it, the chart starts on 'candles' and users can switch from the Chart style menu. Call enableFootprint() before constructing the workspace if you want to register Footprint without enabling the rest of Vela Pro, or pass enableVelaPro({ footprint: false }) to disable it.

The same visualization is also available as two overlay indicators for charts using candlesticks or another price style: Footprint (per-bar footprint) and Visible Range Footprint (edge profile strip). See Built-in indicators for indicator usage.

Data requirements

Standard OHLCV candles alone do not contain per-price volume breakdowns. Footprint reads 1-minute footprint slices containing buy and sell volume per price level, which the chart aggregates dynamically into the bars of any selected timeframe. Providers supply these slices by implementing getFootprints, subscribeFootprints, and footprintCaps alongside the DataProvider interface from Vela's open-source core. See Footprint data for the full feed contract.

The Chart style menu enables Footprint on any symbol whose metadata includes OHLC and volume fields, regardless of provider. Selecting Footprint on a provider that does not implement FootprintFeed leaves standard candles on screen with no footprint cells or loading state, and logs a console warning naming the provider and symbol. If none of your providers serve footprint slices, pass footprint: false to enableVelaPro() to omit Footprint from the menu.

The sample providers bundled with the core (BinanceProvider, CoinbaseProvider, HyperliquidProvider) serve OHLCV candles only and do not implement FootprintFeed.

Display modes

Each footprint renders price rows in one of five visual modes, while the Cell values (displayValue) setting controls the numbers printed inside each row (Auto, Bid × Ask, Total, Delta, Trades, or Bid × Ask Trades).

ModeIDRow visualization
Bid × Ask ProfilebidAskProfileHorizontal sell bar extending left of a center axis and buy bar extending right
Bid × Ask LadderbidAskLadderTwo side-by-side columns (sell on the left, buy on the right) shaded by volume
Volume ProfilevolumeLeft-aligned total volume bar, either split into buy/sell segments or solid
Delta ProfiledeltaNet delta (buy minus sell) bar extending left when negative and right when positive
Absolute DeltadeltaAbsLeft-aligned bar sized by absolute delta magnitude and colored by delta sign

Multiple footprints and visible range

Each bar can display up to five per-bar footprints simultaneously. Footprint 1 is always active, and users can enable Footprint 2 through Footprint 5 from the instance strip at the top of the Footprint settings tab. Each additional instance initializes with a distinct placement and mode:

InstanceDefault positionDefault mode
Footprint 1Right of the candleBid × Ask Profile
Footprint 2LeftBid × Ask Ladder
Footprint 3Within the candleVolume Profile
Footprint 4RightDelta Profile
Footprint 5LeftAbsolute Delta

Multiple footprints assigned to the same side share the horizontal gap between adjacent candles. At most one instance can sit within the candle body; setting a second instance to within moves it to the right of the candle.

In addition to per-bar footprints, the visible-range profile aggregates every bar currently in view into a single summary footprint strip docked along the right or left edge of the pane. It is enabled by default, configured under the Visible range section of the Footprint settings tab, and recalculates live as the user pans or zooms.

Settings reference

When Footprint is the active chart type, the Chart settings dialog displays a Footprint tab next to Symbol. Every footprint instance exposes the following primary settings groups:

GroupSettingConfig keyDefault
DisplayModemodeBid × Ask Profile ('bidAskProfile')
DisplayCell valuesdisplayValueAuto ('auto')
DisplayAverage trade sizeavgTradeSizeOff (false)
DisplayPositionpositionRight ('right')
DisplayRow size, Ticks per rowrowMode, rowTicksAuto ('auto'), 4
DisplayHide candleshideCandlesOff (false)
DisplayShrink numbers to fittextFitOff (false)
DisplayGradient cellsgradientOn (true)
VA & POCValue area, Value area (%)valueArea, valueAreaPercentOn (true), 70
VA & POCPoint of controlpocOn (true)
VA & POCExtend POC until brokenpocExtendOff (false)
ImbalancesImbalance highlight, Ratio (%)imbalance, imbalanceRatioOff (false), 300
ImbalancesStacked imbalances, Min stacked rowsimbalanceStacked, imbalanceStackCountOff (false), 3
Unfinished auctionsUnfinished auctionsunfinishedOff (false)
Unfinished auctionsExtend until revisitedunfinishedExtendOn (true)
Stat tableStat table, Positionstats, statsPositionOff (false), Below ('below')
FiltersVolumeminVolume, maxVolumeOff
FiltersBid volumeminBidVolume, maxBidVolumeOff
FiltersAsk volumeminAskVolume, maxAskVolumeOff

Key analytical settings behave as follows:

  • Average trade size (avgTradeSize): Recomputes each row as volume divided by trade count so cell values, the point of control, and imbalance comparisons reflect average print size. Requires a footprint feed that supplies trade counts.
  • Imbalance highlight (imbalance, imbalanceRatio): Outlines any cell whose volume is at least imbalanceRatio% of the opposite side on the diagonal (ask compared against the bid one row lower; bid compared against the ask one row higher, so 300 requires 3× volume). Stacked imbalances (imbalanceStacked, imbalanceStackCount) fill a horizontal zone wherever three or more consecutive rows are imbalanced on the same side, extending rightward until price trades back into the zone.
  • Unfinished auctions (unfinished, unfinishedExtend): Marks a bar's extreme high or low when both buyers and sellers printed at that price, optionally extending a horizontal ray until a subsequent bar revisits the level.
  • Stat table (stats, statsPosition): Renders a per-bar summary strip displaying Total volume, Delta, and Delta % by default, with optional rows for Buy volume, Sell volume, volume percentages, and trade counts.

Hide candles (hideCandles) applies across the entire chart and therefore appears only under Footprint 1. Additional style rows configure colors, font sizes, and line widths.

Programmatic configuration

Footprint settings live under chartTypes.footprint in the chart renderer configuration. Pass a partial object to renderer.applyConfig() to update specific keys without resetting others:

import type { VelaWorkspace } from '@luxalgo/vela/workspace';

declare const workspace: VelaWorkspace;

const renderer = workspace.chart.renderer;

renderer.applyConfig({
    chartTypes: {
        footprint: {
            mode: 'delta',
            imbalance: true,
            imbalanceRatio: 400,
            fp2Enabled: true, // enable Footprint 2
            fp2Mode: 'volume',
            vrEnabled: false, // hide the visible-range profile
        },
    },
});

const config = renderer.getConfig() as { chartTypes?: Record<string, Record<string, unknown>> } | null;
const mode = config?.chartTypes?.footprint?.mode ?? 'bidAskProfile';

renderer.openSettings('Footprint'); // open Chart settings directly on the Footprint tab

Unprefixed keys configure Footprint 1. Prefix a capitalized key name with fp2 through fp5 for additional per-bar instances, or vr for the visible-range profile (for example, fp3Position or vrMode). Toggle fp2Enabled through fp5Enabled to add or remove per-bar footprints, and vrEnabled to show or hide the visible-range strip. Any omitted key uses its default value.

Enum settings accept string IDs rather than display labels:

KeyAccepted values
mode'bidAskProfile', 'bidAskLadder', 'volume', 'delta', 'deltaAbs'
displayValue'auto', 'bidAsk', 'volume' (Total), 'delta', 'trades', 'bidAskTrades'
position'right', 'left', 'within'
rowMode'auto', 'manual'
statsPosition'below', 'above'

Renderer configuration is included in serialized chart state, so Footprint settings persist automatically in workspace state documents. See Layouts and chart state.

Context menu and hover inspection

Right-clicking directly on footprint cells opens a Footprint-specific context menu, while right-clicking elsewhere on the pane opens the standard chart menu:

Menu itemAction
Stat tableToggles the per-bar stat table for Footprint 1
Average trade sizeToggles Footprint 1 between total volume and average trade size
Visible range profileShows or hides the visible-range edge strip
Shrink numbers to fitScales Footprint 1 cell numbers down to fit narrower cells
Hide CandlesHides base candlesticks underneath the footprints
Footprint SettingsOpens the Chart settings dialog on the Footprint tab

Hovering a footprint row opens a tooltip listing the row's price range, bid × ask, total volume, and delta. Holding Shift while hovering opens a magnified overlay of that bar and its immediate neighbors, sized wide enough to display every numeric label.

Zoom behavior

Because footprint ladders require horizontal space per bar, the renderer crossfades smoothly between candlesticks and footprints as bar spacing changes:

  • Below 5 px per bar: Only standard candlesticks render.
  • 5 px to 10 px per bar: Footprint cells fade in while candlestick bodies narrow to make room beside them (or fade out when a footprint is positioned within the candle).
  • 10 px per bar and wider: Footprints render at full opacity and background gridlines hide.

When Hide candles (hideCandles) is enabled, footprints remain visible at every zoom level because there are no base candles to crossfade into. The visible-range profile strip also stays visible regardless of zoom level.

When Row size is set to Auto, adjacent price ticks merge automatically as vertical space compresses so rows remain tall enough for text. Once cell numbers can no longer fit at a legible font size, all numbers in the footprint hide simultaneously while keeping the color-shaded cells visible.

Bars whose footprint slices are still in flight display pulsing skeleton rows. During Bar replay, Footprint never renders data past the newest revealed bar.

On this page