Class HighlightOverlay

Manages the DOM shapes drawn on top of a Chart.js canvas to provide MAIDR-style highlight feedback for keyboard navigation.

Index

Constructors

Methods

show clear dispose

Constructors

constructor

new HighlightOverlay(
    host: HTMLElement,
    canvas: HTMLCanvasElement,
    highlightColor?: string,
): HighlightOverlay
Parameters
- host: HTMLElement
  Positioned wrapper element that contains the canvas.
- canvas: HTMLCanvasElement
  The Chart.js canvas the overlay aligns to.
- OptionalhighlightColor: string
  Optional outline color override.
Returns HighlightOverlay
- Defined in adapters/chartjs/overlay.ts:80

Methods

show

show(shapes: readonly OverlayShape[]): void
Draw one node per provided geometry. Existing nodes are cleared first.
Parameters
- shapes: readonly OverlayShape[]
Returns void
- Defined in adapters/chartjs/overlay.ts:101

clear

clear(): void
Remove all highlight nodes (e.g., on chart resize before recompute).

Returns void
- Defined in adapters/chartjs/overlay.ts:115

dispose

dispose(): void
Detach overlay from the DOM.

Returns void
- Defined in adapters/chartjs/overlay.ts:124

src