class anychart.core.utils.ChartA11y Improve this Doc
Extends: anychart.core.utils.A11y
Anychart chart accessibility class.
Methods Overview
| Specific settings | |
| enabled() | Accessibility state. |
| mode() | Accessibility mode. |
| titleFormat() | Function to format title text. |
Methods Description
enabled
Getter for the accessibility enabled state (enabled or disabled).
Returns:
boolean - The accessibility state.Try it:
Setter for the accessibility enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.core.utils.ChartA11y - Self instance for method chaining.Try it:
mode
Getter for the accessibility mode.
Returns:
anychart.enums.A11yMode | string - The accessibility mode.Try it:
Setter for the accessibility mode.
Detailed description
"ChartElements" mode transforms a chart into aria tags for VoiceOver. "DataTable" mode transforms a chart into the table.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mode | anychart.enums.A11yMode | string | 'chart-elements' | Accessibility mode to set. |
Returns:
anychart.core.utils.ChartA11y - Self instance for method chaining.Try it:
titleFormat
Getter for the function to format title.
Returns:
function | string - Function to format title text. See listing.
var accessibility = chart.a11y(); var titleFormat = accessibility.titleFormat();
Setter for the function to format title.
Learn more about using titleFormat() method.
Learn more about using titleFormat() method.
Params:
| Name | Type | Description |
|---|---|---|
| formatSettings | function | string | Function or token to format content text. |
Returns:
anychart.core.utils.ChartA11y - Self instance for method chaining.Try it: