Interface PriceLineHandle

Live handle returned by OHLCVChart.createPriceLine.

interface PriceLineHandle {
    id: string;
    getPrice(): number;
    remove(): void;
    setOptions(options: Partial<Omit<PriceLineOptions, "price">>): void;
    setPrice(price: number): void;
}

Index

Properties

Methods

getPrice remove setOptions setPrice

Properties

`Readonly`id

id: string

Methods

getPrice

getPrice(): number
Read the current price.

Returns number
- Defined in primitives/PriceLinePrimitive.ts:32

remove

remove(): void
Remove the line from the chart.

Returns void
- Defined in primitives/PriceLinePrimitive.ts:36

setOptions

setOptions(options: Partial<Omit<PriceLineOptions, "price">>): void
Update color/title/lineStyle/draggable.
Parameters
- options: Partial<Omit<PriceLineOptions, "price">>
Returns void
- Defined in primitives/PriceLinePrimitive.ts:34

setPrice

setPrice(price: number): void
Move the line to a new price.
Parameters
- price: number
Returns void
- Defined in primitives/PriceLinePrimitive.ts:30