Top

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
value boolean
true
Value to set.

Returns:

anychart.core.utils.ChartA11y - Self instance for method chaining.

Try it:

mode

Getter for the accessibility mode.

Returns:

anychart.enums.A11yMode - The accessibility mode.

Try it:

Setter for the accessibility mode.

Params:

Name Type Default Description
value anychart.enums.A11yMode | string
"chartElements"
Value 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.

Params:

Name Type Description
value function | string Function or token to format content text.

Returns:

anychart.core.utils.ChartA11y - Self instance for method chaining.

Try it: