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 default 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 formula 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 | getViewRowHeight(row) | |
Gets the height of a specified row.
|
||
function | getViewRowHeightInch(row) | |
Gets the height of a specified row in unit of inches.
|
||
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, splitter, 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() | |
Removes duplicate rows in the sheet.
|
||
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.
|
function getOdsCellFields()
function getCount()
function getCountLarge()
function getRows()
function getMergedCells()
function getMultiThreadReading() / function setMultiThreadReading(value)
function getMemorySetting() / function setMemorySetting(value)
function getStyle() / function setStyle(value)
function getStandardWidthInch() / function setStandardWidthInch(value)
function getStandardWidthPixels() / function setStandardWidthPixels(value)
function getStandardWidth() / function setStandardWidth(value)
function getStandardHeight() / function setStandardHeight(value)
function getStandardHeightPixels() / function setStandardHeightPixels(value)
function getPreserveString() / function setPreserveString(value)
function getMinRow()
function getMaxRow()
function getMinColumn()
function getMaxColumn()
function getMinDataRow()
function getMaxDataRow()
function getMinDataColumn()
function getMaxDataColumn()
function isDefaultRowHeightMatched() / function setDefaultRowHeightMatched(value)
function isDefaultRowHidden() / function setDefaultRowHidden(value)
function getColumns()
function getRanges()
function getLastCell()
function getMaxDisplayRange()
function getFirstCell()
function get(index)
index
- The zero based index of the element.function get(row, column)
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"
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.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.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.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 optionsfunction endCellInRow(rowIndex)
rowIndex: Number
- Row index.function endCellInColumn(columnIndex)
columnIndex: Number
- Column index.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.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.function moveRange(sourceArea, destRow, destColumn)
sourceArea: CellArea
- The range which should be moved.destRow: Number
- The dest row.destColumn: Number
- The dest column.function insertCutCells(cutRange, row, column, shiftType)
cutRange: Range
- The cut range.row: Number
- The row.column: Number
- The column.shiftType: Number
- A 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.function insertRange(area, shiftType)
area: CellArea
- Shift area.shiftType: Number
- A function insertRange(area, shiftNumber, shiftType)
area: CellArea
- Shift area.shiftNumber: Number
- Number of rows or columns to be inserted.shiftType: Number
- A 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 function retrieveSubtotalSetting(ca)
ca: CellArea
- The rangefunction 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.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 summary below data.function removeFormulas()
function 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.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.function convertStringToNumericValue()
function getDependents(isAll, row, column)
isAll: boolean
- Indicates whether check other worksheetsrow: Number
- The row index.column: Number
- The column index.function getCellStyle(row, column)
row: Number
- row indexcolumn: Number
- columnfunction 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)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.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.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)function hideRow(row)
row: Number
- Row index.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.function hideRows(row, totalRows)
row: Number
- The row index.totalRows: Number
- The row number.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.function setRowHeightPixel(row, pixels)
row: Number
- Row index.pixels: Number
- Number of pixels.function setRowHeightInch(row, inches)
row: Number
- Row index.inches: Number
- Number of inches. It should be between 0 and 409.5/72.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.function hideColumn(column)
column: Number
- Column index.function unhideColumn(column, width)
column: Number
- Column index.width: Number
- Column width.function hideColumns(column, totalColumns)
column: Number
- Column index.totalColumns: Number
- Column number.function unhideColumns(column, totalColumns, width)
column: Number
- Column index.totalColumns: Number
- Column numberwidth: Number
- Column width.function getRowHeight(row)
row: Number
- Row indexfunction getViewRowHeight(row)
row: Number
- Row indexfunction getRowHeightPixel(row)
row: Number
- Row indexfunction getRowHeightInch(row)
row: Number
- Row indexfunction getViewRowHeightInch(row)
row: Number
- Row indexfunction setColumnWidthPixel(column, pixels)
column: Number
- Column index.pixels: Number
- Number of pixels.function setColumnWidthInch(column, inches)
column: Number
- Column index.inches: Number
- Number of inches.function setColumnWidth(column, width)
column: Number
- Column index.width: Number
- Width of column.Column width must be between 0 and 255.function getColumnWidthPixel(column)
column: Number
- Column indexfunction getColumnWidthInch(column)
column: Number
- Column indexfunction getColumnWidth(column)
column: Number
- Column indexfunction getViewColumnWidthPixel(column)
column: Number
- The column index.function setViewColumnWidthPixel(column, pixels)
column: Number
- The column index.pixels: Number
- The width in unit of pixels.function getLastDataRow(column)
column: Number
- Column index.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.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.function applyStyle(style, flag)
style: Style
- The style object which will be applied.flag: StyleFlag
- Flags which indicates applied formatting properties.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.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.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.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.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.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.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.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.function getGroupedRowOutlineLevel(rowIndex)
rowIndex: Number
- The row index.function getGroupedColumnOutlineLevel(columnIndex)
columnIndex: Number
- The column indexfunction getMaxGroupedColumnOutlineLevel()
function getMaxGroupedRowOutlineLevel()
function showGroupDetail(isVertical, index)
isVertical: boolean
- True, uncollapses the grouped rows.index: Number
- The row/column indexfunction hideGroupDetail(isVertical, index)
isVertical: boolean
- True, collapse the grouped rows.index: Number
- The row/column indexfunction ungroupColumns(firstIndex, lastIndex)
firstIndex: Number
- The first column index to be ungrouped.lastIndex: Number
- The last column index to be ungrouped.function groupColumns(firstIndex, lastIndex)
firstIndex: Number
- The first column index to be grouped.lastIndex: Number
- The last column index to be grouped.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.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 outer group info.function ungroupRows(firstIndex, lastIndex)
firstIndex: Number
- The first row index to be ungrouped.lastIndex: Number
- The last row index to be ungrouped.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.function groupRows(firstIndex, lastIndex)
firstIndex: Number
- The first row index to be grouped.lastIndex: Number
- The last row index to be grouped.function deleteColumn(columnIndex, updateReference)
columnIndex: Number
- Column index.updateReference: boolean
- Indicates if update references in other worksheets.function deleteColumn(columnIndex)
columnIndex: Number
- Column index.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.function isDeletingRangeEnabled(startRow, startColumn, totalRows, totalColumns)
startRow: Number
- The start row index of the range.startColumn: Number
- The start column index of the range.totalRows: Number
- The number of the rows in the range.totalColumns: Number
- The number of the columns in the range.function deleteRows(rowIndex, totalRows)
rowIndex: Number
- The first row index to be deleted.totalRows: Number
- Number of rows to be deleted.function deleteRow(rowIndex)
rowIndex: Number
- Row index.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.function deleteBlankColumns()
function deleteBlankColumns(options)
options: DeleteOptions
- The options of deleting range.function isBlankColumn(columnIndex)
columnIndex: Number
- the column indexfunction deleteBlankRows()
function deleteBlankRows(options)
options: DeleteOptions
- The options of deleting range.function insertColumns(columnIndex, totalColumns)
columnIndex: Number
- Column index.totalColumns: Number
- The number of columns.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.function insertColumn(columnIndex, updateReference)
columnIndex: Number
- Column index.updateReference: boolean
- Indicates if references in other worksheets will be updated.function insertColumn(columnIndex)
columnIndex: Number
- Column index.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.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.function insertRows(rowIndex, totalRows)
rowIndex: Number
- Row index.totalRows: Number
- Number of rows to be inserted.function insertRow(rowIndex)
rowIndex: Number
- Row index.function clearRange(range)
range: CellArea
- Range to be cleared.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.function clearContents(range)
range: CellArea
- Range to be cleared.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.function clearFormats(range)
range: CellArea
- Range to be cleared.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.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 mapfunction dispose()
function iterator()
function getRowEnumerator()
function getCell(row, column)
row: Number
- Row indexcolumn: Number
- Column indexfunction getRow(row)
row: Number
- Row indexfunction getColumn(columnIndex)
columnIndex: Number
- The column index.function checkCell(row, column)
row: Number
- Row indexcolumn: Number
- Column indexfunction checkRow(row)
row: Number
- Row indexfunction checkColumn(columnIndex)
columnIndex: Number
- The column index.function isRowHidden(rowIndex)
rowIndex: Number
- row indexfunction isColumnHidden(columnIndex)
columnIndex: Number
- column indexfunction addRange(rangeObject)
rangeObject: Range
- The range object will be contained in the cellsfunction createRange(upperLeftCell, lowerRightCell)
function createRange(firstRow, firstColumn, totalRows, totalColumns)
function createRange(address)
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. function clear()
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.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.function importCSV(fileName, splitter, convertNumericData, firstRow, firstColumn)
fileName: String
- The CSV file name.splitter: String
- The splitterconvertNumericData: 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.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.