Skip to content

Interface: ChartDescription ​

The accessible description of a chart.

Properties ​

PropertyModifierTypeDescription
axesreadonlyreadonly string[]One sentence per axis.
labelreadonlystringThe accessible name: config.ariaLabel, layout.meta.description, or title + summary.
overviewreadonlystringThe generated summary of trends and extremes (E17.2), e.g. "k$ by Month. Revenue rises from 12 (Jan 1, 2024) to 19 (Jun 1, 2024). It peaks at 21 (May 1, 2024)."; empty while its code loads, with config.a11y.summaries: false, or when no trace reports an insight.
summaryreadonlystringChart type(s) and trace count, e.g. "Line and bar chart with 3 traces."
tablesreadonlyreadonly DescribedTable[]-
tracesreadonlyreadonly string[]One summary per trace (visible or legend-only).

Released under the MIT License.