io.starter.formats.XLS.charts

Class YMult

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.charts.GenericChartObject

io.starter.formats.XLS.charts.YMult

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable

public class YMult
extends GenericChartObject
implements ChartObject

YMULT: Y Multiplier (857h) Introduced in Excel 9 (2000), this BIFF record is an FRT record for Charts. This record describes the axis multiplier feature which scales the axis values displayed by the axis tick labels. For instance, an axis multiplier value of "millions" would cause the axis tick labels to show the axis value divided by one million (e.g., the tick label for an axis value of 20,000,000 would show "20".) This record is a "parent" record and is immediately followed by a set of records surrounded by rtStartObject and rtEndObject which describes the axis multiplier label. Record Data Offset Field Name Size Contents 4 rt 2 Record type; this matches the BIFF rt in the first two bytes of the record; =0857h 6 grbitFrt 2 FRT flags; must be zero 8 axmid 2 Axis multiplier ID, one of the following values: -1 = multiplier value is stored in numLabelMultiplier 0 = no multiplier (same as 1.0) 1 = Hundreds, 10 2nd 2 = Thousands, 10 3rd 3 = Ten Thousands, 10 4th 4 = Hundred Thousands, 10 5th 5 = Millions, 10 6th 6 = Ten Millions, 10 7th 7 = Hundred Millions, 10 8th 8 = billion 9 = trillion 16 numLabelMultiplier 4 Numeric value 18 grbit 2 Option flags for y axis multiplier (see description below)* The grbit field contains the following category axis label option flags: Bits Mask Flag Name Contents 0 0001h fEnabled =1 if the multiplier is enabled =0 otherwise 1 0002h fAutoShowMultiplier =1 if the multiplier label is shown =0 otherwise 15-2 FFFCh (unused) 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
YMult()

Method Summary

Modifier and Type	Method and Description
short	getAxMultiplierId() returns the Axis multiplier ID, one of the following values: -1 = multiplier value is stored in numLabelMultiplier 0 = no multiplier (same as 1.0) 1 = Hundreds, 10 2nd 2 = Thousands, 10 3rd 3 = Ten Thousands, 10 4th 4 = Hundred Thousands, 10 5th 5 = Millions, 10 6th 6 = Ten Millions, 10 7th 7 = Hundred Millions, 10 8th 8 = Thousand Millions, 10 9th 9 = Billions, 10 12th
String	getAxMultiplierIdAsString()
double	getCustomMultiplier()
static XLSRecord	getPrototype()
void	init() perform record initialization
void	setAxMultiplierId(int m) Sets Axis multiplier ID, one of the following values: -1 = multiplier value is stored in numLabelMultiplier 0 = no multiplier (same as 1.0) 1 = Hundreds, 10 2nd 2 = Thousands, 10 3rd 3 = Ten Thousands, 10 4th 4 = Hundred Thousands, 10 5th 5 = Millions, 10 6th 6 = Ten Millions, 10 7th 7 = Hundred Millions, 10 8th 8 = Thousand Millions, 10 9th 9 = Billions, 10 12th
void	setAxMultiplierId(String m) Sets Axis multiplier ID via OOXML String value: hundreds Hundreds thousands Thousands tenThousands Ten Thousands hundredThousands Hundred Thousands millions Millions tenMillions Ten Millions hundredMillions Hundred Millions billions Billions trillions Trillions
void	setCustomMultiplier(double m)

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

YMult

public YMult()

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

getAxMultiplierId

public short getAxMultiplierId()

returns the Axis multiplier ID, one of the following values:

-1 = multiplier value is stored in numLabelMultiplier 0 = no multiplier (same as 1.0) 1 = Hundreds, 10 2nd 2 = Thousands, 10 3rd 3 = Ten Thousands, 10 4th 4 = Hundred Thousands, 10 5th 5 = Millions, 10 6th 6 = Ten Millions, 10 7th 7 = Hundred Millions, 10 8th 8 = Thousand Millions, 10 9th 9 = Billions, 10 12th

Returns:

getAxMultiplierIdAsString

public String getAxMultiplierIdAsString()

setAxMultiplierId

public void setAxMultiplierId(int m)

Sets Axis multiplier ID, one of the following values:

-1 = multiplier value is stored in numLabelMultiplier 0 = no multiplier (same as 1.0) 1 = Hundreds, 10 2nd 2 = Thousands, 10 3rd 3 = Ten Thousands, 10 4th 4 = Hundred Thousands, 10 5th 5 = Millions, 10 6th 6 = Ten Millions, 10 7th 7 = Hundred Millions, 10 8th 8 = Thousand Millions, 10 9th 9 = Billions, 10 12th