Class HighlightOverlay

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

Index

Constructors

Methods

show setPlotArea 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:63

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:89

setPlotArea

setPlotArea(plotArea: AmBounds | null, exclude?: readonly AmBounds[]): void
Records where the focused panel's plot area is, and what is drawn over it, for readers of the canvas's pixels; see @util/overlayRegions.
Parameters
- plotArea: AmBounds | null
  The plot area, root-relative CSS pixels
- exclude: readonly AmBounds[] = []
  What amCharts has drawn over the data, such as a legend
Returns void
- Defined in adapters/amcharts/overlay.ts:119

clear

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

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

dispose

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

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

src