public class HIAccessibility extends HIFoundation
Constructor and Description |
---|
HIAccessibility() |
Modifier and Type | Method and Description |
---|---|
HIAnnounceNewData |
getAnnounceNewData() |
HIAxis |
getAxis() |
java.lang.String |
getChartContainerLabel() |
HIChartTypes |
getChartTypes() |
java.lang.String |
getCredits() |
java.lang.Object |
getCustomComponents() |
java.lang.String |
getDefaultChartTitle() |
java.lang.String |
getDefinition() |
java.lang.String |
getDescriptionFormat() |
java.lang.String |
getDrillUpButton() |
java.lang.Boolean |
getEnabled() |
HIExporting |
getExporting() |
java.lang.Boolean |
getExposeAsGroupOnly() |
java.lang.String |
getGraphicContainerLabel() |
java.lang.String |
getHighContrastMode() |
java.lang.Object |
getHighContrastTheme() |
HIKeyboardNavigation |
getKeyboardNavigation() |
java.lang.String |
getLandmarkVerbosity() |
HILegend |
getLegend() |
java.lang.String |
getLinkedDescription() |
HINavigator |
getNavigator() |
java.util.HashMap<java.lang.String,java.lang.Object> |
getParams() |
HIPoint |
getPoint() |
java.lang.String |
getRangeDescription() |
HIRangeSelector |
getRangeSelector() |
HIScreenReaderSection |
getScreenReaderSection() |
HISeries |
getSeries() |
HISeriesTypeDescriptions |
getSeriesTypeDescriptions() |
HISonification |
getSonification() |
java.lang.String |
getSvgContainerLabel() |
java.lang.String |
getSvgContainerTitle() |
HITable |
getTable() |
java.lang.String |
getThousandsSep() |
java.lang.String |
getTypeDescription() |
HIZoom |
getZoom() |
void |
setAnnounceNewData(HIAnnounceNewData announceNewData)
Options for announcing new data to screen reader users.
|
void |
setAxis(HIAxis axis)
Axis description format strings.
|
void |
setChartContainerLabel(java.lang.String chartContainerLabel)
Accessible label for the chart container HTML element.
|
void |
setChartTypes(HIChartTypes chartTypes)
Chart type description strings.
|
void |
setCredits(java.lang.String credits)
Accessible label for the chart credits.
|
void |
setCustomComponents(java.lang.Object customComponents)
A hook for adding custom components to the accessibility module.
|
void |
setDefaultChartTitle(java.lang.String defaultsChartTitle)
Default title of the chart for assistive technology, for charts without a chart title.
|
void |
setDefinition(java.lang.String definition)
A text description of the chart.
|
void |
setDescriptionFormat(java.lang.String descriptionFormat)
Format to use for describing the data series group to assistive technology - including screen readers.
|
void |
setDrillUpButton(java.lang.String drillUpButton)
Accessible label for the drill-up button.
|
void |
setEnabled(java.lang.Boolean enabled)
Enable accessibility functionality for the chart.
|
void |
setExporting(HIExporting exporting)
Exporting menu format strings for accessibility module.
|
void |
setExposeAsGroupOnly(java.lang.Boolean exposeAsGroupOnly)
Expose only the series element to screen readers, not its points.
|
void |
setGraphicContainerLabel(java.lang.String graphicContainerLabel)
Set a label on the container wrapping the SVG.
|
void |
setHighContrastMode(java.lang.String highContrastMode)
Controls how `highContrastTheme` is applied.
|
void |
setHighContrastTheme(java.lang.Object highContrastTheme)
Theme to apply to the chart when Windows High Contrast Mode is detected.
|
void |
setKeyboardNavigation(HIKeyboardNavigation keyboardNavigation)
Options for keyboard navigation.
|
void |
setLandmarkVerbosity(java.lang.String landmarkVerbosity)
Amount of landmarks/regions to create for screen reader users.
|
void |
setLegend(HILegend legend)
Language options for accessibility of the legend.
|
void |
setLinkedDescription(java.lang.String linkedDescription)
Link the chart to an HTML element describing the contents of the chart.
|
void |
setNavigator(HINavigator navigator)
Navigator language options for accessibility.
|
void |
setPoint(HIPoint point)
Options for descriptions of individual data points.
|
void |
setRangeDescription(java.lang.String rangeDescription)
Range description for an axis.
|
void |
setRangeSelector(HIRangeSelector rangeSelector)
Range selector language options for accessibility.
|
void |
setScreenReaderSection(HIScreenReaderSection screenReaderSection)
Accessibility options for the screen reader information sections added before and after the chart.
|
void |
setSeries(HISeries series)
Accessibility options global to all data series.
|
void |
setSeriesTypeDescriptions(HISeriesTypeDescriptions seriesTypeDescriptions)
Descriptions of lesser known series types.
|
void |
setSonification(HISonification sonification)
Language options for sonification.
|
void |
setSvgContainerLabel(java.lang.String svgContainerLabel)
Accessible label for the chart SVG element.
|
void |
setSvgContainerTitle(java.lang.String svgContainerTitle)
Title element text for the chart SVG element.
|
void |
setTable(HITable table)
Accessibility language options for the data table.
|
void |
setThousandsSep(java.lang.String thousandsSep)
Thousands separator to use when formatting numbers for screen readers.
|
void |
setTypeDescription(java.lang.String typeDescription)
A text description of the chart type.
|
void |
setZoom(HIZoom zoom)
Chart and map zoom accessibility language options.
|
public HIAnnounceNewData getAnnounceNewData()
public HIAxis getAxis()
public java.lang.String getChartContainerLabel()
public HIChartTypes getChartTypes()
public java.lang.String getCredits()
public java.lang.Object getCustomComponents()
public java.lang.String getDefaultChartTitle()
public java.lang.String getDefinition()
public java.lang.String getDescriptionFormat()
public java.lang.String getDrillUpButton()
public java.lang.Boolean getEnabled()
public HIExporting getExporting()
public java.lang.Boolean getExposeAsGroupOnly()
public java.lang.String getGraphicContainerLabel()
public java.lang.String getHighContrastMode()
public java.lang.Object getHighContrastTheme()
public HIKeyboardNavigation getKeyboardNavigation()
public java.lang.String getLandmarkVerbosity()
public HILegend getLegend()
public java.lang.String getLinkedDescription()
public HINavigator getNavigator()
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
getParams
in class HIFoundation
public HIPoint getPoint()
public java.lang.String getRangeDescription()
public HIRangeSelector getRangeSelector()
public HIScreenReaderSection getScreenReaderSection()
public HISeries getSeries()
public HISeriesTypeDescriptions getSeriesTypeDescriptions()
public HISonification getSonification()
public java.lang.String getSvgContainerLabel()
public java.lang.String getSvgContainerTitle()
public HITable getTable()
public java.lang.String getThousandsSep()
public java.lang.String getTypeDescription()
public HIZoom getZoom()
public void setAnnounceNewData(HIAnnounceNewData announceNewData)
public void setAxis(HIAxis axis)
public void setChartContainerLabel(java.lang.String chartContainerLabel)
public void setChartTypes(HIChartTypes chartTypes)
public void setCredits(java.lang.String credits)
public void setCustomComponents(java.lang.Object customComponents)
public void setDefaultChartTitle(java.lang.String defaultsChartTitle)
public void setDefinition(java.lang.String definition)
public void setDescriptionFormat(java.lang.String descriptionFormat)
public void setDrillUpButton(java.lang.String drillUpButton)
public void setEnabled(java.lang.Boolean enabled)
public void setExporting(HIExporting exporting)
public void setExposeAsGroupOnly(java.lang.Boolean exposeAsGroupOnly)
public void setGraphicContainerLabel(java.lang.String graphicContainerLabel)
public void setHighContrastMode(java.lang.String highContrastMode)
public void setHighContrastTheme(java.lang.Object highContrastTheme)
public void setKeyboardNavigation(HIKeyboardNavigation keyboardNavigation)
public void setLandmarkVerbosity(java.lang.String landmarkVerbosity)
public void setLegend(HILegend legend)
public void setLinkedDescription(java.lang.String linkedDescription)
public void setNavigator(HINavigator navigator)
public void setPoint(HIPoint point)
public void setRangeDescription(java.lang.String rangeDescription)
public void setRangeSelector(HIRangeSelector rangeSelector)
public void setScreenReaderSection(HIScreenReaderSection screenReaderSection)
public void setSeries(HISeries series)
public void setSeriesTypeDescriptions(HISeriesTypeDescriptions seriesTypeDescriptions)
public void setSonification(HISonification sonification)
public void setSvgContainerLabel(java.lang.String svgContainerLabel)
public void setSvgContainerTitle(java.lang.String svgContainerTitle)
public void setTable(HITable table)
public void setThousandsSep(java.lang.String thousandsSep)
public void setTypeDescription(java.lang.String typeDescription)
public void setZoom(HIZoom zoom)