io.starter.formats.XLS.charts

Class ValueRange

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.charts.GenericChartObject

io.starter.formats.XLS.charts.ValueRange

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable

public class ValueRange
extends GenericChartObject
implements ChartObject

ValueRange: Defines Value Axis Scale (0x101f) Offset Name Size Contents 4 numMin 8 Minimum value on axis. MUST be less than the value of numMax. If the value of fAutoMin is 1, this field MUST be ignored. 12 numMax 8 Maximum value on axis. MUST be greater than the value of numMin. If the value of fAutoMax is 1, this field MUST be ignored. 20 numMajor 8 Value of major increment. MUST be greater than or equal to the value of numMinor. If the value of fAutoMajor is 1, this field MUST be ignored. 28 numMinor 8 Value of minor increment. MUST be greater than or equal to zero. If the value of fAutoMinor is 1, this field MUST be ignored. 36 numCross 8 Value where category axis crosses. If the value of fAutoCross is 1, this field MUST be ignored. 44 grbit 2 Format flags grbit 0 0x1 fAutoMin Automatic Minimum Selected 0 The value specified by numMin is used as the minimum value of the value axis. 1 numMin is calculated such that the data point with the minimum value can be displayed in the plot area. 1 0x2 fAutoMax Automatic Maximum Selected 0 The value specified by numMax is used as the maximum value of the value axis. 1 numMax is calculated such that the data point with the maximum value can be displayed in the plot area. 2 0x4 fAutoMajor Automatic Major Unit Selected 0 The value specified by numMax is used as the maximum value of the value axis. 1 numMax is calculated such that the data point with the maximum value can be displayed in the plot area. 3 0x8 fAutoMinor Automatic Minor Unit Selected 0 The value specified by numMinor is used as the interval at which minor tick marks and minor gridlines are displayed. 1 numMinor is calculated automatically. 4 0x10 fAutoCross Automatic Category Crossing Point Selected 0 The value specified by numCross is used as the point at which the other axes in the axis group cross this value axis. 1 numCross is calculated so that the crossing point is displayed in the plot area. 5 0x20 fLogScale Log Scale 0 The scale of the value axis is linear. 1 The scale of the value axis is logarithmic. The default base of the logarithmic scale is 10, unless a CrtMlFrt record follows this record, specifying the base in a XmlTkLogBaseFrt structure. 6 0x40 fReverse Values in reverse order 0 Values are displayed from smallest-to-largest, from left-to-right, or from bottom-to-top, respectively, depending on the orientation of the axis. 1 The values are displayed in reverse order, meaning largest-to-smallest, from left-to-right, or from bottom-to-top, respectively. 7 0x80 fMaxCross Category is to cross at maximum value 0 The other axes in the axis group cross this value axis at the value specified by numCross. 1 The other axes in the axis group cross the value axis at the maximum value. If fMaxCross is 1, then both fAutoCross and numCross MUST be ignored. All 8-byte numbers in the preceding table are IEEE floating-point numbers. The numMin field defines the minimum numeric value that appears along the value axis. This field is all zeros if Auto Minimum is selected on the Scale tab of the Format Axis dialog box. The numMax field defines the maximum value displayed along the value axis and is all zeros if Auto Maximum is selected. The numMajor field defines the increment (unit) of the major value divisions (gridlines) along the value axis. The numMajor field is all zeros if Auto Major Unit is selected on the Scale tab of the Format Axis dialog box. The numMinor field defines the minor value divisions (gridlines) along the value axis and is all zeros if Auto Minor Unit is selected. The numCross field defines the value along the value axis at which the category axis crosses. This field is all zeros if Auto Category Axis Crosses At is selected.

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

Method Summary

