@univerjs/engine-formula v0.5.4
Class: LambdaValueObjectObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/lambda-value-object.ts:56
Extends
Constructors
new LambdaValueObjectObject()
new LambdaValueObjectObject(
_lambdaNode,
_interpreter,
_lambdaPrivacyVarKeys): LambdaValueObjectObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/lambda-value-object.ts:63
Parameters
Parameter | Type |
---|---|
_lambdaNode | Nullable <BaseAstNode > |
_interpreter | Nullable <Interpreter > |
_lambdaPrivacyVarKeys | string [] |
Returns
Overrides
Properties
Property | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|
pattern | string | '' | BaseValueObject .pattern | submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:18 |
Methods
abs()
abs(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:422
Returns
Inherited from
acos()
acos(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:305
Returns
Inherited from
acosh()
acosh(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:310
Returns
Inherited from
asin()
asin(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:325
Returns
Inherited from
asinh()
asinh(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:330
Returns
Inherited from
atan()
atan(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:345
Returns
Inherited from
atan2()
atan2(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:350
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
atan2Inverse()
atan2Inverse(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:355
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
atanh()
atanh(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:360
Returns
Inherited from
cbrt()
cbrt(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:290
Returns
Inherited from
ceil()
ceil(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:447
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
ceilInverse()
ceilInverse(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:452
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
compare()
compare(
valueObject,
operator,
isCaseSensitive): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:180
Parameters
Parameter | Type | Default value |
---|---|---|
valueObject | BaseValueObject | undefined |
operator | compareToken | undefined |
isCaseSensitive | boolean | false |
Returns
Inherited from
compareBy()
compareBy(value, operator): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:244
Parameters
Parameter | Type |
---|---|
value | string | number | boolean |
operator | compareToken |
Returns
Inherited from
concatenate()
concatenate(value, concatenateType): string
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:249
Parameters
Parameter | Type | Default value |
---|---|---|
value | string | number | boolean | undefined |
concatenateType | ConcatenateType | ConcatenateType.FRONT |
Returns
string
Inherited from
concatenateBack()
concatenateBack(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:214
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
BaseValueObject
.concatenateBack
concatenateFront()
concatenateFront(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:209
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
BaseValueObject
.concatenateFront
convertToBooleanObjectValue()
convertToBooleanObjectValue(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:462
Returns
Inherited from
BaseValueObject
.convertToBooleanObjectValue
convertToNumberObjectValue()
convertToNumberObjectValue(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:457
Returns
Inherited from
BaseValueObject
.convertToNumberObjectValue
cos()
cos(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:295
Returns
Inherited from
cosh()
cosh(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:300
Returns
Inherited from
count()
count(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:115
Returns
Inherited from
countA()
countA(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:119
Returns
Inherited from
countBlank()
countBlank(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:123
Returns
Inherited from
dispose()
dispose(): void
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/lambda-value-object.ts:74
Returns
void
Overrides
divided()
divided(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:150
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
dividedBy()
dividedBy(value): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:234
Parameters
Parameter | Type |
---|---|
value | string | number | boolean |
Returns
Inherited from
execute()
execute(...variants): BaseValueObject | AsyncObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/lambda-value-object.ts:86
Parameters
Parameter | Type |
---|---|
…variants | FunctionVariantType [] |
Returns
executeCustom()
executeCustom(...variants): BaseValueObject | AsyncObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/lambda-value-object.ts:119
Execute custom lambda function, handle basic types
Parameters
Parameter | Type |
---|---|
…variants | PrimitiveValueType [] |
Returns
exp()
exp(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:417
Returns
Inherited from
floor()
floor(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:437
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
floorInverse()
floorInverse(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:442
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
getArrayValue()
getArrayValue(): Nullable<BaseValueObject>[][]
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:62
Returns
Nullable
<BaseValueObject
>[][]
Inherited from
getLambdaPrivacyVarKeys()
getLambdaPrivacyVarKeys(): string[]
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/lambda-value-object.ts:163
Returns
string
[]
getNegative()
getNegative(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:127
Returns
Inherited from
getPattern()
getPattern(): string
Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:24
Returns
string
Inherited from
getReciprocal()
getReciprocal(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:131
Returns
Inherited from
getValue()
getValue(): string | number | boolean
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:57
Returns
string
| number
| boolean
Inherited from
isArray()
isArray(): boolean
Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:52
Returns
boolean
Inherited from
isAsyncArrayObject()
isAsyncArrayObject(): boolean
Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:44
Returns
boolean
Inherited from
BaseValueObject
.isAsyncArrayObject
isAsyncObject()
isAsyncObject(): boolean
Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:40
Returns
boolean
Inherited from
isBoolean()
isBoolean(): boolean
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:87
Returns
boolean
Inherited from
isCube()
isCube(): boolean
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:75
Returns
boolean
Inherited from
isEqual()
isEqual(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:185
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
isEqualType()
isEqualType(object): boolean
Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:60
Parameters
Parameter | Type |
---|---|
object | ObjectClassType |
Returns
boolean
Inherited from
isError()
isError(): boolean
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:95
Returns
boolean
Inherited from
isGreaterThan()
isGreaterThan(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:205
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
isGreaterThanOrEqual()
isGreaterThanOrEqual(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:193
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
BaseValueObject
.isGreaterThanOrEqual
isLambda()
isLambda(): boolean
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/lambda-value-object.ts:82
Returns
boolean
Overrides
isLessThan()
isLessThan(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:201
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
isLessThanOrEqual()
isLessThanOrEqual(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:197
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
BaseValueObject
.isLessThanOrEqual
isNotEqual()
isNotEqual(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:189
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
isNull()
isNull(): boolean
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:99
Returns
boolean
Inherited from
isNumber()
isNumber(): boolean
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:83
Returns
boolean
Inherited from
isReferenceObject()
isReferenceObject(): boolean
Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:48
Returns
boolean
Inherited from
BaseValueObject
.isReferenceObject
isString()
isString(): boolean
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:79
Returns
boolean
Inherited from
isValueObject()
isValueObject(): boolean
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:40
Returns
boolean
Inherited from
log()
log(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:407
Returns
Inherited from
log10()
log10(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:412
Returns
Inherited from
map()
map(callbackFn): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:165
return every value in the array after the callback function, excluding the error value
Parameters
Parameter | Type |
---|---|
callbackFn | callbackMapFnType |
Returns
Inherited from
mapValue()
mapValue(callbackFn): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:175
return every value in the array after the callback function
Parameters
Parameter | Type |
---|---|
callbackFn | callbackMapFnType |
Returns
Inherited from
max()
max(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:107
Returns
Inherited from
mean()
mean(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:371
Calculate the mean of the entire array.
reference https://numpy.org/doc/stable/reference/generated/numpy.mean.html#numpy.mean
Returns
Inherited from
median()
median(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:382
Calculate the median of the entire array.
reference https://numpy.org/doc/stable/reference/generated/numpy.median.html
Returns
Inherited from
min()
min(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:111
Returns
Inherited from
minus()
minus(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:140
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
minusBy()
minusBy(value): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:224
Parameters
Parameter | Type |
---|---|
value | string | number | boolean |
Returns
Inherited from
mod()
mod(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:155
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
modInverse()
modInverse(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:239
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
multiply()
multiply(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:145
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
multiplyBy()
multiplyBy(value): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:229
Parameters
Parameter | Type |
---|---|
value | string | number | boolean |
Returns
Inherited from
plus()
plus(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:135
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
plusBy()
plusBy(value): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:219
Parameters
Parameter | Type |
---|---|
value | string | number | boolean |
Returns
Inherited from
pow()
pow(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:275
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
powInverse()
powInverse(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:280
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
round()
round(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:427
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
roundInverse()
roundInverse(valueObject): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:432
Parameters
Parameter | Type |
---|---|
valueObject | BaseValueObject |
Returns
Inherited from
setArrayValue()
setArrayValue(value): void
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:71
Parameters
Parameter | Type |
---|---|
value | BaseValueObject [][] |
Returns
void
Inherited from
setPattern()
setPattern(pattern): void
Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:32
Only used in NumberValueObject
Parameters
Parameter | Type |
---|---|
pattern | string |
Returns
void
Inherited from
setValue()
setValue(value): void
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:67
Parameters
Parameter | Type |
---|---|
value | string | number | boolean |
Returns
void
Inherited from
sin()
sin(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:315
Returns
Inherited from
sinh()
sinh(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:320
Returns
Inherited from
sqrt()
sqrt(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:285
Returns
Inherited from
std()
std(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:402
Calculate the standard deviation of the entire array.
reference https://numpy.org/doc/stable/reference/generated/numpy.std.html
Returns
Inherited from
sum()
sum(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:103
Returns
Inherited from
tan()
tan(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:335
Returns
Inherited from
tanh()
tanh(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:340
Returns
Inherited from
toUnitRange()
toUnitRange(): {
range: {
endColumn: number;
endRow: number;
startColumn: number;
startRow: number;
};
sheetId: string;
unitId: string;
}
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:44
Returns
{
range: {
endColumn: number;
endRow: number;
startColumn: number;
startRow: number;
};
sheetId: string;
unitId: string;
}
Inherited from
var()
var(): BaseValueObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:392
Calculate the variance of the entire array.
reference https://numpy.org/doc/stable/reference/generated/numpy.var.html
Returns
Inherited from
create()
static create(
lambdaNode,
interpreter,
lambdaPrivacyVarKeys): LambdaValueObjectObject
Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/lambda-value-object.ts:57
Parameters
Parameter | Type |
---|---|
lambdaNode | BaseAstNode |
interpreter | Interpreter |
lambdaPrivacyVarKeys | string [] |