org.fujion.highcharts

Class AccessibilityOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.AccessibilityOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class AccessibilityOptions
extends Options

Options for configuring accessibility for the chart. Requires the accessibility module to be loaded.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AccessibilityOptions.FocusBorderOptions
static class	AccessibilityOptions.KeyboardNavigationOptions

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	describeSingleSeries Whether or not to add series descriptions to charts with a single series.
Boolean	enabled Enable accessibility features for the chart.
AccessibilityOptions.KeyboardNavigationOptions	keyboardNavigatioon Options for keyboard navigation.
String	onTableAnchorClick Function to run upon clicking the "View as Data Table" link in the screen reader region.
String	pointDateFormat Date format to use for points on date/time axes when describing them to screen reader users.
String	pointDateFormatter Formatter function to determine the date/time format used with points on datetime axes when describing them to screen reader users.
String	pointDescriptionFormatter Formatter function to use instead of the default for point descriptions.
Integer	pointDescriptionThreshold When a series contains more points than this, we no longer expose information about individual points to screen readers.
String	screenReaderSectionFormatter A formatter function to create the HTML contents of the hidden screen reader information region.
String	seriesDescriptionFormatter Formatter function to use instead of the default for series descriptions.

Constructor Summary

Constructors

Constructor and Description
AccessibilityOptions()

Method Summary

Methods inherited from class org.fujion.ancillary.Options

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

describeSingleSeries

@Option
public Boolean describeSingleSeries

Whether or not to add series descriptions to charts with a single series. Defaults to false.

enabled

@Option
public Boolean enabled

Enable accessibility features for the chart. Defaults to true.

keyboardNavigatioon

@Option
public final AccessibilityOptions.KeyboardNavigationOptions keyboardNavigatioon

Options for keyboard navigation.

onTableAnchorClick

@Option(convertTo=org.fujion.ancillary.JavaScript.class)
public String onTableAnchorClick

Function to run upon clicking the "View as Data Table" link in the screen reader region. By default Highcharts will insert and set focus to a data table representation of the chart. Defaults to undefined.

pointDateFormat

@Option
public String pointDateFormat

Date format to use for points on date/time axes when describing them to screen reader users. Defaults to the same format as in tooltip. Defaults to undefined.

pointDateFormatter

@Option(convertTo=org.fujion.ancillary.JavaScript.class)
public String pointDateFormatter

Formatter function to determine the date/time format used with points on datetime axes when describing them to screen reader users. Receives one argument, point, referring to the point to describe. Should return a date format string compatible with dateFormat. Defaults to undefined.

pointDescriptionFormatter

@Option(convertTo=org.fujion.ancillary.JavaScript.class)
public String pointDescriptionFormatter

Formatter function to use instead of the default for point descriptions. Receives one argument, point, referring to the point to describe. Should return a String with the description of the point for a screen reader user. Defaults to undefined.

pointDescriptionThreshold

@Option
public Integer pointDescriptionThreshold

When a series contains more points than this, we no longer expose information about individual points to screen readers.

screenReaderSectionFormatter

@Option(convertTo=org.fujion.ancillary.JavaScript.class)
public String screenReaderSectionFormatter

A formatter function to create the HTML contents of the hidden screen reader information region. Receives one argument, chart, referring to the chart object. Should return a String with the HTML content of the region. The link to view the chart as a data table will be added automatically after the custom HTML content. Defaults to undefined.

seriesDescriptionFormatter

@Option(convertTo=org.fujion.ancillary.JavaScript.class)
public String seriesDescriptionFormatter

Formatter function to use instead of the default for series descriptions. Receives one argument, series, referring to the series to describe. Should return a String with the description of the series for a screen reader user. Defaults to undefined.

Constructor Detail

AccessibilityOptions

public AccessibilityOptions()