XSLFChart (POI API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.xslf.usermodel
Class XSLFChart

java.lang.Object
  org.apache.poi.POIXMLDocumentPart
      org.apache.poi.xslf.usermodel.XSLFChart

@Beta public final class XSLFChart
extends POIXMLDocumentPart
extends POIXMLDocumentPart

Represents a Chart in a .pptx presentation

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.POIXMLDocumentPart
`POIXMLDocumentPart.RelationPart`

Constructor Summary
`protected`	`XSLFChart(PackagePart part)` Construct a chart from a package part.

Method Summary
`protected void`	`commit()` Save the content in the underlying package part.
`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 Chart part.

Methods inherited from class org.apache.poi.POIXMLDocumentPart
`_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationParts, getRelations, getTargetPart, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

XSLFChart

protected XSLFChart(PackagePart part)
             throws java.io.IOException,
                    org.apache.xmlbeans.XmlException

Construct a chart from a package part.

Parameters:: part - the package part holding the chart data, the content type must be application/vnd.openxmlformats-officedocument.drawingml.chart+xml
Throws:: java.io.IOException; org.apache.xmlbeans.XmlException
Since:: POI 3.14-Beta1

Method Detail

getCTChartSpace

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

Return the underlying CTChartSpace bean, the root element of the 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

commit

protected void commit()
               throws java.io.IOException

Description copied from class: POIXMLDocumentPart

Save the content in the underlying package part. Default implementation is empty meaning that the package part is left unmodified. Sub-classes should override and add logic to marshal the "model" into Ooxml4J. For example, the code saving a generic XML entry may look as follows:

 protected void commit() throws IOException {
   PackagePart part = getPackagePart();
   OutputStream out = part.getOutputStream();
   XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
   bean.save(out, DEFAULT_XML_OPTIONS);
   out.close();
 }

Overrides:: commit in class POIXMLDocumentPart

Throws:: java.io.IOException - a subclass may throw an IOException if the changes can't be committed