Package org.apache.poi.xssf.usermodel
Class XSSFChart
java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
org.apache.poi.xddf.usermodel.chart.XDDFChart
org.apache.poi.xssf.usermodel.XSSFChart
- All Implemented Interfaces:
Chart,ChartAxisFactory,ManuallyPositionable,TextContainer
Represents a SpreadsheetML Chart
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
POIXMLDocumentPart.RelationPart -
Field Summary
Fields inherited from class org.apache.poi.xddf.usermodel.chart.XDDFChart
axes, chart, chartSpace -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCreate a new SpreadsheetML chartprotectedXSSFChart(PackagePart part) Construct a SpreadsheetML chart from a package part. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcommit()save chart xmlDeprecated.Deprecated.Deprecated.List<? extends XSSFChartAxis>getAxis()Deprecated.Deprecated.Deprecated.protected POIXMLFactoryprotected POIXMLRelationprotected POIXMLRelationReturns the parent graphic frame.Deprecated.Deprecated.Get the chart title formula expression if there is oneReturns the title static text, or null if none is set.voidDeprecated.protected voidsetGraphicFrame(XSSFGraphicFrame frame) Sets the parent graphic frame.voidsetTitleFormula(String formula) Set the formula expression to use for the chart titleMethods inherited from class org.apache.poi.xddf.usermodel.chart.XDDFChart
createCategoryAxis, createData, createDateAxis, createRelationshipInChart, createValueAxis, deleteLegend, deleteShapeProperties, displayBlanksAs, fillSheet, findDefinedParagraphProperty, findDefinedRunProperty, formatRange, getAxes, getChartIndex, getChartSeries, getCTChart, getCTChartSpace, getCTPlotArea, getFormattedTitle, getOrAddLegend, getOrAddManualLayout, getOrAddShapeProperties, getTitle, getTitleOverlay, getWorkbook, importContent, isPlotOnlyVisibleCells, plot, saveWorkbook, setAutoTitleDeleted, setBackWall, setChartIndex, setExternalId, setFloor, setPlotOnlyVisibleCells, setSheetTitle, setSideWall, setTitleOverlay, setTitleText, setValueRange, setWorkbookMethods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommited, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommited, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.poi.ss.usermodel.Chart
deleteLegend
-
Constructor Details
-
XSSFChart
protected XSSFChart()Create a new SpreadsheetML chart -
XSSFChart
Construct a SpreadsheetML chart from a package part.- Parameters:
part- the package part holding the chart data, the content type must beapplication/vnd.openxmlformats-officedocument.drawingml.chart+xml- Throws:
IOExceptionorg.apache.xmlbeans.XmlException- Since:
- POI 3.14-Beta1
-
-
Method Details
-
getChartRelation
- Specified by:
getChartRelationin classXDDFChart- Returns:
- the chart relation in the implementing subclass.
-
getChartWorkbookRelation
- Specified by:
getChartWorkbookRelationin classXDDFChart- Returns:
- the chart workbook relation in the implementing subclass.
-
getChartFactory
- Specified by:
getChartFactoryin classXDDFChart- Returns:
- the chart factory in the implementing subclass.
-
commit
Description copied from class:XDDFChartsave chart xml- Overrides:
commitin classXDDFChart- Throws:
IOException- a subclass may throw an IOException if the changes can't be committed
-
getGraphicFrame
Returns the parent graphic frame.- Returns:
- the graphic frame this chart belongs to
-
setGraphicFrame
Sets the parent graphic frame. -
getChartDataFactory
Deprecated.- Specified by:
getChartDataFactoryin interfaceChart- Returns:
- an appropriate ChartDataFactory implementation
-
getChartAxisFactory
Deprecated.- Specified by:
getChartAxisFactoryin interfaceChart- Returns:
- an appropriate ChartAxisFactory implementation
-
plot
Deprecated.Description copied from interface:ChartPlots specified data on the chart. -
createValueAxis
Deprecated.- Specified by:
createValueAxisin interfaceChartAxisFactory- Returns:
- new value axis at the end of the list at the specified chart position
-
createCategoryAxis
Deprecated.- Specified by:
createCategoryAxisin interfaceChartAxisFactory- Returns:
- new category axis at the end of the list at the specified chart position
-
createDateAxis
Deprecated.- Specified by:
createDateAxisin interfaceChartAxisFactory- Returns:
- new date category axis at the end of the list at the specified chart position
-
getAxis
Deprecated.useXDDFChart.getAxes()instead -
getManualLayout
Deprecated.Description copied from interface:ManuallyPositionableReturns manual layout for the chart element.- Specified by:
getManualLayoutin interfaceManuallyPositionable- Returns:
- manual layout for the chart element.
-
getTitleText
Returns the title static text, or null if none is set. Note that a title formula may be set instead. Empty text result is for backward compatibility, and could mean the title text is empty or there is a formula instead. Check for a formula first, falling back on text for cleaner logic.- Returns:
- static title text if set, null if there is no title, empty string if the title text is empty or the title uses a formula instead
-
getTitleFormula
Get the chart title formula expression if there is one- Returns:
- formula expression or null
-
setTitleFormula
Set the formula expression to use for the chart title- Parameters:
formula-
-
getOrCreateLegend
Deprecated.- Specified by:
getOrCreateLegendin interfaceChart- Returns:
- chart legend instance
-
XDDFChart.getAxes()instead