Interface: IPaneApi
Charting Library.IPaneApi
You can retrieve this interface by using the IChartWidgetApi.getPanes method
Methods
collapse
collapse(): void
Collapse the current pane
getHeight
getHeight(): number
Returns the pane's height
Returns
number
getLeftPriceScales
getLeftPriceScales(): readonly IPriceScaleApi[]
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
Returns
readonly IPriceScaleApi[]
getMainSourcePriceScale
getMainSourcePriceScale(): IPriceScaleApi
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)
Returns
getPriceScaleById
getPriceScaleById(priceScaleId): IPriceScaleApi
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)
Parameters
| Name | Type |
|---|---|
priceScaleId | string |
Returns
getRightPriceScales
getRightPriceScales(): readonly IPriceScaleApi[]
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
Returns
readonly IPriceScaleApi[]
hasMainSeries
hasMainSeries(): boolean
Returns true if the price scale contains the main series
Returns
boolean
isCollapsed
isCollapsed(): boolean
Returns the pane's collapsed state
Returns
boolean
isMaximized
isMaximized(): boolean
Returns the maximized state of the pane
Returns
boolean
moveTo
moveTo(paneIndex): void
Moves the pane to a new position, paneIndex should be a number between 0 and all panes count - 1
Parameters
| Name | Type |
|---|---|
paneIndex | number |
paneIndex
paneIndex(): number
Returns the pane's index, it's a number between 0 and all panes count - 1
Returns
number
restore
restore(): void
Restore the size of a previously collapsed pane
setHeight
setHeight(height): void
Sets the pane's height
Parameters
| Name | Type |
|---|---|
height | number |
setMaximized
setMaximized(value): void
Change the maximized state of the pane
Parameters
| Name | Type |
|---|---|
value | boolean |