Ai (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.XLSRecord
- - io.starter.formats.XLS.charts.GenericChartObject
  - - io.starter.formats.XLS.charts.Ai

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable
```
public final class Ai
extends GenericChartObject
implements ChartObject
```
Ai: Linked Chart Data (1051h)
This record specifies linked series data or text. Offset Name Size Contents -- 4 id 1 index id: (0=title or text, 1=series vals, 2=series cats + (3=bubbles) 5 rt 1 reference type(0=default,1=text in formula bar, 2=worksheet, 4=error) 6 grbit 2 flags 8 ifmt 2 Index to number format (used if fCustomIfmt= true) 10 cce 2 size of rgce (in bytes) 12 rgce var Parsed formula of link The grbit field contains the following option flags. 0 0 0x1 fCustomIfmt TRUE if this object has a custom number format; FALSE if number format is linked to data source a 1 0x2 (reserved) Reserved; must be zero 0 5-2 0x3C st Source type (always zero) a 7-6 0xCO (reserved) Reserved; must be zero 1 7-0 0xFF (reserved) Reserved; must be zero

See Also:

Formula, Chart, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static byte[]`	`AI_TYPE_BUBBLE`
`protected static byte[]`	`AI_TYPE_CATEGORY`
`protected static byte[]`	`AI_TYPE_LEGEND`
`protected static byte[]`	`AI_TYPE_NULL_LEGEND`
`protected static byte[]`	`AI_TYPE_SERIES`
`protected int`	`cce`
`protected int`	`id`
`protected int`	`ifmt`
`static int`	`TYPE_BUBBLES`
`static int`	`TYPE_CATEGORIES`
`static int`	`TYPE_TEXT`
`static int`	`TYPE_VALS`

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

Ai()

Constructors
Constructor and Description
`Ai()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`changeAiLocation(Ptg p, String newLoc)` simplified version of changeAiLocation which locates current Ptg and updates expression NOTE: newLoc is expected to be a valid reference
`boolean`	`changeAiLocation(String loc, String newLoc)` Takes a string as a current formula location, and changes that pointer in the formula to the new string that is sent.
`void`	`close()` clear out object references in prep for closing workbook
`protected void`	`finalize()`
`String`	`getBoundName()` returns the bound sheet name - must be called after populateForTransfer
`int`	`getBoundXti()` returns the sheet reference index - must call after populateForTransfer
`Ptg[]`	`getCellRangePtgs()`
`String`	`getDefinition()` get the definition text the definition is stored in Excel parsed format
`Stack`	`getExpression()`
`int`	`getIfmt()` return the custom number format for this AI (category, series or bubble) if 0, use default number format as specified by Axis or Chart
`static ChartObject`	`getPrototype(byte[] aiType)` Get a prototype with the specified ai types.
`List<Ptg>`	`getPtgsByLocation(String loc)`
`String`	`getText()`
`int`	`getType()` Return the type (ID) of this Ai record
`void`	`init()` perform record initialization
`boolean`	`isfCustomIfmt()`
`void`	`populateForTransfer(String origSheetName)` Sets the boundsheet name for the data referenced in this AI.
`void`	`setExternsheetRef(int x)` set the Externsheet reference for any associated PtgArea3d's
`void`	`setExternsheetRef(int oldRef, int newRef)` set the Externsheet reference for any associated PtgArea3d's that match the old reference.
`void`	`setfCustomIfmt(boolean fCustomIfmt)`
`void`	`setLegend(String newLegend)`
`boolean`	`setLocationPolicy(String loc, int l)` locks the Ptg at the specified location
`void`	`setRt(int i)` set reference type(0=default,1=text in formula bar, 2=worksheet, 4=error)
`void`	`setSeriesText(SeriesText s)`
`boolean`	`setText(String txt)` Refer to the associated Series Text.
`String`	`toString()`
`void`	`updateRecord()`
`void`	`updateSheetRef(String newSheetName, String origWorkBookName)` take the original boundSheet + boundSheet xti reference and update it to the sheet reference in the new workbook (or same workbook but different ixti reference)

Methods inherited from class io.starter.formats.XLS.charts.GenericChartObject
addChartRecord, 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

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.starter.formats.XLS.charts.ChartObject
addChartRecord, getChartRecords, getParentChart, getRecordArray, setParentChart

- Field Detail
  - id
```
protected int id
```
  - ifmt
```
protected int ifmt
```
  - cce
```
protected int cce
```
  - TYPE_TEXT
```
public static final int TYPE_TEXT
```
    See Also:
    
    Constant Field Values
  - TYPE_VALS
```
public static final int TYPE_VALS
```
    See Also:
    
    Constant Field Values
  - TYPE_CATEGORIES
```
public static final int TYPE_CATEGORIES
```
    See Also:
    
    Constant Field Values
  - TYPE_BUBBLES
```
public static final int TYPE_BUBBLES
```
    See Also:
    
    Constant Field Values
  - AI_TYPE_LEGEND
```
protected static byte[] AI_TYPE_LEGEND
```
  - AI_TYPE_SERIES
```
protected static byte[] AI_TYPE_SERIES
```
  - AI_TYPE_CATEGORY
```
protected static byte[] AI_TYPE_CATEGORY
```
  - AI_TYPE_BUBBLE
```
protected static byte[] AI_TYPE_BUBBLE
```
  - AI_TYPE_NULL_LEGEND
```
protected static byte[] AI_TYPE_NULL_LEGEND
```
- Constructor Detail
  - Ai
```
public Ai()
```
- Method Detail
  - getBoundName
```
public String getBoundName()
```
    returns the bound sheet name - must be called after populateForTransfer
    
    Returns:
    
    String
  - getBoundXti
```
public int getBoundXti()
```
    returns the sheet reference index - must call after populateForTransfer
    
    Returns:
  - populateForTransfer
```
public void populateForTransfer(String origSheetName)
```
    Sets the boundsheet name for the data referenced in this AI. + sets the xti of the boundsheet reference (necessary upon sheet copy/move) Does not currently support multi-boundsheet references.
    
    See Also:
    
    updateSheetRef
  - setLegend
```
public void setLegend(String newLegend)
```
  - setText
```
public boolean setText(String txt)
```
    Refer to the associated Series Text.
    
    Parameters:
    
    txt -
    
    Returns:
  - getText
```
public String getText()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class XLSRecord
  - setSeriesText
```
public void setSeriesText(SeriesText s)
```
  - setExternsheetRef
```
public void setExternsheetRef(int x)
                       throws WorkSheetNotFoundException
```
    set the Externsheet reference for any associated PtgArea3d's
    
    Throws:
    
    WorkSheetNotFoundException
  - setExternsheetRef
```
public void setExternsheetRef(int oldRef,
                              int newRef)
                       throws WorkSheetNotFoundException
```
    set the Externsheet reference for any associated PtgArea3d's that match the old reference. invaluble for modifying only one sheets worth of references (ie a move sheet situation)
    
    Throws:
    
    WorkSheetNotFoundException
  - updateSheetRef
```
public void updateSheetRef(String newSheetName,
                           String origWorkBookName)
```
    take the original boundSheet + boundSheet xti reference and update it to the sheet reference in the new workbook (or same workbook but different ixti reference)
  - getDefinition
```
public String getDefinition()
```
    get the definition text the definition is stored in Excel parsed format
  - getCellRangePtgs
```
public Ptg[] getCellRangePtgs()
                       throws FormulaNotFoundException
```
    Throws:
    
    FormulaNotFoundException
  - getType
```
public int getType()
```
    Return the type (ID) of this Ai record
    
    Returns:
    
    int rt
  - getIfmt
```
public int getIfmt()
```
    return the custom number format for this AI (category, series or bubble)
    if 0, use default number format as specified by Axis or Chart
    
    Returns:
  - getPtgsByLocation
```
public List<Ptg> getPtgsByLocation(String loc)
```
  - setLocationPolicy
```
public boolean setLocationPolicy(String loc,
                                 int l)
```
    locks the Ptg at the specified location
  - changeAiLocation
```
public boolean changeAiLocation(Ptg p,
                                String newLoc)
```
    simplified version of changeAiLocation which locates current Ptg and updates expression NOTE: newLoc is expected to be a valid reference
    
    Parameters:
    
    p -
    
    newLoc -
    
    Returns:
  - changeAiLocation
```
public boolean changeAiLocation(String loc,
                                String newLoc)
```
    Takes a string as a current formula location, and changes that pointer in the formula to the new string that is sent. This can take single cells "A5" and cell ranges, "A3:d4" Returns true if the cell range specified in formulaLoc exists & can be changed else false. This also cannot change a cell pointer to a cell range or vice versa.
    
    Parameters:
    
    String - - range of Cells within Formula to modify
    
    String - - new range of Cells within Formula
  - updateRecord
```
public void updateRecord()
```
  - init
```
public void init()
```
    Description copied from class: XLSRecord
    
    perform record initialization
    
    Specified by:
    
    init in interface BiffRec
    
    Overrides:
    
    init in class XLSRecord
  - setRt
```
public void setRt(int i)
```
    set reference type(0=default,1=text in formula bar, 2=worksheet, 4=error)
    
    Parameters:
    
    i -
  - getPrototype
```
public static ChartObject getPrototype(byte[] aiType)
```
    Get a prototype with the specified ai types. 0 = Legend AI 1= Series Value Ai 2 = Category Ai 3 = Unknown, undocumented, but neccesarry AI 4 = Blank Legend AI with no reference.
  - getExpression
```
public Stack getExpression()
```
  - close
```
public void close()
```
    Description copied from class: GenericChartObject
    
    clear out object references in prep for closing workbook
    
    Overrides:
    
    close in class GenericChartObject
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class Object
  - isfCustomIfmt
```
public boolean isfCustomIfmt()
```
    Returns:
    
    the fCustomIfmt
  - setfCustomIfmt
```
public void setfCustomIfmt(boolean fCustomIfmt)
```
    Parameters:
    
    fCustomIfmt - the fCustomIfmt to set

Class Ai

Field Summary

Fields inherited from class io.starter.formats.XLS.charts.GenericChartObject

Fields inherited from class io.starter.formats.XLS.XLSRecord

Fields inherited from interface io.starter.formats.XLS.charts.ChartConstants

Fields inherited from interface io.starter.formats.XLS.XLSConstants

Constructor Summary

Method Summary

Methods inherited from class io.starter.formats.XLS.charts.GenericChartObject

Methods inherited from class io.starter.formats.XLS.XLSRecord

Methods inherited from class java.lang.Object

Methods inherited from interface io.starter.formats.XLS.charts.ChartObject

Field Detail

id

ifmt

cce

TYPE_TEXT

TYPE_VALS

TYPE_CATEGORIES

TYPE_BUBBLES

AI_TYPE_LEGEND

AI_TYPE_SERIES

AI_TYPE_CATEGORY

AI_TYPE_BUBBLE

AI_TYPE_NULL_LEGEND

Constructor Detail

Ai

Method Detail

getBoundName

getBoundXti

populateForTransfer

setLegend

setText

getText

toString

setSeriesText

setExternsheetRef

setExternsheetRef

updateSheetRef

getDefinition

getCellRangePtgs

getType

getIfmt

getPtgsByLocation

setLocationPolicy

changeAiLocation

changeAiLocation

updateRecord

init

setRt

getPrototype

getExpression

close

finalize

isfCustomIfmt

setfCustomIfmt