io.starter.formats.XLS.charts

Class Bar

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.charts.GenericChartObject

io.starter.formats.XLS.charts.Bar

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable

public class Bar
extends GenericChartObject
implements ChartObject

Bar: Chart Group is a Bar or Column Chart Group (0x1017) NOTE: Bar is also base type for Pyramid, Cone and Cylinder charts; actual chart type is determined also by bar shape see ChartFormat.getChartType for more information 4 pcOverlap 2 Space between bars (default= 0) values: -100 to -1 Size of the separation between data points 0 No overlap. 1 to 100 Size of the overlap between data points 6 pcGap 2 Space between categories (%) (default=50%) An unsigned integer that specifies the width of the gap between the categories and the left and right edges of the plot area as a percentage of the data point width divided by 2. It also specifies the width of the gap between adjacent categories as a percentage of the data point width. MUST be less than or equal to 500. 8 grbit 2 grbit: 0 0 0x1 fTranspose 1= horizontal bars (=bar chart) 0= vertical bars (= column chart) 1 0x2 fStacked Stack the displayed values 2 0x4 f100 Each category is displayed as a percentage 3 0x8 fHasShadow 1= this bar has a shadow

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	f100
protected boolean	fHasShadow
protected boolean	fStacked
protected short	pcGap
protected short	pcOverlap

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

Method Summary

Modifier and Type	Method and Description
String	getChartOption(String op) look up bar-specific chart options such as "Gap" or "Overlap" setting
int	getGap()
int	getOverlap()
static XLSRecord	getPrototype()
boolean	hasShadow()
void	init() perform record initialization
boolean	is100Percent()
boolean	isStacked()
void	setAsBarChart()
void	setAsColumnChart()
boolean	setChartOption(String op, String val) Set specific options
void	setHasShadow(boolean bHasShadow)
void	setIs100Percent(boolean bOn)
void	setIsClustered() sets this bar/col chart to have clustered series: series are drawn next to each other along the category axis
void	setIsStacked(boolean bIsStacked) sets this bar/col chart to have stacked series: series are drawn next to each other along the value axis
void	setpcGap(int gap) sets the Space between categories (%) (default=50%)
void	setpcOverlap(int overlap) sets the Space between bars (default= 0)

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

addChartRecord, close, getChartRecords, getOptionsXML, getParentChart, getRecordArray, getScript, 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

Field Detail

fStacked

protected boolean fStacked

f100

protected boolean f100

fHasShadow

protected boolean fHasShadow

pcOverlap

protected short pcOverlap

pcGap

protected short pcGap

Constructor Detail

Bar

public Bar()

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

isStacked

public boolean isStacked()

Overrides:

isStacked in class GenericChartObject

is100Percent

public boolean is100Percent()

Overrides:

is100Percent in class GenericChartObject

hasShadow

public boolean hasShadow()

Overrides:

hasShadow in class GenericChartObject

getGap

public int getGap()

getOverlap

public int getOverlap()

setIsStacked

public void setIsStacked(boolean bIsStacked)

sets this bar/col chart to have stacked series: series are drawn next to each other along the value axis

Overrides:

setIsStacked in class GenericChartObject

Parameters:

bIsClustered -

setIs100Percent

public void setIs100Percent(boolean bOn)

Overrides:

setIs100Percent in class GenericChartObject

setHasShadow

public void setHasShadow(boolean bHasShadow)

setIsClustered

public void setIsClustered()

sets this bar/col chart to have clustered series: series are drawn next to each other along the category axis

Parameters:

bIsClustered -

setpcOverlap

public void setpcOverlap(int overlap)

sets the Space between bars (default= 0)

Parameters:

overlap -

setpcGap

public void setpcGap(int gap)

sets the Space between categories (%) (default=50%)

Parameters:

gap -

setAsBarChart

public void setAsBarChart()

setAsColumnChart

public void setAsColumnChart()

getPrototype

public static XLSRecord getPrototype()

setChartOption

public boolean setChartOption(String op,
                              String val)

Set specific options

Overrides:

setChartOption in class GenericChartObject

getChartOption

public String getChartOption(String op)

look up bar-specific chart options such as "Gap" or "Overlap" setting

Overrides:

getChartOption in class GenericChartObject

Returns: