Package io.keikai.model.impl.chart

Class SeriesImpl

java.lang.Object

io.keikai.model.impl.AbstractSeriesAdv

io.keikai.model.impl.chart.SeriesImpl

All Implemented Interfaces:

SSeries, FormulaContent, LinkedModelObject, Serializable

public class SeriesImpl
extends AbstractSeriesAdv
implements SSeries, Serializable, LinkedModelObject

Since:

3.5.0

Author:

dennis

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SeriesImpl(AbstractChartAdv chart, String id)

Method Summary

Modifier and Type	Method	Description
void	addDataPointColors(int index, SColor color)
void	addDataPointExplosion(int index, int explosion)
STrendline	addTrendline(STrendline.TrendlineType type)	Adds a new trendline of the given type and returns it.
void	checkOrphan()
void	clearFormulaResultCache()	Clear the formula result cache if there is evaluation result
SeriesImpl	cloneSeriesImpl(AbstractChartAdv chart)
void	destroy()	Destroy / release this model object, for example all the dependency, parent linking.
DataLabelsInfo	getDataLabels()	The series' declared data-label configuration, or null when the file declared none.
Map<Integer,SColor>	getDataPointColors()
Map<Integer,Integer>	getDataPointExplosions()	KEIKAI-291: per-data-point pie/doughnut slice explosion (in percent, matching OOXML <c:dPt><c:explosion val="..."/>).
SColor	getDefaultColor()	data point colors
SErrorBar	getErrorBar()	Returns the error bar attached to this series, or null if none.
String	getId()
String	getName()
String	getNameFormula()
FormulaExpression	getNameFormulaExpression()
int	getNumOfValue()
int	getNumOfXValue()	Gets the number of x value, the result is same as SSeries.getNumOfValue()
int	getNumOfYValue()
int	getNumOfZValue()
int	getOrder()
List<STrendline>	getTrendlines()	Returns an unmodifiable list of trendlines attached to this series.
Object	getValue(int index)
String	getValuesFormula()
FormulaExpression	getValuesFormulaExpression()
Object	getXValue(int index)
String	getXValuesFormula()	Gets the x value formula, the result is same as SSeries.getValuesFormula()
FormulaExpression	getXValuesFormulaExpression()
Object	getYValue(int index)
String	getYValuesFormula()
FormulaExpression	getYValuesFormulaExpression()
Object	getZValue(int index)
String	getZValuesFormula()
FormulaExpression	getZValuesFormulaExpression()
boolean	isDataLabelsVisible()
boolean	isFormulaParsingError()
boolean	isNameFomulaHidden(int index)	detect visibility for index
boolean	isSmooth()
boolean	isXValueFomulaHidden(int index)
boolean	isYValueFomulaHidden(int index)
boolean	isZValueFomulaHidden(int index)
void	setDataLabels(DataLabelsInfo dataLabels)
void	setDataLabelsVisible(boolean dataLabelsVisible)
void	setDefaultColor(SColor defaultColor)
void	setErrorBar(SErrorBar errorBar)	Sets the error bar for this series.
void	setFormula(String nameExpression, String valueExpression)
void	setOrder(int order)
void	setSmooth(boolean _smooth)
void	setXYFormula(String nameExpression, String xValueExpression, String yValueExpression)
void	setXYZFormula(FormulaExpression nameExpr, FormulaExpression xValueExpr, FormulaExpression yValueExpr, FormulaExpression zValueExpr)
void	setXYZFormula(String nameExpression, String xValueExpression, String yValueExpression, String zValueExpression)

Methods inherited from class java.lang.Object

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

Constructor Details

SeriesImpl

public SeriesImpl(AbstractChartAdv chart,
 String id)

Method Details

getId

public String getId()

Specified by:

getId in interface SSeries

getName

public String getName()

Specified by:

getName in interface SSeries

getNumOfValue

public int getNumOfValue()

Specified by:

getNumOfValue in interface SSeries

getValue

public Object getValue(int index)

Specified by:

getValue in interface SSeries

getNumOfYValue

public int getNumOfYValue()

Specified by:

getNumOfYValue in interface SSeries

getYValue

public Object getYValue(int index)

Specified by:

getYValue in interface SSeries

getNumOfZValue

public int getNumOfZValue()

Specified by:

getNumOfZValue in interface SSeries

getZValue

public Object getZValue(int index)

Specified by:

getZValue in interface SSeries

setFormula

public void setFormula(String nameExpression,
 String valueExpression)

Specified by:

setFormula in interface SSeries

setXYFormula

public void setXYFormula(String nameExpression,
 String xValueExpression,
 String yValueExpression)

Specified by:

setXYFormula in interface SSeries

setXYZFormula

public void setXYZFormula(String nameExpression,
 String xValueExpression,
 String yValueExpression,
 String zValueExpression)

Specified by:

setXYZFormula in interface SSeries

isFormulaParsingError

public boolean isFormulaParsingError()

Specified by:

isFormulaParsingError in interface FormulaContent

Returns:

returns TRUE if it has parsing error, FALSE if no error found or not a formula content

getNameFormula

public String getNameFormula()

Specified by:

getNameFormula in interface SSeries

getValuesFormula

public String getValuesFormula()

Specified by:

getValuesFormula in interface SSeries

getYValuesFormula

public String getYValuesFormula()

Specified by:

getYValuesFormula in interface SSeries

getZValuesFormula

public String getZValuesFormula()

Specified by:

getZValuesFormula in interface SSeries

clearFormulaResultCache

public void clearFormulaResultCache()

Description copied from interface: FormulaContent

Clear the formula result cache if there is evaluation result

Specified by:

clearFormulaResultCache in interface FormulaContent

destroy

public void destroy()

Description copied from interface: LinkedModelObject

Destroy / release this model object, for example all the dependency, parent linking. this method has to be called before remove this linking from parent object

Specified by:

destroy in interface LinkedModelObject

checkOrphan

public void checkOrphan()

Specified by:

checkOrphan in interface LinkedModelObject

getNumOfXValue

public int getNumOfXValue()

Description copied from interface: SSeries

Gets the number of x value, the result is same as SSeries.getNumOfValue()

Specified by:

getNumOfXValue in interface SSeries

Returns:

getXValue

public Object getXValue(int index)

Specified by:

getXValue in interface SSeries

Returns:

returns the x value specifed by the index, the result is same as SSeries.getValue(int)

getXValuesFormula

public String getXValuesFormula()

Description copied from interface: SSeries

Gets the x value formula, the result is same as SSeries.getValuesFormula()

Specified by:

getXValuesFormula in interface SSeries

Returns:

cloneSeriesImpl

public SeriesImpl cloneSeriesImpl(AbstractChartAdv chart)

getNameFormulaExpression

public FormulaExpression getNameFormulaExpression()

Specified by:

getNameFormulaExpression in class AbstractSeriesAdv

getValuesFormulaExpression

public FormulaExpression getValuesFormulaExpression()

Specified by:

getValuesFormulaExpression in class AbstractSeriesAdv

Returns:

getXValuesFormulaExpression

public FormulaExpression getXValuesFormulaExpression()

Specified by:

getXValuesFormulaExpression in class AbstractSeriesAdv

Returns:

getYValuesFormulaExpression

public FormulaExpression getYValuesFormulaExpression()

Specified by:

getYValuesFormulaExpression in class AbstractSeriesAdv

Returns:

getZValuesFormulaExpression

public FormulaExpression getZValuesFormulaExpression()

Specified by:

getZValuesFormulaExpression in class AbstractSeriesAdv

Returns:

setXYZFormula

public void setXYZFormula(FormulaExpression nameExpr,
 FormulaExpression xValueExpr,
 FormulaExpression yValueExpr,
 FormulaExpression zValueExpr)

Specified by:

setXYZFormula in class AbstractSeriesAdv

isNameFomulaHidden

public boolean isNameFomulaHidden(int index)

Description copied from interface: SSeries

detect visibility for index

Specified by:

isNameFomulaHidden in interface SSeries

