IPaneApi
You can retrieve this interface by using the IChartWidgetApi.getPanes method
Methods
collapse
Collapse the current pane
Signature
collapse() => void
Returns
void
getHeight
Returns the pane's height
Signature
getHeight() => number
Returns
number
getLeftPriceScales
Returns an array of the PriceScaleApi instances that allows interaction with right price scales. The array may be empty if there is not any price scale on the left side of the pane
Signature
getLeftPriceScales() => readonly IPriceScaleApi[]
Returns
readonly IPriceScaleApi[]
getMainSourcePriceScale
Returns an instance of the PriceScaleApi that allows you to interact with the price scale of the main source
or null if the main source is not attached to any price scale (it is in 'No Scale' mode)
Signature
getMainSourcePriceScale() => IPriceScaleApi
Returns
getPriceScaleById
Returns an instance of the PriceScaleApi that allows you to interact with the price scale of the main source
or null if the main source is not attached to any price scale (it is in 'No Scale' mode)
Signature
getPriceScaleById(priceScaleId: string) => IPriceScaleApi
Parameters
| Name | Type |
|---|---|
| priceScaleId | string |
Returns
getRightPriceScales
Returns an array of the PriceScaleApi instances that allows interaction with right price scales. The array may be empty if there is not any price scale on the right side of the pane
Signature
getRightPriceScales() => readonly IPriceScaleApi[]
Returns
readonly IPriceScaleApi[]
hasMainSeries
Returns true if the price scale contains the main series
Signature
hasMainSeries() => boolean
Returns
boolean
moveTo
Moves the pane to a new position, paneIndex should be a number between 0 and all panes count - 1
Signature
moveTo(paneIndex: number) => void
Parameters
| Name | Type |
|---|---|
| paneIndex | number |
Returns
void
paneIndex
Returns the pane's index, it's a number between 0 and all panes count - 1
Signature
paneIndex() => number
Returns
number
restore
Restore the size of a previously collapsed pane
Signature
restore() => void
Returns
void
setHeight
Sets the pane's height
Signature
setHeight(height: number) => void
Parameters
| Name | Type |
|---|---|
| height | number |
Returns
void