Package org.zkoss.chart

Class SeriesNavigation

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.SeriesNavigation

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class SeriesNavigation
extends Optionable

An options for the keyboard navigation of data points and series.

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
SeriesNavigation()

Method Summary

Modifier and Type	Method	Description
String	getMode()	Returns the keyboard navigation mode for the chart.
boolean	isPointNavigationEnabledThreshold()	Returns whether to enable/disable when a series contains more points than this, we no longer allow keyboard navigation for it.
boolean	isRememberPointFocus()	Returns whether to remember which point was focused even after navigating away from the series, so that when navigating back to the series you start at the last focused point.
boolean	isSkipNullPoints()	Returns whether to skip null points when navigating through points with the keyboard
void	setMode(String mode)	Sets the keyboard navigation mode for the chart.
void	setPointNavigationEnabledThreshold(boolean pointNavigationEnabledThreshold)	Sets whether to enable/disable when a series contains more points than this, we no longer allow keyboard navigation for it.
void	setRememberPointFocus(boolean rememberPointFocus)	Sets whether to remember which point was focused even after navigating away from the series, so that when navigating back to the series you start at the last focused point.
void	setSkipNullPoints(boolean skipNullPoints)	Sets whether to skip null points when navigating through points with the keyboard

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

SeriesNavigation

public SeriesNavigation()

Method Detail

getMode

public String getMode()

Returns the keyboard navigation mode for the chart. Can be "normal" or "serialize".

Default: "normal"

setMode

public void setMode(String mode)

Sets the keyboard navigation mode for the chart. Can be "normal" or "serialize". In normal mode, left/right arrow keys move between points in a series, while up/down arrow keys move between series. Up/down navigation acts intelligently to figure out which series makes sense to move to from any given point.

In "serialize" mode, points are instead navigated as a single list. Left/right behaves as in "normal" mode. Up/down arrow keys will behave like left/right. This can be useful for unifying navigation behavior with/without screen readers enabled.

Default: "normal"

isPointNavigationEnabledThreshold

public boolean isPointNavigationEnabledThreshold()

Returns whether to enable/disable when a series contains more points than this, we no longer allow keyboard navigation for it.

Default: false

setPointNavigationEnabledThreshold

public void setPointNavigationEnabledThreshold(boolean pointNavigationEnabledThreshold)

Sets whether to enable/disable when a series contains more points than this, we no longer allow keyboard navigation for it.

Default: false

isRememberPointFocus

public boolean isRememberPointFocus()

Returns whether to remember which point was focused even after navigating away from the series, so that when navigating back to the series you start at the last focused point.

Default: false

setRememberPointFocus

public void setRememberPointFocus(boolean rememberPointFocus)

Sets whether to remember which point was focused even after navigating away from the series, so that when navigating back to the series you start at the last focused point.

Default: false

isSkipNullPoints

public boolean isSkipNullPoints()

Returns whether to skip null points when navigating through points with the keyboard

Default: true

setSkipNullPoints

public void setSkipNullPoints(boolean skipNullPoints)

Sets whether to skip null points when navigating through points with the keyboard

Default: true