Interface PriceLineOptions

interface PriceLineOptions {
    badge?: string;
    closeButton?: boolean;
    color: string;
    cursor?: string;
    dashed?: boolean;
    extentFromRight?: number;
    id: string;
    label?: string;
    leftLabel?: string;
    lineStyle?: CanvasLineStyle;
    lineWidth?: number;
    price: number;
    qty?: string | number;
}

Properties

badge? closeButton? color cursor? dashed? extentFromRight? id label? leftLabel? lineStyle? lineWidth? price qty?

Properties

Optionalbadge

badge?: string

Solid colored badge segment at the start of the pill group (e.g. 'BUY', 'TP', 'SL').

OptionalcloseButton

closeButton?: boolean

Draw a cancel (✕) segment at the end of the pill group; hit-tests as ${id}::close.

color

color: string

Optionalcursor

cursor?: string

Cursor hint when hovered (e.g. 'ns-resize' for draggable lines).

Optionaldashed

dashed?: boolean

Legacy two-state dash switch, equivalent to lineStyle: 'dashed'.

OptionalextentFromRight

extentFromRight?: number

Fraction of the plot width the line spans, measured from the right (price) axis. 1 = full width (default); 0.3 = only the rightmost 30%, like a partial-width order line. The right-axis tag is always drawn.

id

id: string

Stable id returned by hit-test (for click/drag routing).

Optionallabel

label?: string

Right-axis tag text. Defaults to the formatted price.

OptionalleftLabel

leftLabel?: string

Info text segment (order type, price, P&L ...) — the classic left tag text.

OptionallineStyle

lineStyle?: CanvasLineStyle

Dash style, the three-way form of dashed. Set, it wins over the boolean; unset, the boolean still decides, so a line built before this existed draws exactly as it did.

OptionallineWidth

lineWidth?: number

Line thickness in media px. Default 1.

price

price: number

Optionalqty

qty?: string | number

Quantity segment rendered as a neutral box after the badge.

Settings

Member Visibility

On This Page

Properties