Chart (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.XLSRecord
- - io.starter.formats.XLS.charts.GenericChartObject
  - - io.starter.formats.XLS.charts.Chart

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable

Direct Known Subclasses:

OOXMLChart
```
public class Chart
extends GenericChartObject
implements ChartObject
```
Chart: Chart Location and Dimensions 0x1002h
The Chart record determines the chart dimensions and marks the beginning of the Chart records.
```
 Note that all these values are split up 2 bytes integer and 2 bytes fractional
    
    offset  name        size    contents
    ---    
    4       x           4       x pos of upper left corner
    8       y           4       y pos of upper left corner
    12      dx          4       x-size
    16      dy          4       y-size
        
    
```
notes on implementation:
A chart may have up to 9 chart types (specific instances of a chart e.g. bar, line, etc.) known as chart groups. These are identified by the chartgroup array list.
The parent of these chart groups are the axis group.
A chart's series and trendlines contains indexes into the chart group.
See Also:

Ai, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected ChartAxes`	`chartaxes`
`protected ArrayList<ChartType>`	`chartgroup`
`protected ArrayList`	`chartRecs`
`protected ChartSeries`	`chartseries`
`protected TextDisp`	`charttitle`
`protected Ai`	`currentAi`
`protected Dimensions`	`dimensions`
`protected boolean`	`dirtyflag`
`protected int`	`hierarchyDepth`
`protected ArrayList`	`initobs`
`protected boolean`	`metricsDirty`
`protected MSODrawing`	`msodrawobj`
`protected int`	`nCharts`
`protected Obj`	`obj`
`protected AbstractList`	`postRecs`
`protected AbstractList`	`preRecs`
`WorkBookHandle`	`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

Chart()

Constructors
Constructor and Description
`Chart()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addChartType(ChartType ct, int nChart)` adds a new Chart Type to the group of Chart Type Objects, or replaces one at existing index
`boolean`	`addInitialChartRecord(BiffRec br)` Adds chart records to the chartRecs array.
`Series`	`addSeries(String seriesRange, String categoryRange, String bubbleRange, String legendRange, String legendText, int nChart)` Add a series object to the array.
`List`	`assembleChartRecords()` put together the chart records for output to the streamer
`boolean`	`changeCategoryRange(String originalrange, String newrange)`
`boolean`	`changeSeriesRange(String originalrange, String newrange)` Change series ranges for ALL matching series
`boolean`	`changeTextValue(String originalval, String newval)`
`static BiffRec`	`findRec(ArrayList chartArr, Class c)` generic method to find a specific record in the list of recs in chartarr
`static int`	`findRecPosition(ArrayList chartArr, Class c)` generic method to find a specific record in the list of recs in chartArr
`int[]`	`getAllChartTypes()` returns an array of all chart types found in this chart 0= default, 1-9 (max) are overlay charts
`Vector`	`getAllSeries()` get all the series objects for ALL charts (i.e.
`Vector`	`getAllSeries(int nChart)` get all the series objects in the specified chart (-1 for ALL)
`ChartAxes`	`getAxes()` Return the Chart Axes object
`boolean`	`getAxisAutomaticScale()` Returns true if the Y Axis (Value axis) is set to automatic scale
`short[]`	`getBounds()` return bounds relative to row/cols including their respective offsets
`String[]`	`getCategories(int nChart)` Return an array of strings, one for each category
`byte[]`	`getChartBytes()` Returns a serialized copy of this Chart
`String`	`getChartFontRecsXML()` Return all the Chart-specific font recs in XML form These include the default fonts + title font + axis fonts ...
`String`	`getChartFontsXML()` return the fontid for non-axis chart fonts (title, default ...)
`ChartType`	`getChartObject()` return the default Chart Object associated with this chart
`ChartType`	`getChartObject(int nChart)` return the nth Chart Object associated with this chart (default=0, overlay=1 thru 9)
`protected ChartFormat`	`getChartOjectParent(int nChart)` retrieves the parent of the chart type object (==ChartFormat) at index nChart, or creates a new Chart Type Parent
`String`	`getChartOption(String op)` get the value of almost any chart option (axis options are in Axis) for the default chart
`String`	`getChartOptionsXML(int nChart)` return chart-type-specific options in XML form
`int`	`getChartOrder(ChartType ct)` gets the integral order of the specific chart obect in question
`ChartSeries`	`getChartSeries()` return the Chart Series object
`int`	`getChartType()` returns the chart type for the default chart
`int`	`getChartType(int nChart)` returns the chart type for the desired chart
`int`	`getCol0()` return the left col of the chart
`short`	`getColOffset()` returns the offset within the column in pixels
`short[]`	`getCoords()` return int[4] representing the coordinates (L, T, W, H) of this chart in pixels
`protected int`	`getDataLabel()` return the default data label setting for the chart, if any NOTE: each series can override the default data label fo the chart can be one or more of: VALUELABEL= 0x1; VALUEPERCENT= 0x2; CATEGORYPERCENT= 0x4; CATEGORYLABEL= 0x10; BUBBLELABEL= 0x20; SERIESLABEL= 0x40;
`protected int[]`	`getDataLabelsPerSeries(int defaultDL)` return data label options for each series as an int array each can be one or more of: VALUELABEL= 0x1; VALUEPERCENT= 0x2; CATEGORYPERCENT= 0x4; CATEGORYLABEL= 0x10; BUBBLELABEL= 0x20; SERIESLABEL= 0x40;
`Font`	`getDefaultFont()` return the default font for the chart
`ArrayList`	`getFontxRecs()` Get all of the Fontx records in this chart.
`int`	`getHeight()` return the height of this chart
`int`	`getId()` returns the unique Obj Id # of this chart as seen in Vb macros et.
`Legend`	`getLegend()` return the Data Legend for this chart, if any
`String[]`	`getLegends(int nChart)` return an array of legend text
`protected int[]`	`getMarkerFormats(int nChart)` return an array of the type of markers for each series: 0 = no marker 1 = square 2 = diamond 3 = triangle 4 = X 5 = star 6 = Dow-Jones 7 = standard deviation 8 = circle 9 = plus sign
`int`	`getMaxCol()`
`int`	`getMaxRow()`
`HashMap`	`getMetrics(WorkBookHandle wbh)`
`int`	`getMinCol()`
`double[]`	`getMinMax(WorkBookHandle wbh)` returns the minimum and maximum values by examining all series on the chart
`int`	`getMinRow()` Dimensions rec holds the datarange for the chart; must update ...
`MSODrawing`	`getMsodrawobj()`
`int`	`getNumberOfCharts()` returns the number of charts in this chart - 1= default, can have up to 9 overlay charts as well
`Obj`	`getObj()`
`String`	`getPlotAreaBgColor()` returns the plot area background color string (hex)
`float[]`	`getPlotAreaCoords(float w, float h)` return the coordinates of the outer plot area (plot + axes + labels) in pixels
`String`	`getPlotAreaLnColor()` returns the plot area line color string (hex)
`int`	`getRow0()` return the top row of the chart
`byte[]`	`getSerialBytes()`
`String[]`	`getSeries(int nChart)` Return a string representing all series in this chart
`Series`	`getSeries(String seriesName, int nChart)` get a chart series handle based off the series name
`org.json.JSONArray`	`getSeriesJSON()` retrieve the current Series JSON for comparisons
`HashMap`	`getSeriesPtgs()` Returns a map of series ==> series ptgs Ranges can either be in the format "C5" or "Sheet1!C4:D9"
`ThreeD`	`getThreeDRec(int nChart)` return the 3d rec for this chart or null if it doesn't exist
`String`	`getThreeDXML()` return ThreeD settings for this chart in XML form
`String`	`getThreeDXML(int nChart)` return ThreeD settings for this chart in XML form
`String`	`getTitle()` Get the title of the Chart
`Font`	`getTitleFont()` return the font associated with the chart title
`TextDisp`	`getTitleTd()` return the title TextDisp element
`List`	`getXLSrecs()` Gets the records for the chart, including the global references, ie the MSODrawing and Obj records
`boolean`	`hasDataLegend()` return truth if Chart has a data legend key showing
`boolean`	`hasMarkers(int nChart)` returns true if this chart has data markers (line, scatter and radar charts only)
`void`	`init()` perform record initialization
`void`	`initChartRecords()` Take the initial array of records for the chart, and create a hierarchial array of objects for the chart.
`ThreeD`	`initThreeD()` returns the 3d record of the desired chart
`ThreeD`	`initThreeD(int nChart, int chartType)` returns the 3d record of the desired chart
`boolean`	`is100PercentStacked()` return truth of "Chart is 100% Stacked"
`boolean`	`is100PercentStacked(int nChart)` return truth of "Chart is 100% Stacked"
`boolean`	`isClustered()`
`boolean`	`isClustered(int nChart)`
`boolean`	`isStacked()`
`boolean`	`isStacked(int nChart)`
`boolean`	`isThreeD()`
`boolean`	`isThreeD(int nChart)`
`void`	`populateForTransfer()` Utilized by external chart copy, this sets references internally in this chart which allows cross-workbook identification of worksheets to occur.
`void`	`removeLegend()` remove the legend from the chart
`void`	`removeSeries(int index)` specialty method to take absoulte index of series and remove it only used in WorkSheetHandle
`void`	`removeSeries(Series seriestodelete)` remove desired series from chart
`void`	`resetFonts()` resets all fonts in the chart to the default font of the workbook Useful for OOXML charts which are based upon default chart
`void`	`setBounds(short[] bounds)` set the bounds relative to row/col and their offsets into them
`void`	`setChartFont(String type, String val)` Set the specific chart font (title, default ...) NOTE: Axis fonts are handled separately
`boolean`	`setChartOption(String op, String val)` interface for setting chart-type-specific options in a generic fashion
`boolean`	`setChartOption(String op, String val, int nChart)` interface for setting chart-type-specific options in a generic fashion
`void`	`setChartType(int chartType, int nChart, EnumSet<ChartHandle.ChartOptions> options)` changes this chart to be a specific chart type with specific display options for multiple charts, specify nChart 1-9, for the default chart, nChart= 0
`void`	`setCoords(short[] coords)` set the coordinates of ths chart in pixels
`void`	`setDefaultFont(int type, int fontId)` Set the default font for the specific DefaultText rec
`void`	`setDimensions(Dimensions d)`
`void`	`setDimensionsRecord()`
`void`	`setDimensionsRecord(int r0, int r1, int c0, int c1)`
`void`	`setDirtyFlag(boolean b)`
`void`	`setHeight(int h)` set the height of this chart
`void`	`setId(int id)` sets the unique id # for this chart used upon addChart
`void`	`setMetricsDirty()` flags chart metrics should to be recalculated
`void`	`setPlotAreaBgColor(int bg)` sets the plot area background color
`void`	`setPreRecords(AbstractList recs)` This handles setting the records external to, but supporting the chart object hierarchy.
`void`	`setRow(int r)` set the top row for this chart
`void`	`setSeriesJSON(org.json.JSONArray s)` set the current Series JSON
`void`	`setSheet(Sheet b)` set the sheet for this chart plus its subrecords as well
`void`	`setTitle(String str)` Set the title of the Chart
`void`	`setTitleFont(int fontId)` set the fontId for the chart title rec
`void`	`setVaryColor(boolean vary, int nChart)` sets bar colors to vary or not
`void`	`showDataTable(boolean bShow)` Show or remove Data Table for Chart NOTE: METHOD IS STILL EXPERIMENTAL
`void`	`showLegend(boolean bShow, boolean vertical)` show or hide chart legend key
`String`	`toString()` return the textdisp object that defines the chart title
`void`	`updateSheetRefs(String newSheetName, String origWorkBook)` update Sheet References contained in associated Series/Category Ai's using saved Original Sheet References
`void`	`writeChartRecs(String fName)`

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
  - chartgroup
```
protected ArrayList<ChartType> chartgroup
```
  - nCharts
```
protected int nCharts
```
  - chartaxes
```
protected ChartAxes chartaxes
```
  - chartseries
```
protected ChartSeries chartseries
```
  - charttitle
```
protected TextDisp charttitle
```
  - dimensions
```
protected Dimensions dimensions
```
  - obj
```
protected Obj obj
```
  - msodrawobj
```
protected MSODrawing msodrawobj
```
  - wbh
```
public transient WorkBookHandle wbh
```
  - chartRecs
```
protected ArrayList chartRecs
```
  - preRecs
```
protected AbstractList preRecs
```
  - postRecs
```
protected AbstractList postRecs
```
  - dirtyflag
```
protected boolean dirtyflag
```
  - metricsDirty
```
protected boolean metricsDirty
```
  - currentAi
```
protected Ai currentAi
```
  - hierarchyDepth
```
protected int hierarchyDepth
```
  - initobs
```
protected ArrayList initobs
```
- Constructor Detail
  - Chart
```
public Chart()
```
- Method Detail
  - init
```
public void init()
```
    Description copied from class: XLSRecord
    
    perform record initialization
    
    Specified by:
    
    init in interface BiffRec
    
    Overrides:
    
    init in class XLSRecord
  - addInitialChartRecord
```
public boolean addInitialChartRecord(BiffRec br)
```
    Adds chart records to the chartRecs array. This array should be completed with all chart records before the initChartRecords method is called, creating the hierarchical chart structure.
    
    Parameters:
    
    br - - a chart record
    
    Returns:
    
    false if we reach the final "end" record, signifying the end of the chart object structure. Be aware that there can be additional chart records after this structure, Chart only deals with it's own heirarchy.
  - setDirtyFlag
```
public void setDirtyFlag(boolean b)
```
  - initChartRecords
```
public void initChartRecords()
```
    Take the initial array of records for the chart, and create a hierarchial array of objects for the chart. Also, populate initial values for easy access.
  - assembleChartRecords
```
public List assembleChartRecords()
```
    put together the chart records for output to the streamer
    
    Returns:
    
    arranged List of Chart Records.
  - setPreRecords
```
public void setPreRecords(AbstractList recs)
```
    This handles setting the records external to, but supporting the chart object hierarchy. Think of this kind of like the recvec & cell records in the XLS parsing we do. We have a pre and post array of biffrecs that are (for now) unmodifieable. These get appended into the whole array on ouput in append chart records.
    
    Parameters:
    
    recs -
  - getSeriesPtgs
```
public HashMap getSeriesPtgs()
```
    Returns a map of series ==> series ptgs Ranges can either be in the format "C5" or "Sheet1!C4:D9"
  - getChartBytes
```
public byte[] getChartBytes()
```
    Returns a serialized copy of this Chart
  - getSerialBytes
```
public byte[] getSerialBytes()
```
  - getXLSrecs
```
public List getXLSrecs()
```
    Gets the records for the chart, including the global references, ie the MSODrawing and Obj records
    
    Returns:
  - getMinRow
```
public int getMinRow()
```
    Dimensions rec holds the datarange for the chart; must update ...
    
    Returns:
  - getMaxRow
```
public int getMaxRow()
```
  - getMinCol
```
public int getMinCol()
```
  - getMaxCol
```
public int getMaxCol()
```
  - setDimensionsRecord
```
public void setDimensionsRecord(int r0,
                                int r1,
                                int c0,
                                int c1)
```
  - setDimensions
```
public void setDimensions(Dimensions d)
```
  - setDimensionsRecord
```
public void setDimensionsRecord()
```
  - getId
```
public int getId()
```
    returns the unique Obj Id # of this chart as seen in Vb macros et. al
    
    Returns:
    
    in id #
  - setId
```
public void setId(int id)
```
    sets the unique id # for this chart used upon addChart
    
    Parameters:
    
    id -
  - setMetricsDirty
```
public void setMetricsDirty()
```
    flags chart metrics should to be recalculated
  - changeSeriesRange
```
public boolean changeSeriesRange(String originalrange,
                                 String newrange)
```
    Change series ranges for ALL matching series
    
    Parameters:
    
    originalrange -
    
    newrange -
    
    Returns:
  - getSeries
```
public String[] getSeries(int nChart)
```
    Return a string representing all series in this chart
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts -1 for ALL charts
    
    Returns:
  - getCategories
```
public String[] getCategories(int nChart)
```
    Return an array of strings, one for each category
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts -1 for All
    
    Returns:
  - getAllSeries
```
public Vector getAllSeries()
```
    get all the series objects for ALL charts (i.e. even in overlay charts)
    
    Returns:
  - getAllSeries
```
public Vector getAllSeries(int nChart)
```
    get all the series objects in the specified chart (-1 for ALL)
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts -1 for ALL series
    
    Returns:
  - addSeries
```
public Series addSeries(String seriesRange,
                        String categoryRange,
                        String bubbleRange,
                        String legendRange,
                        String legendText,
                        int nChart)
```
    Add a series object to the array.
    
    Parameters:
    
    seriesRange - = one row range, expressed as (Sheet1!A1:A12);
    
    categoryRange - = category range
    
    bubbleRange= - bubble range, if any 20070731 KSC
    
    seriesText - = label for the series;
    
    nChart - 0=default, 1-9= overlay charts s * @return
  - getLegends
```
public String[] getLegends(int nChart)
```
    return an array of legend text
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts -1 for ALL
  - removeSeries
```
public void removeSeries(int index)
```
    specialty method to take absoulte index of series and remove it
    only used in WorkSheetHandle
    
    Parameters:
    
    index -
  - removeSeries
```
public void removeSeries(Series seriestodelete)
```
    remove desired series from chart
    
    Parameters:
    
    index -
  - getSeries
```
public Series getSeries(String seriesName,
                        int nChart)
```
    get a chart series handle based off the series name
    
    Parameters:
    
    seriesName -
    
    nChart - 0=default, 1-9= overlay charts
    
    Returns:
  - changeCategoryRange
```
public boolean changeCategoryRange(String originalrange,
                                   String newrange)
```
    Parameters:
    
    originalrange -
    
    newrange -
    
    Returns:
  - changeTextValue
```
public boolean changeTextValue(String originalval,
                               String newval)
```
  - getPlotAreaBgColor
```
public String getPlotAreaBgColor()
```
    returns the plot area background color string (hex)
    
    Returns:
    
    color string
  - setPlotAreaBgColor
```
public void setPlotAreaBgColor(int bg)
```
    sets the plot area background color
    
    Parameters:
    
    bg - color int
  - getPlotAreaLnColor
```
public String getPlotAreaLnColor()
```
    returns the plot area line color string (hex)
    
    Returns:
    
    color string
  - getTitle
```
public String getTitle()
```
    Get the title of the Chart
    
    Returns:
    
    title of the Chart
  - getTitleTd
```
public TextDisp getTitleTd()
```
    return the title TextDisp element
    
    Returns:
  - toString
```
public String toString()
```
    return the textdisp object that defines the chart title
    
    Overrides:
    
    toString in class XLSRecord
    
    Returns:
    
    public TextDisp getTitleTD(){ if(title != null){ return title; } for (int i=0;i
  - getDefaultFont
```
public Font getDefaultFont()
```
    return the default font for the chart
    
    Returns:
  - setDefaultFont
```
public void setDefaultFont(int type,
                           int fontId)
```
    Set the default font for the specific DefaultText rec
    
    Parameters:
    
    type -
    
    fontId -
  - getFontxRecs
```
public ArrayList getFontxRecs()
```
    Get all of the Fontx records in this chart. Utilized for updating font references when moving between workbooks
  - resetFonts
```
public void resetFonts()
```
    resets all fonts in the chart to the default font of the workbook Useful for OOXML charts which are based upon default chart
  - getTitleFont
```
public Font getTitleFont()
```
    return the font associated with the chart title
    
    Returns:
    
    Font
  - populateForTransfer
```
public void populateForTransfer()
```
    Utilized by external chart copy, this sets references internally in this chart which allows cross-workbook identification of worksheets to occur.
  - updateSheetRefs
```
public void updateSheetRefs(String newSheetName,
                            String origWorkBook)
```
    update Sheet References contained in associated Series/Category Ai's using saved Original Sheet References
  - setTitle
```
public void setTitle(String str)
```
    Set the title of the Chart
    
    Parameters:
    
    str - title of the Chart
  - getChartType
```
public int getChartType()
```
    returns the chart type for the default chart
  - getChartType
```
public int getChartType(int nChart)
```
    returns the chart type for the desired chart
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts
    
    Returns:
  - getAllChartTypes
```
public int[] getAllChartTypes()
```
    returns an array of all chart types found in this chart 0= default, 1-9 (max) are overlay charts
    
    Returns:
  - getNumberOfCharts
```
public int getNumberOfCharts()
```
    returns the number of charts in this chart - 1= default, can have up to 9 overlay charts as well
    
    Returns:
  - getChartObject
```
public ChartType getChartObject()
```
    return the default Chart Object associated with this chart
    
    Returns:
  - getChartObject
```
public ChartType getChartObject(int nChart)
```
    return the nth Chart Object associated with this chart (default=0, overlay=1 thru 9)
    
    Returns:
  - getChartOrder
```
public int getChartOrder(ChartType ct)
```
    gets the integral order of the specific chart obect in question
    
    Parameters:
    
    ct - Chart Type rwobject
    
    Returns:
  - addChartType
```
protected void addChartType(ChartType ct,
                            int nChart)
```
    adds a new Chart Type to the group of Chart Type Objects, or replaces one at existing index
    
    Parameters:
    
    ct - Chart Type Object
    
    nChart - index
  - getChartOjectParent
```
protected ChartFormat getChartOjectParent(int nChart)
```
    retrieves the parent of the chart type object (==ChartFormat) at index nChart, or creates a new Chart Type Parent
    
    Parameters:
    
    nChart -
    
    Returns:
    
    ChartFormat
  - setChartType
```
public void setChartType(int chartType,
                         int nChart,
                         EnumSet<ChartHandle.ChartOptions> options)
```
    changes this chart to be a specific chart type with specific display options
    for multiple charts, specify nChart 1-9, for the default chart, nChart= 0
    
    Parameters:
    
    chartType - chart type one of: BARCHART, LINECHART, AREACHART, COLCHART, PIECHART, DONUGHTCHART, RADARCHART, RADARAREACHART, PYRAMIDCHART, CONECHART, CYLINDERCHART, SURFACTCHART
    
    nChart - chart # 0 is default
    
    EnumSet - 0 or more chart options (Such as Stacked, Exploded ...)
    
    See Also:
    
    ChartHandle.ChartOptions
  - isThreeD
```
public boolean isThreeD()
```
    Returns:
    
    truth of "Chart is Three-D"
  - isThreeD
```
public boolean isThreeD(int nChart)
```
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts
    
    Returns:
    
    truth of "Chart is Three-D"
  - getThreeDRec
```
public ThreeD getThreeDRec(int nChart)
```
    return the 3d rec for this chart or null if it doesn't exist
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts
    
    Returns:
  - isStacked
```
public boolean isStacked()
```
    Overrides:
    
    isStacked in class GenericChartObject
    
    Returns:
    
    truth of "Chart is Stacked"
  - isStacked
```
public boolean isStacked(int nChart)
```
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts
    
    Returns:
    
    truth of "Chart is Stacked"
  - is100PercentStacked
```
public boolean is100PercentStacked()
```
    return truth of "Chart is 100% Stacked"
    
    Returns:
  - is100PercentStacked
```
public boolean is100PercentStacked(int nChart)
```
    return truth of "Chart is 100% Stacked"
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts
    
    Returns:
  - isClustered
```
public boolean isClustered()
```
    Returns:
    
    truth of "Chart is Clustered" (Bar/Col only)
  - isClustered
```
public boolean isClustered(int nChart)
```
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts
    
    Returns:
    
    truth of "Chart is Clustered" (Bar/Col only)
  - getChartOptionsXML
```
public String getChartOptionsXML(int nChart)
```
    return chart-type-specific options in XML form
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts
    
    Returns:
    
    String XML
  - setChartOption
```
public boolean setChartOption(String op,
                              String val)
```
    interface for setting chart-type-specific options in a generic fashion
    
    Overrides:
    
    setChartOption in class GenericChartObject
    
    Parameters:
    
    op - option
    
    val - value
    
    See Also:
    
    OpenXLS.handleChartElement, ChartHandle.getXML
  - setChartOption
```
public boolean setChartOption(String op,
                              String val,
                              int nChart)
```
    interface for setting chart-type-specific options in a generic fashion
    
    Parameters:
    
    op - option
    
    val - value
    
    nChart - 0=default, 1-9= overlay charts
    
    See Also:
    
    OpenXLS.handleChartElement, ChartHandle.getXML
  - getChartOption
```
public String getChartOption(String op)
```
    get the value of *almost* any chart option (axis options are in Axis) for the default chart
    
    Overrides:
    
    getChartOption in class GenericChartObject
    
    Parameters:
    
    op - String option e.g. Shadow or Percentage
    
    Returns:
    
    String value of option
  - getThreeDXML
```
public String getThreeDXML()
```
    return ThreeD settings for this chart in XML form
    
    Returns:
    
    String XML
  - getThreeDXML
```
public String getThreeDXML(int nChart)
```
    return ThreeD settings for this chart in XML form
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts
    
    Returns:
    
    String XML
  - initThreeD
```
public ThreeD initThreeD()
```
    returns the 3d record of the desired chart
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts
    
    Returns:
  - initThreeD
```
public ThreeD initThreeD(int nChart,
                         int chartType)
```
    returns the 3d record of the desired chart
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts
    
    chartType - one of the chart type constants
    
    Returns:
  - getAxes
```
public ChartAxes getAxes()
```
    Return the Chart Axes object
    
    Returns:
    
    ChartAxis
  - getChartSeries
```
public ChartSeries getChartSeries()
```
    return the Chart Series object
    
    Returns:
  - getAxisAutomaticScale
```
public boolean getAxisAutomaticScale()
```
    Returns true if the Y Axis (Value axis) is set to automatic scale
    The default setting for charts is known as Automatic Scaling
    When data changes, the chart automatically adjusts the scale (minimum, maximum values plus major and minor tick units) as necessary
    
    Returns:
    
    boolean true if Automatic Scaling is turned on
    
    See Also:
    
    getAxisAutomaticScale(int axisType)
  - getMinMax
```
public double[] getMinMax(WorkBookHandle wbh)
```
    returns the minimum and maximum values by examining all series on the chart
    
    Parameters:
    
    bk -
    
    Returns:
    
    double[] min, max
  - getChartFontRecsXML
```
public String getChartFontRecsXML()
```
    Return all the Chart-specific font recs in XML form These include the default fonts + title font + axis fonts ...
    
    Returns:
  - getChartFontsXML
```
public String getChartFontsXML()
```
    return the fontid for non-axis chart fonts (title, default ...)
    
    Returns:
  - setChartFont
```
public void setChartFont(String type,
                         String val)
```
    Set the specific chart font (title, default ...) NOTE: Axis fonts are handled separately
    
    Parameters:
    
    type -
    
    val -
    
    See Also:
    
    Axis.setChartOption, TextDisp.setChartOption
  - setTitleFont
```
public void setTitleFont(int fontId)
```
    set the fontId for the chart title rec
    
    Parameters:
    
    fontId -
  - writeChartRecs
```
public void writeChartRecs(String fName)
```
  - setSheet
```
public void setSheet(Sheet b)
```
    set the sheet for this chart plus its subrecords as well
    
    Specified by:
    
    setSheet in interface BiffRec
    
    Overrides:
    
    setSheet in class XLSRecord
  - getCoords
```
public short[] getCoords()
```
    return int[4] representing the coordinates (L, T, W, H) of this chart in pixels
    
    Returns:
    
    int[4] bounds
  - getPlotAreaCoords
```
public float[] getPlotAreaCoords(float w,
                                 float h)
```
    return the coordinates of the outer plot area (plot + axes + labels) in pixels
    
    Returns:
  - setCoords
```
public void setCoords(short[] coords)
```
    set the coordinates of ths chart in pixels
    
    Parameters:
    
    coords - int[4]: L, T, W, H
  - getBounds
```
public short[] getBounds()
```
    return bounds relative to row/cols including their respective offsets
    
    Returns:
  - getColOffset
```
public short getColOffset()
```
    returns the offset within the column in pixels
    
    Returns:
  - setBounds
```
public void setBounds(short[] bounds)
```
    set the bounds relative to row/col and their offsets into them
    
    Parameters:
    
    bounds - short[]
  - getRow0
```
public int getRow0()
```
    return the top row of the chart
  - setRow
```
public void setRow(int r)
```
    set the top row for this chart
    
    Parameters:
    
    r -
  - getCol0
```
public int getCol0()
```
    return the left col of the chart
  - getHeight
```
public int getHeight()
```
    return the height of this chart
  - setHeight
```
public void setHeight(int h)
```
    set the height of this chart
    
    Parameters:
    
    h -
  - getSeriesJSON
```
public org.json.JSONArray getSeriesJSON()
```
    retrieve the current Series JSON for comparisons
    
    Returns:
    
    JSONArray
  - setSeriesJSON
```
public void setSeriesJSON(org.json.JSONArray s)
                   throws org.json.JSONException
```
    set the current Series JSON
    
    Parameters:
    
    s - JSONArray
    
    Throws:
    
    org.json.JSONException
  - showDataTable
```
public void showDataTable(boolean bShow)
```
    Show or remove Data Table for Chart NOTE: METHOD IS STILL EXPERIMENTAL
    
    Parameters:
    
    bShow -
  - showLegend
```
public void showLegend(boolean bShow,
                       boolean vertical)
```
    show or hide chart legend key
    
    Parameters:
    
    bShow - boolean show or hide
    
    vertical - boolean show as vertical or horizontal
  - removeLegend
```
public void removeLegend()
```
    remove the legend from the chart
  - getLegend
```
public Legend getLegend()
```
    return the Data Legend for this chart, if any
    
    Returns:
  - getDataLabel
```
protected int getDataLabel()
```
    return the default data label setting for the chart, if any
    NOTE: each series can override the default data label fo the chart
    can be one or more of:
    VALUELABEL= 0x1;
    VALUEPERCENT= 0x2;
    CATEGORYPERCENT= 0x4;
    CATEGORYLABEL= 0x10;
    BUBBLELABEL= 0x20;
    SERIESLABEL= 0x40;
    
    Returns:
    
    int default data label for chart
  - getDataLabelsPerSeries
```
protected int[] getDataLabelsPerSeries(int defaultDL)
```
    return data label options for each series as an int array
    each can be one or more of:
    VALUELABEL= 0x1;
    VALUEPERCENT= 0x2;
    CATEGORYPERCENT= 0x4;
    CATEGORYLABEL= 0x10;
    BUBBLELABEL= 0x20;
    SERIESLABEL= 0x40;
    
    Returns:
    
    int array
    
    See Also:
    
    AttachedLabel
  - getMarkerFormats
```
protected int[] getMarkerFormats(int nChart)
```
    return an array of the type of markers for each series:
    0 = no marker
    1 = square
    2 = diamond
    3 = triangle
    4 = X
    5 = star
    6 = Dow-Jones
    7 = standard deviation
    8 = circle
    9 = plus sign
  - hasMarkers
```
public boolean hasMarkers(int nChart)
```
    returns true if this chart has data markers (line, scatter and radar charts only)
    
    Returns:
  - hasDataLegend
```
public boolean hasDataLegend()
```
    return truth if Chart has a data legend key showing
    
    Returns:
  - getMsodrawobj
```
public MSODrawing getMsodrawobj()
```
  - getObj
```
public Obj getObj()
```
  - setVaryColor
```
public void setVaryColor(boolean vary,
                         int nChart)
```
    sets bar colors to vary or not
    
    Parameters:
    
    vary -
    
    nChart -
  - findRec
```
public static BiffRec findRec(ArrayList chartArr,
                              Class c)
```
    generic method to find a specific record in the list of recs in chartarr
    
    Parameters:
    
    chartArr -
    
    c - class of record to find
    
    Returns:
    
    biffrec or null
  - findRecPosition
```
public static int findRecPosition(ArrayList chartArr,
                                  Class c)
```
    generic method to find a specific record in the list of recs in chartArr
    
    Parameters:
    
    c - class of record to find
    
    Returns:
    
    position of record
  - getMetrics
```
public HashMap getMetrics(WorkBookHandle wbh)
```

Class Chart

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

chartgroup

nCharts

chartaxes

chartseries

charttitle

dimensions

obj

msodrawobj

wbh

chartRecs

preRecs

postRecs

dirtyflag

metricsDirty

currentAi

hierarchyDepth

initobs

Constructor Detail

Chart

Method Detail

init

addInitialChartRecord

setDirtyFlag

initChartRecords

assembleChartRecords

setPreRecords

getSeriesPtgs

getChartBytes

getSerialBytes

getXLSrecs

getMinRow

getMaxRow

getMinCol

getMaxCol

setDimensionsRecord

setDimensions

setDimensionsRecord

getId

setId

setMetricsDirty

changeSeriesRange

getSeries

getCategories

getAllSeries

getAllSeries

addSeries

getLegends

removeSeries

removeSeries

getSeries

changeCategoryRange

changeTextValue

getPlotAreaBgColor

setPlotAreaBgColor

getPlotAreaLnColor

getTitle

getTitleTd

toString

getDefaultFont

setDefaultFont

getFontxRecs

resetFonts

getTitleFont

populateForTransfer

updateSheetRefs

setTitle

getChartType