io.starter.formats.XLS.charts

Class OOXMLChart

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.charts.GenericChartObject

io.starter.formats.XLS.charts.Chart

io.starter.formats.XLS.charts.OOXMLChart

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable

public class OOXMLChart
extends Chart

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	lang
Legend	ooxmlLegend
Layout	plotAreaLayout
boolean	roundedCorners
Title	ttl

Fields inherited from class io.starter.formats.XLS.charts.Chart

chartaxes, chartgroup, chartRecs, chartseries, charttitle, currentAi, dimensions, dirtyflag, hierarchyDepth, initobs, metricsDirty, msodrawobj, nCharts, obj, postRecs, preRecs, wbh

Fields inherited from class io.starter.formats.XLS.charts.GenericChartObject

chartArr, chartType, parentChart

Fields inherited from class io.starter.formats.XLS.XLSRecord

col, continues, DEBUGLEVEL, hyperlink, idx, isBlank, isBoolean, isContinueMerged, isString, lastidx, myxf, offset, rw, streamer, wkbook, worksheet

Fields inherited from interface io.starter.formats.XLS.charts.ChartConstants

AREACHART, BARCHART, BUBBLECHART, COLCHART, CONEBARCHART, CONECHART, CYLINDERBARCHART, CYLINDERCHART, DOUGHNUTCHART, LINECHART, OFPIECHART, PIECHART, PYRAMIDBARCHART, PYRAMIDCHART, RADARAREACHART, RADARCHART, SCATTERCHART, SHAPECOLUMN, SHAPECONE, SHAPECONETOMAX, SHAPECYLINDER, SHAPEDEFAULT, SHAPEPYRAMID, SHAPEPYRAMIDTOMAX, STOCKCHART, SURFACECHART, XAXIS, XVALAXIS, YAXIS, ZAXIS

Fields inherited from interface io.starter.formats.XLS.XLSConstants

