SeriesAccessibility

Extends accessibility settings specifically for chart series elements.

Props

The following table outlines the props for the SeriesAccessibility:

NameTypeDefaultDescription
ariaLabel
string
null

Provides a descriptive label for the chart to assist screen readers. This value is automatically mapped to the aria-label attribute in the DOM.

descriptionFormat
string
null

Defines a format string for the accessibility description of the chart series. This format is used by screen readers to describe the series contextually.

focusable
boolean
true

Determines whether chart elements can receive keyboard focus. Set to false to exclude chart elements from the tab order, which may be useful for purely decorative charts.

role
string
null

Specifies the ARIA role of the chart element. Helps assistive technologies understand the semantic purpose of the chart (e.g., "img", "figure", "application"). If not set, the default role will be inferred based on the element type.

tabIndex
number
0

Controls the tab order for keyboard navigation. A value of 0 places the chart element in the natural tab sequence.