Property Getters/Setters Summary | ||
---|---|---|
function | getCalculatedValue() | |
function | setCalculatedValue(value) | |
Gets or sets the calculated value for this function. | ||
function | getCell() | |
Gets the Cell object where the function is in.
|
||
function | getCellColumn() | |
Gets the column index of the cell where the function is in.
|
||
function | getCellRow() | |
Gets the row index of the cell where the function is in.
|
||
function | getFunctionName() | |
Gets the function name to be calculated.
|
||
function | getParamCount() | |
Gets the count of parameters
|
||
function | getWorkbook() | |
Gets the Workbook object where the function is in.
|
||
function | getWorksheet() | |
Gets the Worksheet object where the function is in.
|
Method Summary | ||
---|---|---|
function | getParamText(index) | |
Gets the literal text of the parameter at given index.
|
||
function | getParamValue(index) | |
Gets the represented value object of the parameter at given index.
|
||
function | getParamValueInArrayMode(index, maxRowCount, maxColumnCount) | |
Gets the value(s) of the parameter at given index.
If the parameter is some kind of expression that needs to be calculated,
then it will be calculated in array mode.
|
function getCalculatedValue() / function setCalculatedValue(value)
function getWorkbook()
function getWorksheet()
function getCellRow()
function getCellColumn()
function getCell()
function getFunctionName()
function getParamCount()
function getParamValue(index)
If it is plain value, then returns the plain value itself;
If it is reference, then returns ReferredArea object;
If it references to dataset(s) with multiple values, then returns array of objects;
If it is some kind of expression that needs to be calculated, then it will be calculated in value mode
and generally a single value will be returned according to current cell base. For example,
if one parameter of D2's formula is A:A+B:B, then A2+B2 will be calculated and returned.
However, if this parameter has been specified as array mode
(by
index: Number
- The index of the parameter(0 based)function getParamValueInArrayMode(index, maxRowCount, maxColumnCount)
index: Number
- The index of the parameter(0 based)maxRowCount: Number
- The row count limit for the returned array.
If it is non-positive or greater than the actual row count, then actual row count will be used.
maxColumnCount: Number
- The column count limit for the returned array.
If it is non-positive or greater than the actual row count, then actual column count will be used.
function getParamText(index)
index: Number
- index of the parameter(0 based)