Accessibility Config

Configure the chart accessibility features and screen-reader labels.

Every property is optional and falls back to its default. Property anchors are stable: link to any entry as #accessibility.propertyName, and to a member of a nested property as #accessibility.propertyName.memberName.

Properties

chartLabel

The screen-reader name for the chart when the title has no text.

The accessible name of the chart svg when title.text is unset; a set title always wins. Replace to localize the announced name.

• Default: "Chart"
• Validation: should be a string

chartRoleDescription

The role description screen readers announce for the chart.

Announced by screen readers in place of the generic "group" role, e.g. "Monthly sales, chart". Replace to localize it, as required for aria-roledescription values.

• Default: "chart"
• Validation: should be a string

enabled

Whether the chart exposes keyboard navigation and screen-reader semantics.

When true, the chart is keyboard- and screen-reader-accessible: the plot area is a tab stop that opens and steps the tooltip (with the values spoken through a hidden live region), legend items and interactive pie slices are roving tab stops, and the svg carries roles, labels and aria-hidden markers for assistive tech. Set to false to render the chart without any of these attributes or key handlers — for example when the host page provides its own accessible alternative. respectReducedMotion is not gated by this switch.

• Default: true
• Validation: should be a boolean

hidden

Whether the chart is hidden from assistive tech and keyboard navigation, for purely decorative charts.

Set to true for a purely decorative chart — for example a sparkline that repeats a value already shown as text. The chart’s container is marked aria-hidden so screen readers skip it entirely, and every keyboard tab stop (plot area, legend items, pie slices, tooltip rows and controls) is removed, so keyboard users cannot land on content assistive tech cannot see. Overrides enabled; respectReducedMotion is not gated by this switch.

• Default: false
• Validation: should be a boolean

legendLabel

The screen-reader label for the legend.

The accessible name of the legend group that contains the keyboard-reachable legend items. Replace to localize it.

• Default: "Legend"
• Validation: should be a string

plotLabel

The screen-reader label for the keyboard-focusable plot area.

The accessible name of the plot-area tab stop that keyboard users activate to open and step the tooltip. Replace to localize it.

• Default: "Chart values"
• Validation: should be a string

respectReducedMotion

Whether to respect the user’s reduced-motion system preference.

When true and the user’s system requests reduced motion (the prefers-reduced-motion: reduce accessibility setting, for users sensitive to movement), the chart behaves as if animation.animate were false: config, data, and focus changes apply instantly. The preference is watched live, so changing the system setting takes effect without re-creating the chart. Set to false to animate regardless of the preference. Independent of enabled.

• Default: true
• Validation: should be a boolean

tooltipNextLabel

The label for the tooltip controls’ next-category button (aria-label and hover title).

The accessible name and hover title of the › button shown when tooltip.showControls is on; the button itself shows only the glyph. Replace to localize it.

• Default: "Next category"
• Validation: should be a string

tooltipPreviousLabel

The label for the tooltip controls’ previous-category button (aria-label and hover title).

The accessible name and hover title of the ‹ button shown when tooltip.showControls is on; the button itself shows only the glyph. Replace to localize it.

• Default: "Previous category"
• Validation: should be a string