public final class Series extends GenericChartObject implements ChartObject
| Modifier and Type | Field and Description |
|---|---|
static int[] |
automaticSeriesColors |
protected int |
cValx |
protected int |
cValy |
protected int |
sdtBSz |
protected int |
sdtValBSz |
protected int |
sdtX |
protected int |
sdtY |
static int |
SERIES_TYPE_NUMERIC |
static int |
SERIES_TYPE_STRING |
chartArr, chartType, parentChartcol, continues, DEBUGLEVEL, hyperlink, idx, isBlank, isBoolean, isContinueMerged, isString, lastidx, myxf, offset, rw, streamer, wkbook, worksheetAREACHART, 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, ZAXISAI, 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 and Description |
|---|
Series() |
| Modifier and Type | Method and Description |
|---|---|
void |
addDpt(DPt d)
add a dPt element (data point) for this series
|
protected int |
getBubbleCount() |
StringBuffer |
getBubbleOOXML(boolean isBubble3d)
returns the bubbleSize OOXML element that defines the values for the series values
|
Ai |
getBubbleValueAi() |
protected int |
getCategoryCount() |
int |
getCategoryDataType() |
String |
getCategoryFormatPattern()
return the String representation of the numeric format pattern for the Catgeory axis
|
Ai |
getCategoryValueAi()
Returns the category value AI associated with this series.
|
StringBuffer |
getCatOOXML(String cat,
String catstr)
return the cat OOXML element used to define a series category
|
int |
getDataLabel()
return data label options as an int
can be one or more of: SHOWVALUE= 0x1; SHOWVALUEPERCENT= 0x2; SHOWCATEGORYPERCENT= 0x4; SMOOTHEDLINE= 0x8; SHOWCATEGORYLABEL= 0x10; SHOWBUBBLELABEL= 0x20; SHOWSERIESLABEL= 0x40; |
int[] |
getDataLabelsPIE(int defaultdl)
PIE data label information is contained within the 1st series only
TODO: not implemented yet return data label options as an int can be one or more of: SHOWVALUE= 0x1; SHOWVALUEPERCENT= 0x2; SHOWCATEGORYPERCENT= 0x4; SMOOTHEDLINE= 0x8; SHOWCATEGORYLABEL= 0x10; SHOWBUBBLELABEL= 0x20; SHOWSERIESLABEL= 0x40; |
DLbls |
getDLbls()
return the OOXML dLbls (data labels) properties for this series
|
DPt[] |
getDPt()
return OOXML dPt (data points) for this series
|
boolean |
getHasSmoothedLines()
returns true if this series has smoothed lines
|
Ai |
getLegendAi()
Returns the legend value Ai associated with this series
|
StringBuffer |
getLegendOOXML(boolean from2003)
returns the bubbleSize OOXML element that defines the values for the series values
|
String |
getLegendRef()
return the legend cell reference
|
protected SeriesText |
getLegendSeriesText()
Return the SeriesText object related to the Legend
|
String |
getLegendText()
get legend text
|
Marker |
getMarker()
return the OOXML marker properties for this series
|
int |
getMarkerFormat()
return 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 |
String |
getPieSliceColor(int slice)
get the pie slice color in this pie chart
|
static XLSRecord |
getPrototype() |
protected static Series |
getPrototype(String seriesRange,
String categoryRange,
String bubbleRange,
String legendRange,
String legendText,
ChartType chartobj)
Create a series with all sub components.
|
String |
getSeriesColor()
retrieve the series/bar color for this series
NOTE: for Pie Charts, must use getPieSliceColor
|
String |
getSeriesFormatPattern()
return the String representation of the numeric format pattern for the series (values) axis
|
protected int |
getSeriesIndex()
Get the series index (file relative)
|
protected int |
getSeriesNumber()
Get the series Number (display)
|
Ai |
getSeriesValueAi()
Returns the series value AI associated with this series.
|
int |
getShape()
returns the shape of the data point for this series
|
SpPr |
getSpPr()
return the OOXML shape property for this series
|
StringBuffer |
getValOOXML(String valstr)
returns the val OOXML element that defines the values for the series values
|
protected int |
getValueCount() |
int |
getValueDataType() |
boolean |
hasBubbleSizes() |
void |
init()
perform record initialization
|
void |
setBubbleCount(int i) |
void |
setCategoryCount(int i) |
void |
setCategoryDataType(int i) |
void |
setColor(int clr)
sets the color for this series
NOTE: for PIE Charts, use setPieSliceColor
|
void |
setColor(String clr)
sets the color for this series
NOTE: for PIE Charts, use setPieSliceColor
|
void |
setDLbls(DLbls d)
set the OOXML dLbls (data labels) properties for this series
|
void |
setHasLines(int lineStyle)
sets this series to have lines
Style of line (0= solid, 1= dash, 2= dot, 3= dash-dot,4= dash dash-dot, 5= none, 6= dk gray pattern, 7= med. |
void |
setHasSmoothLines(boolean smooth)
set smooth lines setting (applicable for line, scatter charts)
|
void |
setLegend(String newLegend,
WorkBookHandle wbh)
sets the legend for this series to a text value
|
void |
setLegendRef(String newLegendCell)
set legend to a cell ref.
|
void |
setMarker(Marker m)
set the OOXML marker properties for this series
|
void |
setPieSliceColor(int clr,
int slice)
sets the color of the desired pie slice
|
void |
setPieSliceColor(String clr,
int slice)
sets the color of the desired pie slice
|
void |
setShape(int shape) |
void |
setSpPr(SpPr sp)
set the OOXML shape properties for this series
|
void |
setValueCount(int i) |
void |
setValueDataType(int i) |
void |
update() |
addChartRecord, close, getChartOption, getChartRecords, getOptionsXML, getParentChart, getRecordArray, getScript, hasShadow, is100Percent, isStacked, setChartOption, setIs100Percent, setIsStacked, setParentChartaddContinue, 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, 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, setSheet, setStreamer, setStringVal, setValueForCell, setWorkBook, setXFRecord, setXFRecord, shouldEncrypt, toHexDump, toStringequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddChartRecord, getChartRecords, getParentChart, getRecordArray, setParentChartpublic static int SERIES_TYPE_NUMERIC
public static int SERIES_TYPE_STRING
protected int sdtX
protected int sdtY
protected int cValx
protected int cValy
protected int sdtBSz
protected int sdtValBSz
public static int[] automaticSeriesColors
public void init()
XLSRecordpublic void update()
public Ai getSeriesValueAi()
public String getSeriesFormatPattern()
public String getCategoryFormatPattern()
public void setLegend(String newLegend, WorkBookHandle wbh)
newLegend - new text value for legend for the current serieswbh - workbookhandlepublic void setLegendRef(String newLegendCell)
newLegendCell - public String getLegendText()
public String getLegendRef()
protected SeriesText getLegendSeriesText()
public Ai getLegendAi()
public Ai getBubbleValueAi()
protected static Series getPrototype(String seriesRange, String categoryRange, String bubbleRange, String legendRange, String legendText, ChartType chartobj)
seriesData - public static XLSRecord getPrototype()
public Ai getCategoryValueAi()
protected int getSeriesIndex()
protected int getSeriesNumber()
protected int getCategoryCount()
protected int getValueCount()
public void setCategoryCount(int i)
protected int getBubbleCount()
public void setBubbleCount(int i)
public void setValueCount(int i)
public int getCategoryDataType()
public int getValueDataType()
public void setCategoryDataType(int i)
public void setValueDataType(int i)
public boolean hasBubbleSizes()
public int getShape()
public void setShape(int shape)
public boolean getHasSmoothedLines()
public void setHasSmoothLines(boolean smooth)
smooth - public void setHasLines(int lineStyle)
public void setColor(String clr)
clr - String color hex StringsetPieSliceColorpublic void setColor(int clr)
clr - color intsetPieSliceColorpublic void setPieSliceColor(int clr,
int slice)
clr - color intslice - 0-based pie slice numberpublic void setPieSliceColor(String clr, int slice)
clr - color intslice - 0-based pie slice numberpublic String getSeriesColor()
getPieSliceColorpublic String getPieSliceColor(int slice)
slice - public int getMarkerFormat()
public int getDataLabel()
AttachedLabelpublic int[] getDataLabelsPIE(int defaultdl)
defaultdl - int default data label setting for overall chartAttachedLabelpublic SpPr getSpPr()
public void setSpPr(SpPr sp)
sp - public Marker getMarker()
public void setMarker(Marker m)
Sp - public DLbls getDLbls()
public void setDLbls(DLbls d)
Sp - public DPt[] getDPt()
public void addDpt(DPt d)
Sp - public StringBuffer getValOOXML(String valstr)
valstr - either "val" or "yval" for scatter/bubble chartspublic StringBuffer getCatOOXML(String cat, String catstr)
cat - string category cell range for the given series --
almost always the same for each series (except for scatter/bubble charts)catstr - either "cat" or "xval" for scatter/bubble charts
cat elements must contain string references
xval contain numeric referencespublic StringBuffer getBubbleOOXML(boolean isBubble3d)
isBubble3d - true if it's a 3d bubble chartpublic StringBuffer getLegendOOXML(boolean from2003)
isBubble3d - true if it's a 3d bubble chartCopyright © 2002–2019 Starter Inc.. All rights reserved.