Package org.zkoss.chart

Class AxisAccessibility

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.AxisAccessibility

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class AxisAccessibility
extends Optionable

Accessibility options for an axis.

Requires the accessibility module to be loaded. For example,

 Library.setProperty("org.zkoss.chart.modules.accessibility", "true");
 

Since:

10.2.1.0

Author:

jumperchen

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
AxisAccessibility()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description for an axis to expose to screen reader users.
String	getRangeDescription()	Returns the range description for an axis.
Boolean	isEnabled()	Returns whether to enable axis accessibility features, including axis information in the screen reader information region.
void	setDescription(String description)	Sets the description for an axis to expose to screen reader users.
void	setEnabled(boolean enabled)	Sets whether to enable axis accessibility features, including axis information in the screen reader information region.
void	setRangeDescription(String rangeDescription)	Sets the range description for an axis.

Methods inherited from class org.zkoss.chart.Optionable

addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, onChange, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, setAttr, toJSONString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AxisAccessibility

public AxisAccessibility()

Method Detail

getDescription

public String getDescription()

Returns the description for an axis to expose to screen reader users.

Default: null

setDescription

public void setDescription(String description)

Sets the description for an axis to expose to screen reader users.

Default: null

isEnabled

public Boolean isEnabled()

Returns whether to enable axis accessibility features, including axis information in the screen reader information region. If this is disabled on the xAxis, the x values are not exposed to screen readers for the individual data points by default.

Default: null

setEnabled

public void setEnabled(boolean enabled)

Sets whether to enable axis accessibility features, including axis information in the screen reader information region. If this is disabled on the xAxis, the x values are not exposed to screen readers for the individual data points by default.

getRangeDescription

public String getRangeDescription()

Returns the range description for an axis. Overrides the default range description. Set to empty to disable range description for this axis.

Default: null

setRangeDescription

public void setRangeDescription(String rangeDescription)

Sets the range description for an axis. Overrides the default range description. Set to empty to disable range description for this axis.

Default: null