Package org.apache.poi.xddf.usermodel.chart

Class XDDFChartData.Series

java.lang.Object

org.apache.poi.xddf.usermodel.chart.XDDFChartData.Series

Direct Known Subclasses:

XDDFArea3DChartData.Series, XDDFAreaChartData.Series, XDDFBar3DChartData.Series, XDDFBarChartData.Series, XDDFBubbleChartData.Series, XDDFDoughnutChartData.Series, XDDFLine3DChartData.Series, XDDFLineChartData.Series, XDDFPie3DChartData.Series, XDDFPieChartData.Series, XDDFRadarChartData.Series, XDDFScatterChartData.Series, XDDFSurface3DChartData.Series, XDDFSurfaceChartData.Series

Enclosing class:

XDDFChartData

public abstract static class XDDFChartData.Series
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected XDDFDataSource<?>	categoryData
protected XDDFNumericalDataSource<? extends Number>	valuesData

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Series(XDDFDataSource<?> category, XDDFNumericalDataSource<? extends Number> values)

Method Summary

Modifier and Type	Method	Description
void	clearDataPoint(long index)	If a data point definition with the given index exists, then remove it.
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTAxDataSource	getAxDS()
XDDFDataSource<?>	getCategoryData()
XDDFDataPoint	getDataPoint(long index)	If a data point definition with the given index exists, then return it.
protected abstract List<org.openxmlformats.schemas.drawingml.x2006.chart.CTDPt>	getDPtList()
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTNumDataSource	getNumDS()
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTSerTx	getSeriesText()
abstract XDDFShapeProperties	getShapeProperties()
XDDFNumericalDataSource<? extends Number>	getValuesData()
void	plot()
void	replaceData(XDDFDataSource<?> category, XDDFNumericalDataSource<? extends Number> values)
protected org.openxmlformats.schemas.drawingml.x2006.chart.CTNumData	retrieveNumCache(org.openxmlformats.schemas.drawingml.x2006.chart.CTNumDataSource numDataSource, XDDFDataSource<?> data)
void	setFillProperties(XDDFFillProperties fill)
protected abstract void	setIndex(long index)
void	setLineProperties(XDDFLineProperties line)
protected abstract void	setOrder(long order)
abstract void	setShapeProperties(XDDFShapeProperties properties)
abstract void	setShowLeaderLines(boolean showLeaderLines)
void	setTitle(String title)	Set the Chart Series title.
void	setTitle(String title, CellReference titleRef)	Set the Chart Series title.

Methods inherited from class java.lang.Object

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

Field Detail

categoryData

protected XDDFDataSource<?> categoryData

valuesData

protected XDDFNumericalDataSource<? extends Number> valuesData

Constructor Detail

Series

protected Series(XDDFDataSource<?> category,
                 XDDFNumericalDataSource<? extends Number> values)

Method Detail

getSeriesText

protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTSerTx getSeriesText()

setShowLeaderLines

public abstract void setShowLeaderLines(boolean showLeaderLines)

getShapeProperties

public abstract XDDFShapeProperties getShapeProperties()

setShapeProperties

public abstract void setShapeProperties(XDDFShapeProperties properties)

getAxDS

protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTAxDataSource getAxDS()

getNumDS

protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTNumDataSource getNumDS()

setIndex

protected abstract void setIndex(long index)

setOrder

protected abstract void setOrder(long order)

getDPtList

protected abstract List<org.openxmlformats.schemas.drawingml.x2006.chart.CTDPt> getDPtList()

replaceData

public void replaceData(XDDFDataSource<?> category,
                        XDDFNumericalDataSource<? extends Number> values)

setTitle

public void setTitle(String title)

Set the Chart Series title.

Parameters:

title - chart series title

Since:

POI 5.2.3

setTitle

public void setTitle(String title,
                     CellReference titleRef)

Set the Chart Series title.

Parameters:

title - chart series title

titleRef - cell reference

getCategoryData

public XDDFDataSource<?> getCategoryData()

getValuesData

public XDDFNumericalDataSource<? extends Number> getValuesData()

plot

public void plot()

setFillProperties

public void setFillProperties(XDDFFillProperties fill)

Parameters:

fill - fill property for the shape representing the series.

Since:

POI 4.1.1

setLineProperties

public void setLineProperties(XDDFLineProperties line)

Parameters:

line - line property for the shape representing the series.

Since:

POI 4.1.1

clearDataPoint

public void clearDataPoint(long index)

If a data point definition with the given index exists, then remove it. Otherwise do nothing.

Parameters:

index - data point index.

Since:

POI 5.1.0

getDataPoint

public XDDFDataPoint getDataPoint(long index)

If a data point definition with the given index exists, then return it. Otherwise create a new data point definition and return it.

Parameters:

index - data point index.

Returns:

the data point with the given index.

Since:

POI 5.1.0

retrieveNumCache

protected org.openxmlformats.schemas.drawingml.x2006.chart.CTNumData retrieveNumCache(org.openxmlformats.schemas.drawingml.x2006.chart.CTNumDataSource numDataSource,
                                                                                      XDDFDataSource<?> data)