Returns:

isXValueFomulaHidden

public boolean isXValueFomulaHidden(int index)

Specified by:

isXValueFomulaHidden in interface SSeries

isYValueFomulaHidden

public boolean isYValueFomulaHidden(int index)

Specified by:

isYValueFomulaHidden in interface SSeries

isZValueFomulaHidden

public boolean isZValueFomulaHidden(int index)

Specified by:

isZValueFomulaHidden in interface SSeries

getDefaultColor

public SColor getDefaultColor()

Description copied from class: AbstractSeriesAdv

data point colors

Specified by:

getDefaultColor in class AbstractSeriesAdv

setDefaultColor

public void setDefaultColor(SColor defaultColor)

Specified by:

setDefaultColor in class AbstractSeriesAdv

getDataPointColors

public Map<Integer,SColor> getDataPointColors()

Specified by:

getDataPointColors in class AbstractSeriesAdv

addDataPointColors

public void addDataPointColors(int index,
 SColor color)

Specified by:

addDataPointColors in class AbstractSeriesAdv

getDataPointExplosions

public Map<Integer,Integer> getDataPointExplosions()

Description copied from class: AbstractSeriesAdv

KEIKAI-291: per-data-point pie/doughnut slice explosion (in percent, matching OOXML <c:dPt><c:explosion val="..."/>). Keyed by the 0-based point index; absent / 0 means no explosion.

Specified by:

getDataPointExplosions in class AbstractSeriesAdv

addDataPointExplosion

public void addDataPointExplosion(int index,
 int explosion)

Specified by:

addDataPointExplosion in class AbstractSeriesAdv

getOrder

public int getOrder()

Specified by:

getOrder in class AbstractSeriesAdv

setOrder

public void setOrder(int order)

Specified by:

setOrder in class AbstractSeriesAdv

isSmooth

public boolean isSmooth()

Specified by:

isSmooth in class AbstractSeriesAdv

setSmooth

public void setSmooth(boolean _smooth)

Specified by:

setSmooth in class AbstractSeriesAdv

isDataLabelsVisible

public boolean isDataLabelsVisible()

Specified by:

isDataLabelsVisible in class AbstractSeriesAdv

setDataLabelsVisible

public void setDataLabelsVisible(boolean dataLabelsVisible)

Specified by:

setDataLabelsVisible in class AbstractSeriesAdv

getDataLabels

public DataLabelsInfo getDataLabels()

Description copied from class: AbstractSeriesAdv

The series' declared data-label configuration, or null when the file declared none. AbstractSeriesAdv.isDataLabelsVisible() answers only whether labels are drawn; this says what they contain.

Specified by:

getDataLabels in class AbstractSeriesAdv

setDataLabels

public void setDataLabels(DataLabelsInfo dataLabels)

Specified by:

setDataLabels in class AbstractSeriesAdv

getTrendlines

public List<STrendline> getTrendlines()

Description copied from interface: SSeries

Returns an unmodifiable list of trendlines attached to this series.

Specified by:

getTrendlines in interface SSeries

Specified by:

getTrendlines in class AbstractSeriesAdv

Returns:

the trendlines, never null

addTrendline

public STrendline addTrendline(STrendline.TrendlineType type)

Description copied from interface: SSeries

Adds a new trendline of the given type and returns it.

Specified by:

addTrendline in interface SSeries

Specified by:

addTrendline in class AbstractSeriesAdv

Parameters:

type - the trendline type

Returns:

the newly created trendline

getErrorBar

public SErrorBar getErrorBar()

Description copied from interface: SSeries

Returns the error bar attached to this series, or null if none.

Specified by:

getErrorBar in interface SSeries

Specified by:

getErrorBar in class AbstractSeriesAdv

Returns:

the error bar, or null

setErrorBar

public void setErrorBar(SErrorBar errorBar)

Description copied from interface: SSeries

Sets the error bar for this series.

Specified by:

setErrorBar in interface SSeries

Specified by:

setErrorBar in class AbstractSeriesAdv

Parameters:

errorBar - the error bar, or null to remove