io.starter.formats.XLS.charts

Class Boppop

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.charts.GenericChartObject

io.starter.formats.XLS.charts.Boppop

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable

public class Boppop
extends GenericChartObject
implements ChartObject

Boppop: Bar of Pie/Pie of Pie chart options(0x1061) pst (1 byte): An unsigned integer that specifies whether this chart group is a bar of pie chart group or a pie of pie chart group. MUST be a value from the following table: 1= pie of pie 2= bar of pie fAutoSplit (1 byte): A Boolean that specifies whether the split point of the chart group is determined automatically. If the value is 1, when a bar of pie chart group or pie of pie chart group is initially created the data points from the primary pie are selected and inserted into the secondary bar/pie automatically. split (2 bytes): An unsigned integer that specifies what determines the split between the primary pie and the secondary bar/pie. MUST be ignored if fAutoSplit is set to 1. MUST be a value from the following table: Value Type of split Meaning 0x0000 Position The data is split based on the position of the data point in the series as specified by iSplitPos. 0x0001 Value The data is split based on a threshold value as specified by numSplitValue. 0x0002 Percent The data is split based on a percentage threshold and the data point values represented as a percentage as specified by pcSplitPercent. 0x0003 Custom The data is split as arranged by the user. Custom split is specified in a following BopPopCustom record. iSplitPos (2 bytes): A signed integer that specifies how many data points are contained in the secondary bar/pie. Data points are contained in the secondary bar/pie starting from the end of the series. For example, if the value is 2, the last 2 data points in the series are contained in the secondary bar/pie. MUST be a value greater than or equal to 0 and less than or equal to 32000. If the value is more than the number of data points in the series, the entire series will be in the secondary bar/pie, except for the first data point. If split is not set to 0x0000 or fAutoSplit is set to 1, this value MUST be ignored. pcSplitPercent (2 bytes): A signed integer that specifies the percentage below which each data point is contained in the secondary bar/pie as opposed to the primary pie. The percentage value of a data point is calculated using the following formula: (value of the data point x 100) / sum of all data points in the series If split is not set to 0x0002 or if fAutoSplit is set to 1, this value MUST be ignored pcPie2Size (2 bytes): A signed integer that specifies the size of the secondary bar/pie as a percentage of the size of the primary pie. MUST be a value greater than or equal to 5 and less than or equal to 200. pcGap (2 bytes): A signed integer that specifies the distance between the primary pie and the secondary bar/pie. The distance is specified as a percentage of the average width of the primary pie and secondary bar/pie. MUST be a value greater than or equal to 0 and less than or equal to 500, where 0 is 0% of the average width of the primary pie and the secondary bar/pie, and 500 is 250% of the average width of the primary pie and the secondary bar/pie. numSplitValue (8 bytes): An Xnum value that specifies the split when the split field is set to 0x0001 . The value of this field specifies the threshold that selects which data points of the primary pie move to the secondary bar/pie. The secondary bar/pie contains any data points with a value less than the value of this field. If split is not set to 0x0001 or if fAutoSplit is set to 1, this value MUST be ignored. A - fHasShadow (1 bit): A bit that specifies whether one or more data points in the chart group have shadows. reserved (15 bits): MUST be zero, and MUST be ignored.

See Also:

Serialized Form

Field Summary

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
Boppop()

Method Summary

Modifier and Type	Method and Description
int	getpcGap() returns the distance between the primary pie and the secondary bar/pie.
static XLSRecord	getPrototype()
int	getSecondPieSize() returns the size of the secondary bar/pie as a percentage of the size of the primary pie.
int	getSplitPos() returns how many data points are contained in the secondary bar/pie.
int	getSplitType() returns split type, or -1 if autosplit 0x0000 Position The data is split based on the position of the data point in the series as specified by iSplitPos.
String	getSplitTypeOOXML()
void	init() perform record initialization
boolean	isPieOfPie() returns true of pie of pie, false if bar of pie
boolean	setChartOption(String op, String val) Set specific options
void	setIsPieOfPie(boolean b)
void	setpcGap(int g) specifies the distance between the primary pie and the secondary bar/pie.
void	setSecondPieSize(int s) specifies the size of the secondary bar/pie as a percentage of the size of the primary pie.
void	setSplitPos(int sp) specifies how many data points are contained in the secondary bar/pie.
void	setSplitType(int t) specifies what determines the split between the primary pie and the secondary bar/pie.
void	setSplitType(String s) specifies what determines the split between the primary pie and the secondary bar/pie via OOXML string value: auto -- split point of the chart group is determined automatically pos -- The data is split based on the position of the data point in the series as specified by iSplitPos.

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