AI, ALLOWDUPES, ALRUNS, AREA, AREAFORMAT, ARRAY, ATTACHEDLABEL, AUTOFILTER, AXCENT, AXESUSED, AXIS, AXISLINEFORMAT, AXISPARENT, BACKUP, BAR, BEGIN, BLANK, BOF, BOOKBOOL, BOOLERR, BOPPOP, BOPPOPCUSTOM, BOTTOM_MARGIN, BOTTOMMARGIN, BOUNDSHEET, CALC_MODE_PROP, CALCCOUNT, CALCMODE, CALCULATE_ALWAYS, CALCULATE_AUTO, CALCULATE_EXPLICIT, CATLAB, CATSERRANGE, CF, CF12, CHART, CHART3DBARSHAPE, CHARTFORMAT, CHARTFORMATLINK, CHARTFRTINFO, CHARTLINE, CODENAME, COLINFO, CONDFMT, CONDFMT12, CONTINUE, COUNTRY, CRN, CRTLAYOUT12, CRTLAYOUT12A, DAT, DATAFORMAT, DATALABEXT, DATALABEXTCONTENTS, DATE1904, DBCELL, DCON, DCONBIN, DCONNAME, DCONREF, DEBUG_HIGH, DEBUG_LOW, DEBUG_MEDIUM, DEFAULTENCODING, DEFAULTROWHEIGHT, DEFAULTTEXT, DEFCOLWIDTH, DELTA, DIMENSIONS, DROPBAR, DSF, DV, DVAL, END, ENDBLOCK, ENDEXTSST, ENDOBJECT, EOF, EXCEL2K, EXTERNCOUNT, EXTERNNAME, EXTERNSHEET, EXTSST, FBI, FEATHEADR, FILE_LOCK, FILEPASS, FONT, FONTBASIS, FONTX, FOOTERREC, FORMAT, FORMULA, FRAME, FRTFONTLIST, FRTWRAPPER, GARBAGE, GELFRAME, GUTS, HCENTER, HEADERREC, HLINK, HORIZONTAL_PAGE_BREAKS, IFMT, INDEX, INTERFACE_HDR, ITERATION, LABEL, LABELSST, LEFT_MARGIN, LEFTMARGIN, LEGEND, LEGENDXN, LINE, LINEFORMAT, MARKERFORMAT, MAXCOLS, MAXCOLS_BIFF8, MAXRECLEN, MAXROWS, MAXROWS_BIFF8, MERGEDCELLS, MSODRAWING, MSODRAWINGGROUP, MSODRAWINGSELECTION, MULBLANK, MULRK, NAME, NOTE, NUMBER, OBJ, OBJECTLINK, OBJPROTECT, OBPROJ, PALETTE, PANE, PASSWORD, PHONETIC, PICF, PIE, PIEFORMAT, PIVOTCHARTBITS, PIVOTCHARTLINK, PLOTAREA, PLOTGROWTH, PLS, PLV, POS, PRECISION, PRINT_GRIDLINES, PRINT_ROW_HEADERS, PRINTGRID, PRINTROWCOL, PROT4REV, PROTECT, QSISXTAG, RADAR, RADARAREA, RANGEPROTECTION, REFMODE, REFTRACK_PROP, RIGHT_MARGIN, RIGHTMARGIN, RK, ROW, RRD_HEAD, RRD_INFO, RSTRING, RTENTEXU, RTMERGECELLS, SBASEREF, SCATTER, SCENPROTECT, SCL, SELECTION, SERAUXERRBAR, SERAUXTREND, SERFMT, SERIES, SERIESLIST, SERIESTEXT, SERPARENT, SERTOCRT, SETUP, SHAREDUPES, SHEETLAYOUT, SHEETPROTECTION, SHRFMLA, SHTPROPS, SIIINDEX, SST, STARTBLOCK, STARTOBJECT, STRING_ENCODING_AUTO, STRING_ENCODING_COMPRESSED, STRING_ENCODING_UNICODE, STRINGREC, STYLE, SUPBOOK, SURFACE, SXADDL, SXBOOL, SXDB, SXDBB, SXDBEX, SXDI, SXEX, SXFDB, SXFDBTYPE, SXFORMAT, SXIVD, SXLI, SXNUM, SXPI, SXSTREAMID, SXSTRING, SXVD, SXVDEX, SXVI, SXVIEW, SXVIEWEX9, SXVIEWLINK, SXVS, TABID, TABLE, TABLESTYLES, TEXTDISP, THREED, TICK, TOP_MARGIN, TOPMARGIN, TXO, TYPE_BLANK, TYPE_BOOLEAN, TYPE_DOUBLE, TYPE_FORMULA, TYPE_FP, TYPE_INT, TYPE_STRING, UNICODEENCODING, UNITS, USERBVIEW, USERSVIEWBEGIN, USERSVIEWEND, USETEMPFILE_PROP, USR_EXCL, VALIDATEWORKBOOK, VALUERANGE, VB_MODULE, VCENTER, VERTICAL_PAGE_BREAKS, WINDOW_PROTECT, WINDOW1, WINDOW2, WK_CHART, WK_FILE, WK_GLOBALS, WK_MACROSHEET, WK_WORKSHEET, WSBOOL, XCT, XF, XLS_MAX_COLS, YMULT

Constructor Summary

Constructors

Constructor and Description
OOXMLChart(Chart c, WorkBookHandle wbh) create a new OOXMLChart from a 2003-v chart object

Method Summary

Modifier and Type	Method and Description
void	addChartEmbed(String[] ce) sets external information linked to or "embedded" in this OOXML chart; can be a chart user shape, an image ...
ArrayList	getChartEmbeds() returns information regarding external files associated with this chart e.g.
String	getEditMovement() return state of how to resize or move upon edit OOXML specific
StringBuffer	getOOXML(String catAxisId, String valAxisId, String serAxisId) return the OOXML representation of this chart object "c:chart" representing OOXML element in chartX.xml below is complete the ordered sequence of child elements of the chart element c:chart - parent= chartSpace title autoTitleDeleted pivotFmts view3d floor sideWall backWall plotArea (see below) legend plotVisOnly dispBlankAs showDlblsOverMax plotArea: layout chart type (see below) axes *** dTable spPr chart type: barDir Bar, Bar3d only radarStyle || scatterStyle ofPieType wireFrame surface grouping Area, Area3d, Line, Line3d, Bar, Bar3D varyColors not for Stock ser *n series dLbls not for surface Area Chart, AreaChart3D, LineChart, Line3D, Stock dropLines Bar Chart, Bar3d, ofPieChart gapWidth AreaChart3D, Line3D, Bar3D gapDepth Line, Stock hiLowLines upDownBars Line marker smooth BarChart only overlap serLines Bar 3d only shape ofPieChart splitType splitPos custSplit secondPieSize serLines Pie, Doughnut firstSliceAng Doughnut holeSize Surface bandFmts Bubble bubble3D bubbleScale showNegBubbles sizeRepresents axId
String	getOOXMLName()
Title	getOOXMLTitle() return the OOXML title element for this chart
SpPr	getSpPr(int type) return the OOXML shape property for this chart
TxPr	getTxPr() return the OOXML text formatting element for this chart, if present
void	removeLegend() remove the legend from the chart
void	setEditMovement(String editMovement) specify how to resize or move upon edit OOXML specific
void	setOOXMLName(String name) set the OOXML-specific name for this chart
void	setOOXMLTitle(Title t, WorkBookHandle wb) set the OOXML title element for this chart
void	setSpPr(int type, SpPr spPr) define the OOXML shape property for this chart from an existing spPr element
void	setTxPr(TxPr txPr) store the OOXML text formatting element for this chart
String	toString() return the textdisp object that defines the chart title

