HighchartsAccessibilityOptions class

Options for configuring accessibility for the chart. Requires the accessibility module to be loaded. For a description of the module and information on its features, see Highcharts Accessibility.

API Docs: https://api.highcharts.com/highcharts/accessibility

Inheritance

Constructors

HighchartsAccessibilityOptions.new({HighchartsAccessibilityAnnounceNewDataOptions? announceNewData, dynamic customComponents, String? description, bool? enabled, String? highContrastMode, dynamic highContrastTheme, HighchartsAccessibilityKeyboardNavigationOptions? keyboardNavigation, String? landmarkVerbosity, String? linkedDescription, HighchartsAccessibilityPointOptions? point, HighchartsAccessibilityScreenReaderSectionOptions? screenReaderSection, HighchartsAccessibilitySeriesOptions? series, String? typeDescription})
Options for configuring accessibility for the chart. Requires the accessibility module to be loaded. For a description of the module and information on its features, see Highcharts Accessibility.

Properties

announceNewData ↔ HighchartsAccessibilityAnnounceNewDataOptions?
Options for announcing new data to screen reader users. Useful for dynamic data applications and drilldown.
getter/setter pair
customComponents ↔ dynamic
A hook for adding custom components to the accessibility module. Should be an object mapping component names to instances of classes inheriting from the Highcharts.AccessibilityComponent base class. Remember to add the component to the keyboardNavigation.order for the keyboard navigation to be usable.
getter/setter pair
description ↔ String?
A text description of the chart.
getter/setter pair
enabled ↔ bool?
Enable accessibility functionality for the chart. For more information on how to include these features, and why this is recommended, see Highcharts Accessibility.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
highContrastMode ↔ String?
Controls how highContrastTheme is applied.
getter/setter pair
highContrastTheme ↔ dynamic
Theme to apply to the chart when Windows High Contrast Mode is detected. By default, a high contrast theme matching the high contrast system colors is used.
getter/setter pair
keyboardNavigation ↔ HighchartsAccessibilityKeyboardNavigationOptions?
Options for keyboard navigation.
getter/setter pair
landmarkVerbosity ↔ String?
Amount of landmarks/regions to create for screen reader users. More landmarks can make navigation with screen readers easier, but can be distracting if there are lots of charts on the page. Three modes are available:
getter/setter pair
linkedDescription ↔ String?
Link the chart to an HTML element describing the contents of the chart.
getter/setter pair
point ↔ HighchartsAccessibilityPointOptions?
Options for descriptions of individual data points.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
screenReaderSection ↔ HighchartsAccessibilityScreenReaderSectionOptions?
Accessibility options for the screen reader information sections added before and after the chart.
getter/setter pair
series ↔ HighchartsAccessibilitySeriesOptions?
Accessibility options global to all data series. Individual series can also have specific accessibility options set.
getter/setter pair
typeDescription ↔ String?
A text description of the chart type.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJSON() → String
Serializes the settings to a JSON string.
inherited
toOptionsJSON(StringBuffer buffer) → void
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited