Skip to main content
Version: Next

Interface: ICustomSeriesPaneRenderer

Renderer for the custom series. This paints on the main chart pane.

Methods

draw()

draw(target, priceConverter, isHovered, hitTestData?): void

Draw function for the renderer.

Parameters

target: CanvasRenderingTarget2D

canvas context to draw on, refer to FancyCanvas library for more details about this class.

priceConverter: PriceToCoordinateConverter

converter function for changing prices into vertical coordinate values.

isHovered: boolean

Whether the series is hovered.

hitTestData?: unknown

Optional hit test data for the series.

Returns

void


hitTest()?

optional hitTest(x, y, priceConverter): CustomSeriesHitTestResult

Optional hit test function for the renderer.

Parameters

x: Coordinate

horizontal coordinate for the hit test.

y: Coordinate

vertical coordinate for the hit test.

priceConverter: PriceToCoordinateConverter

converter function for changing prices into vertical coordinate values.

Returns

CustomSeriesHitTestResult

hit test result or null if no item was hit.