org.apache.poi.xssf.usermodel

Class XSSFChart

java.lang.Object

org.apache.poi.POIXMLDocumentPart

org.apache.poi.xssf.usermodel.XSSFChart

All Implemented Interfaces:

Chart, ChartAxisFactory, ManuallyPositionable

public final class XSSFChart
extends POIXMLDocumentPart
implements Chart, ChartAxisFactory

Represents a SpreadsheetML Chart

Field Summary

Fields inherited from class org.apache.poi.POIXMLDocumentPart

DEFAULT_XML_OPTIONS

Method Summary

Modifier and Type	Method and Description
XSSFCategoryAxis	createCategoryAxis(AxisPosition pos)
XSSFValueAxis	createValueAxis(AxisPosition pos)
void	deleteLegend() Delete current chart legend.
java.util.List<? extends XSSFChartAxis>	getAxis()
XSSFChart	getChartAxisFactory()
XSSFChartDataFactory	getChartDataFactory()
org.openxmlformats.schemas.drawingml.x2006.chart.CTChart	getCTChart() Return the underlying CTChart bean, within the Chart Space
org.openxmlformats.schemas.drawingml.x2006.chart.CTChartSpace	getCTChartSpace() Return the underlying CTChartSpace bean, the root element of the SpreadsheetML Chart part.
XSSFGraphicFrame	getGraphicFrame() Returns the parent graphic frame.
XSSFManualLayout	getManualLayout() Returns manual layout for the chart element.
XSSFChartLegend	getOrCreateLegend()
XSSFRichTextString	getTitle() Returns the title, or null if none is set
boolean	isPlotOnlyVisibleCells()
void	plot(ChartData data, ChartAxis... axis) Plots specified data on the chart.
void	setPlotOnlyVisibleCells(boolean plotVisOnly)

Methods inherited from class org.apache.poi.POIXMLDocumentPart

addRelation, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelations, toString

Methods inherited from class java.lang.Object

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

Method Detail

getCTChartSpace

@Internal
public org.openxmlformats.schemas.drawingml.x2006.chart.CTChartSpace getCTChartSpace()

Return the underlying CTChartSpace bean, the root element of the SpreadsheetML Chart part.

Returns:

the underlying CTChartSpace bean

getCTChart

@Internal
public org.openxmlformats.schemas.drawingml.x2006.chart.CTChart getCTChart()

Return the underlying CTChart bean, within the Chart Space

Returns:

the underlying CTChart bean

getGraphicFrame

public XSSFGraphicFrame getGraphicFrame()

Returns the parent graphic frame.

Returns:

the graphic frame this chart belongs to

getChartDataFactory

public XSSFChartDataFactory getChartDataFactory()

Specified by:

getChartDataFactory in interface Chart

Returns:

an appropriate ChartDataFactory implementation

getChartAxisFactory

public XSSFChart getChartAxisFactory()

Specified by:

getChartAxisFactory in interface Chart

Returns:

an appropriate ChartAxisFactory implementation

plot

public void plot(ChartData data,
                 ChartAxis... axis)

Description copied from interface: Chart

Plots specified data on the chart.

Specified by:

plot in interface Chart

Parameters:

data - a data to plot

createValueAxis

public XSSFValueAxis createValueAxis(AxisPosition pos)

Specified by:

createValueAxis in interface ChartAxisFactory

Returns:

new value axis

createCategoryAxis

public XSSFCategoryAxis createCategoryAxis(AxisPosition pos)

Specified by:

createCategoryAxis in interface ChartAxisFactory

Returns:

new category axis.

getAxis

public java.util.List<? extends XSSFChartAxis> getAxis()

Specified by:

getAxis in interface Chart

Returns:

list of all chart axis

getManualLayout

public XSSFManualLayout getManualLayout()

Description copied from interface: ManuallyPositionable

Returns manual layout for the chart element.

Specified by:

getManualLayout in interface ManuallyPositionable

Returns:

manual layout for the chart element.

isPlotOnlyVisibleCells

public boolean isPlotOnlyVisibleCells()

Returns:

true if only visible cells will be present on the chart, false otherwise

setPlotOnlyVisibleCells

public void setPlotOnlyVisibleCells(boolean plotVisOnly)

Parameters:

plotVisOnly - a flag specifying if only visible cells should be present on the chart

getTitle

public XSSFRichTextString getTitle()

Returns the title, or null if none is set

getOrCreateLegend

public XSSFChartLegend getOrCreateLegend()

Specified by:

getOrCreateLegend in interface Chart

Returns:

chart legend instance

deleteLegend

public void deleteLegend()

Description copied from interface: Chart

Delete current chart legend.

Specified by:

deleteLegend in interface Chart