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?: string

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

closeButton?: boolean

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

color: string
cursor?: string

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

dashed?: boolean

Two-state shorthand for lineStyle: true draws 'dashed'. A retained form rather than a deprecated one (COMPATIBILITY.md lists why); reach for lineStyle when a line needs 'dotted'.

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. Visible scales also carry a price tag.

id: string

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

label?: string

Price-axis tag text. Defaults to the formatted price. Hidden scales omit the tag.

leftLabel?: string

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

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.

lineWidth?: number

Line thickness in media px. Default 1.

price: number
qty?: string | number

Quantity segment rendered as a neutral box after the badge.