io.starter.formats.XLS.charts

Class DataFormat

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.charts.GenericChartObject

io.starter.formats.XLS.charts.DataFormat

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable

public class DataFormat
extends GenericChartObject
implements ChartObject

DataFormat: Series and Data Point Numbers(0x1006) 4 xi 2 the zero-based index of the data point within the series specified by yi. (FFFFh means entire series) 6 yi 2 the zero-based index of a Series record 8 iss 2 An unsigned integer that specifies properties of the data series, trendline or error bar, depending on the type of records in sequence of records: If does not contain a SerAuxTrend or SerAuxErrBar record, then this field specifies the plot order of the data series. If the series order was changed, this field can be different from yi. MUST be less than or equal to the number of series in the chart. MUST be unique among iss values for all instances of this record contained in the SERIESFORMAT rule that does not contain a SerAuxTrend or SerAuxErrBar record. If the SERIESFORMAT rule contains a SerAuxTrend record on the chart group, then this field specifies the trendline number for the series. If the SERIESFORMAT rule contains a SerAuxErrBar record on the chart group, then this field specifies a zero-based index into a Series record in the collection of Series records in the current chart sheet substream for which the error bar applies to. 10 grbit 2 flags (0?) ignored ORDER OF SUB-RECS: [Chart3DBarShape] [LineFormat, AreaFormat, PieFormat] == lines, fill [SerFormat] == smoothed lines ... [GelFrame] [MarkerFormat] [AttachedLabel] == data labels [ShapeProps] [CtrlMltFrt]

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

Method Summary

