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:

org.apache.poi.xddf.usermodel.text.TextContainer

public final class XSSFChart
extends org.apache.poi.xddf.usermodel.chart.XDDFChart

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

DEFAULT_HEIGHT, DEFAULT_WIDTH, DEFAULT_X, DEFAULT_Y

Method Summary

Modifier and Type	Method	Description
XSSFGraphicFrame	getGraphicFrame()	Returns the parent graphic frame.
String	getTitleFormula()	Get the chart title formula expression if there is one
XSSFRichTextString	getTitleText()	Returns the title static text, or null if none is set.
void	setTitleFormula(String formula)	Set the formula expression to use for the chart title

Methods inherited from class org.apache.poi.xddf.usermodel.chart.XDDFChart

clear, clearChartSeries, createCategoryAxis, createData, createDateAxis, createRelationshipInChart, createSeriesAxis, createValueAxis, deleteLegend, deleteShapeProperties, displayBlanksAs, findDefinedParagraphProperty, findDefinedRunProperty, formatRange, getAxes, getChartSeries, getCTChart, getCTChartSpace, getFormattedTitle, getOrAddLegend, getOrAddManualLayout, getOrAddShapeProperties, getOrAddView3D, getTitle, getTitleOverlay, getWorkbook, importContent, isPlotOnlyVisibleCells, plot, removeTitle, replaceReferences, saveWorkbook, setAutoTitleDeleted, setBackWall, setChartIndex, setExternalId, setFloor, setPlotOnlyVisibleCells, setSheetTitle, setSideWall, setTitleOverlay, setTitleText, setValueRange, setWorkbook

Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, isCommitted, setCommitted, toString

Methods inherited from class java.lang.Object

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

Method Details

getGraphicFrame

public XSSFGraphicFrame getGraphicFrame()

Returns the parent graphic frame.

Returns:

the graphic frame this chart belongs to

getTitleText

public XSSFRichTextString 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

public String getTitleFormula()

Get the chart title formula expression if there is one

Returns:

formula expression or null

setTitleFormula

public void setTitleFormula(String formula)

Set the formula expression to use for the chart title