charton API

---

charton API / @chart-on/core / index / PriceLineSeriesOptions

Interface: PriceLineSeriesOptions

Defined in: packages/core/src/series.ts:265

Options shared by the candle, line, histogram and custom series: price line, off-screen label and autoscale.

Extended by

• CandleSeriesOptions
• HistogramSeriesOptions
• LineSeriesOptions
• CustomSeriesBaseOptions
• PointSeriesOptions

Properties

autoscale?

optional autoscale?: boolean | AutoscaleProvider

Defined in: packages/core/src/series.ts:272

How the series takes part in its price scale's autoscale. true (the default) fits its visible values, false leaves it out (it still draws, possibly off the pane), and a function adjusts the range it adds. Primitives attached to the series still add their own ranges.

---

offscreenLastPrice?

optional offscreenLastPrice?: "hidden" | "hollow"

Defined in: packages/core/src/series.ts:283

The last-value label when the newest bar is panned off screen: 'hollow' draws it as an outline, 'hidden' leaves it out. Unset keeps it as is.

---

priceLine?

optional priceLine?: boolean | SeriesPriceLineOptions

Defined in: packages/core/src/series.ts:278

Price line across the plot: true for the default style, an object to style it, false for none. Separate from lastValueLabel. Default: on for the main candle series, off for the others.