public class ChartFormat extends GenericChartObject implements ChartObject
chartArr, chartType, parentChartcol, continues, DEBUGLEVEL, hyperlink, idx, isBlank, isBoolean, isContinueMerged, isString, lastidx, myxf, offset, rw, streamer, wkbook, worksheetAREACHART, 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, ZAXISAI, 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 and Description |
|---|
ChartFormat() |
| Modifier and Type | Method and Description |
|---|---|
ChartLine |
addChartLines(int lineType)
Chart Line options (not available on all charts):
Drop Lines available on Line, Area and Stock charts HiLow Lines are available on Line and Stock charts Series Lines are available on Bar and OfPie charts |
void |
addUpDownBars()
add up/down bars (line, area stock)
|
int |
getBarShape()
returns the bar shape for a column or bar type chart can be one of:
ChartConstants.SHAPECOLUMN default ChartConstants.SHAPECONE ChartConstants.SHAPECONETOMAX ChartConstants.SHAPECYLINDER ChartConstants.SHAPEPYRAMID ChartConstants.SHAPEPYRAMIDTOMAX |
int |
getChartLines()
return ChartLines option, if any
|
ChartLine |
getChartLinesRec()
return the record governing chart lines: dropLines, Hi-low lines or Series Lines
|
ChartLine |
getChartLinesRec(int id) |
String |
getChartOption(String op)
get the value of *almost* any chart option (axis options are in Axis)
|
String |
getChartOptionsXML()
access chart-type record and return any options specific for this chart
in XML form Gathers chart options such as show legend, grid lines, etc
...
|
String |
getDataLabels()
return the Data Labels chosen for this chart, if any can be one or more
of:
Value ValuePerecentage CategoryPercentage CategoryLabel BubbleLabel SeriesLabel or an empty string if no data labels are chosen for the chart |
int |
getDataLabelsInt()
return data label options as an int
can be one or more of: SHOWVALUE= 0x1; SHOWVALUEPERCENT= 0x2; SHOWCATEGORYPERCENT= 0x4; SHOWCATEGORYLABEL= 0x10; SHOWBUBBLELABEL= 0x20; SHOWSERIESLABEL= 0x40; |
int |
getDrawingOrder()
return the drawing order of this ChartFormat
For multiple charts-in-one, drawing order determines the order of the charts |
int |
getGapDepth()
returns an int representing the space between points in a 3d area, bar or line chart, or 0 if not 3d
|
boolean |
getHasDropLines()
returns true if chart has Drop Lines
|
boolean |
getHasLines()
returns true if this chart displays lines (Line, Scatter, Radar)
|
boolean |
getHasSmoothLines()
returns true if this chart has smoothed lines (Scatter, Line, Radar)
|
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 |
static XLSRecord |
getPrototype() |
ThreeD |
getThreeDRec(boolean bCreate)
Return the ThreeD rec associated with this ChartFormat, create if not
present
|
String |
getThreeDXML()
return ThreeD options in XML form
|
String |
getUpDownBarOOXML()
return the OOXML to define the upDownBars element
defined by 2 Dropbar records in this subarray Only valid for Line and Stock charts |
boolean |
getVaryColor()
returns whether
the color for each data point and the color and type for each data marker
vary
|
void |
init()
perform record initialization
|
boolean |
is3DClustered()
return truth of "chart is 3d clustered"
|
boolean |
isThreeD(int chartType) |
void |
parseUpDownBarsOOXML(org.xmlpull.v1.XmlPullParser xpp,
Stack<String> lastTag,
WorkBookHandle bk)
parse upDownBars OOXML element (controled by 2 DropBar records in this subArray)
Valid for Line and Stock charts only |
void |
setBarShape(int shape)
bar shape:
the shape is as follows: public static final int SHAPECOLUMN= 0; // default public static final int SHAPECYLINDER= 1; public static final int SHAPEPYRAMID= 256; public static final int SHAPECONE= 257; public static final int SHAPEPYRAMIDTOMAX= 516; public static final int SHAPECONETOMAX= 517; |
protected void |
setChartObject(ChartObject co)
replace the existing chart object with the desired ChartObject,
effectively changing the type of the chart
|
void |
setDrawingOrder(int order)
set the drawing order of this ChartFormat
For multiple charts-in-one, drawing order determines the order of the charts |
void |
setGapDepth(int gap)
sets the Space between points (50 or 150 is default)
|
void |
setHas3DBubbles(boolean has3dBubbles)
sets 3d bubble state
|
void |
setHasDataLabels(int dl)
sets the data labels for the entire chart (as opposed to a specific series/data point).
|
void |
setHasDropLines()
sets this chart (Area, Line or Stock) to have Drop Lines
|
void |
setHasLines()
sets this chart to have default lines (Scatter, Line chart ...)
|
void |
setHasLines(int lineStyle)
sets this chart to have lines (Scatter, Line chart ...) of style lineStyle
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 |
setHasSmoothLines(boolean b)
sets this chart to have smoothed lines (Scatter, Line, Radar)
|
void |
setIsClustered(boolean bIsClustered)
sets if this chart has clustered bar/columns
|
void |
setMarkers(int markerFormat)
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 |
setOption(String op,
String val)
sets chart options such as threed options, grid lines, etc ...
|
void |
setPercentage(int p)
percentage=distance of pie slice from center of pie as %
|
void |
setVaryColor(boolean vary)
specifies whether
the color for each data point and the color and type for each data marker
vary
|
addChartRecord, close, getChartRecords, getOptionsXML, getParentChart, getRecordArray, getScript, hasShadow, is100Percent, isStacked, setChartOption, setIs100Percent, setIsStacked, setParentChartaddContinue, 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, toStringequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddChartRecord, getChartRecords, getParentChart, getRecordArray, setParentChartpublic void init()
XLSRecordpublic void setVaryColor(boolean vary)
b - public boolean getVaryColor()
b - protected void setChartObject(ChartObject co)
co - public boolean isThreeD(int chartType)
public boolean is3DClustered()
public void setIsClustered(boolean bIsClustered)
bIsClustered - public void setGapDepth(int gap)
gap - public int getGapDepth()
public String getThreeDXML()
public void setPercentage(int p)
p - public void setBarShape(int shape)
shape - public void setOption(String op, String val)
op - String option nameval - Object valuepublic ThreeD getThreeDRec(boolean bCreate)
public String getDataLabels()
public boolean getHasLines()
public void setHasLines()
public void setHasLines(int lineStyle)
public boolean getHasSmoothLines()
public void setHasSmoothLines(boolean b)
public boolean getHasDropLines()
public void setHasDropLines()
public void setHas3DBubbles(boolean has3dBubbles)
has3dBubbles - public int getDataLabelsInt()
AttachedLabelpublic void setHasDataLabels(int dl)
public int getBarShape()
public int getMarkerFormat()
public void setMarkers(int markerFormat)
public ChartLine addChartLines(int lineType)
0= drop lines below the data points of Line, Area and Stock charts
1= High-low lines around the data points of Line and Stock charts
2- Series Line connecting data points of stacked column and bar charts and OfPie Charts
lineType - public int getChartLines()
0= drop lines below the data points of Line, Area and Stock charts
1= High-low lines around the data points of Line and Stock charts
2- Series Line connecting data points of stacked column and bar charts and OfPie Charts
public ChartLine getChartLinesRec()
public ChartLine getChartLinesRec(int id)
public void addUpDownBars()
public void parseUpDownBarsOOXML(org.xmlpull.v1.XmlPullParser xpp,
Stack<String> lastTag,
WorkBookHandle bk)
public String getUpDownBarOOXML()
public int getDrawingOrder()
public void setDrawingOrder(int order)
order - public static XLSRecord getPrototype()
public String getChartOptionsXML()
setChartOption,
setOption,
getThreeDXML(),
getAxesXML()public String getChartOption(String op)
getChartOption in class GenericChartObjectop - String option e.g. Shadow or PercentageCopyright © 2002–2019 Starter Inc.. All rights reserved.