Modifier and Type	Method and Description
String	getBgColor() get the bg color identified by this DataFormat Usually part of a series group of records
String	getDataLabelType() return a string of ALL the label options chosen.
String	getDataLabelType(String type) return if has the specified data label "ShowValueLabel" "ShowValueAsPercent" "ShowLabelAsPercent" "ShowLabel" "ShowSeriesName" "ShowBubbleLabel"
int	getDataLabelTypeInt() return the data label int or 0 if no data labels chosen
boolean	getHas3DBubbles() returns true if this paernt chart has 3D bubbles (Bubble chart only)
boolean	getHasDataLabels() returns true if has data labels
boolean	getHasLines() returns true if this parent chart has lines (Line, Scatter, Radar charts)
boolean	getHasShadow() return if data markers are displayed with a shadow on bubble, scatter, radar, stock, and line chart groups.
int	getMarkerFormat() returns type of marker, if any 0 = no marker 1 = square 2 = diamond 3 = triangle 4 = X 5 = star 6 = Dow-Jones 7 = standard deviation 8 = circle 9 = plus sign
int	getPercentage() return percentage=distance of pie slice from center of pie as %
short	getPointNumber()
static XLSRecord	getPrototype() Create a new dataformat
static XLSRecord	getPrototypeWithFormatRecs(Chart parentChart)
static XLSRecord	getPrototypeWithFormatRecs(int seriesNumber, Chart parentChart) Create DataFormat Record that HOPEFULLY reflects the necessary associated recs
short	getSeriesIndex()
short	getSeriesNumber()
short	getShape() return XLSRecord data (2 bytes), which controls bar shape
boolean	getSmoothedLines() returns true if this parent chart has smoothed lines (Line, Scatter, Radar charts)
void	init() perform record initialization
void	initNew()
void	setDataLabels(String type) sets the data labels to the desired type: "ShowValueLabel" "ShowValueAsPercent" "ShowLabelAsPercent" "ShowLabel" "ShowSeriesName" "ShowBubbleLabel"
void	setHas3DBubbles(boolean b) sets 3D Bubbles (Bubble Chart only)
void	setHasDataLabels(int dl) sets the data labels for the entire chart (as opposed to a specific series/data point).
void	setHasLines() sets this chart to have lines (line chart, radar, scatter ...)
void	setHasLines(int lineStyle) sets this chart to have lines (line chart, radar, scatter ...) of the specific line style Style of line (0= solid, 1= dash, 2= dot, 3= dash-dot,4= dash dash-dot, 5= none, 6= dk gray pattern, 7= med.
void	setHasShadow(boolean b) data markers are displayed with a shadow on bubble, scatter, radar, stock, and line chart groups.
void	setMarkerFormat(int marker) 0 = no marker 1 = square 2 = diamond 3 = triangle 4 = X 5 = star 6 = Dow-Jones 7 = standard deviation 8 = circle 9 = plus sign
void	setPercentage(int p) percentage=distance of pie slice from center of pie as %
void	setPieSliceColor(int clr, int slice) sets the color of the desired pie slice
void	setPieSliceColor(String clr, int slice) sets the color of the desired pie slice
void	setPointNumber(int idx)
void	setSeriesColor(int clr) sets the color identified by this DataFormat in the group of records belonging to the parent series
void	setSeriesColor(String clr) sets the color identified by this DataFormat in the group of records belonging to the parent series
void	setSeriesIndex(int idx) Set the series index
void	setSeriesNumber(int idx)
void	setShape(int shape) set the shape bit of the associated XLSRecord
void	setSmoothLines(boolean smooth) set smooth lines setting (applicable for line, scatter charts)

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

DataFormat

public DataFormat()

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

initNew

public void initNew()

getPrototype

public static XLSRecord getPrototype()

Create a new dataformat

Parameters:

parentChart -

Returns:

getPrototypeWithFormatRecs

public static XLSRecord getPrototypeWithFormatRecs(Chart parentChart)

getPrototypeWithFormatRecs

public static XLSRecord getPrototypeWithFormatRecs(int seriesNumber,
                                                   Chart parentChart)

Create DataFormat Record that HOPEFULLY reflects the necessary associated recs

Parameters:

type -

Returns:

DataFormat Record

setPointNumber

public void setPointNumber(int idx)

setSeriesIndex

public void setSeriesIndex(int idx)

Set the series index

setSeriesNumber

public void setSeriesNumber(int idx)

getSeriesIndex

public short getSeriesIndex()

getSeriesNumber

public short getSeriesNumber()

getPointNumber

public short getPointNumber()

getShape

public short getShape()

return XLSRecord data (2 bytes), which controls bar shape

setShape

public void setShape(int shape)

set the shape bit of the associated XLSRecord

Parameters:

shape -

setSmoothLines

public void setSmoothLines(boolean smooth)

set smooth lines setting (applicable for line, scatter charts)

Parameters:

smooth -

getSmoothedLines

public boolean getSmoothedLines()

returns true if this parent chart has smoothed lines (Line, Scatter, Radar charts)

Returns:

getHasLines

public boolean getHasLines()

returns true if this parent chart has lines (Line, Scatter, Radar charts)

Returns:

setHasLines

public void setHasLines()

sets this chart to have lines (line chart, radar, scatter ...)

setHasLines

public void setHasLines(int lineStyle)

sets this chart to have lines (line chart, radar, scatter ...) of the specific line style
Style of line (0= solid, 1= dash, 2= dot, 3= dash-dot,4= dash dash-dot, 5= none, 6= dk gray pattern, 7= med. gray, 8= light gray

setHas3DBubbles

public void setHas3DBubbles(boolean b)

sets 3D Bubbles (Bubble Chart only)

Parameters:

b - true if has 3d Bubbles

getHas3DBubbles

public boolean getHas3DBubbles()

returns true if this paernt chart has 3D bubbles (Bubble chart only)

Returns:

getHasShadow

public boolean getHasShadow()

return if data markers are displayed with a shadow on bubble, scatter, radar, stock, and line chart groups.

setHasShadow

public void setHasShadow(boolean b)

data markers are displayed with a shadow on bubble, scatter, radar, stock, and line chart groups.

Parameters:

b -

setPercentage

public void setPercentage(int p)

percentage=distance of pie slice from center of pie as %

Parameters:

p -

getPercentage

public int getPercentage()

return percentage=distance of pie slice from center of pie as %

setDataLabels

public void setDataLabels(String type)

sets the data labels to the desired type:

"ShowValueLabel" "ShowValueAsPercent" "ShowLabelAsPercent" "ShowLabel" "ShowSeriesName" "ShowBubbleLabel"

Parameters:

type -

getHasDataLabels

public boolean getHasDataLabels()

returns true if has data labels

Returns:

getDataLabelType

public String getDataLabelType(String type)

return if has the specified data label

"ShowValueLabel" "ShowValueAsPercent" "ShowLabelAsPercent" "ShowLabel" "ShowSeriesName" "ShowBubbleLabel"