@univerjs-pro/engine-formula v0.5.4

Class: BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:35

Extends

• ObjectClassType

Extended by

• ArrayValueObject
• ErrorValueObject
• BooleanValueObject
• NullValueObject
• NumberValueObject
• StringValueObject
• LambdaValueObjectObject

Constructors

new BaseValueObject()

new BaseValueObject(_rawValue): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:36

Parameters

Returns

BaseValueObject

Overrides

ObjectClassType.constructor

Properties

Methods

abs()

abs(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:422

Returns

BaseValueObject

acos()

acos(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:305

Returns

BaseValueObject

acosh()

acosh(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:310

Returns

BaseValueObject

asin()

asin(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:325

Returns

BaseValueObject

asinh()

asinh(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:330

Returns

BaseValueObject

atan()

atan(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:345

Returns

BaseValueObject

atan2()

atan2(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:350

Parameters

Returns

BaseValueObject

atan2Inverse()

atan2Inverse(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:355

Parameters

Returns

BaseValueObject

atanh()

atanh(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:360

Returns

BaseValueObject

cbrt()

cbrt(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:290

Returns

BaseValueObject

ceil()

ceil(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:447

Parameters

Returns

BaseValueObject

ceilInverse()

ceilInverse(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:452

Parameters

Returns

BaseValueObject

compare()

compare(
   valueObject, 
   operator, 
   isCaseSensitive): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:180

Parameters

Returns

BaseValueObject

compareBy()

compareBy(value, operator): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:244

Parameters

Returns

BaseValueObject

concatenate()

concatenate(value, concatenateType): string

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:249

Parameters

Returns

string

concatenateBack()

concatenateBack(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:214

Parameters

Returns

BaseValueObject

concatenateFront()

concatenateFront(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:209

Parameters

Returns

BaseValueObject

convertToBooleanObjectValue()

convertToBooleanObjectValue(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:462

Returns

BaseValueObject

convertToNumberObjectValue()

convertToNumberObjectValue(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:457

Returns

BaseValueObject

cos()

cos(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:295

Returns

BaseValueObject

cosh()

cosh(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:300

Returns

BaseValueObject

count()

count(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:115

Returns

BaseValueObject

countA()

countA(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:119

Returns

BaseValueObject

countBlank()

countBlank(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:123

Returns

BaseValueObject

dispose()

dispose(): void

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:20

Returns

void

Inherited from

ObjectClassType.dispose

divided()

divided(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:150

Parameters

Returns

BaseValueObject

dividedBy()

dividedBy(value): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:234

Parameters

Returns

BaseValueObject

exp()

exp(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:417

Returns

BaseValueObject

floor()

floor(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:437

Parameters

Returns

BaseValueObject

floorInverse()

floorInverse(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:442

Parameters

Returns

BaseValueObject

getArrayValue()

getArrayValue(): Nullable<BaseValueObject>[][]

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:62

Returns

Nullable<BaseValueObject>[][]

getNegative()

getNegative(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:127

Returns

BaseValueObject

getPattern()

getPattern(): string

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:24

Returns

string

Inherited from

ObjectClassType.getPattern

getReciprocal()

getReciprocal(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:131

Returns

BaseValueObject

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

isArray()

isArray(): boolean

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:52

Returns

boolean

Inherited from

ObjectClassType.isArray

isAsyncArrayObject()

isAsyncArrayObject(): boolean

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:44

Returns

boolean

Inherited from

ObjectClassType.isAsyncArrayObject

isAsyncObject()

isAsyncObject(): boolean

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:40

Returns

boolean

Inherited from

ObjectClassType.isAsyncObject

isBoolean()

isBoolean(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:87

Returns

boolean

isCube()

isCube(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:75

Returns

boolean

isEqual()

isEqual(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:185

Parameters

Returns

BaseValueObject

isEqualType()

isEqualType(object): boolean

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:60

Parameters

Returns

boolean

Inherited from

ObjectClassType.isEqualType

isError()

isError(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:95

Returns

boolean

Overrides

ObjectClassType.isError

isGreaterThan()

isGreaterThan(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:205

Parameters

Returns

BaseValueObject

isGreaterThanOrEqual()

isGreaterThanOrEqual(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:193

Parameters

Returns

BaseValueObject

isLambda()

isLambda(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:91

Returns

boolean

isLessThan()

isLessThan(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:201

Parameters

Returns

BaseValueObject

isLessThanOrEqual()

isLessThanOrEqual(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:197

Parameters

Returns

BaseValueObject

isNotEqual()

isNotEqual(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:189

Parameters

Returns

BaseValueObject

isNull()

isNull(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:99

Returns

boolean

isNumber()

isNumber(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:83

Returns

boolean

isReferenceObject()

isReferenceObject(): boolean

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:48

Returns

boolean

Inherited from

ObjectClassType.isReferenceObject

isString()

isString(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:79

Returns

boolean

isValueObject()

isValueObject(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:40

Returns

boolean

Overrides

ObjectClassType.isValueObject

log()

log(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:407

Returns

BaseValueObject

log10()

log10(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:412

Returns

BaseValueObject

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

Returns

BaseValueObject

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

Returns

BaseValueObject

max()

max(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:107

Returns

BaseValueObject

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

BaseValueObject

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

BaseValueObject

min()

min(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:111

Returns

BaseValueObject

minus()

minus(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:140

Parameters

Returns

BaseValueObject

minusBy()

minusBy(value): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:224

Parameters

Returns

BaseValueObject

mod()

mod(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:155

Parameters

Returns

BaseValueObject

modInverse()

modInverse(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:239

Parameters

Returns

BaseValueObject

multiply()

multiply(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:145

Parameters

Returns

BaseValueObject

multiplyBy()

multiplyBy(value): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:229

Parameters

Returns

BaseValueObject

plus()

plus(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:135

Parameters

Returns

BaseValueObject

plusBy()

plusBy(value): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:219

Parameters

Returns

BaseValueObject

pow()

pow(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:275

Parameters

Returns

BaseValueObject

powInverse()

powInverse(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:280

Parameters

Returns

BaseValueObject

round()

round(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:427

Parameters

Returns

BaseValueObject

roundInverse()

roundInverse(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:432

Parameters

Returns

BaseValueObject

setArrayValue()

setArrayValue(value): void

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:71

Parameters

Returns

void

setPattern()

setPattern(pattern): void

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:32

Only used in NumberValueObject

Parameters

Returns

void

Inherited from

ObjectClassType.setPattern

setValue()

setValue(value): void

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:67

Parameters

Returns

void

sin()

sin(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:315

Returns

BaseValueObject

sinh()

sinh(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:320

Returns

BaseValueObject

sqrt()

sqrt(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:285

Returns

BaseValueObject

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

BaseValueObject

sum()

sum(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:103

Returns

BaseValueObject

tan()

tan(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:335

Returns

BaseValueObject

tanh()

tanh(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:340

Returns

BaseValueObject

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;
}

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

BaseValueObject