charton API / @chart-on/core / index / Pane
Interface: Pane
Defined in: packages/core/src/pane.ts:17
One horizontal pane of the chart: its series, its price scales and its place in the layout. Create one with chart.addPane.
Properties
collapsed
collapsed:
boolean=false
Defined in: packages/core/src/pane.ts:30
Shrunk to a thin header showing only its legend.
height
height:
number=0
Defined in: packages/core/src/pane.ts:28
id
readonlyid:number
Defined in: packages/core/src/pane.ts:34
price
readonlyprice:PriceScale
Defined in: packages/core/src/pane.ts:19
The main scale (id 'right'); its axis is on the right, or the left in a right-to-left chart.
series
readonlyseries:Series<object>[] =[]
Defined in: packages/core/src/pane.ts:24
stretch
stretch:
number
Defined in: packages/core/src/pane.ts:25
top
top:
number=0
Defined in: packages/core/src/pane.ts:27
Layout in css px, relative to the chart plot area.
Accessors
hidden
Get Signature
get hidden():
boolean
Defined in: packages/core/src/pane.ts:42
Hidden with chart.setPaneHidden: no height, no separator; its series and drawings stay.
Returns
boolean
primary
Get Signature
get primary():
PriceScale
Defined in: packages/core/src/pane.ts:74
The scale drawings, the crosshair event and pointer events read prices on: the right scale while it shows, else the first scale with an axis.
Returns
scales
Get Signature
get scales():
PriceScale[]
Defined in: packages/core/src/pane.ts:110
Every named scale, price first, then in creation order.
Returns
Methods
claimScale()
claimScale(
id):void
Defined in: packages/core/src/pane.ts:90
Internal
Mark scale id as made for a series, unless the pane has it already (the right and left scales, or one the app set up): pruneScales then drops it once no series uses it.
Parameters
id
string
Returns
void
isClaimed()
isClaimed(
id):boolean
Defined in: packages/core/src/pane.ts:95
Internal
Whether scale id was made for a series (see claimScale).
Parameters
id
string
Returns
boolean
pruneScales()
pruneScales():
void
Defined in: packages/core/src/pane.ts:100
Internal
Drop the claimed scales no series on the pane uses any more.
Returns
void
removeScale()
removeScale(
id):void
Defined in: packages/core/src/pane.ts:80
Forget the scale id (not the right one), e.g. when its last series goes.
Parameters
id
string
Returns
void
scale()
scale(
id):PriceScale
Defined in: packages/core/src/pane.ts:55
The scale id, created on first use: 'right' is price, 'left' gets a left axis, and any other id starts as an overlay with no axis.
Parameters
id
string
Returns
setHidden()
setHidden(
hidden):void
Defined in: packages/core/src/pane.ts:47
Internal
Set by chart.setPaneHidden, which lays the panes out again.
Parameters
hidden
boolean
Returns
void