PaneComponent

September 12, 2023 ยท View on GitHub

MethodParametersReturnsDescription
doActivatevoidMethod that activates the canvas bounds container and recalculates the zoom Y of the scale model.
toYprice: numbernumber
createGridComponentuuid: string - The unique identifier of the pane.scale: ScaleModel yAxisLabelsGenerator: NumericYAxisLabelsGenerator - The generator used to create the labels for the y-axis.yAxisState: YAxisConfigGridComponentCreates a new GridComponent instance with the provided parameters.
createYPanHandleruuid: string - The unique identifier of the chart pane.scale: ScaleModel[Unsubscriber, DragNDropYComponent]Creates a handler for Y-axis panning of the chart.
addCursorsextentIdx: number yAxisComponent: YAxisComponentUnsubscriber
createExtentComponentoptions: AtLeastOne<YExtentCreationOptions>YExtentComponent
removeExtentComponentextentComponent: YExtentComponentvoid
updateViewvoidThis method updates the view by calling the doAutoScale method of the scaleModel and firing the Draw event using the eventBus.
mergeYExtentsvoidMerges all the y-axis extents on the pane into one.
getBoundsBoundsReturns the bounds of the pane component.
hidevoidHides the pane by removing its bounds from the canvasBoundsContainer and firing a draw event.
showvoidAdds the bounds of the pane to the canvas bounds container and fires a draw event.
createDataSeriesDataSeriesModel<DataSeriesPoint, VisualSeriesPoint>Creates a new DataSeriesModel object.
addDataSeriesseries: DataSeriesModel<DataSeriesPoint, VisualSeriesPoint> - The data series to be added.voidAdds a new data series to the chart.
removeDataSeriesseries: DataSeriesModel<DataSeriesPoint, VisualSeriesPoint> - The data series to be removed.voidRemoves a data series from the chart.
getAxisTypePriceAxisTypeReturns the type of the y-axis component for the current pane.
moveUpvoidMoves the canvas bounds container up by calling the movePaneUp method with the uuid of the current object.
moveDownvoidMoves the canvas bounds container down by calling the movePaneDown method with the uuid of the current object.
canMoveUpbooleanChecks if the current pane can move up.
canMoveDownbooleanChecks if the current pane can move down.
setPaneValueFormattersformatters: YExtentFormatters - The pane value formatters to be set.voidSets the pane value formatters for the current instance.
regularValueFromYy: number - The Y coordinate.numberReturns the regular value from Y coordinate.