Methods inherited from class io.starter.formats.XLS.charts.Chart

addChartType, addInitialChartRecord, addSeries, assembleChartRecords, changeCategoryRange, changeSeriesRange, changeTextValue, findRec, findRecPosition, getAllChartTypes, getAllSeries, getAllSeries, getAxes, getAxisAutomaticScale, getBounds, getCategories, getChartBytes, getChartFontRecsXML, getChartFontsXML, getChartObject, getChartObject, getChartOjectParent, getChartOption, getChartOptionsXML, getChartOrder, getChartSeries, getChartType, getChartType, getCol0, getColOffset, getCoords, getDataLabel, getDataLabelsPerSeries, getDefaultFont, getFontxRecs, getHeight, getId, getLegend, getLegends, getMarkerFormats, getMaxCol, getMaxRow, getMetrics, getMinCol, getMinMax, getMinRow, getMsodrawobj, getNumberOfCharts, getObj, getPlotAreaBgColor, getPlotAreaCoords, getPlotAreaLnColor, getRow0, getSerialBytes, getSeries, getSeries, getSeriesJSON, getSeriesPtgs, getThreeDRec, getThreeDXML, getThreeDXML, getTitle, getTitleFont, getTitleTd, getXLSrecs, hasDataLegend, hasMarkers, init, initChartRecords, initThreeD, initThreeD, is100PercentStacked, is100PercentStacked, isClustered, isClustered, isStacked, isStacked, isThreeD, isThreeD, populateForTransfer, removeSeries, removeSeries, resetFonts, setBounds, setChartFont, setChartOption, setChartOption, setChartType, setCoords, setDefaultFont, setDimensions, setDimensionsRecord, setDimensionsRecord, setDirtyFlag, setHeight, setId, setMetricsDirty, setPlotAreaBgColor, setPreRecords, setRow, setSeriesJSON, setSheet, setTitle, setTitleFont, setVaryColor, showDataTable, showLegend, updateSheetRefs, writeChartRecs

Methods inherited from class io.starter.formats.XLS.charts.GenericChartObject

addChartRecord, close, getChartRecords, getOptionsXML, getParentChart, getRecordArray, getScript, hasShadow, is100Percent, setIs100Percent, setIsStacked, setParentChart

Methods inherited from class io.starter.formats.XLS.XLSRecord

addContinue, clone, copyFormat, getBooleanVal, getByteAt, getByteReader, getBytes, getBytesAt, getCellAddress, getCellAddressWithSheet, getCellType, getColNumber, getColorTable, getContinueVect, getData, getDataType, getDblVal, getDefaultVal, getEncryptedByteReader, getFirstBlock, getFloatVal, getFont, getFormatPattern, getFormulaRec, getHyperlink, getInternalVal, getIntLocation, getIntVal, getIxfe, getLastBlock, getLength, getMergeRange, getOffset, getOpcode, getPrototype, getRealRecordIndex, getRecDesc, getRecordIndex, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getStringVal, getWorkBook, getXfRec, hasContinues, initRowCol, isFormula, isNumber, isReadOnly, isValueForCell, mergeContinues, postStream, preStream, remove, removeContinues, resetCacheBytes, setBooleanVal, setByteReader, setCol, setData, setDebugLevel, setDoubleVal, setEncryptedByteReader, setFirstBlock, setFloatVal, setHyperlink, setIndex, setIntVal, setIsValueForCell, setIxfe, setLastBlock, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setRowNumber, setStreamer, setStringVal, setValueForCell, setWorkBook, setXFRecord, setXFRecord, shouldEncrypt, toHexDump

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.starter.formats.XLS.charts.ChartObject

