PaneManager
PaneManager API
- PaneManager.addBounds
- Parameters
- uuid: string
- order: number
- Returns
- Unsubscriber
PaneManager.addBounds(uuid: string, order: number): Unsubscriber
- PaneManager.addResizer
- Parameters
- uuid: string
- - The uuid of the pane to which the resizer is to be added.
- Returns
- BarResizerComponent
PaneManager.addResizer(uuid: string): BarResizerComponent
Adds a resizer to the canvas bounds container for the given uuid.
- PaneManager.getPaneIfHit
- Parameters
- point: Point
- - The point to check.
- Returns
- PaneComponent
PaneManager.getPaneIfHit(point: Point): PaneComponent
Returns the pane component that contains the given point.
- PaneManager.createPane
- Parameters
- uuid: string
- options: AtLeastOne<YExtentCreationOptions, keyof YExtentCreationOptions>
- Returns
- PaneComponent
PaneManager.createPane(uuid: string, options: AtLeastOne<YExtentCreationOptions, keyof YExtentCreationOptions>): PaneComponent
Creates sub-plot on the chart with y-axis
- PaneManager.movePaneUp
- Parameters
- uuid: string
- Returns
- void
PaneManager.movePaneUp(uuid: string): void
Moves the canvas bounds container up by calling the movePaneUp method with the uuid of the current object.
- PaneManager.movePaneDown
- Parameters
- uuid: string
- Returns
- void
PaneManager.movePaneDown(uuid: string): void
Moves the canvas bounds container down by calling the movePaneDown method with the uuid of the current object.
- PaneManager.canMovePaneUp
- Parameters
- uuid: string
- Returns
- boolean
PaneManager.canMovePaneUp(uuid: string): boolean
Checks if the current pane can move up.
- PaneManager.canMovePaneDown
- Parameters
- uuid: string
- Returns
- boolean
PaneManager.canMovePaneDown(uuid: string): boolean
Checks if the current pane can move down.
- PaneManager.removePane
- Parameters
- uuid: string
- Returns
- void
PaneManager.removePane(uuid: string): void
Removes pane from the chart and all related components
- PaneManager.hidePane
- Parameters
- paneUUID: string
- Returns
- void
PaneManager.hidePane(paneUUID: string): void
Hides a pane from the chart and all related components
- PaneManager.showPane
- Parameters
- paneUUID: string
- Returns
- void
PaneManager.showPane(paneUUID: string): void
Shows a pane, use if the pane is hidden
- PaneManager.moveDataSeriesToPane
- Parameters
- dataSeries: DataSeriesModel<DataSeriesPoint, VisualSeriesPoint, DataSeriesConfig>[]
- initialPane: PaneComponent
- initialExtent: YExtentComponent
- options: MoveDataSeriesToPaneOptions
- Returns
- void
PaneManager.moveDataSeriesToPane(dataSeries: DataSeriesModel<DataSeriesPoint, VisualSeriesPoint, DataSeriesConfig>[], initialPane: PaneComponent, initialExtent: YExtentComponent, options: MoveDataSeriesToPaneOptions): void
Move data series to a certain pane, or create a new one if no pane is found
- PaneManager.addCursors
- Parameters
- uuid: string
- - The unique identifier for the chart element.
- cursor: string
- - The type of cursor to be added to the chart element.
- Returns
- () => void
PaneManager.addCursors(uuid: string, cursor: string): () => void
Adds cursors to the chart elements based on the provided uuid and cursor type.
- PaneManager.recalculateState
- Returns
- void
PaneManager.recalculateState(): void
Recalculates the zoom Y of all pane components and fires a draw event on the event bus.