Interface BuySellButtonsOptions

interface BuySellButtonsOptions {
    buyColor?: string;
    buyLabel?: string;
    id?: string;
    margin?: number | { x: number; y: number };
    position?: WatermarkPosition;
    qty?: string | number;
    scale?: number;
    sellColor?: string;
    sellLabel?: string;
    showPrices?: boolean;
}

Properties

buyColor? buyLabel? id? margin? position? qty? scale? sellColor? sellLabel? showPrices?

Properties

OptionalbuyColor

buyColor?: string

Buy button color (defaults to the theme buy).

OptionalbuyLabel

buyLabel?: string

Button labels. Default BUY / SELL.

Optionalid

id?: string

Stable id prefix; hit-tests emit ${id}:sell / ${id}:buy / ${id}:qty. Default trade.

Optionalmargin

margin?: number | { x: number; y: number }

Gap from the plot edges in media px. A number applies to both axes; pass { x, y } to offset independently (e.g. clear an OHLC legend at the top).

Optionalposition

position?: WatermarkPosition

Corner to dock to. Default top-left.

Optionalqty

qty?: string | number

Quantity shown in the centre chip (e.g. lots or absolute qty).

Optionalscale

scale?: number

Uniform size multiplier for the whole panel — box, gaps and type. Default 1. A dense trading layout wants these smaller so they do not crowd the pane's legend rows. Clamped to 0.6..1.5; below that the labels stop being legible.

OptionalsellColor

sellColor?: string

Sell button color (defaults to the theme sell).

OptionalsellLabel

sellLabel?: string

OptionalshowPrices

showPrices?: boolean

Show the price line above each label. Default true.

Settings

Member Visibility

On This Page

Properties