io.starter.formats.XLS.charts

Class CatserRange

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.charts.GenericChartObject

io.starter.formats.XLS.charts.CatserRange

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable

public class CatserRange
extends GenericChartObject
implements ChartObject

CatserRange: Defines a Category or Series Axis (0x1020) 4 catCross 2 Value axis/category crossing point (2-D charts only) If fMaxCross is set to 1, the value this field MUST be ignored. for series axes, must be 0 for cat: This field specifies the category at which the value axis crosses. For example, if this field is 2, the value axis crosses this axis at the second category on this axis. MUST be greater than or equal to 1 and less than or equal to 31999. 6 catLabel 2 Frequency of labels. A signed integer that specifies the interval between axis labels on this axis. MUST be greater than or equal to 1 and less than or equal to 31999. MUST be ignored for a date axis. 8 catMark 2 Frequency of tick marks. A signed integer that specifies the interval at which major tick marks and minor tick marks are displayed on the axis. Major tick marks and minor tick marks that would have been visible are hidden unless they are located at a multiple of this field. MUST be greater than or equal to 1, and less than or equal to 31999. MUST be ignored for a date axis. 10 grbit 2 Format flags The catCross field defines the point on the category axis where the value axis crosses. A value of 01 indicates that the value axis crosses to the left, or in the center, of the first category (depending on the value of bit 0 of the grbit field); a value of 02 indicates that the value axis crosses to the left or center of the second category, and so on. Bit 2 of the grbit field overrides the value of catCross when set to 1. The catLabel field defines how often labels appear along the category or series axis. A value of 01 indicates that a category label will appear with each category, a value of 02 means a label appears every other category, and so on. The catMark field defines how often tick marks appear along the category or series axis. A value of 01 indicates that a tick mark will appear between each category or series; a value of 02 means a label appears between every other category or series, etc. format flags: 0 0xOl fBetween Value axis crossing a = axis crosses midcategory I = axis crosses between categories 1 0x02 fMaxCross Value axis crosses at the far right category (in a line, bar, column, scatter, or area chart; 2-D charts only) 0 The value axis crosses this axis at the value specified by catCross. 1 The value axis crosses this axis at the last category, the last series, or the maximum date. 2 0x04 fReverse Display categories in reverse order 7-3 0xF8 (reserved) Reserved; must be zero 7-0 0xFF (reserved) Reserved; must be zero

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

Method Summary

Modifier and Type	Method and Description
int	getCatCross()
int	getCatLabel()
int	getCatMark()
boolean	getCrossBetween()
boolean	getCrossMax()
String	getOption(String op) retrieve generic Category axis option
static XLSRecord	getPrototype()
void	init() perform record initialization
boolean	isReversed() returns true if the axis should be displayed at top of chart area false if axis is displayed in the default bottom location
void	setCatCross(int c)
void	setCatLabel(int c)
void	setCatMark(int c)
void	setCrossBetween(boolean b)
void	setCrossMax(boolean b)
void	setOpt(int op)
boolean	setOption(String op, String val) sets a specific OOXML axis option can be one of: auto crosses possible crossing points (autoZero, max, min) crossesAt where on axis the perpendicular axis crosses (double val) lblAlign text alignment for tick labels (ctr, l, r) (cat only) lblOffset distance of labels from the axis (0-1000) (cat only) tickLblSkip how many tick labels to skip between label (int >= 1) tickMarkSkip how many tick marks to skip betwen ticks (int >= 1)

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

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

CatserRange

public CatserRange()

Method Detail

getPrototype

public static XLSRecord getPrototype()

setOpt

public void setOpt(int op)

init

public void init()

Description copied from class: XLSRecord

perform record initialization

Specified by:

init in interface BiffRec

Overrides:

init in class XLSRecord

getCatCross

public int getCatCross()

getCatLabel

public int getCatLabel()

getCatMark

public int getCatMark()

getCrossBetween

public boolean getCrossBetween()

getCrossMax

public boolean getCrossMax()

setCatCross

public void setCatCross(int c)

setCatLabel

public void setCatLabel(int c)

setCatMark

public void setCatMark(int c)

setCrossBetween

public void setCrossBetween(boolean b)

setCrossMax

public void setCrossMax(boolean b)

setOption

public boolean setOption(String op,
                         String val)

sets a specific OOXML axis option
can be one of:
auto
crosses possible crossing points (autoZero, max, min)
crossesAt where on axis the perpendicular axis crosses (double val)
lblAlign text alignment for tick labels (ctr, l, r) (cat only)
lblOffset distance of labels from the axis (0-1000) (cat only)
tickLblSkip how many tick labels to skip between label (int >= 1)
tickMarkSkip how many tick marks to skip betwen ticks (int >= 1)

Parameters:

op -

val -

getOption

public String getOption(String op)

retrieve generic Category axis option

Parameters:

op -

Returns:

isReversed

public boolean isReversed()

returns true if the axis should be displayed at top of chart area false if axis is displayed in the default bottom location

Returns: