CalculationCell
CalculationCell class
Represents the calculation relevant data about one cell which is being calculated.
class CalculationCell;
Remarks
All objects provided by this class are for “read” purpose only. User should not change any data in the Workbook during the formula calculation process, Otherwise unexpected result or Exception may be caused.
Properties
| Property | Type | Description |
|---|---|---|
| workbook | Workbook | Readonly. Gets the Workbook object. |
| worksheet | Worksheet | Readonly. Gets the Worksheet object where the cell is in. |
| cellRow | number | Readonly. Gets the row index of the cell. |
| cellColumn | number | Readonly. Gets the column index of the cell. |
| cell | Cell | Readonly. Gets the Cell object which is being calculated. |
Methods
| Method | Description |
|---|---|
| getWorkbook() | @deprecated. Please use the ‘workbook’ property instead. Gets the Workbook object. |
| getWorksheet() | @deprecated. Please use the ‘worksheet’ property instead. Gets the Worksheet object where the cell is in. |
| getCellRow() | @deprecated. Please use the ‘cellRow’ property instead. Gets the row index of the cell. |
| getCellColumn() | @deprecated. Please use the ‘cellColumn’ property instead. Gets the column index of the cell. |
| getCell() | @deprecated. Please use the ‘cell’ property instead. Gets the Cell object which is being calculated. |
| setCalculatedValue(Object) | Sets the calculated value for the cell. |
| isNull() | Checks whether the implementation object is null. |
workbook
Readonly. Gets the Workbook object.
workbook : Workbook;
worksheet
Readonly. Gets the Worksheet object where the cell is in.
worksheet : Worksheet;
cellRow
Readonly. Gets the row index of the cell.
cellRow : number;
cellColumn
Readonly. Gets the column index of the cell.
cellColumn : number;
cell
Readonly. Gets the Cell object which is being calculated.
cell : Cell;
getWorkbook()
@deprecated. Please use the ‘workbook’ property instead. Gets the Workbook object.
getWorkbook() : Workbook;
Returns
getWorksheet()
@deprecated. Please use the ‘worksheet’ property instead. Gets the Worksheet object where the cell is in.
getWorksheet() : Worksheet;
Returns
getCellRow()
@deprecated. Please use the ‘cellRow’ property instead. Gets the row index of the cell.
getCellRow() : number;
getCellColumn()
@deprecated. Please use the ‘cellColumn’ property instead. Gets the column index of the cell.
getCellColumn() : number;
getCell()
@deprecated. Please use the ‘cell’ property instead. Gets the Cell object which is being calculated.
getCell() : Cell;
Returns
setCalculatedValue(Object)
Sets the calculated value for the cell.
setCalculatedValue(v: Object) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| v | Object |
Remarks
User can set the calculated result by this method to ignore the automatic calculation for the cell.
isNull()
Checks whether the implementation object is null.
isNull() : boolean;