AnyChart
API Reference
Still have questions?
Contact support
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.
Setter for the accessibility enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

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

mode

Getter for the accessibility mode.

Returns:

anychart.enums.A11yMode | string - The accessibility mode.
Setter for the accessibility mode.

Params:

NameTypeDefaultDescription
modeanychart.enums.A11yMode | string
'chart-elements'
Accessibility mode to set.

Returns:

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

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:

NameTypeDescription
formatSettingsfunction | stringFunction or token to format content text.

Returns:

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