charton API / @chart-on/core / index / AccessibilityOptions
Interface: AccessibilityOptions
Defined in: packages/core/src/a11y.ts:2
What the chart exposes to assistive technology (screen readers).
Properties
announceBars
announceBars:
boolean
Defined in: packages/core/src/a11y.ts:18
Announce each new bar of the main series (its time and the close and change of the bar before it) in a polite live region. Default false.
announceIntervalMs
announceIntervalMs:
number
Defined in: packages/core/src/a11y.ts:23
Shortest time between two announcements, new bars and chart.announce alike, ms. Bars that arrive faster are skipped for the newest. Default 5000.
crosshairReadout
crosshairReadout:
boolean
Defined in: packages/core/src/a11y.ts:9
Read the values under the crosshair as it moves (a polite live region). Default false.
label?
optionallabel?:string
Defined in: packages/core/src/a11y.ts:11
The chart's accessible name. Default: '<symbol> chart', or 'Chart' without a symbol.
summary
summary:
boolean
Defined in: packages/core/src/a11y.ts:7
Describe the chart to screen readers: symbol, interval, visible range, last price and change, read when the chart gets focus. Default true.
throttleMs
throttleMs:
number
Defined in: packages/core/src/a11y.ts:13
Shortest time between updates of the summary and the readout, ms. Default 1000.