@univerjs/engine-formula v0.5.0-beta.1 • Docs

Class: StringValueObject

Extends

• BaseValueObject

Constructors

new StringValueObject()

new StringValueObject(rawValue): StringValueObject

Parameters

Returns

StringValueObject

Overrides

BaseValueObject.constructor

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1314

Properties

Methods

abs()

abs(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.abs

Defined in

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

acos()

acos(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.acos

Defined in

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

acosh()

acosh(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.acosh

Defined in

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

asin()

asin(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.asin

Defined in

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

asinh()

asinh(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.asinh

Defined in

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

atan()

atan(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.atan

Defined in

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

atan2()

atan2(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.atan2

Defined in

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

atan2Inverse()

atan2Inverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.atan2Inverse

Defined in

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

atanh()

atanh(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.atanh

Defined in

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

cbrt()

cbrt(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.cbrt

Defined in

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

ceil()

ceil(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.ceil

Defined in

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

ceilInverse()

ceilInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.ceilInverse

Defined in

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

compare()

compare(
   valueObject, 
   operator, 
   isCaseSensitive?): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.compare

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1357

compareBy()

compareBy(
   value, 
   operator, 
   isCaseSensitive): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.compareBy

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1368

concatenate()

concatenate(value, concatenateType): string

Parameters

Returns

string

Inherited from

BaseValueObject.concatenate

Defined in

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

concatenateBack()

concatenateBack(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.concatenateBack

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1334

concatenateFront()

concatenateFront(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.concatenateFront

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1327

convertToBooleanObjectValue()

convertToBooleanObjectValue(): BooleanValueObject

Returns

BooleanValueObject

Overrides

BaseValueObject.convertToBooleanObjectValue

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1443

convertToNumberObjectValue()

convertToNumberObjectValue(): ErrorValueObject | NumberValueObject

Returns

ErrorValueObject | NumberValueObject

Overrides

BaseValueObject.convertToNumberObjectValue

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1439

cos()

cos(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.cos

Defined in

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

cosh()

cosh(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.cosh

Defined in

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

count()

count(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.count

Defined in

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

countA()

countA(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.countA

Defined in

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

countBlank()

countBlank(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.countBlank

Defined in

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

dispose()

dispose(): void

Returns

void

Inherited from

BaseValueObject.dispose

Defined in

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

divided()

divided(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.divided

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1353

dividedBy()

dividedBy(value): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.dividedBy

Defined in

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

exp()

exp(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.exp

Defined in

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

floor()

floor(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.floor

Defined in

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

floorInverse()

floorInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.floorInverse

Defined in

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

getArrayValue()

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

Returns

Nullable<BaseValueObject>[][]

Inherited from

BaseValueObject.getArrayValue

Defined in

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

getNegative()

getNegative(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.getNegative

Defined in

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

getPattern()

getPattern(): string

Returns

string

Inherited from

BaseValueObject.getPattern

Defined in

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

getReciprocal()

getReciprocal(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.getReciprocal

Defined in

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

getValue()

getValue(): string

Returns

string

Overrides

BaseValueObject.getValue

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1319

isArray()

isArray(): boolean

Returns

boolean

Inherited from

BaseValueObject.isArray

Defined in

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

isAsyncArrayObject()

isAsyncArrayObject(): boolean

Returns

boolean

Inherited from

BaseValueObject.isAsyncArrayObject

Defined in

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

isAsyncObject()

isAsyncObject(): boolean

Returns

boolean

Inherited from

BaseValueObject.isAsyncObject

Defined in

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

isBoolean()

isBoolean(): boolean

Returns

boolean

Inherited from

BaseValueObject.isBoolean

Defined in

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

isCube()

isCube(): boolean

Returns

boolean

Inherited from

BaseValueObject.isCube

Defined in

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

isEqual()

isEqual(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isEqual

Defined in

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

isEqualType()

isEqualType(object): boolean

Parameters

Returns

boolean

Inherited from

BaseValueObject.isEqualType

Defined in

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

isError()

isError(): boolean

Returns

boolean

Inherited from

BaseValueObject.isError

Defined in

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

isGreaterThan()

isGreaterThan(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isGreaterThan

Defined in

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

isGreaterThanOrEqual()

isGreaterThanOrEqual(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isGreaterThanOrEqual

Defined in

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

isLambda()

isLambda(): boolean

Returns

boolean

Inherited from

BaseValueObject.isLambda

Defined in

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

isLessThan()

isLessThan(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isLessThan

Defined in

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

isLessThanOrEqual()

isLessThanOrEqual(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isLessThanOrEqual

Defined in

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

isNotEqual()

isNotEqual(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isNotEqual

Defined in

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

isNull()

isNull(): boolean

Returns

boolean

Inherited from

BaseValueObject.isNull

Defined in

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

isNumber()

isNumber(): boolean

Returns

boolean

Inherited from

BaseValueObject.isNumber

Defined in

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

isReferenceObject()

isReferenceObject(): boolean

Returns

boolean

Inherited from

BaseValueObject.isReferenceObject

Defined in

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

isString()

isString(): boolean

Returns

boolean

Overrides

BaseValueObject.isString

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1323

isValueObject()

isValueObject(): boolean

Returns

boolean

Inherited from

BaseValueObject.isValueObject

Defined in

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

log()

log(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.log

Defined in

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

log10()

log10(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.log10

Defined in

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

map()

map(callbackFn): BaseValueObject

return every value in the array after the callback function, excluding the error value

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.map

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:165

mapValue()

mapValue(callbackFn): BaseValueObject

return every value in the array after the callback function

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.mapValue

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:175

max()

max(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.max

Defined in

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

mean()

mean(): BaseValueObject

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

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:371

median()

median(): BaseValueObject

Calculate the median of the entire array.

reference https://numpy.org/doc/stable/reference/generated/numpy.median.html

Returns

BaseValueObject

Inherited from

BaseValueObject.median

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:382

min()

min(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.min

Defined in

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

minus()

minus(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.minus

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1345

minusBy()

minusBy(value): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.minusBy

Defined in

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

mod()

mod(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.mod

Defined in

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

modInverse()

modInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.modInverse

Defined in

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

multiply()

multiply(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.multiply

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1349

multiplyBy()

multiplyBy(value): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.multiplyBy

Defined in

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

plus()

plus(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.plus

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1341

plusBy()

plusBy(value): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.plusBy

Defined in

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

pow()

pow(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.pow

Defined in

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

powInverse()

powInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.powInverse

Defined in

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

round()

round(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.round

Defined in

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

roundInverse()

roundInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.roundInverse

Defined in

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

setArrayValue()

setArrayValue(value): void

Parameters

Returns

void

Inherited from

BaseValueObject.setArrayValue

Defined in

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

setPattern()

setPattern(pattern): void

Only used in NumberValueObject

Parameters

Returns

void

Inherited from

BaseValueObject.setPattern

Defined in

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

setValue()

setValue(value): void

Parameters

Returns

void

Inherited from

BaseValueObject.setValue

Defined in

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

sin()

sin(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.sin

Defined in

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

sinh()

sinh(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.sinh

Defined in

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

sqrt()

sqrt(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.sqrt

Defined in

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

std()

std(): BaseValueObject

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

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:402

sum()

sum(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.sum

Defined in

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

tan()

tan(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.tan

Defined in

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

tanh()

tanh(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.tanh

Defined in

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

toUnitRange()

toUnitRange(): {
  range: {
     endColumn: -1;
     endRow: -1;
     startColumn: -1;
     startRow: -1;
    };
  sheetId: '';
  unitId: '';
}

Returns

{
  range: {
     endColumn: -1;
     endRow: -1;
     startColumn: -1;
     startRow: -1;
    };
  sheetId: '';
  unitId: '';
}

Inherited from

BaseValueObject.toUnitRange

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:44

var()

var(): BaseValueObject

Calculate the variance of the entire array.

reference https://numpy.org/doc/stable/reference/generated/numpy.var.html

Returns

BaseValueObject

Inherited from

BaseValueObject.var

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/base-value-object.ts:392

create()

static create(value): StringValueObject

Parameters

Returns

StringValueObject

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/primitive-object.ts:1304