@finchart

Appearance

Documentation / @finchart/core / index / PriceLineOptions

Interface: PriceLineOptions ​

Defined in: packages/core/src/extensions/standard.ts:24

The standard decoration set — all small functions built on the existing contract. priceLine and markers use the value axis, so they're pane decorations; watermark and span belong to the chart itself, so they're plot decorations.

Properties ​

badge? ​

optional badge?: boolean

Defined in: packages/core/src/extensions/standard.ts:33

Turns off the badge. Defaults to on — a price line's whole reason to exist is the axis value.

format? ​

optional format?: (value) => string

Defined in: packages/core/src/extensions/standard.ts:31

Value format for the badge. Defaults to that pane's y wording (formatY).

Parameters ​

value ​

number

Returns ​

string

label? ​

optional label?: string

Defined in: packages/core/src/extensions/standard.ts:29

Label for the y-axis badge — a wholesale override. If omitted, format (or the axis's own wording if that's absent too) formats the value.

style? ​

optional style?: Partial<LineStyle>

Defined in: packages/core/src/extensions/standard.ts:27

Line style. Defaults to a faint dotted line.

value ​

value: number

Defined in: packages/core/src/extensions/standard.ts:25