Cell
Cell class
Encapsulates the object that represents a single Workbook cell.
class Cell;
Example
const { Workbook, Color, TextAlignmentType } = require("aspose.cells.node");
var excel = new Workbook();
var cells = excel.getWorksheets().get(0).getCells();
//Put a string into a cell
var cell = cells.get(0, 0);
cell.putValue("Hello");
var first = cell.getStringValue();
//Put an integer into a cell
cell = cells.get("B1");
cell.putValue(12);
var second = cell.getIntValue();
//Put a double into a cell
cell = cells.get(0, 2);
cell.putValue(-1.234);
var third = cell.getDoubleValue();
//Put a formula into a cell
cell = cells.get("D1");
cell.setFormula("=B1 + C1");
//Put a combined formula: "sum(average(b1,c1), b1)" to cell at b2
cell = cells.get("b2");
cell.setFormula("=sum(average(b1,c1), b1)");
//Set style of a cell
var style = cell.getStyle();
//Set background color
style.setBackgroundColor(new Color(0xff, 0xff, 0));
//Set format of a cell
style.getFont().setName("Courier New");
style.setVerticalAlignment(TextAlignmentType.Top);
cell.setStyle(style);
Methods
Method | Description |
---|---|
getWorksheet() | Gets the parent worksheet. |
getDateTimeValue() | Gets the DateTime value contained in the cell. |
getRow() | Gets row number (zero based) of the cell. |
getColumn() | Gets column number (zero based) of the cell. |
isFormula() | Represents if the specified cell contains formula. |
getType() | Represents cell value type. |
getName() | Gets the name of the cell. |
isErrorValue() | Checks if the value of this cell is an error. |
isNumericValue() | Indicates whether the value of this cell is numeric(int, double and datetime) |
getStringValue() | Gets the string value contained in the cell. If the type of this cell is string, then return the string value itself. For other cell types, the formatted string value (formatted with the specified style of this cell) will be returned. The formatted cell value is same with what you can get from excel when copying a cell as text(such as copying cell to text editor or exporting to csv). |
getNumberCategoryType() | Represents the category type of this cell’s number formatting. |
getDisplayStringValue() | Gets the formatted string value of this cell by cell’s display style. |
getIntValue() | Gets the integer value contained in the cell. |
getDoubleValue() | Gets the double value contained in the cell. |
getFloatValue() | Gets the float value contained in the cell. |
getBoolValue() | Gets the boolean value contained in the cell. |
getHasCustomStyle() | Indicates whether this cell has custom style settings(different from the default one inherited from corresponding row, column, or workbook). |
getSharedStyleIndex() | Gets cell’s shared style index in the style pool. |
getFormula() | Gets or sets a formula of the Cell. |
setFormula(string) | Gets or sets a formula of the Cell. |
getFormulaLocal() | Get the locale formatted formula of the cell. |
setFormulaLocal(string) | Get the locale formatted formula of the cell. |
getR1C1Formula() | Gets or sets a R1C1 formula of the Cell. |
setR1C1Formula(string) | Gets or sets a R1C1 formula of the Cell. |
getContainsExternalLink() | Indicates whether this cell contains an external link. Only applies when the cell is a formula cell. |
isArrayHeader() | Indicates the cell’s formula is an array formula and it is the first cell of the array. |
isDynamicArrayFormula() | Indicates whether the cell’s formula is dynamic array formula(true) or legacy array formula(false). |
isArrayFormula() | Indicates whether the cell formula is an array formula. |
isSharedFormula() | Indicates whether the cell formula is part of shared formula. |
isTableFormula() | Indicates whether this cell is part of table formula. |
getValue() | Gets/sets the value contained in this cell. |
setValue(object) | Gets/sets the value contained in this cell. |
isStyleSet() | Indicates if the cell’s style is set. If return false, it means this cell has a default cell format. |
isMerged() | Checks if a cell is part of a merged range or not. |
getComment() | Gets the comment of this cell. |
getHtmlString() | Gets and sets the html string which contains data and some formats in this cell. |
setHtmlString(string) | Gets and sets the html string which contains data and some formats in this cell. |
isCheckBoxStyle() | Indicates whether setting this cell as a check box. |
setIsCheckBoxStyle(boolean) | Indicates whether setting this cell as a check box. |
getEmbeddedImage() | Gets and sets the embeddedn image in the cell. |
setEmbeddedImage(number[]) | Gets and sets the embeddedn image in the cell. |
calculate(CalculationOptions) | Calculates the formula of the cell. |
putValue(boolean) | Puts a boolean value into the cell. |
putValue(number) | Puts an integer value into the cell. |
putValue(number) | Puts a double value into the cell. |
putValue(string, boolean, boolean) | Puts a value into the cell, if appropriate the value will be converted to other data type and cell’s number format will be reset. |
putValue(string, boolean) | Puts a string value into the cell and converts the value to other data type if appropriate. |
putValue(string) | Puts a string value into the cell. |
putValue(Date) | Puts a DateTime value into the cell. |
putValue(object) | Puts an object value into the cell. |
getStringValue(CellValueFormatStrategy) | Gets the string value by specific formatted strategy. |
getWidthOfValue() | Gets the width of the value in unit of pixels. |
getHeightOfValue() | Gets the height of the value in unit of pixels. |
getDisplayStyle() | Gets the display style of the cell. If this cell is also affected by other settings such as conditional formatting, list objects, etc., then the display style may be different from cell.GetStyle(). |
getDisplayStyle(boolean) | Gets the display style of the cell. If the cell is conditional formatted, the display style is not same as the cell.GetStyle(). |
getFormatConditions() | Gets format conditions which applies to this cell. |
getStyle() | Gets the cell style. |
getStyle(boolean) | If checkBorders is true, check whether other cells’ borders will effect the style of this cell. |
setStyle(Style) | Sets the cell style. |
setStyle(Style, boolean) | Apply the changed property of style to the cell. |
setStyle(Style, StyleFlag) | Apply the cell style based on flags. |
setFormula(string, object) | Set the formula and the value(calculated result) of the formula. |
setFormula(string, FormulaParseOptions) | Set the formula and the value(calculated result) of the formula. |
setFormula(string, FormulaParseOptions, object) | Set the formula and the value(calculated result) of the formula. |
getFormula(boolean, boolean) | Get the formula of this cell. |
setArrayFormula(string, number, number) | Sets an array formula(legacy array formula entered via CTRL+SHIFT+ENTER in ms excel) to a range of cells. |
setArrayFormula(string, number, number, FormulaParseOptions) | Sets an array formula to a range of cells. |
setArrayFormula(string, number, number, FormulaParseOptions, object[][]) | Sets an array formula to a range of cells. |
setSharedFormula(string, number, number) | Sets shared formulas to a range of cells. |
setSharedFormula(string, number, number, FormulaParseOptions) | Sets shared formulas to a range of cells. |
setSharedFormula(string, number, number, FormulaParseOptions, object[][]) | Sets shared formulas to a range of cells. |
getPrecedents() | Gets all references appearing in this cell’s formula. |
getDependents(boolean) | Get all cells whose formula references to this cell directly. |
getPrecedentsInCalculation() | Gets all precedents(reference to cells in current workbook) used by this cell’s formula while calculating it. |
getDependentsInCalculation(boolean) | Gets all cells whose calculated result depends on this cell. |
getArrayRange() | Gets the array range if the cell’s formula is an array formula. |
setDynamicArrayFormula(string, FormulaParseOptions, boolean) | Sets dynamic array formula and make the formula spill into neighboring cells if possible. |
setDynamicArrayFormula(string, FormulaParseOptions, object[][], boolean, boolean) | Sets dynamic array formula and make the formula spill into neighboring cells if possible. |
setDynamicArrayFormula(string, FormulaParseOptions, object[][], boolean, boolean, CalculationOptions) | Sets dynamic array formula and make the formula spill into neighboring cells if possible. |
setTableFormula(number, number, string, string, object[][]) | Create two-variable data table for given range starting from this cell. |
setTableFormula(number, number, string, boolean, object[][]) | Create one-variable data table for given range starting from this cell. |
setTableFormula(number, number, number, number, number, number, object[][]) | Create two-variable data table for given range starting from this cell. |
setTableFormula(number, number, number, number, boolean, object[][]) | Create one-variable data table for given range starting from this cell. |
removeArrayFormula(boolean) | Remove array formula. |
copy(Cell) | Copies data from a source cell. |
characters(number, number) | Returns a Characters object that represents a range of characters within the cell text. |
replace(string, string, ReplaceOptions) | Replace text of the cell with options. |
insertText(number, string) | Insert some characters to the cell. If the cell is rich formatted, this method could keep the original formatting. |
isRichText() | Indicates whether the string value of this cell is a rich formatted text. |
getCharacters() | Returns all Characters objects that represents a range of characters within the cell text. |
getCharacters(boolean) | Returns all Characters objects that represents a range of characters within the cell text. |
setCharacters(FontSetting[]) | Sets rich text format of the cell. |
getMergedRange() | Returns a Range object which represents a merged range. |
getHtmlString(boolean) | Gets the html string which contains data and some formats in this cell. |
toString() | Returns a string represents the current Cell object. |
toJson() | Convert Cell to JSON struct data. |
equals(object) | Checks whether this object refers to the same cell with another. |
equals(Cell) | Checks whether this object refers to the same cell with another cell object. |
getHashCode() | Serves as a hash function for a particular type. |
getConditionalFormattingResult() | Get the result of the conditional formatting. |
getValidation() | Gets the validation applied to this cell. |
getValidationValue() | Gets the value of validation which applied to this cell. |
getTable() | Gets the table which contains this cell. |
dispose() | |
isNull() | Checks whether the implementation object is null. |
getWorksheet()
Gets the parent worksheet.
getWorksheet() : Worksheet;
Returns
getDateTimeValue()
Gets the DateTime value contained in the cell.
getDateTimeValue() : Date;
getRow()
Gets row number (zero based) of the cell.
getRow() : number;
getColumn()
Gets column number (zero based) of the cell.
getColumn() : number;
isFormula()
Represents if the specified cell contains formula.
isFormula() : boolean;
getType()
Represents cell value type.
getType() : CellValueType;
Returns
getName()
Gets the name of the cell.
getName() : string;
Remarks
A cell name includes its column letter and row number. For example, the name of a cell in row 0 and column 0 is A1.
isErrorValue()
Checks if the value of this cell is an error.
isErrorValue() : boolean;
Remarks
Also applies to formula cell to check whether the calculated result is an error.
isNumericValue()
Indicates whether the value of this cell is numeric(int, double and datetime)
isNumericValue() : boolean;
Remarks
Also applies to formula cell to check the calculated result
getStringValue()
Gets the string value contained in the cell. If the type of this cell is string, then return the string value itself. For other cell types, the formatted string value (formatted with the specified style of this cell) will be returned. The formatted cell value is same with what you can get from excel when copying a cell as text(such as copying cell to text editor or exporting to csv).
getStringValue() : string;
getNumberCategoryType()
Represents the category type of this cell’s number formatting.
getNumberCategoryType() : NumberCategoryType;
Returns
Remarks
When cell’s formatting pattern is combined with conditional formatting patterns, then the returned type is corresponding to the part which is used for current value of this cell. For example, if the formatting pattern for this cell is “#,##0;(#,##0);”-";@", then when cell’s value is numeric and not 0, the returned type is NumberCategoryType.Number; When cell’s value is 0 or not numeric value, the returned type is NumberCategoryType.Text.
getDisplayStringValue()
Gets the formatted string value of this cell by cell’s display style.
getDisplayStringValue() : string;
getIntValue()
Gets the integer value contained in the cell.
getIntValue() : number;
getDoubleValue()
Gets the double value contained in the cell.
getDoubleValue() : number;
getFloatValue()
Gets the float value contained in the cell.
getFloatValue() : number;
getBoolValue()
Gets the boolean value contained in the cell.
getBoolValue() : boolean;
getHasCustomStyle()
Indicates whether this cell has custom style settings(different from the default one inherited from corresponding row, column, or workbook).
getHasCustomStyle() : boolean;
getSharedStyleIndex()
Gets cell’s shared style index in the style pool.
getSharedStyleIndex() : number;
getFormula()
Gets or sets a formula of the Cell.
getFormula() : string;
Remarks
A formula string always begins with an equal sign (=). And please always use comma(,) as parameters delimiter, such as “=SUM(A1, E1, H2)”.
setFormula(string)
Gets or sets a formula of the Cell.
setFormula(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
Remarks
A formula string always begins with an equal sign (=). And please always use comma(,) as parameters delimiter, such as “=SUM(A1, E1, H2)”.
Example
const { Workbook } = require("aspose.cells.node");
var excel = new Workbook();
var cells = excel.getWorksheets().get(0).getCells();
cells.get("B6").setFormula("=SUM(B2:B5, E1) + sheet2!A1");
getFormulaLocal()
Get the locale formatted formula of the cell.
getFormulaLocal() : string;
setFormulaLocal(string)
Get the locale formatted formula of the cell.
setFormulaLocal(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
getR1C1Formula()
Gets or sets a R1C1 formula of the Cell.
getR1C1Formula() : string;
setR1C1Formula(string)
Gets or sets a R1C1 formula of the Cell.
setR1C1Formula(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
getContainsExternalLink()
Indicates whether this cell contains an external link. Only applies when the cell is a formula cell.
getContainsExternalLink() : boolean;
isArrayHeader()
Indicates the cell’s formula is an array formula and it is the first cell of the array.
isArrayHeader() : boolean;
isDynamicArrayFormula()
Indicates whether the cell’s formula is dynamic array formula(true) or legacy array formula(false).
isDynamicArrayFormula() : boolean;
isArrayFormula()
Indicates whether the cell formula is an array formula.
isArrayFormula() : boolean;
isSharedFormula()
Indicates whether the cell formula is part of shared formula.
isSharedFormula() : boolean;
isTableFormula()
Indicates whether this cell is part of table formula.
isTableFormula() : boolean;
getValue()
Gets/sets the value contained in this cell.
getValue() : object;
Remarks
Possible type:
null,
Boolean,
DateTime,
Double,
Integer
String.
For int value, it may be returned as an Integer object or a Double object. And there is no guarantee that the returned value will be kept as the same type of object always.setValue(object)
Gets/sets the value contained in this cell.
setValue(value: object) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | object | The value to set. |
Remarks
Possible type:
null,
Boolean,
DateTime,
Double,
Integer
String.
For int value, it may be returned as an Integer object or a Double object. And there is no guarantee that the returned value will be kept as the same type of object always.isStyleSet()
Indicates if the cell’s style is set. If return false, it means this cell has a default cell format.
isStyleSet() : boolean;
isMerged()
Checks if a cell is part of a merged range or not.
isMerged() : boolean;
getComment()
Gets the comment of this cell.
getComment() : Comment;
Returns
Remarks
If there is no comment applies to the cell, returns null.
getHtmlString()
Gets and sets the html string which contains data and some formats in this cell.
getHtmlString() : string;
setHtmlString(string)
Gets and sets the html string which contains data and some formats in this cell.
setHtmlString(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
isCheckBoxStyle()
Indicates whether setting this cell as a check box.
isCheckBoxStyle() : boolean;
setIsCheckBoxStyle(boolean)
Indicates whether setting this cell as a check box.
setIsCheckBoxStyle(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getEmbeddedImage()
Gets and sets the embeddedn image in the cell.
getEmbeddedImage() : number[];
Returns
number[]
setEmbeddedImage(number[])
Gets and sets the embeddedn image in the cell.
setEmbeddedImage(value: number[]) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number[] | The value to set. |
calculate(CalculationOptions)
Calculates the formula of the cell.
calculate(options: CalculationOptions) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
options | CalculationOptions | Options for calculation |
putValue(boolean)
Puts a boolean value into the cell.
putValue(boolValue: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
boolValue | boolean |
putValue(number)
Puts an integer value into the cell.
putValue(intValue: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
intValue | number | Input value |
putValue(number)
Puts a double value into the cell.
putValue(doubleValue: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
doubleValue | number | Input value |
putValue(string, boolean, boolean)
Puts a value into the cell, if appropriate the value will be converted to other data type and cell’s number format will be reset.
putValue(stringValue: string, isConverted: boolean, setStyle: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
stringValue | string | Input value |
isConverted | boolean | True: converted to other data type if appropriate. |
setStyle | boolean | True: set the number format to cell’s style when converting to other data type |
putValue(string, boolean)
Puts a string value into the cell and converts the value to other data type if appropriate.
putValue(stringValue: string, isConverted: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
stringValue | string | Input value |
isConverted | boolean | True: converted to other data type if appropriate. |
putValue(string)
Puts a string value into the cell.
putValue(stringValue: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
stringValue | string | Input value |
putValue(Date)
Puts a DateTime value into the cell.
putValue(dateTime: Date) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
dateTime | Date | Input value |
Remarks
Setting a DateTime value for a cell dose not means the cell will be formatted as date time automatically. DateTime value was maintained as numeric value in the data model of both ms excel and Aspose.Cells. Whether the numeric value will be taken as the numeric value itself or date time depends on the number format applied on this cell. If this cell has not been formatted as date time, it will be displayed as a numeric value even though what you input is DateTime.
putValue(object)
Puts an object value into the cell.
putValue(objectValue: object) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
objectValue | object | input value |
getStringValue(CellValueFormatStrategy)
Gets the string value by specific formatted strategy.
getStringValue(formatStrategy: CellValueFormatStrategy) : string;
Parameters:
Parameter | Type | Description |
---|---|---|
formatStrategy | CellValueFormatStrategy | The formatted strategy. |
getWidthOfValue()
Gets the width of the value in unit of pixels.
getWidthOfValue() : number;
getHeightOfValue()
Gets the height of the value in unit of pixels.
getHeightOfValue() : number;
getDisplayStyle()
Gets the display style of the cell. If this cell is also affected by other settings such as conditional formatting, list objects, etc., then the display style may be different from cell.GetStyle().
getDisplayStyle() : Style;
Returns
getDisplayStyle(boolean)
Gets the display style of the cell. If the cell is conditional formatted, the display style is not same as the cell.GetStyle().
getDisplayStyle(includeMergedBorders: boolean) : Style;
Parameters:
Parameter | Type | Description |
---|---|---|
includeMergedBorders | boolean | Indicates whether checking borders of the merged cells. |
Returns
getFormatConditions()
Gets format conditions which applies to this cell.
getFormatConditions() : FormatConditionCollection[];
Returns
Returns FormatConditionCollection object
getStyle()
Gets the cell style.
getStyle() : Style;
Returns
Style object.
Remarks
To change the style of the cell, please call Cell.SetStyle() method after modifying the returned style object. This method is same with GetStyle(bool) with true value for the parameter.
getStyle(boolean)
If checkBorders is true, check whether other cells’ borders will effect the style of this cell.
getStyle(checkBorders: boolean) : Style;
Parameters:
Parameter | Type | Description |
---|---|---|
checkBorders | boolean | Check other cells’ borders |
Returns
Style object.
setStyle(Style)
Sets the cell style.
setStyle(style: Style) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
style | Style | The cell style. |
Remarks
If the border settings are changed, the border of adjust cells will be updated too.
setStyle(Style, boolean)
Apply the changed property of style to the cell.
setStyle(style: Style, explicitFlag: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
style | Style | The cell style. |
explicitFlag | boolean | True, only overwriting formatting which is explicitly set. |
setStyle(Style, StyleFlag)
Apply the cell style based on flags.
setStyle(style: Style, flag: StyleFlag) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
style | Style | The cell style. |
flag | StyleFlag | The style flag. |
setFormula(string, object)
Set the formula and the value(calculated result) of the formula.
setFormula(formula: string, value: object) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
formula | string | The formula. |
value | object | The value(calculated result) of the formula. |
setFormula(string, FormulaParseOptions)
Set the formula and the value(calculated result) of the formula.
setFormula(formula: string, options: FormulaParseOptions) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
formula | string | The formula. |
options | FormulaParseOptions | Options for parsing the formula. |
setFormula(string, FormulaParseOptions, object)
Set the formula and the value(calculated result) of the formula.
setFormula(formula: string, options: FormulaParseOptions, value: object) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
formula | string | The formula. |
options | FormulaParseOptions | Options for parsing the formula. |
value | object | The value(calculated result) of the formula. |
getFormula(boolean, boolean)
Get the formula of this cell.
getFormula(isR1C1: boolean, isLocal: boolean) : string;
Parameters:
Parameter | Type | Description |
---|---|---|
isR1C1 | boolean | Whether the formula needs to be formatted as R1C1. |
isLocal | boolean | Whether the formula needs to be formatted by locale. |
Returns
the formula of this cell.
setArrayFormula(string, number, number)
Sets an array formula(legacy array formula entered via CTRL+SHIFT+ENTER in ms excel) to a range of cells.
setArrayFormula(arrayFormula: string, rowNumber: number, columnNumber: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
arrayFormula | string | Array formula. |
rowNumber | number | Number of rows to populate result of the array formula. |
columnNumber | number | Number of columns to populate result of the array formula. |
setArrayFormula(string, number, number, FormulaParseOptions)
Sets an array formula to a range of cells.
setArrayFormula(arrayFormula: string, rowNumber: number, columnNumber: number, options: FormulaParseOptions) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
arrayFormula | string | Array formula. |
rowNumber | number | Number of rows to populate result of the array formula. |
columnNumber | number | Number of columns to populate result of the array formula. |
options | FormulaParseOptions | Options for parsing the formula. |
setArrayFormula(string, number, number, FormulaParseOptions, object[][])
Sets an array formula to a range of cells.
setArrayFormula(arrayFormula: string, rowNumber: number, columnNumber: number, options: FormulaParseOptions, values: object[][]) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
arrayFormula | string | Array formula. |
rowNumber | number | Number of rows to populate result of the array formula. |
columnNumber | number | Number of columns to populate result of the array formula. |
options | FormulaParseOptions | Options for parsing the formula. |
values | object[][] | values for those cells with given array formula |
setSharedFormula(string, number, number)
Sets shared formulas to a range of cells.
setSharedFormula(sharedFormula: string, rowNumber: number, columnNumber: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
sharedFormula | string | Shared formula. |
rowNumber | number | Number of rows to populate the formula. |
columnNumber | number | Number of columns to populate the formula. |
setSharedFormula(string, number, number, FormulaParseOptions)
Sets shared formulas to a range of cells.
setSharedFormula(sharedFormula: string, rowNumber: number, columnNumber: number, options: FormulaParseOptions) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
sharedFormula | string | Shared formula. |
rowNumber | number | Number of rows to populate the formula. |
columnNumber | number | Number of columns to populate the formula. |
options | FormulaParseOptions | Options for parsing the formula. |
setSharedFormula(string, number, number, FormulaParseOptions, object[][])
Sets shared formulas to a range of cells.
setSharedFormula(sharedFormula: string, rowNumber: number, columnNumber: number, options: FormulaParseOptions, values: object[][]) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
sharedFormula | string | Shared formula. |
rowNumber | number | Number of rows to populate the formula. |
columnNumber | number | Number of columns to populate the formula. |
options | FormulaParseOptions | Options for parsing the formula. |
values | object[][] | values for those cells with given shared formula |
getPrecedents()
Gets all references appearing in this cell’s formula.
getPrecedents() : ReferredAreaCollection;
Returns
Collection of all references appearing in this cell’s formula.
Remarks
ul>
Example
const { Workbook, CellsHelper } = require("aspose.cells.node");
var workbook = new Workbook();
var cells = workbook.getWorksheets().get(0).getCells();
cells.get("A1").setFormula("= B1 + SUM(B1:B10)");
var areas = cells.get("A1").getPrecedents();
for (var i = 0; i < areas.getCount(); i++)
{
var area = areas.get(i);
var stringBuilder = "";
if (area.isExternalLink())
{
stringBuilder += "[";
stringBuilder += area.getExternalFileName();
stringBuilder += "]";
}
stringBuilder += area.getSheetName();
stringBuilder += "!";
stringBuilder += CellsHelper.cellIndexToName(area.getStartRow(), area.getStartColumn());
if (area.isArea())
{
stringBuilder += ":";
stringBuilder += CellsHelper.cellIndexToName(area.getEndRow(), area.getEndColumn());
}
}
workbook.save("output/CellGetPrecedents.xls");
getDependents(boolean)
Get all cells whose formula references to this cell directly.
getDependents(isAll: boolean) : Cell[];
Parameters:
Parameter | Type | Description |
---|---|---|
isAll | boolean | Indicates whether check formulas in other worksheets |
Returns
Cell[]
Remarks
ul>
getPrecedentsInCalculation()
Gets all precedents(reference to cells in current workbook) used by this cell’s formula while calculating it.
getPrecedentsInCalculation() : ReferredAreaEnumerator;
Returns
Enumerator to enumerate all references(ReferredArea)
Remarks
This method can only work with the situation that FormulaSettings.EnableCalculationChain is true for the workbook and the workbook has been fully calculated. If this cell is not a formula or it does not reference to any other cells, null will be returned.
getDependentsInCalculation(boolean)
Gets all cells whose calculated result depends on this cell.
getDependentsInCalculation(recursive: boolean) : CellEnumerator;
Parameters:
Parameter | Type | Description |
---|---|---|
recursive | boolean | Whether returns those dependents which do not reference to this cell directly /// but reference to other leafs of this cell |
Returns
Enumerator to enumerate all dependents(Cell objects)
Remarks
To use this method, please make sure the workbook has been set with true value for FormulaSettings.EnableCalculationChain and has been fully calculated with this setting. If there is no formula reference to this cell, null will be returned.
getArrayRange()
Gets the array range if the cell’s formula is an array formula.
getArrayRange() : CellArea;
Returns
The array range.
Remarks
Only applies when the cell’s formula is an array formula
setDynamicArrayFormula(string, FormulaParseOptions, boolean)
Sets dynamic array formula and make the formula spill into neighboring cells if possible.
setDynamicArrayFormula(arrayFormula: string, options: FormulaParseOptions, calculateValue: boolean) : CellArea;
Parameters:
Parameter | Type | Description |
---|---|---|
arrayFormula | string | the formula expression |
options | FormulaParseOptions | options to parse formula. /// “Parse” option will be ignored and the formula will always be parsed immediately |
calculateValue | boolean | whether calculate this dynamic array formula for those cells in the spilled range. |
Returns
the range that the formula should spill into.
Remarks
the returned range may be not same with the actual one that this dynamic array formula spills into. If there are non-empty cells in the range, the formula will be set for current cell only and marked as “#SPILL!”. But for such kind of situation we still return the whole range that this formula should spill into.
setDynamicArrayFormula(string, FormulaParseOptions, object[][], boolean, boolean)
Sets dynamic array formula and make the formula spill into neighboring cells if possible.
setDynamicArrayFormula(arrayFormula: string, options: FormulaParseOptions, values: object[][], calculateRange: boolean, calculateValue: boolean) : CellArea;
Parameters:
Parameter | Type | Description |
---|---|---|
arrayFormula | string | the formula expression |
options | FormulaParseOptions | options to parse formula. /// “Parse” option will be ignored and the formula will always be parsed immediately |
values | object[][] | values(calculated results) for those cells with given dynamic array formula |
calculateRange | boolean | Whether calculate the spilled range for this dynamic array formula. /// If the “values” parameter is not null and this flag is false, /// then the spilled range’s height will be values.Length and width will be values[0].Length. |
calculateValue | boolean | whether calculate this dynamic array formula for those cells in the spilled range when “values” is null /// or corresponding item in “values” for one cell is null. |
Returns
the range that the formula should spill into.
Remarks
the returned range may be not same with the actual one that this dynamic array formula spills into. If there are non-empty cells in the range, the formula will be set for current cell only and marked as “#SPILL!”. But for such kind of situation we still return the whole range that this formula should spill into.
setDynamicArrayFormula(string, FormulaParseOptions, object[][], boolean, boolean, CalculationOptions)
Sets dynamic array formula and make the formula spill into neighboring cells if possible.
setDynamicArrayFormula(arrayFormula: string, options: FormulaParseOptions, values: object[][], calculateRange: boolean, calculateValue: boolean, copts: CalculationOptions) : CellArea;
Parameters:
Parameter | Type | Description |
---|---|---|
arrayFormula | string | the formula expression |
options | FormulaParseOptions | options to parse formula. /// “Parse” option will be ignored and the formula will always be parsed immediately |
values | object[][] | values(calculated results) for those cells with given dynamic array formula |
calculateRange | boolean | Whether calculate the spilled range for this dynamic array formula. /// If the “values” parameter is not null and this flag is false, /// then the spilled range’s height will be values.Length and width will be values[0].Length. |
calculateValue | boolean | whether calculate this dynamic array formula for those cells in the spilled range when “values” is null /// or corresponding item in “values” for one cell is null. |
copts | CalculationOptions | The options for calculating formula. /// Commonly, for performance consideration, the CalculationOptions.Recursive property should be false. |
Returns
the range that the formula should spill into.
Remarks
the returned range may be not same with the actual one that this dynamic array formula spills into. If there are non-empty cells in the range, the formula will be set for current cell only and marked as “#SPILL!”. But for such kind of situation we still return the whole range that this formula should spill into.
setTableFormula(number, number, string, string, object[][])
Create two-variable data table for given range starting from this cell.
setTableFormula(rowNumber: number, columnNumber: number, rowInputCell: string, columnInputCell: string, values: object[][]) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
rowNumber | number | Number of rows to populate the formula. |
columnNumber | number | Number of columns to populate the formula. |
rowInputCell | string | the row input cell |
columnInputCell | string | the column input cell |
values | object[][] | values for cells in table formula range |
setTableFormula(number, number, string, boolean, object[][])
Create one-variable data table for given range starting from this cell.
setTableFormula(rowNumber: number, columnNumber: number, inputCell: string, isRowInput: boolean, values: object[][]) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
rowNumber | number | Number of rows to populate the formula. |
columnNumber | number | Number of columns to populate the formula. |
inputCell | string | the input cell |
isRowInput | boolean | Indicates whether the input cell is a row input cell(true) or a column input cell(false). |
values | object[][] | values for cells in table formula range |
setTableFormula(number, number, number, number, number, number, object[][])
Create two-variable data table for given range starting from this cell.
setTableFormula(rowNumber: number, columnNumber: number, rowIndexOfRowInputCell: number, columnIndexOfRowInputCell: number, rowIndexOfColumnInputCell: number, columnIndexOfColumnInputCell: number, values: object[][]) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
rowNumber | number | Number of rows to populate the formula. |
columnNumber | number | Number of columns to populate the formula. |
rowIndexOfRowInputCell | number | row index of the row input cell |
columnIndexOfRowInputCell | number | column index of the row input cell |
rowIndexOfColumnInputCell | number | row index of the column input cell |
columnIndexOfColumnInputCell | number | column index of the column input cell |
values | object[][] | values for cells in table formula range |
setTableFormula(number, number, number, number, boolean, object[][])
Create one-variable data table for given range starting from this cell.
setTableFormula(rowNumber: number, columnNumber: number, rowIndexOfInputCell: number, columnIndexOfInputCell: number, isRowInput: boolean, values: object[][]) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
rowNumber | number | Number of rows to populate the formula. |
columnNumber | number | Number of columns to populate the formula. |
rowIndexOfInputCell | number | row index of the input cell |
columnIndexOfInputCell | number | column index of the input cell |
isRowInput | boolean | Indicates whether the input cell is a row input cell(true) or a column input cell(false). |
values | object[][] | values for cells in table formula range |
removeArrayFormula(boolean)
Remove array formula.
removeArrayFormula(leaveNormalFormula: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
leaveNormalFormula | boolean | True represents converting the array formula to normal formula. |
copy(Cell)
Copies data from a source cell.
copy(cell: Cell) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
cell | Cell | Source Cell object. |
characters(number, number)
Returns a Characters object that represents a range of characters within the cell text.
characters(startIndex: number, length: number) : FontSetting;
Parameters:
Parameter | Type | Description |
---|---|---|
startIndex | number | The index of the start of the character. |
length | number | The number of characters. |
Returns
Characters object.
Remarks
This method only works on cell with string value.
Example
const { Workbook, Color } = require("aspose.cells.node");
var excel = new Workbook();
excel.getWorksheets().get(0).getCells().get("A1").putValue("Helloworld");
excel.getWorksheets().get(0).getCells().get("A1").characters(5, 5).getFont().setIsBold(true);
excel.getWorksheets().get(0).getCells().get("A1").characters(5, 5).getFont().setColor(new Color(0, 0, 0xff));
replace(string, string, ReplaceOptions)
Replace text of the cell with options.
replace(placeHolder: string, newValue: string, options: ReplaceOptions) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
placeHolder | string | Cell placeholder |
newValue | string | String value to replace |
options | ReplaceOptions | The replace options |
insertText(number, string)
Insert some characters to the cell. If the cell is rich formatted, this method could keep the original formatting.
insertText(index: number, text: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
index | number | The index. |
text | string | Inserted text. |
isRichText()
Indicates whether the string value of this cell is a rich formatted text.
isRichText() : boolean;
getCharacters()
Returns all Characters objects that represents a range of characters within the cell text.
getCharacters() : FontSetting[];
Returns
All Characters objects
getCharacters(boolean)
Returns all Characters objects that represents a range of characters within the cell text.
getCharacters(flag: boolean) : FontSetting[];
Parameters:
Parameter | Type | Description |
---|---|---|
flag | boolean | Indicates whether applying table style to the cell if the cell is in the table. |
Returns
All Characters objects
setCharacters(FontSetting[])
Sets rich text format of the cell.
setCharacters(characters: FontSetting[]) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
characters | FontSetting[] | All Characters objects. |
getMergedRange()
Returns a Range object which represents a merged range.
getMergedRange() : Range;
Returns
Range object. Null if this cell is not merged.
getHtmlString(boolean)
Gets the html string which contains data and some formats in this cell.
getHtmlString(html5: boolean) : string;
Parameters:
Parameter | Type | Description |
---|---|---|
html5 | boolean | Indicates whether the value is compatible for html5 |
toString()
Returns a string represents the current Cell object.
toString() : string;
toJson()
Convert Cell to JSON struct data.
toJson() : string;
equals(object)
Checks whether this object refers to the same cell with another.
equals(obj: object) : boolean;
Parameters:
Parameter | Type | Description |
---|---|---|
obj | object | another object |
Returns
true if two objects refers to the same cell.
equals(Cell)
Checks whether this object refers to the same cell with another cell object.
equals(cell: Cell) : boolean;
Parameters:
Parameter | Type | Description |
---|---|---|
cell | Cell | another cell object |
Returns
true if two cell objects refers to the same cell.
getHashCode()
Serves as a hash function for a particular type.
getHashCode() : number;
Returns
A hash code for current Cell object.
getConditionalFormattingResult()
Get the result of the conditional formatting.
getConditionalFormattingResult() : ConditionalFormattingResult;
Returns
Remarks
Returns null if no conditional formatting is applied to this cell,
getValidation()
Gets the validation applied to this cell.
getValidation() : Validation;
Returns
getValidationValue()
Gets the value of validation which applied to this cell.
getValidationValue() : boolean;
getTable()
Gets the table which contains this cell.
getTable() : ListObject;
Returns
dispose()
dispose() : void;
isNull()
Checks whether the implementation object is null.
isNull() : boolean;