addChartRecord, close, getChartOption, getChartRecords, getOptionsXML, getParentChart, getRecordArray, getScript, hasShadow, is100Percent, isStacked, 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, 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, toString

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

Constructor Detail

Boppop

public Boppop()

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

getPrototype

public static XLSRecord getPrototype()

isPieOfPie

public boolean isPieOfPie()

returns true of pie of pie, false if bar of pie

Returns:

setIsPieOfPie

public void setIsPieOfPie(boolean b)

setpcGap

public void setpcGap(int g)

specifies the distance between the primary pie and the secondary bar/pie. The distance is specified as a percentage of the average width of the primary pie and secondary bar/pie.

Parameters:

g -

getpcGap

public int getpcGap()

returns the distance between the primary pie and the secondary bar/pie. The distance is specified as a percentage of the average width of the primary pie and secondary bar/pie.

setSecondPieSize

public void setSecondPieSize(int s)

specifies the size of the secondary bar/pie as a percentage of the size of the primary pie.

Parameters:

s -

getSecondPieSize

public int getSecondPieSize()

returns the size of the secondary bar/pie as a percentage of the size of the primary pie.

setSplitType

public void setSplitType(int t)

specifies what determines the split between the primary pie and the secondary bar/pie. 0x0000 Position The data is split based on the position of the data point in the series as specified by iSplitPos. 0x0001 Value The data is split based on a threshold value as specified by numSplitValue. 0x0002 Percent The data is split based on a percentage threshold and the data point values represented as a percentage as specified by pcSplitPercent. 0x0003 Custom The data is split as arranged by the user. Custom split is specified in a following BopPopCustom record.

Parameters:

t -

setSplitType

public void setSplitType(String s)

specifies what determines the split between the primary pie and the secondary bar/pie via OOXML string value: auto -- split point of the chart group is determined automatically pos -- The data is split based on the position of the data point in the series as specified by iSplitPos. val -- The data is split based on a threshold value as specified by numSplitValue. percent --The data is split based on a percentage threshold and the data point values represented as a percentage as specified by pcSplitPercent. cust -- The data is split as arranged by the user.

Parameters:

s -

getSplitType

public int getSplitType()

returns split type, or -1 if autosplit 0x0000 Position The data is split based on the position of the data point in the series as specified by iSplitPos. 0x0001 Value The data is split based on a threshold value as specified by numSplitValue. 0x0002 Percent The data is split based on a percentage threshold and the data point values represented as a percentage as specified by pcSplitPercent. 0x0003 Custom The data is split as arranged by the user. Custom split is specified in a following BopPopCustom record.

Returns:

getSplitTypeOOXML

public String getSplitTypeOOXML()

setSplitPos

public void setSplitPos(int sp)

specifies how many data points are contained in the secondary bar/pie. Data points are contained in the secondary bar/pie starting from the end of the series. For example, if the value is 2, the last 2 data points in the series are contained in the secondary bar/pie.

Parameters:

sp -

getSplitPos

public int getSplitPos()

returns how many data points are contained in the secondary bar/pie. Data points are contained in the secondary bar/pie starting from the end of the series. For example, if the value is 2, the last 2 data points in the series are contained in the secondary bar/pie.

setChartOption

public boolean setChartOption(String op,
                              String val)

Set specific options

Overrides:

setChartOption in class GenericChartObject