Modifier and Type	Method and Description
static double[]	calcMaxMin(double MaxVal, double MinVal, double area) static utlity to calculate the min and max on a scale in a given area NOTE: this is usually the Y Axis, but scatter charts can have a value axis on the X Axis
double	getMajorTick() all important major tick step -
double	getMax() return max scale value -- see setMinMax for calc
double	getMin() return minumum scale value -- see setMinMax for calc
double	getMinorTick()
String	getOption(String op) retrieve generic Value axis option can be one of: crosses possible crossing points (autoZero, max, min) crossBeteween whether axis crosses the cat.
static XLSRecord	getPrototype()
void	init() perform record initialization
boolean	isAutomaticMax()
boolean	isAutomaticMin()
boolean	isAutomaticScale()
boolean	isReversed() returns true if axis should be displayed on RHS of chart false for default LHS
void	setAutomaticMax(boolean b)
void	setAutomaticMin(boolean b)
void	setMax(double max) set the max scale value of this Y or value axis Doing so turns automatic maximum off
void	setMaxMin(double yMax, double yMin) sets the max and min values for the axis and uses these to calculate the all-important major unit (and minor unit) step NOTE that Excel keeps it's "automatic" calculation private so below is the best guess looking at existing chart data max and min units are also based upon chart size, so this is only a rough approximation
void	setMin(double min) set the minimum scale value of this Y or value axis Doing so turns automatic minimum off
boolean	setOption(String op, String val) sets a specific OOXML axis option can be one of: crosses possible crossing points (autoZero, max, min) crossBeteween whether axis crosses the cat.

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

ValueRange

public ValueRange()

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

getMin

public double getMin()

return minumum scale value -- see setMinMax for calc

Returns:

double

getMax

public double getMax()

return max scale value -- see setMinMax for calc

Returns:

double

getMajorTick

public double getMajorTick()

all important major tick step -

Returns:

double major tick step value

See Also:

setMinMax

getMinorTick

public double getMinorTick()

setMaxMin

public void setMaxMin(double yMax,
                      double yMin)

sets the max and min values for the axis and uses these to calculate the all-important major unit (and minor unit) step
NOTE that Excel keeps it's "automatic" calculation private so below is the best guess looking at existing chart data
max and min units are also based upon chart size, so this is only a rough approximation

Parameters:

yMax - double maximum series value

yMin - double minimum series value

calcMaxMin

public static double[] calcMaxMin(double MaxVal,
                                  double MinVal,
                                  double area)

static utlity to calculate the min and max on a scale in a given area NOTE: this is usually the Y Axis, but scatter charts can have a value axis on the X Axis

Parameters:

MaxVal - Actual Maximum Value on Axis

MinVal - Actual Mimumum Value on Axis

area - Area of Axis in pixels (I think :))

Returns:

setOption

public boolean setOption(String op,
                         String val)

sets a specific OOXML axis option
can be one of:
crosses possible crossing points (autoZero, max, min)
crossBeteween whether axis crosses the cat. axis between or on categories (between, midCat)
crossesAt where on axis the perpendicular axis crosses (double val)
majorTickMark major tick mark position (cross, in, none, out)
minorTickMark minor tick mark position ("")
tickLblPos tick label position (high, low, nextTo, none)
majorUnit distance between major tick marks (val, date ax only) (double >= 0)
minorUnit distance between minor tick marks (val, date ax only) (double >= 0)

Parameters:

op -

val -

getOption

public String getOption(String op)

retrieve generic Value axis option
can be one of:
crosses possible crossing points (autoZero, max, min)
crossBeteween whether axis crosses the cat. axis between or on categories (between, midCat)
crossesAt where on axis the perpendicular axis crosses (double val)
majorTickMark major tick mark position (cross, in, none, out)
minorTickMark minor tick mark position ("")
tickLblPos tick label position (high, low, nextTo, none)
majorUnit distance between major tick marks (val, date ax only) (double >= 0)
minorUnit distance between minor tick marks (val, date ax only) (double >= 0)

Parameters:

op -

Returns:

setMin

public void setMin(double min)

set the minimum scale value of this Y or value axis
Doing so turns automatic minimum off

Parameters:

min -

setMax

public void setMax(double max)

set the max scale value of this Y or value axis
Doing so turns automatic maximum off

Parameters:

max -

isAutomaticScale

public boolean isAutomaticScale()

isAutomaticMax

public boolean isAutomaticMax()

isAutomaticMin

public boolean isAutomaticMin()

setAutomaticMin

public void setAutomaticMin(boolean b)

setAutomaticMax

public void setAutomaticMax(boolean b)

isReversed

public boolean isReversed()

returns true if axis should be displayed on RHS of chart false for default LHS

Returns: