@univerjs-pro/engine-formula v0.5.4

Class: NumberValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:438

Extends

• BaseValueObject

Constructors

new NumberValueObject()

new NumberValueObject(rawValue): NumberValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:450

Parameters

Returns

NumberValueObject

Overrides

BaseValueObject.constructor

Properties

Methods

abs()

abs(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1154

Returns

BaseValueObject

Overrides

BaseValueObject.abs

acos()

acos(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:902

Returns

BaseValueObject

Overrides

BaseValueObject.acos

acosh()

acosh(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:918

Returns

BaseValueObject

Overrides

BaseValueObject.acosh

asin()

asin(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:966

Returns

BaseValueObject

Overrides

BaseValueObject.asin

asinh()

asinh(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:982

Returns

BaseValueObject

Overrides

BaseValueObject.asinh

atan()

atan(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1030

Returns

BaseValueObject

Overrides

BaseValueObject.atan

atan2()

atan2(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1046

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.atan2

atan2Inverse()

atan2Inverse(valueObject): BaseValueObject

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

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.atan2Inverse

atanh()

atanh(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1082

Returns

BaseValueObject

Overrides

BaseValueObject.atanh

cbrt()

cbrt(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:854

Returns

BaseValueObject

Overrides

BaseValueObject.cbrt

ceil()

ceil(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1234

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.ceil

ceilInverse()

ceilInverse(valueObject): BaseValueObject

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

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.ceilInverse

compare()

compare(valueObject, operator): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:625

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.compare

compareBy()

compareBy(value, operator): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:720

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.compareBy

concatenate()

concatenate(value, concatenateType): string

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

Parameters

Returns

string

Inherited from

BaseValueObject.concatenate

concatenateBack()

concatenateBack(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:618

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.concatenateBack

concatenateFront()

concatenateFront(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:611

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.concatenateFront

convertToBooleanObjectValue()

convertToBooleanObjectValue(): BooleanValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1270

Returns

BooleanValueObject

Overrides

BaseValueObject.convertToBooleanObjectValue

convertToNumberObjectValue()

convertToNumberObjectValue(): NumberValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1266

Returns

NumberValueObject

Overrides

BaseValueObject.convertToNumberObjectValue

cos()

cos(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:870

Returns

BaseValueObject

Overrides

BaseValueObject.cos

cosh()

cosh(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:886

Returns

BaseValueObject

Overrides

BaseValueObject.cosh

count()

count(): BaseValueObject

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

Returns

BaseValueObject

Inherited from

BaseValueObject.count

countA()

countA(): BaseValueObject

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

Returns

BaseValueObject

Inherited from

BaseValueObject.countA

countBlank()

countBlank(): BaseValueObject

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

Returns

BaseValueObject

Inherited from

BaseValueObject.countBlank

dispose()

dispose(): void

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

Returns

void

Inherited from

BaseValueObject.dispose

divided()

divided(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:539

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.divided

dividedBy()

dividedBy(value): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:695

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.dividedBy

equalZero()

equalZero(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:495

Returns

boolean

exp()

exp(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1138

Returns

BaseValueObject

Overrides

BaseValueObject.exp

floor()

floor(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1202

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.floor

floorInverse()

floorInverse(valueObject): BaseValueObject

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

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.floorInverse

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

BaseValueObject.getArrayValue

getNegative()

getNegative(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:468

Returns

BaseValueObject

Overrides

BaseValueObject.getNegative

getPattern()

getPattern(): string

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

Returns

string

Inherited from

BaseValueObject.getPattern

getReciprocal()

getReciprocal(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:472

Returns

BaseValueObject

Overrides

BaseValueObject.getReciprocal

getValue()

getValue(): number

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:456

Returns

number

Overrides

BaseValueObject.getValue

isArray()

isArray(): boolean

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

Returns

boolean

Inherited from

BaseValueObject.isArray

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

BaseValueObject.isAsyncObject

isBoolean()

isBoolean(): boolean

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

Returns

boolean

Inherited from

BaseValueObject.isBoolean

isCube()

isCube(): boolean

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

Returns

boolean

Inherited from

BaseValueObject.isCube

isEqual()

isEqual(valueObject): BaseValueObject

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

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isEqual

isEqualType()

isEqualType(object): boolean

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

Parameters

Returns

boolean

Inherited from

BaseValueObject.isEqualType

isError()

isError(): boolean

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

Returns

boolean

Inherited from

BaseValueObject.isError

isGreaterThan()

isGreaterThan(valueObject): BaseValueObject

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

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isGreaterThan

isGreaterThanOrEqual()

isGreaterThanOrEqual(valueObject): BaseValueObject

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

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isGreaterThanOrEqual

isLambda()

isLambda(): boolean

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

Returns

boolean

Inherited from

BaseValueObject.isLambda

isLessThan()

isLessThan(valueObject): BaseValueObject

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

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isLessThan

isLessThanOrEqual()

isLessThanOrEqual(valueObject): BaseValueObject

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

Parameters

Returns

BaseValueObject

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

Returns

BaseValueObject

Inherited from

BaseValueObject.isNotEqual

isNull()

isNull(): boolean

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

Returns

boolean

Inherited from

BaseValueObject.isNull

isNumber()

isNumber(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:464

Returns

boolean

Overrides

BaseValueObject.isNumber

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

BaseValueObject.isString

isValueObject()

isValueObject(): boolean

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

Returns

boolean

Inherited from

BaseValueObject.isValueObject

log()

log(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1098

Returns

BaseValueObject

Overrides

BaseValueObject.log

log10()

log10(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1118

Returns

BaseValueObject

Overrides

BaseValueObject.log10

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

Inherited from

BaseValueObject.map

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

Inherited from

BaseValueObject.mapValue

max()

max(): BaseValueObject

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

Returns

BaseValueObject

Inherited from

BaseValueObject.max

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

Inherited from

BaseValueObject.mean

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

Inherited from

BaseValueObject.median

min()

min(): BaseValueObject

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

Returns

BaseValueObject

Inherited from

BaseValueObject.min

minus()

minus(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:499

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.minus

minusBy()

minusBy(value): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:653

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.minusBy

mod()

mod(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:561

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.mod

modInverse()

modInverse(valueObject): BaseValueObject

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

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.modInverse

multiply()

multiply(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:521

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.multiply

multiplyBy()

multiplyBy(value): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:674

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.multiplyBy

plus()

plus(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:476

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.plus

plusBy()

plusBy(value): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:632

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.plusBy

pow()

pow(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:786

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.pow

powInverse()

powInverse(valueObject): BaseValueObject

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

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.powInverse

round()

round(valueObject): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1170

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.round

roundInverse()

roundInverse(valueObject): BaseValueObject

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

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.roundInverse

setArrayValue()

setArrayValue(value): void

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

Parameters

Returns

void

Inherited from

BaseValueObject.setArrayValue

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

BaseValueObject.setPattern

setValue()

setValue(value): void

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:460

Parameters

Returns

void

Overrides

BaseValueObject.setValue

sin()

sin(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:934

Returns

BaseValueObject

Overrides

BaseValueObject.sin

sinh()

sinh(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:950

Returns

BaseValueObject

Overrides

BaseValueObject.sinh

sqrt()

sqrt(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:838

Returns

BaseValueObject

Overrides

BaseValueObject.sqrt

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

Inherited from

BaseValueObject.std

sum()

sum(): BaseValueObject

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

Returns

BaseValueObject

Inherited from

BaseValueObject.sum

tan()

tan(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:998

Returns

BaseValueObject

Overrides

BaseValueObject.tan

tanh()

tanh(): BaseValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1014

Returns

BaseValueObject

Overrides

BaseValueObject.tanh

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

BaseValueObject.toUnitRange

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

Inherited from

BaseValueObject.var

create()

static create(value, pattern): NumberValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:441

Parameters

Returns

NumberValueObject