Class Accessibility
- All Implemented Interfaces:
Serializable
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.
- Version:
- $Id: $Id
- Author:
- Vaadin
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor for Accessibility.Accessibility(Boolean enabled) Constructor for Accessibility. -
Method Summary
Modifier and TypeMethodDescriptionGetter for the fielddescribeSingleSeries.Getter for the fieldenabled.Getter for the fieldkeyboardNavigation.getOnTableAnchorClick.Getter for the fieldpointDateFormat.getPointDateFormatter.getPointDescriptionFormatter.getScreenReaderSectionFormatter.getSeriesDescriptionFormatter.voidsetDescribeSingleSeries(Boolean describeSingleSeries) Whether or not to add series descriptions to charts with a single series.voidsetEnabled(Boolean enabled) Enable accessibility features for the chart.voidsetKeyboardNavigation(KeyboardNavigation keyboardNavigation) Options for keyboard navigation.voidsetOnTableAnchorClick(String _fn_onTableAnchorClick) setOnTableAnchorClick.voidsetPointDateFormat(String pointDateFormat) Date format to use for points on datetime axes when describing them to screen reader users.voidsetPointDateFormatter(String _fn_pointDateFormatter) setPointDateFormatter.voidsetPointDescriptionFormatter(String _fn_pointDescriptionFormatter) setPointDescriptionFormatter.voidsetScreenReaderSectionFormatter(String _fn_screenReaderSectionFormatter) setScreenReaderSectionFormatter.voidsetSeriesDescriptionFormatter(String _fn_seriesDescriptionFormatter) setSeriesDescriptionFormatter.
-
Constructor Details
-
Accessibility
public Accessibility()Constructor for Accessibility.
-
Accessibility
Constructor for Accessibility.
- Parameters:
enabled- aBooleanobject.
-
-
Method Details
-
getDescribeSingleSeries
Getter for the field
describeSingleSeries.- Returns:
- a
Booleanobject. - See Also:
-
setDescribeSingleSeries
Whether or not to add series descriptions to charts with a single series.Defaults to: false
- Parameters:
describeSingleSeries- aBooleanobject.
-
getEnabled
Getter for the field
enabled.- Returns:
- a
Booleanobject. - See Also:
-
setEnabled
Enable accessibility features for the chart.Defaults to: true
- Parameters:
enabled- aBooleanobject.
-
getOnTableAnchorClick
getOnTableAnchorClick.
- Returns:
- a
Stringobject.
-
setOnTableAnchorClick
setOnTableAnchorClick.
- Parameters:
_fn_onTableAnchorClick- aStringobject.
-
getPointDateFormat
Getter for the field
pointDateFormat.- Returns:
- a
Stringobject. - See Also:
-
setPointDateFormat
Date format to use for points on datetime axes when describing them to screen reader users.
Defaults to the same format as in tooltip.
For an overview of the replacement codes, see dateFormat.
- Parameters:
pointDateFormat- aStringobject.
-
getPointDateFormatter
getPointDateFormatter.
- Returns:
- a
Stringobject.
-
setPointDateFormatter
setPointDateFormatter.
- Parameters:
_fn_pointDateFormatter- aStringobject.
-
getPointDescriptionFormatter
getPointDescriptionFormatter.
- Returns:
- a
Stringobject.
-
setPointDescriptionFormatter
setPointDescriptionFormatter.
- Parameters:
_fn_pointDescriptionFormatter- aStringobject.
-
getScreenReaderSectionFormatter
getScreenReaderSectionFormatter.
- Returns:
- a
Stringobject.
-
setScreenReaderSectionFormatter
setScreenReaderSectionFormatter.
- Parameters:
_fn_screenReaderSectionFormatter- aStringobject.
-
getSeriesDescriptionFormatter
getSeriesDescriptionFormatter.
- Returns:
- a
Stringobject.
-
setSeriesDescriptionFormatter
setSeriesDescriptionFormatter.
- Parameters:
_fn_seriesDescriptionFormatter- aStringobject.
-