HighchartsLangAccessibilityOptions class

Configure the accessibility strings in the chart. Requires the accessibility module to be loaded. For a description of the module and information on its features, see Highcharts Accessibility.

The lang options use Format Strings with variables that are replaced at run time. These variables should be used when available, to avoid duplicating text that is defined elsewhere.

For more dynamic control over the accessibility functionality, see accessibility.point.descriptionFormatter, accessibility.series.descriptionFormatter, and accessibility.screenReaderSection.beforeChartFormatter.

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

Inheritance

Constructors

HighchartsLangAccessibilityOptions.new({HighchartsLangAccessibilityAnnounceNewDataOptions? announceNewData, HighchartsLangAccessibilityAxisOptions? axis, String? chartContainerLabel, HighchartsLangAccessibilityChartTypesOptions? chartTypes, String? credits, String? defaultChartTitle, String? drillUpButton, HighchartsLangAccessibilityExportingOptions? exporting, String? graphicContainerLabel, HighchartsLangAccessibilityLegendOptions? legend, HighchartsLangAccessibilityNavigatorOptions? navigator, HighchartsLangAccessibilityRangeSelectorOptions? rangeSelector, String? resetZoomButton, HighchartsLangAccessibilityScreenReaderSectionOptions? screenReaderSection, HighchartsLangAccessibilitySeriesOptions? series, HighchartsLangAccessibilitySeriesTypeDescriptionsOptions? seriesTypeDescriptions, HighchartsLangAccessibilitySonificationOptions? sonification, String? svgContainerLabel, String? svgContainerTitle, HighchartsLangAccessibilityTableOptions? table, String? thousandsSep, HighchartsLangAccessibilityZoomOptions? zoom})
Configure the accessibility strings in 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 ↔ HighchartsLangAccessibilityAnnounceNewDataOptions?
Default announcement for new data in charts. If addPoint or addSeries is used, and only one series/point is added, the newPointAnnounce and newSeriesAnnounce strings are used. The ...Single versions will be used if there is only one chart on the page, and the ...Multiple versions will be used if there are multiple charts on the page. For all other new data events, the newDataAnnounce string will be used.
getter/setter pair
axis ↔ HighchartsLangAccessibilityAxisOptions?
Axis description format strings.
getter/setter pair
chartContainerLabel ↔ String?
Accessible label for the chart container HTML element. {title} refers to the chart title.
getter/setter pair
chartTypes ↔ HighchartsLangAccessibilityChartTypesOptions?
Chart type description strings. This is added to the chart information region.
getter/setter pair
credits ↔ String?
Accessible label for the chart credits. {creditsStr} refers to the visual text in the credits.
getter/setter pair
defaultChartTitle ↔ String?
Default title of the chart for assistive technology, for charts without a chart title.
getter/setter pair
drillUpButton ↔ String?
Accessible label for the drill-up button. {buttonText} refers to the visual text on the button.
getter/setter pair
exporting ↔ HighchartsLangAccessibilityExportingOptions?
Exporting menu format strings for accessibility module.
getter/setter pair
graphicContainerLabel ↔ String?
Set a label on the container wrapping the SVG.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
legend ↔ HighchartsLangAccessibilityLegendOptions?
Language options for accessibility of the legend.
getter/setter pair
Navigator language options for accessibility.
getter/setter pair
rangeSelector ↔ HighchartsLangAccessibilityRangeSelectorOptions?
Range selector language options for accessibility.
getter/setter pair
resetZoomButton ↔ String?
Highcharts Options Widget.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
screenReaderSection ↔ HighchartsLangAccessibilityScreenReaderSectionOptions?
Language options for the screen reader information sections added before and after the charts.
getter/setter pair
series ↔ HighchartsLangAccessibilitySeriesOptions?
Lang configuration for different series types. For more dynamic control over the series element descriptions, see accessibility.seriesDescriptionFormatter.
getter/setter pair
seriesTypeDescriptions ↔ HighchartsLangAccessibilitySeriesTypeDescriptionsOptions?
Descriptions of lesser known series types. The relevant description is added to the screen reader information region when these series types are used.
getter/setter pair
sonification ↔ HighchartsLangAccessibilitySonificationOptions?
Language options for sonification.
getter/setter pair
svgContainerLabel ↔ String?
Accessible label for the chart SVG element. {chartTitle} refers to the chart title.
getter/setter pair
svgContainerTitle ↔ String?
Title element text for the chart SVG element. Leave this empty to disable adding the title element. Browsers will display this content when hovering over elements in the chart. Assistive technology may use this element to label the chart.
getter/setter pair
table ↔ HighchartsLangAccessibilityTableOptions?
Accessibility language options for the data table.
getter/setter pair
thousandsSep ↔ String?
Thousands separator to use when formatting numbers for screen readers. Note that many screen readers will not handle space as a thousands separator, and will consider "11 700" as two numbers.
getter/setter pair
zoom ↔ HighchartsLangAccessibilityZoomOptions?
Chart and map zoom accessibility language options.
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