com.highsoft.highcharts.common.hichartsclasses

Class HIScreenReaderSection

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIScreenReaderSection

public class HIScreenReaderSection
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIScreenReaderSection()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAfterChartFormat()
HIFunction	getAfterChartFormatter()
java.lang.String	getAfterRegionLabel()
HIAnnotations	getAnnotations()
java.lang.String	getAxisRangeDateFormat()
java.lang.String	getBeforeChartFormat()
HIFunction	getBeforeChartFormatter()
java.lang.String	getBeforeRegionLabel()
java.lang.String	getEndOfChartMarker()
HIFunction	getOnPlayAsSoundClick()
HIFunction	getOnViewDataTableClick()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
void	setAfterChartFormat(java.lang.String afterChartFormat) Format for the screen reader information region after the chart.
void	setAfterChartFormatter(HIFunction afterChartFormatter) A formatter function to create the HTML contents of the hidden screen reader information region after the chart.
void	setAfterRegionLabel(java.lang.String afterRegionLabel)
void	setAnnotations(HIAnnotations annotations) Language options for annotation descriptions.
void	setAxisRangeDateFormat(java.lang.String axisRangeDateFormat) Date format to use to describe range of datetime axes.
void	setBeforeChartFormat(java.lang.String beforeChartFormat) Format for the screen reader information region before the chart.
void	setBeforeChartFormatter(HIFunction beforeChartFormatter) A formatter function to create the HTML contents of the hidden screen reader information region before the chart.
void	setBeforeRegionLabel(java.lang.String beforeRegionLabel)
void	setEndOfChartMarker(java.lang.String endOfChartMarker) Label for the end of the chart.
void	setOnPlayAsSoundClick(HIFunction onPlayAsSoundClick) Function to run upon clicking the "Play as sound" button in the screen reader region.
void	setOnViewDataTableClick(HIFunction onViewDataTableClick) Function to run upon clicking the "View as Data Table" link in the screen reader region.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

HIScreenReaderSection

public HIScreenReaderSection()

Method Detail

getAfterChartFormat

public java.lang.String getAfterChartFormat()

getAfterChartFormatter

public HIFunction getAfterChartFormatter()

getAfterRegionLabel

public java.lang.String getAfterRegionLabel()

getAnnotations

public HIAnnotations getAnnotations()

getAxisRangeDateFormat

public java.lang.String getAxisRangeDateFormat()

getBeforeChartFormat

public java.lang.String getBeforeChartFormat()

getBeforeChartFormatter

public HIFunction getBeforeChartFormatter()

getBeforeRegionLabel

public java.lang.String getBeforeRegionLabel()

getEndOfChartMarker

public java.lang.String getEndOfChartMarker()

getOnPlayAsSoundClick

public HIFunction getOnPlayAsSoundClick()

getOnViewDataTableClick

public HIFunction getOnViewDataTableClick()

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Specified by:

getParams in class HIFoundation

setAfterChartFormat

public void setAfterChartFormat(java.lang.String afterChartFormat)

Format for the screen reader information region after the chart. Analogous to `beforeChartFormat`.

defaults:

 {endOfChartMarker}

setAfterChartFormatter

public void setAfterChartFormatter(HIFunction afterChartFormatter)

A formatter function to create the HTML contents of the hidden screen reader information region after the chart. Analogous to `beforeChartFormatter`.

setAfterRegionLabel

public void setAfterRegionLabel(java.lang.String afterRegionLabel)

setAnnotations

public void setAnnotations(HIAnnotations annotations)

Language options for annotation descriptions.

setAxisRangeDateFormat

public void setAxisRangeDateFormat(java.lang.String axisRangeDateFormat)

Date format to use to describe range of datetime axes. For an overview of the replacement codes, see `dateFormat`.

defaults:

 %Y-%m-%d %H:%M:%S

setBeforeChartFormat

public void setBeforeChartFormat(java.lang.String beforeChartFormat)

Format for the screen reader information region before the chart. Supported HTML tags are ``, `

`, `

`, ``, `

`, `
`, `
1. `, and `

setBeforeChartFormatter

public void setBeforeChartFormatter(HIFunction beforeChartFormatter)

A formatter function to create the HTML contents of the hidden screen reader information region before the chart. Receives one argument, `chart`, referring to the chart object. Should return a string with the HTML content of the region. By defaults this returns an automatic description of the chart based on `beforeChartFormat`.

setBeforeRegionLabel

public void setBeforeRegionLabel(java.lang.String beforeRegionLabel)

setEndOfChartMarker

public void setEndOfChartMarker(java.lang.String endOfChartMarker)

Label for the end of the chart. Announced by screen readers.

defaults:

 End of interactive chart.

setOnPlayAsSoundClick

public void setOnPlayAsSoundClick(HIFunction onPlayAsSoundClick)

Function to run upon clicking the "Play as sound" button in the screen reader region. By defaults Highcharts will call the `chart.sonify` function.

setOnViewDataTableClick

public void setOnViewDataTableClick(HIFunction onViewDataTableClick)

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