Class HighlightOverlay

Manages DOM rectangles drawn over an amCharts 5 chart to provide MAIDR-style highlight feedback during keyboard navigation.

Index

Constructors

Methods

show clear dispose

Constructors

constructor

new HighlightOverlay(
    host: HTMLElement,
    rootDom: HTMLElement,
    getColor: () => string,
): HighlightOverlay
Parameters
- host: HTMLElement
  Positioned wrapper element that contains root.dom.
- rootDom: HTMLElement
  The amCharts root DOM element the overlay aligns to.
- getColor: () => string
  Returns the current highlight color (read at draw time).
Returns HighlightOverlay
- Defined in adapters/amcharts/overlay.ts:50

Methods

show

show(rects: readonly OverlayRect[]): void
Draw one rect per provided geometry. Existing rects are cleared first.
Parameters
- rects: readonly OverlayRect[]
Returns void
- Defined in adapters/amcharts/overlay.ts:73

clear

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

Returns void
- Defined in adapters/amcharts/overlay.ts:99

dispose

dispose(): void
Detach the overlay from the DOM.

Returns void
- Defined in adapters/amcharts/overlay.ts:108

src