Top
You are looking at an outdated 7.13.0 version of this document. Switch to the 7.13.1 version to see the up to date information.

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.
titleFormatter()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:

titleFormatter

Getter for the function to format title.

Returns:

function string - Function to format title text.
See listing.
var accessibility = chart.a11y();
var currentTitleFormatter = accessibility.titleFormatter();
Setter for the function to format title.

Params:

Name Type Description
value function | string Function to format content text. Function that looks like function(){ ChartContextProvider Chart context provider // this.getStat() - statistics from data // this.getTokenType() - token type // this.getTokenValue() - token value return titleFormatterValue; // type Function }.

Returns:

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

Try it: