charton API / @chart-on/core / index / ReferenceLines
Class: ReferenceLines
Defined in: packages/core/src/reference-lines.ts:166
Optional price lines of the main series: previous close, the visible high, low and average close, bid and ask, and the newest extended-hours price. Values are cached and recomputed only when the bars, the visible range or the session change, so panning and live bars cost no per-frame allocations.
Constructors
Constructor
new ReferenceLines(
host):ReferenceLines
Defined in: packages/core/src/reference-lines.ts:192
Parameters
host
ReferenceHost
Returns
ReferenceLines
Accessors
options
Get Signature
get options():
Readonly<ReferenceLinesOptions>
Defined in: packages/core/src/reference-lines.ts:197
The resolved options of every line; the same object, updated in place by applyOptions.
Returns
Readonly<ReferenceLinesOptions>
quote
Get Signature
get quote():
Quote|null
Defined in: packages/core/src/reference-lines.ts:225
Returns
Quote | null
sessionPhase
Get Signature
get sessionPhase():
SessionPhase
Defined in: packages/core/src/reference-lines.ts:241
Phase of the newest main bar: always open without a session or on daily bars.
Returns
Methods
applyOptions()
applyOptions(
update):void
Defined in: packages/core/src/reference-lines.ts:202
Merge option changes per line; throws on an unknown line or line style.
Parameters
update
Returns
void
drawLines()
drawLines(
ctx,pane,width):void
Defined in: packages/core/src/reference-lines.ts:269
Lines in pane, in pane-local coordinates (the caller clips and translates).
Parameters
ctx
CanvasRenderingContext2D
pane
width
number
Returns
void
labels()
labels(
pane,push):void
Defined in: packages/core/src/reference-lines.ts:297
Hand each visible axis label of pane to push, with y in chart space.
Parameters
pane
push
(scale, label) => void
Returns
void
mainLast()
mainLast(
last):LastValue
Defined in: packages/core/src/reference-lines.ts:250
The main series' last-value label: the regular-session close while the newest bar is outside the session and the extended-hours line is on, else last.
Parameters
last
Returns
setQuote()
setQuote(
quote):void
Defined in: packages/core/src/reference-lines.ts:216
The latest bid and ask; null clears both. Non-finite prices are ignored.
Parameters
quote
Quote | null
Returns
void
value()
value(
kind):number|null
Defined in: packages/core/src/reference-lines.ts:234
Current price of a line whether or not it is visible; null when it has none.
Parameters
kind
Returns
number | null