Package org.zkoss.chart

Class LangSeries

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.LangSeries

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class LangSeries
extends Optionable

Lang configuration for different series types. For more dynamic control over the series element descriptions, see AccessibilitySeries.getDescriptionFormatter().

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

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns user supplied description text.
String	getNullPointValue()	Returns the description for the value of null points.
String	getPointAnnotationsDescription()	Returns the description for annotations on a point, as it is made available to assistive technology.
LangSeriesSummary	getSummary()	Returns lang configuration for the series main summary.
String	getXAxisDescription()	Returns xAxis description for series if there are multiple xAxes in the chart.
String	getYAxisDescription()	Returns yAxis description for series if there are multiple yAxes in the chart.
void	setDescription(String description)	Sets user supplied description text.
void	setNullPointValue(String nullPointValue)	Sets the description for the value of null points.
void	setPointAnnotationsDescription(String pointAnnotationsDescription)	Sets the description for annotations on a point, as it is made available to assistive technology.
void	setSummary(LangSeriesSummary summary)	Sets lang configuration for the series main summary.
void	setXAxisDescription(String xAxisDescription)	Sets xAxis description for series if there are multiple xAxes in the chart.
void	setYAxisDescription(String yAxisDescription)	Sets yAxis description for series if there are multiple yAxes in the chart.

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

LangSeries

public LangSeries()

Method Detail

getDescription

public String getDescription()

Returns user supplied description text. This is added in the point comment description by default if present.

Default: "Bar chart with {numSeries} data series."

setDescription

public void setDescription(String description)

Sets user supplied description text. This is added in the point comment description by default if present.

getNullPointValue

public String getNullPointValue()

Returns the description for the value of null points.

Default: "No value"

setNullPointValue

public void setNullPointValue(String nullPointValue)

Sets the description for the value of null points.

getPointAnnotationsDescription

public String getPointAnnotationsDescription()

Returns the description for annotations on a point, as it is made available to assistive technology.

Default: "{Annotation: #each(annotations). }"

setPointAnnotationsDescription

public void setPointAnnotationsDescription(String pointAnnotationsDescription)

Sets the description for annotations on a point, as it is made available to assistive technology.

getSummary

public LangSeriesSummary getSummary()

Returns lang configuration for the series main summary. If null, create a new one.

setSummary

public void setSummary(LangSeriesSummary summary)

Sets lang configuration for the series main summary.

getXAxisDescription

public String getXAxisDescription()

Returns xAxis description for series if there are multiple xAxes in the chart.

Default: "X axis, {name}"

setXAxisDescription

public void setXAxisDescription(String xAxisDescription)

Sets xAxis description for series if there are multiple xAxes in the chart.

getYAxisDescription

public String getYAxisDescription()

Returns yAxis description for series if there are multiple yAxes in the chart.

Default: "Y axis, {name}"

setYAxisDescription

public void setYAxisDescription(String yAxisDescription)

Sets yAxis description for series if there are multiple yAxes in the chart.