io.starter.formats.XLS.charts

Class AxisParent

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.charts.GenericChartObject

io.starter.formats.XLS.charts.AxisParent

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable

public class AxisParent
extends GenericChartObject
implements ChartObject

AxisParent: Axis Size and Location (0x1014) This record specifies properties of an axis group and the beginning of a collection of records as defined by the chart sheet substream. The Axis parent record stores most of the actual chart information, what type of chart, x and y labels, etc. 4 iax 2 axis index (0= main, 1= secondary) This field MUST be set to zero when it is in the first AxisParent record in the chart sheet substream, This field MUST be set to 1 when it is in the second AxisParent record in the chart sheet substream. 16 unused (16 bytes): Undefined and MUST be ignored. this doesn't appear correct given ms doc 6 x 4 10 y 4 14 dx 4 len of x axis 18 dy 4 len of y axis

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

Method Summary

Modifier and Type	Method and Description
protected ChartFormat	createNewChart(int nChart) create basic cf necessary to define multiple or overlay charts and add to this AxisParent
Axis	getAxis(int axisType) return the desired axis according to AxisType (will create the axis if it doesn't exist) Also finds and associates the axis rec with it's TextDisp so as to be able to set axis optins ...
Axis	getAxis(int axisType, boolean bCreateIfNecessary) return the desired axis according to AxisType Also finds and associates the axis rec with it's TextDisp so as to be able to set axis optins ...
protected String	getAxisOptionsXML(int axis) return XML of axis label and specific options for the desired axis (both the Axis record + it's "associated" TextDisp record are consulted)
protected ChartFormat	getChartFormat() default version, returns the 1sst chart format record if there are more than 1 chart type in the chart there will be multiple chart format records
protected ChartFormat	getChartFormat(int nChart, boolean addNew) get the chart format collection
String	getPlotAreaBgColor() returns the plot area background color
void	init() perform record initialization
boolean	isSecondaryAxis() returns true if this is a secondary axis
void	removeAxes() remove axis records for pie-type charts ...
void	removeAxis(int axisType) remove the desired axis + associated records
protected void	removePlotArea() for those charts such as Radar, remove the axis frame and plot area records as are not necessary
void	setIsSecondaryAxis(boolean b) sets if this is a secondary axis
void	setPlotAreaBgColor(int bg) sets the plot area background color
void	setPlotAreaBorder(int lw, int lclr) adds a border around the plot area with the desired line width and line color

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, getPrototype, 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

AxisParent

public AxisParent()

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

getChartFormat

protected ChartFormat getChartFormat()

default version, returns the 1sst chart format record
if there are more than 1 chart type in the chart there will be multiple chart format records

Returns:

getChartFormat

protected ChartFormat getChartFormat(int nChart,
                                     boolean addNew)

get the chart format collection

Returns:

createNewChart

protected ChartFormat createNewChart(int nChart)

create basic cf necessary to define multiple or overlay charts and add to this AxisParent

Parameters:

nChart - overlay chart number (>0 and <=9)

Returns:

new ChartFormat

removeAxes

public void removeAxes()

remove axis records for pie-type charts ...

removeAxis

public void removeAxis(int axisType)

remove the desired axis + associated records

Parameters:

axisType -

removePlotArea

protected void removePlotArea()

for those charts such as Radar, remove the axis frame and plot area records as are not necessary

getAxisOptionsXML

protected String getAxisOptionsXML(int axis)

return XML of axis label and specific options for the desired axis (both the Axis record + it's "associated" TextDisp record are consulted)

Parameters:

Axis - int desired Axis

Returns:

String XML of axis label + specific options

See Also:

ObjectLink

getAxis

public Axis getAxis(int axisType)

return the desired axis according to AxisType (will create the axis if it doesn't exist) Also finds and associates the axis rec with it's TextDisp so as to be able to set axis optins ... will create Axis + TextDisp if not present ...

Parameters:

axisType -

Returns:

Desired axis

getAxis

public Axis getAxis(int axisType,
                    boolean bCreateIfNecessary)

return the desired axis according to AxisType Also finds and associates the axis rec with it's TextDisp so as to be able to set axis optins ... will create Axis + TextDisp if not present ...

Parameters:

axisType -

bCreateIfNecessary - - if true, will create the axis if it doesn't exist

Returns:

Desired axis

getPlotAreaBgColor

public String getPlotAreaBgColor()

returns the plot area background color

Returns:

plot area background color hex string

setPlotAreaBgColor

public void setPlotAreaBgColor(int bg)

sets the plot area background color

Parameters:

bg - color int

setPlotAreaBorder

public void setPlotAreaBorder(int lw,
                              int lclr)

adds a border around the plot area with the desired line width and line color

Parameters:

lw -

lclr -

isSecondaryAxis

public boolean isSecondaryAxis()

returns true if this is a secondary axis

Returns:

setIsSecondaryAxis

public void setIsSecondaryAxis(boolean b)

sets if this is a secondary axis

Parameters:

b -