Example:
$workbook = new cells\Workbook(); $cells = $workbook->getWorksheets()->get(0)->getCells(); //Set default row height $cells->setStandardHeight(20); //Set row height $cells->setRowHeight(2, 20.5); //Set default colum width $cells->setStandardWidth(15); //Set column width $cells->setColumnWidth(3, 12.57); //Merge cells $cells->merge(5, 4, 2, 2);
Property Getters/Setters Summary | ||
---|---|---|
function | getColumns() | |
Gets the collection of |
||
function | getCount() | |
Gets the total count of instantiated Cell objects. | ||
function | getCountLarge() | |
Gets the total count of instantiated Cell objects. | ||
function | getFirstCell() | |
Gets the first cell in this worksheet. | ||
function | isDefaultRowHeightMatched() | |
function | setDefaultRowHeightMatched(value) | |
Indicates that row height and default font height matches | ||
function | isDefaultRowHidden() | |
function | setDefaultRowHidden(value) | |
Indicates whether the row is defaultly hidden. | ||
function | getLastCell() | |
Gets the last cell in this worksheet. | ||
function | getMaxColumn() | |
Maximum column index of cell which contains data or style. | ||
function | getMaxDataColumn() | |
Maximum column index of cell which contains data. | ||
function | getMaxDataRow() | |
Maximum row index of cell which contains data. | ||
function | getMaxDisplayRange() | |
Gets the max range which includes data, merged cells and shapes. | ||
function | getMaxRow() | |
Maximum row index of cell which contains data or style. | ||
function | getMemorySetting() | |
function | setMemorySetting(value) | |
Gets or sets the memory usage option for this cells. The value of the property is MemorySetting integer constant. | ||
function | getMergedCells() | |
Gets the collection of merged cells. | ||
function | getMinColumn() | |
Minimum column index of cell which contains data or style. | ||
function | getMinDataColumn() | |
Minimum column index of cell which contains data. | ||
function | getMinDataRow() | |
Minimum row index of cell which contains data. | ||
function | getMinRow() | |
Minimum row index of cell which contains data or style. | ||
function | getMultiThreadReading() | |
function | setMultiThreadReading(value) | |
Gets or sets whether the cells data model should support Multi-Thread reading. Default value of this property is false. If there are multiple threads to read Row/Cell objects in this collection concurrently, this property should be set as true, otherwise unexpected result may be produced. Supporting Multi-Thread reading may degrade the performance for accessing Row/Cell objects from this collection. | ||
function | getOdsCellFields() | |
Gets the list of fields of ods. | ||
function | getPreserveString() | |
function | setPreserveString(value) | |
Gets or sets a value indicating whether all worksheet values are preserved as strings. Default is false. | ||
function | getRanges() | |
Gets the collection of |
||
function | getRows() | |
Gets the collection of |
||
function | getStandardHeight() | |
function | setStandardHeight(value) | |
Gets or sets the default row height in this worksheet, in unit of points. | ||
function | getStandardHeightPixels() | |
function | setStandardHeightPixels(value) | |
Gets or sets the default row height in this worksheet, in unit of pixels. | ||
function | getStandardWidth() | |
function | setStandardWidth(value) | |
Gets or sets the default column width in the worksheet, in unit of characters. | ||
function | getStandardWidthInch() | |
function | setStandardWidthInch(value) | |
Gets or sets the default column width in the worksheet, in unit of inches. | ||
function | getStandardWidthPixels() | |
function | setStandardWidthPixels(value) | |
Gets or sets the default column width in the worksheet, in unit of pixels. | ||
function | getStyle() | |
function | setStyle(value) | |
Gets and sets the default style. | ||
function | get(index) | |
Gets |
||
function | get(row, column) | |
Gets the |
||
function | get(cellName) | |
Gets the |
Method Summary | ||
---|---|---|
function | addRange(rangeObject) | |
Adds a range object reference to cells | ||
function | applyColumnStyle(column, style, flag) | |
Applies formats for a whole column. | ||
function | applyRowStyle(row, style, flag) | |
Applies formats for a whole row. | ||
function | applyStyle(style, flag) | |
Applies formats for a whole worksheet. | ||
function | checkCell(row, column) | |
Gets the |
||
function | checkColumn(columnIndex) | |
Gets the |
||
function | checkRow(row) | |
Gets the |
||
function | clear() | |
Clears all cell and row objects. | ||
function | clearContents(range) | |
Clears contents of a range. | ||
function | clearContents(startRow, startColumn, endRow, endColumn) | |
Clears contents of a range. | ||
function | clearFormats(range) | |
Clears formatting of a range. | ||
function | clearFormats(startRow, startColumn, endRow, endColumn) | |
Clears formatting of a range. | ||
function | clearRange(range) | |
Clears contents and formatting of a range. | ||
function | clearRange(startRow, startColumn, endRow, endColumn) | |
Clears contents and formatting of a range. | ||
function | convertStringToNumericValue() | |
Converts string data in cells to numeric value if possible. | ||
function | copyColumn(sourceCells, sourceColumnIndex, destinationColumnIndex) | |
Copies data and formats of a whole column. | ||
function | copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber) | |
Copies data and formats of a whole column. | ||
function | copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber, pasteOptions) | |
Copies data and formats of a whole column. | ||
function | copyColumns(sourceCells, sourceColumnIndex, sourceTotalColumns, destinationColumnIndex, destinationTotalColumns) | |
Copies data and formats of the whole columns. | ||
function | copyRow(sourceCells, sourceRowIndex, destinationRowIndex) | |
Copies data and formats of a whole row. | ||
function | copyRows(sourceCells, sourceRowIndex, destinationRowIndex, rowNumber) | |
Copies data and formats of some whole rows. | ||
function | copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions) | |
Copies data and formats of some whole rows. | ||
function | copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions, pasteOptions) | |
Copies data and formats of some whole rows. | ||
function | createRange(firstIndex, number, isVertical) | |
Creates a |
||
function | createRange(firstRow, firstColumn, totalRows, totalColumns) | |
Creates a |
||
function | createRange(address) | |
Creates a |
||
function | createRange(upperLeftCell, lowerRightCell) | |
Creates a |
||
function | deleteBlankColumns() | |
Delete all blank columns which do not contain any data. | ||
function | deleteBlankColumns(options) | |
Delete all blank columns which do not contain any data. | ||
function | deleteBlankRows() | |
Delete all blank rows which do not contain any data. | ||
function | deleteBlankRows(options) | |
Delete all blank rows which do not contain any data. | ||
function | deleteColumn(columnIndex) | |
Deletes a column. | ||
function | deleteColumn(columnIndex, updateReference) | |
Deletes a column. | ||
function | deleteColumns(columnIndex, totalColumns, updateReference) | |
Deletes several columns. | ||
function | deleteRange(startRow, startColumn, endRow, endColumn, shiftType) | |
Deletes a range of cells and shift cells according to the shift option. | ||
function | deleteRow(rowIndex) | |
Deletes a row. | ||
function | deleteRows(rowIndex, totalRows) | |
Deletes several rows. | ||
function | deleteRows(rowIndex, totalRows, updateReference) | |
Deletes multiple rows in the worksheet. | ||
function | dispose() | |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. | ||
function | endCellInColumn(startRow, endRow, startColumn, endColumn) | |
Gets the last cell with maximum column index in this range. | ||
function | endCellInColumn(columnIndex) | |
Gets the last cell in this column. | ||
function | endCellInRow(rowIndex) | |
Gets the last cell in this row. | ||
function | endCellInRow(startRow, endRow, startColumn, endColumn) | |
Gets the last cell with maximum row index in this range. | ||
function | find(what, previousCell) | |
Finds the cell containing with the input object. | ||
function | find(what, previousCell, findOptions) | |
Finds the cell containing with the input object. | ||
function | findFormula(formula, previousCell) | |
Finds the cell with the input string. | ||
function | findFormulaContains(formula, previousCell) | |
Finds the cell with formla which contains the input string. | ||
function | getCell(row, column) | |
Gets the |
||
function | getCellStyle(row, column) | |
Get the style of given cell. | ||
function | getColumn(columnIndex) | |
Gets the |
||
function | getColumnWidth(column) | |
Gets the width of the specified column in normal view | ||
function | getColumnWidthInch(column) | |
Gets the width of the specified column in normal view, in units of inches. | ||
function | getColumnWidthPixel(column) | |
Gets the width of the specified column in normal view, in units of pixel. | ||
function | getDependents(isAll, row, column) | |
Get all cells which refer to the specific cell. | ||
function | getGroupedColumnOutlineLevel(columnIndex) | |
Gets the outline level (zero-based) of the column. | ||
function | getGroupedRowOutlineLevel(rowIndex) | |
Gets the outline level (zero-based) of the row. | ||
function | getLastDataRow(column) | |
Gets the last row index of cell which contains data in the specified column. | ||
function | getMaxGroupedColumnOutlineLevel() | |
Gets the max grouped column outline level (zero-based). | ||
function | getMaxGroupedRowOutlineLevel() | |
Gets the max grouped row outline level (zero-based). | ||
function | getRow(row) | |
Gets the |
||
function | getRowEnumerator() | |
Gets the rows enumerator | ||
function | getRowHeight(row) | |
Gets the height of a specified row. | ||
function | getRowHeightInch(row) | |
Gets the height of a specified row in unit of inches. | ||
function | getRowHeightPixel(row) | |
Gets the height of a specified row in unit of pixel. | ||
function | getViewColumnWidthPixel(column) | |
Get the width in different view type. | ||
function | groupColumns(firstIndex, lastIndex) | |
Groups columns. | ||
function | groupColumns(firstIndex, lastIndex, isHidden) | |
Groups columns. | ||
function | groupRows(firstIndex, lastIndex) | |
Groups rows. | ||
function | groupRows(firstIndex, lastIndex, isHidden) | |
Groups rows. | ||
function | hideColumn(column) | |
Hides a column. | ||
function | hideColumns(column, totalColumns) | |
Hide multiple columns. | ||
function | hideGroupDetail(isVertical, index) | |
Collapses the grouped rows/columns. | ||
function | hideRow(row) | |
Hides a row. | ||
function | hideRows(row, totalRows) | |
Hides multiple rows. | ||
function | importCSV(fileName, options, firstRow, firstColumn) | |
Import a CSV file to the cells. | ||
function | importCSV(fileName, spliter, convertNumericData, firstRow, firstColumn) | |
Import a CSV file to the cells. | ||
function | importFormulaArray(stringArray, firstRow, firstColumn, isVertical) | |
Imports an array of formula into a worksheet. | ||
function | insertColumn(columnIndex) | |
Inserts a new column into the worksheet. | ||
function | insertColumn(columnIndex, updateReference) | |
Inserts a new column into the worksheet. | ||
function | insertColumns(columnIndex, totalColumns) | |
Inserts some columns into the worksheet. | ||
function | insertColumns(columnIndex, totalColumns, updateReference) | |
Inserts some columns into the worksheet. | ||
function | insertCutCells(cutRange, row, column, shiftType) | |
Insert cut range. | ||
function | insertRange(area, shiftType) | |
Inserts a range of cells and shift cells according to the shift option. | ||
function | insertRange(area, shiftNumber, shiftType) | |
Inserts a range of cells and shift cells according to the shift option. | ||
function | insertRange(area, shiftNumber, shiftType, updateReference) | |
Inserts a range of cells and shift cells according to the shift option. | ||
function | insertRow(rowIndex) | |
Inserts a new row into the worksheet. | ||
function | insertRows(rowIndex, totalRows) | |
Inserts multiple rows into the worksheet. | ||
function | insertRows(rowIndex, totalRows, updateReference) | |
Inserts multiple rows into the worksheet. | ||
function | insertRows(rowIndex, totalRows, options) | |
Inserts multiple rows into the worksheet. | ||
function | isBlankColumn(columnIndex) | |
Checks whether given column is blank(does not contain any data). | ||
function | isColumnHidden(columnIndex) | |
Checks whether a column at given index is hidden. | ||
function | isDeletingRangeEnabled(startRow, startColumn, totalRows, totalColumns) | |
Check whether the range could be deleted. | ||
function | isRowHidden(rowIndex) | |
Checks whether a row at given index is hidden. | ||
function | iterator() | |
Gets the cells enumerator. | ||
function | linkToXmlMap(mapName, row, column, path) | |
Link to a xml map. | ||
function | merge(firstRow, firstColumn, totalRows, totalColumns) | |
Merges a specified range of cells into a single cell. | ||
function | merge(firstRow, firstColumn, totalRows, totalColumns, mergeConflict) | |
Merges a specified range of cells into a single cell. | ||
function | merge(firstRow, firstColumn, totalRows, totalColumns, checkConflict, mergeConflict) | |
Merges a specified range of cells into a single cell. | ||
function | moveRange(sourceArea, destRow, destColumn) | |
Moves the range. | ||
function | removeDuplicates(startRow, startColumn, endRow, endColumn) | |
Removes duplicate values in the range. | ||
function | removeDuplicates(startRow, startColumn, endRow, endColumn, hasHeaders, columnOffsets) | |
Removes duplicate data of the range. | ||
function | removeFormulas() | |
Removes all formula and replaces with the value of the formula. | ||
function | retrieveSubtotalSetting(ca) | |
Retrieves subtotals setting of the range. | ||
function | setColumnWidth(column, width) | |
Sets the width of the specified column in normal view. | ||
function | setColumnWidthInch(column, inches) | |
Sets column width in unit of inches in normal view. | ||
function | setColumnWidthPixel(column, pixels) | |
Sets column width in unit of pixels in normal view. | ||
function | setRowHeight(row, height) | |
Sets the height of the specified row. | ||
function | setRowHeightInch(row, inches) | |
Sets row height in unit of inches. | ||
function | setRowHeightPixel(row, pixels) | |
Sets row height in unit of pixels. | ||
function | setViewColumnWidthPixel(column, pixels) | |
Sets the width of the column in different view. | ||
function | showGroupDetail(isVertical, index) | |
Uncollapses the grouped rows/columns. | ||
function | subtotal(ca, groupBy, function, totalList) | |
Creates subtotals for the range. | ||
function | subtotal(ca, groupBy, function, totalList, replace, pageBreaks, summaryBelowData) | |
Creates subtotals for the range. | ||
function | textToColumns(row, column, totalRows, options) | |
Splits the text in the column to columns. | ||
function | ungroupColumns(firstIndex, lastIndex) | |
Ungroups columns. | ||
function | ungroupRows(firstIndex, lastIndex) | |
Ungroups rows. | ||
function | ungroupRows(firstIndex, lastIndex, isAll) | |
Ungroups rows. | ||
function | unhideColumn(column, width) | |
Unhides a column | ||
function | unhideColumns(column, totalColumns, width) | |
Unhide multiple columns. | ||
function | unhideRow(row, height) | |
Unhides a row. | ||
function | unhideRows(row, totalRows, height) | |
Unhides the hidden rows. | ||
function | unMerge(firstRow, firstColumn, totalRows, totalColumns) | |
Unmerges a specified range of merged cells. |
Property Getters/Setters Detail |
---|
getOdsCellFields : OdsCellFieldCollection | |
function getOdsCellFields() |
getCount : Number | |
function getCount() |
getCountLarge : long | |
function getCountLarge() |
getRows : RowCollection | |
function getRows() |
getMergedCells : ArrayList | |
function getMergedCells() |
getMultiThreadReading/setMultiThreadReading : boolean | |
function getMultiThreadReading() / function setMultiThreadReading(value) |
getMemorySetting/setMemorySetting : Number | |
function getMemorySetting() / function setMemorySetting(value) |
getStyle/setStyle : Style | |
function getStyle() / function setStyle(value) |
getStandardWidthInch/setStandardWidthInch : Number | |
function getStandardWidthInch() / function setStandardWidthInch(value) |
getStandardWidthPixels/setStandardWidthPixels : Number | |
function getStandardWidthPixels() / function setStandardWidthPixels(value) |
getStandardWidth/setStandardWidth : Number | |
function getStandardWidth() / function setStandardWidth(value) |
getStandardHeight/setStandardHeight : Number | |
function getStandardHeight() / function setStandardHeight(value) |
getStandardHeightPixels/setStandardHeightPixels : Number | |
function getStandardHeightPixels() / function setStandardHeightPixels(value) |
getPreserveString/setPreserveString : boolean | |
function getPreserveString() / function setPreserveString(value) |
getMinRow : Number | |
function getMinRow() |
getMaxRow : Number | |
function getMaxRow() |
getMinColumn : Number | |
function getMinColumn() |
getMaxColumn : Number | |
function getMaxColumn() |
getMinDataRow : Number | |
function getMinDataRow() |
getMaxDataRow : Number | |
function getMaxDataRow() |
getMinDataColumn : Number | |
function getMinDataColumn() |
getMaxDataColumn : Number | |
function getMaxDataColumn() |
isDefaultRowHeightMatched/setDefaultRowHeightMatched : boolean | |
function isDefaultRowHeightMatched() / function setDefaultRowHeightMatched(value) |
isDefaultRowHidden/setDefaultRowHidden : boolean | |
function isDefaultRowHidden() / function setDefaultRowHidden(value) |
getColumns : ColumnCollection | |
function getColumns() |
getRanges : RangeCollection | |
function getRanges() |
getLastCell : Cell | |
function getLastCell() |
getMaxDisplayRange : Range | |
function getMaxDisplayRange() |
getFirstCell : Cell | |
function getFirstCell() |
get : Cell | |
function get(index) |
index
- The zero based index of the element.get : Cell | |
function get(row, column) |
row
- Row index.column
- Column index.Example:
$workbook = new cells\Workbook(); $cells = $workbook->getWorksheets()->get(0)->getCells(); $cell =$cells->get(0, 0); //Gets the cell at "A1"
get : Cell | |
function get(cellName) |
cellName
- Cell name,including its column letter and row number, for example A5.Example:
$workbook = new cells\Workbook(); $cells = $workbook->getWorksheets()->get(0)->getCells(); $cell =$cells->get("A1"); //Gets the cell at "A1"
Method Detail |
---|
findFormula | |
function findFormula(formula, previousCell) |
formula: String
- The formula to search for.previousCell: Cell
- Previous cell with the same formula. This parameter can be set to null if searching from the start.findFormulaContains | |
function findFormulaContains(formula, previousCell) |
formula: String
- The formula to search for.previousCell: Cell
- Previous cell with the same formula. This parameter can be set to null if searching from the start.find | |
function find(what, previousCell) |
what: Object
- The object to search for.
The type should be int,double,DateTime,string,bool.
previousCell: Cell
- Previous cell with the same object.
This parameter can be set to null if searching from the start.find | |
function find(what, previousCell, findOptions) |
what: Object
- The object to search for.
The type should be int,double,DateTime,string,bool.
previousCell: Cell
- Previous cell with the same object.
This parameter can be set to null if searching from the start.findOptions: FindOptions
- Find optionsendCellInRow | |
function endCellInRow(rowIndex) |
rowIndex: Number
- Row index.endCellInColumn | |
function endCellInColumn(columnIndex) |
columnIndex: Number
- Column index.endCellInColumn | |
function endCellInColumn(startRow, endRow, startColumn, endColumn) |
startRow: Number
- Start row index.endRow: Number
- End row index.startColumn: Number
- Start column index.endColumn: Number
- End column index.endCellInRow | |
function endCellInRow(startRow, endRow, startColumn, endColumn) |
startRow: Number
- Start row index.endRow: Number
- End row index.startColumn: Number
- Start column index.endColumn: Number
- End column index.moveRange | |
function moveRange(sourceArea, destRow, destColumn) |
sourceArea: CellArea
- The range which should be moved.destRow: Number
- The dest row.destColumn: Number
- The dest column.insertCutCells | |
function insertCutCells(cutRange, row, column, shiftType) |
cutRange: Range
- The cut range.row: Number
- The row.column: Number
- The column.shiftType: Number
- A insertRange | |
function insertRange(area, shiftNumber, shiftType, updateReference) |
area: CellArea
- Shift area.shiftNumber: Number
- Number of rows or columns to be inserted.shiftType: Number
- A updateReference: boolean
- Indicates if update references in other worksheets.insertRange | |
function insertRange(area, shiftType) |
area: CellArea
- Shift area.shiftType: Number
- A insertRange | |
function insertRange(area, shiftNumber, shiftType) |
area: CellArea
- Shift area.shiftNumber: Number
- Number of rows or columns to be inserted.shiftType: Number
- A deleteRange | |
function deleteRange(startRow, startColumn, endRow, endColumn, shiftType) |
startRow: Number
- Start row index.startColumn: Number
- Start column index.endRow: Number
- End row index.endColumn: Number
- End column index.shiftType: Number
- A retrieveSubtotalSetting | |
function retrieveSubtotalSetting(ca) |
ca: CellArea
- The rangesubtotal | |
function subtotal(ca, groupBy, function, totalList) |
ca: CellArea
- The rangegroupBy: Number
- The field to group by, as a zero-based integer offsetfunction: Number
- A totalList: Number Array
- An array of zero-based field offsets, indicating the fields to which the subtotals are added.subtotal | |
function subtotal(ca, groupBy, function, totalList, replace, pageBreaks, summaryBelowData) |
ca: CellArea
- The rangegroupBy: Number
- The field to group by, as a zero-based integer offsetfunction: Number
- A totalList: Number Array
- An array of zero-based field offsets, indicating the fields to which the subtotals are added.replace: boolean
- Indicates whether replace the current subtotalspageBreaks: boolean
- Indicates whether add page break between groupssummaryBelowData: boolean
- Indicates whether add summarry below data.removeFormulas | |
function removeFormulas() |
removeDuplicates | |
function removeDuplicates(startRow, startColumn, endRow, endColumn) |
startRow: Number
- The start row.startColumn: Number
- The start columnendRow: Number
- The end row index.endColumn: Number
- The end column index.removeDuplicates | |
function removeDuplicates(startRow, startColumn, endRow, endColumn, hasHeaders, columnOffsets) |
startRow: Number
- The start row.startColumn: Number
- The start columnendRow: Number
- The end row index.endColumn: Number
- The end column index.hasHeaders: boolean
- Indicates whether the range contains headers.columnOffsets: Number Array
- The column offsets.convertStringToNumericValue | |
function convertStringToNumericValue() |
getDependents | |
function getDependents(isAll, row, column) |
isAll: boolean
- Indicates whether check other worksheetsrow: Number
- The row index.column: Number
- The column index.getCellStyle | |
function getCellStyle(row, column) |
row: Number
- row indexcolumn: Number
- columnmerge | |
function merge(firstRow, firstColumn, totalRows, totalColumns) |
firstRow: Number
- First row of this range(zero based)firstColumn: Number
- First column of this range(zero based)totalRows: Number
- Number of rows(one based)totalColumns: Number
- Number of columns(one based)merge | |
function merge(firstRow, firstColumn, totalRows, totalColumns, mergeConflict) |
firstRow: Number
- First row of this range(zero based)firstColumn: Number
- First column of this range(zero based)totalRows: Number
- Number of rows(one based)totalColumns: Number
- Number of columns(one based)mergeConflict: boolean
- Merge conflict merged ranges.merge | |
function merge(firstRow, firstColumn, totalRows, totalColumns, checkConflict, mergeConflict) |
firstRow: Number
- First row of this range(zero based)firstColumn: Number
- First column of this range(zero based)totalRows: Number
- Number of rows(one based)totalColumns: Number
- Number of columns(one based)checkConflict: boolean
- Indicates whether check the merged cells intersects other merged cellsmergeConflict: boolean
- Merge conflict merged ranges.unMerge | |
function unMerge(firstRow, firstColumn, totalRows, totalColumns) |
firstRow: Number
- First row of this range(zero based)firstColumn: Number
- First column of this range(zero based)totalRows: Number
- Number of rows(one based)totalColumns: Number
- Number of columns(one based)hideRow | |
function hideRow(row) |
row: Number
- Row index.unhideRow | |
function unhideRow(row, height) |
row: Number
- Row index.height: Number
- Row height. The row's height will be changed only when the row is hidden and given height value is positive.hideRows | |
function hideRows(row, totalRows) |
row: Number
- The row index.totalRows: Number
- The row number.unhideRows | |
function unhideRows(row, totalRows, height) |
row: Number
- The row index.totalRows: Number
- The row number.height: Number
- Row height. The row's height will be changed only when the row is hidden and given height value is positive.setRowHeightPixel | |
function setRowHeightPixel(row, pixels) |
row: Number
- Row index.pixels: Number
- Number of pixels.setRowHeightInch | |
function setRowHeightInch(row, inches) |
row: Number
- Row index.inches: Number
- Number of inches.It should be between 0 and 409.5/72.setRowHeight | |
function setRowHeight(row, height) |
row: Number
- Row index.height: Number
- Height of row.In unit of point It should be between 0 and 409.5.getRowHeight | |
function getRowHeight(row) |
row: Number
- Row indexhideColumn | |
function hideColumn(column) |
column: Number
- Column index.unhideColumn | |
function unhideColumn(column, width) |
column: Number
- Column index.width: Number
- Column width.hideColumns | |
function hideColumns(column, totalColumns) |
column: Number
- Column index.totalColumns: Number
- Column number.unhideColumns | |
function unhideColumns(column, totalColumns, width) |
column: Number
- Column index.totalColumns: Number
- Column numberwidth: Number
- Column width.getRowHeightPixel | |
function getRowHeightPixel(row) |
row: Number
- Row indexgetRowHeightInch | |
function getRowHeightInch(row) |
row: Number
- Row indexsetColumnWidthPixel | |
function setColumnWidthPixel(column, pixels) |
column: Number
- Column index.pixels: Number
- Number of pixels.setColumnWidthInch | |
function setColumnWidthInch(column, inches) |
column: Number
- Column index.inches: Number
- Number of inches.setColumnWidth | |
function setColumnWidth(column, width) |
column: Number
- Column index.width: Number
- Width of column.Column width must be between 0 and 255.getColumnWidthPixel | |
function getColumnWidthPixel(column) |
column: Number
- Column indexgetColumnWidthInch | |
function getColumnWidthInch(column) |
column: Number
- Column indexgetColumnWidth | |
function getColumnWidth(column) |
column: Number
- Column indexgetViewColumnWidthPixel | |
function getViewColumnWidthPixel(column) |
column: Number
- The column index.setViewColumnWidthPixel | |
function setViewColumnWidthPixel(column, pixels) |
column: Number
- The column index.pixels: Number
- The width in unit of pixels.getLastDataRow | |
function getLastDataRow(column) |
column: Number
- Column index.applyColumnStyle | |
function applyColumnStyle(column, style, flag) |
column: Number
- The column index.style: Style
- The style object which will be applied.flag: StyleFlag
- Flags which indicates applied formatting properties.applyRowStyle | |
function applyRowStyle(row, style, flag) |
row: Number
- The row index.style: Style
- The style object which will be applied.flag: StyleFlag
- Flags which indicates applied formatting properties.applyStyle | |
function applyStyle(style, flag) |
style: Style
- The style object which will be applied.flag: StyleFlag
- Flags which indicates applied formatting properties.copyColumns | |
function copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber, pasteOptions) |
sourceCells0: Cells
- Source Cells object contains data and formats to copy.sourceColumnIndex: Number
- Source column index.destinationColumnIndex: Number
- Destination column index.columnNumber: Number
- The copied column number.pasteOptions: PasteOptions
- the options of pasting.copyColumn | |
function copyColumn(sourceCells, sourceColumnIndex, destinationColumnIndex) |
sourceCells: Cells
- Source Cells object contains data and formats to copy.sourceColumnIndex: Number
- Source column index.destinationColumnIndex: Number
- Destination column index.copyColumns | |
function copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber) |
sourceCells0: Cells
- Source Cells object contains data and formats to copy.sourceColumnIndex: Number
- Source column index.destinationColumnIndex: Number
- Destination column index.columnNumber: Number
- The copied column number.copyColumns | |
function copyColumns(sourceCells, sourceColumnIndex, sourceTotalColumns, destinationColumnIndex, destinationTotalColumns) |
sourceCells: Cells
- Source Cells object contains data and formats to copy.sourceColumnIndex: Number
- Source column index.sourceTotalColumns: Number
- The number of the source columns.destinationColumnIndex: Number
- Destination column index.destinationTotalColumns: Number
- The number of the destination columns.copyRow | |
function copyRow(sourceCells, sourceRowIndex, destinationRowIndex) |
sourceCells: Cells
- Source Cells object contains data and formats to copy.sourceRowIndex: Number
- Source row index.destinationRowIndex: Number
- Destination row index.copyRows | |
function copyRows(sourceCells, sourceRowIndex, destinationRowIndex, rowNumber) |
sourceCells: Cells
- Source Cells object contains data and formats to copy.sourceRowIndex: Number
- Source row index.destinationRowIndex: Number
- Destination row index.rowNumber: Number
- The copied row number.copyRows | |
function copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions) |
sourceCells0: Cells
- Source Cells object contains data and formats to copy.sourceRowIndex: Number
- Source row index.destinationRowIndex: Number
- Destination row index.rowNumber: Number
- The copied row number.copyOptions: CopyOptions
- The copy options.copyRows | |
function copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions, pasteOptions) |
sourceCells0: Cells
- Source Cells object contains data and formats to copy.sourceRowIndex: Number
- Source row index.destinationRowIndex: Number
- Destination row index.rowNumber: Number
- The copied row number.copyOptions: CopyOptions
- The copy options.pasteOptions: PasteOptions
- the options of pasting.getGroupedRowOutlineLevel | |
function getGroupedRowOutlineLevel(rowIndex) |
rowIndex: Number
- The row index.getGroupedColumnOutlineLevel | |
function getGroupedColumnOutlineLevel(columnIndex) |
columnIndex: Number
- The column indexgetMaxGroupedColumnOutlineLevel | |
function getMaxGroupedColumnOutlineLevel() |
getMaxGroupedRowOutlineLevel | |
function getMaxGroupedRowOutlineLevel() |
showGroupDetail | |
function showGroupDetail(isVertical, index) |
isVertical: boolean
- True, uncollapse the grouped rows.index: Number
- The row/column indexhideGroupDetail | |
function hideGroupDetail(isVertical, index) |
isVertical: boolean
- True, collapse the grouped rows.index: Number
- The row/column indexungroupColumns | |
function ungroupColumns(firstIndex, lastIndex) |
firstIndex: Number
- The first column index to be ungrouped.lastIndex: Number
- The last column index to be ungrouped.groupColumns | |
function groupColumns(firstIndex, lastIndex) |
firstIndex: Number
- The first column index to be grouped.lastIndex: Number
- The last column index to be grouped.groupColumns | |
function groupColumns(firstIndex, lastIndex, isHidden) |
firstIndex: Number
- The first column index to be grouped.lastIndex: Number
- The last column index to be grouped.isHidden: boolean
- Specifies if the grouped columns are hidden.ungroupRows | |
function ungroupRows(firstIndex, lastIndex, isAll) |
firstIndex: Number
- The first row index to be ungrouped.lastIndex: Number
- The last row index to be ungrouped.isAll: boolean
- True, removes all grouped info.Otherwise, remove the outter group info.ungroupRows | |
function ungroupRows(firstIndex, lastIndex) |
firstIndex: Number
- The first row index to be ungrouped.lastIndex: Number
- The last row index to be ungrouped.groupRows | |
function groupRows(firstIndex, lastIndex, isHidden) |
firstIndex: Number
- The first row index to be grouped.lastIndex: Number
- The last row index to be grouped.isHidden: boolean
- Specifies if the grouped columns are hidden.groupRows | |
function groupRows(firstIndex, lastIndex) |
firstIndex: Number
- The first row index to be grouped.lastIndex: Number
- The last row index to be grouped.deleteColumn | |
function deleteColumn(columnIndex, updateReference) |
columnIndex: Number
- Column index.updateReference: boolean
- Indicates if update references in other worksheets.deleteColumn | |
function deleteColumn(columnIndex) |
columnIndex: Number
- Column index.deleteColumns | |
function deleteColumns(columnIndex, totalColumns, updateReference) |
columnIndex: Number
- Column index.totalColumns: Number
- Number of columns to be deleted.updateReference: boolean
- Indicates if update references in other worksheets.isDeletingRangeEnabled | |
function isDeletingRangeEnabled(startRow, startColumn, totalRows, totalColumns) |
startRow: Number
- The start row index of the range.startColumn: Number
- The start column idnex of the range.totalRows: Number
- The number of the rows in the range.totalColumns: Number
- The number of the columns in the range.deleteRows | |
function deleteRows(rowIndex, totalRows) |
rowIndex: Number
- The first row index to be deleted.totalRows: Number
- Number of rows to be deleted.deleteRow | |
function deleteRow(rowIndex) |
rowIndex: Number
- Row index.deleteRows | |
function deleteRows(rowIndex, totalRows, updateReference) |
rowIndex: Number
- Row index.totalRows: Number
- Number of rows to be deleted.updateReference: boolean
- Indicates if update references in other worksheets.deleteBlankColumns | |
function deleteBlankColumns() |
deleteBlankColumns | |
function deleteBlankColumns(options) |
options: DeleteOptions
- The options of deleting range.isBlankColumn | |
function isBlankColumn(columnIndex) |
columnIndex: Number
- the column indexdeleteBlankRows | |
function deleteBlankRows() |
deleteBlankRows | |
function deleteBlankRows(options) |
options: DeleteOptions
- The options of deleting range.insertColumns | |
function insertColumns(columnIndex, totalColumns) |
columnIndex: Number
- Column index.totalColumns: Number
- The number of columns.insertColumns | |
function insertColumns(columnIndex, totalColumns, updateReference) |
columnIndex: Number
- Column index.totalColumns: Number
- The number of columns.updateReference: boolean
- Indicates if references in other worksheets will be updated.insertColumn | |
function insertColumn(columnIndex, updateReference) |
columnIndex: Number
- Column index.updateReference: boolean
- Indicates if references in other worksheets will be updated.insertColumn | |
function insertColumn(columnIndex) |
columnIndex: Number
- Column index.insertRows | |
function insertRows(rowIndex, totalRows, updateReference) |
rowIndex: Number
- Row index.totalRows: Number
- Number of rows to be inserted.updateReference: boolean
- Indicates if references in other worksheets will be updated.insertRows | |
function insertRows(rowIndex, totalRows, options) |
rowIndex: Number
- Row index.totalRows: Number
- Number of rows to be inserted.options: InsertOptions
- Indicates if references in other worksheets will be updated.insertRows | |
function insertRows(rowIndex, totalRows) |
rowIndex: Number
- Row index.totalRows: Number
- Number of rows to be inserted.insertRow | |
function insertRow(rowIndex) |
rowIndex: Number
- Row index.clearRange | |
function clearRange(range) |
range: CellArea
- Range to be cleared.clearRange | |
function clearRange(startRow, startColumn, endRow, endColumn) |
startRow: Number
- Start row index.startColumn: Number
- Start column index.endRow: Number
- End row index.endColumn: Number
- End column index.clearContents | |
function clearContents(range) |
range: CellArea
- Range to be cleared.clearContents | |
function clearContents(startRow, startColumn, endRow, endColumn) |
startRow: Number
- Start row index.startColumn: Number
- Start column index.endRow: Number
- End row index.endColumn: Number
- End column index.clearFormats | |
function clearFormats(range) |
range: CellArea
- Range to be cleared.clearFormats | |
function clearFormats(startRow, startColumn, endRow, endColumn) |
startRow: Number
- Start row index.startColumn: Number
- Start column index.endRow: Number
- End row index.endColumn: Number
- End column index.linkToXmlMap | |
function linkToXmlMap(mapName, row, column, path) |
mapName: String
- name of xml maprow: Number
- row of the destination cellcolumn: Number
- column of the destination cellpath: String
- path of xml element in xml mapdispose | |
function dispose() |
iterator | |
function iterator() |
getRowEnumerator | |
function getRowEnumerator() |
getCell | |
function getCell(row, column) |
row: Number
- Row indexcolumn: Number
- Column indexgetRow | |
function getRow(row) |
row: Number
- Row indexgetColumn | |
function getColumn(columnIndex) |
columnIndex: Number
- The column index.checkCell | |
function checkCell(row, column) |
row: Number
- Row indexcolumn: Number
- Column indexcheckRow | |
function checkRow(row) |
row: Number
- Row indexcheckColumn | |
function checkColumn(columnIndex) |
columnIndex: Number
- The column index.isRowHidden | |
function isRowHidden(rowIndex) |
rowIndex: Number
- row indexisColumnHidden | |
function isColumnHidden(columnIndex) |
columnIndex: Number
- column indexaddRange | |
function addRange(rangeObject) |
rangeObject: Range
- The range object will be contained in the cellscreateRange | |
function createRange(upperLeftCell, lowerRightCell) |
upperLeftCell: String
- Upper left cell name.lowerRightCell: String
- Lower right cell name.createRange | |
function createRange(firstRow, firstColumn, totalRows, totalColumns) |
firstRow: Number
- First row of this rangefirstColumn: Number
- First column of this rangetotalRows: Number
- Number of rowstotalColumns: Number
- Number of columnscreateRange | |
function createRange(address) |
address: String
- The address of the range.createRange | |
function createRange(firstIndex, number, isVertical) |
firstIndex: Number
- First row index or first column index, zero based.number: Number
- Total number of rows or columns, one based.isVertical: boolean
- True - Range created from columns of cells. False - Range created from rows of cells. clear | |
function clear() |
importFormulaArray | |
function importFormulaArray(stringArray, firstRow, firstColumn, isVertical) |
stringArray: String[]
- Formula array.firstRow: Number
- The row number of the first cell to import in.firstColumn: Number
- The column number of the first cell to import in.isVertical: boolean
- Specifies to import data vertically or horizontally.textToColumns | |
function textToColumns(row, column, totalRows, options) |
row: Number
- The row index.column: Number
- The column index.totalRows: Number
- The number of rows.options: TxtLoadOptions
- The split options.importCSV | |
function importCSV(fileName, spliter, convertNumericData, firstRow, firstColumn) |
fileName: String
- The CSV file name.spliter: String
- The spliterconvertNumericData: boolean
- Whether the string in text file is converted to numeric data.firstRow: Number
- The row number of the first cell to import in.firstColumn: Number
- The column number of the first cell to import in.importCSV | |
function importCSV(fileName, options, firstRow, firstColumn) |
fileName: String
- The CSV file name.options: TxtLoadOptions
- The load options for reading text filefirstRow: Number
- The row number of the first cell to import in.firstColumn: Number
- The column number of the first cell to import in.