Skip to main content

VolumeConfig

type VolumeConfig = {
  downColor?: string | number;
  enabled?: boolean;
  height?: number;
  opacity?: number;
  radius?: number;
  upColor?: string | number;
};

Source: types/src/index.ts:942

Volume bar config. One bottom-anchored bar per candle on the price pane, drawn under the candles and sharing their x position and body width.

Unlike the other indicator configs the bars are on by default, so omitting this prop leaves the chart looking as it always has.

Properties​

downColor?​

optional downColor?: string | number;

Source: types/src/index.ts:962

Down-bar color (hex string or packed ARGB number). Defaults to theme.accentBear.

enabled?​

optional enabled?: boolean;

Source: types/src/index.ts:944

Draw the bars. Default true.

height?​

optional height?: number;

Source: types/src/index.ts:956

Height of the tallest bar as a fraction of the price pane, 0..1. Default 0.2.

This is a ceiling rather than a reserved strip: raising it lets the bars reach further up over the candles rather than compressing them, matching the conventional volume overlay. Heights always auto-fit the loudest volume in view, so the tallest bar sits exactly at the ceiling.

opacity?​

optional opacity?: number;

Source: types/src/index.ts:946

Bar opacity 0..1 (1 = opaque). Default 0.5, so bars read quieter than the candles.

radius?​

optional radius?: number;

Source: types/src/index.ts:958

Corner radius (px) of the top of each bar. Defaults to theme.volumeRadius, else 0 (square).

upColor?​

optional upColor?: string | number;

Source: types/src/index.ts:960

Up-bar color (hex string or packed ARGB number). Defaults to theme.accentBull.