Class GoToLiveRenderer

Floating "Go to live ▶" pill that appears in the lower-right corner of the chart area when the viewport is not following the live edge. Clicking it scrolls the chart to the newest candle and re-enables auto-follow.

The renderer draws into any CanvasRenderingContext2D and returns the pill's bounding box in logical pixels so the controller can hit-test clicks.

Index

Constructors

Methods

getBounds hide hitTest render

Constructors

constructor

new GoToLiveRenderer(): GoToLiveRenderer
Returns GoToLiveRenderer

Methods

getBounds

getBounds(): GoToLiveBounds | null
Returns the last-rendered pill bounds, or null if the pill is hidden.

Returns GoToLiveBounds | null
- Defined in rendering/GoToLiveRenderer.ts:23

hide

hide(): void
Returns void
- Defined in rendering/GoToLiveRenderer.ts:27

hitTest

hitTest(localX: number, localY: number): boolean
Hit-test a pointer event in logical chart coordinates.
Parameters
- localX: number
- localY: number
Returns boolean
- Defined in rendering/GoToLiveRenderer.ts:83

render

render(
    ctx: CanvasRenderingContext2D,
    layout: ChartLayout,
    theme: ThemeColors,
    label?: string,
): void
Parameters
- ctx: CanvasRenderingContext2D
- layout: ChartLayout
- theme: ThemeColors
- label: string = 'Go to live ▶'
Returns void
- Defined in rendering/GoToLiveRenderer.ts:31