addChartRecord, getChartRecords, getParentChart, getRecordArray, setParentChart

Field Detail

lang

public String lang

roundedCorners

public boolean roundedCorners

ttl

public Title ttl

ooxmlLegend

public Legend ooxmlLegend

plotAreaLayout

public Layout plotAreaLayout

Constructor Detail

OOXMLChart

public OOXMLChart(Chart c,
                  WorkBookHandle wbh)

create a new OOXMLChart from a 2003-v chart object

Parameters:

c -

wbh -

Method Detail

toString

public String toString()

Description copied from class: Chart

return the textdisp object that defines the chart title

Overrides:

toString in class Chart

Returns:

public TextDisp getTitleTD(){ if(title != null){ return title; } for (int i=0;i

getSpPr

public SpPr getSpPr(int type)

return the OOXML shape property for this chart

Parameters:

type - 0= chart shape props, 1=plot area shape props 2= chartspace shape props, 3= legend shape props

Returns:

setTxPr

public void setTxPr(TxPr txPr)

store the OOXML text formatting element for this chart

getTxPr

public TxPr getTxPr()

return the OOXML text formatting element for this chart, if present

Returns:

setSpPr

public void setSpPr(int type,
                    SpPr spPr)

define the OOXML shape property for this chart from an existing spPr element

Parameters:

type - 0=plot area shape props 1= chartspace shape props, 2= legend shape props

getOOXMLTitle

public Title getOOXMLTitle()

return the OOXML title element for this chart

Returns:

setOOXMLTitle

public void setOOXMLTitle(Title t,
                          WorkBookHandle wb)

set the OOXML title element for this chart

Parameters:

t -

setEditMovement

public void setEditMovement(String editMovement)

specify how to resize or move upon edit OOXML specific

Parameters:

editMovement -

getEditMovement

public String getEditMovement()

return state of how to resize or move upon edit OOXML specific

Returns:

editMovement string

removeLegend

public void removeLegend()

remove the legend from the chart

Overrides:

removeLegend in class Chart

getOOXMLName

public String getOOXMLName()

setOOXMLName

public void setOOXMLName(String name)

set the OOXML-specific name for this chart

Parameters:

name -

getChartEmbeds

public ArrayList getChartEmbeds()

returns information regarding external files associated with this chart
e.g. a chart user shape, an image

Returns:

addChartEmbed

public void addChartEmbed(String[] ce)

sets external information linked to or "embedded" in this OOXML chart; can be a chart user shape, an image ...
NOTE: a userShape is a drawingml file name which defines the userShape (if any)
a userShape is a drawing or shape ontop of a chart

Parameters:

String[] - embedType, filename e.g. {"userShape", "userShape file name"}

getOOXML

public StringBuffer getOOXML(String catAxisId,
                             String valAxisId,
                             String serAxisId)

return the OOXML representation of this chart object "c:chart" representing OOXML element in chartX.xml
below is complete the ordered sequence of child elements of the chart element
c:chart - parent= chartSpace

title autoTitleDeleted pivotFmts view3d floor sideWall backWall plotArea (see below) legend plotVisOnly dispBlankAs showDlblsOverMax
plotArea: layout chart type (see below) axes *** dTable spPr
chart type: barDir Bar, Bar3d only radarStyle || scatterStyle ofPieType wireFrame surface grouping Area, Area3d, Line, Line3d, Bar, Bar3D varyColors not for Stock ser *n series dLbls not for surface Area Chart, AreaChart3D, LineChart, Line3D, Stock dropLines Bar Chart, Bar3d, ofPieChart gapWidth AreaChart3D, Line3D, Bar3D gapDepth Line, Stock hiLowLines upDownBars Line marker smooth BarChart only overlap serLines Bar 3d only shape ofPieChart splitType splitPos custSplit secondPieSize serLines Pie, Doughnut firstSliceAng Doughnut holeSize Surface bandFmts Bubble bubble3D bubbleScale showNegBubbles sizeRepresents axId

Returns:

StringBuffer