@univerjs/engine-formula v0.4.2 • Docs

Class: StringValueObject

Extends

• BaseValueObject

Constructors

new StringValueObject()

new StringValueObject(rawValue): StringValueObject

Parameters

Returns

StringValueObject

Overrides

BaseValueObject.constructor

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1326 (opens in a new tab)

Properties

Methods

abs()

abs(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.abs

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:422 (opens in a new tab)

acos()

acos(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.acos

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:305 (opens in a new tab)

acosh()

acosh(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.acosh

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:310 (opens in a new tab)

asin()

asin(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.asin

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:325 (opens in a new tab)

asinh()

asinh(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.asinh

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:330 (opens in a new tab)

atan()

atan(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.atan

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:345 (opens in a new tab)

atan2()

atan2(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.atan2

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:350 (opens in a new tab)

atan2Inverse()

atan2Inverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.atan2Inverse

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:355 (opens in a new tab)

atanh()

atanh(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.atanh

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:360 (opens in a new tab)

cbrt()

cbrt(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.cbrt

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:290 (opens in a new tab)

ceil()

ceil(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.ceil

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:447 (opens in a new tab)

ceilInverse()

ceilInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.ceilInverse

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:452 (opens in a new tab)

compare()

compare(
   valueObject, 
   operator, 
   isCaseSensitive?): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.compare

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1369 (opens in a new tab)

compareBy()

compareBy(
   value, 
   operator, 
   isCaseSensitive): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.compareBy

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1380 (opens in a new tab)

concatenate()

concatenate(value, concatenateType): string

Parameters

Returns

string

Inherited from

BaseValueObject.concatenate

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:249 (opens in a new tab)

concatenateBack()

concatenateBack(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.concatenateBack

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1346 (opens in a new tab)

concatenateFront()

concatenateFront(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.concatenateFront

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1339 (opens in a new tab)

convertToBooleanObjectValue()

convertToBooleanObjectValue(): BooleanValueObject

Returns

BooleanValueObject

Overrides

BaseValueObject.convertToBooleanObjectValue

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1455 (opens in a new tab)

convertToNumberObjectValue()

convertToNumberObjectValue(): ErrorValueObject | NumberValueObject

Returns

ErrorValueObject | NumberValueObject

Overrides

BaseValueObject.convertToNumberObjectValue

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1451 (opens in a new tab)

cos()

cos(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.cos

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:295 (opens in a new tab)

cosh()

cosh(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.cosh

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:300 (opens in a new tab)

count()

count(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.count

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:115 (opens in a new tab)

countA()

countA(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.countA

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:119 (opens in a new tab)

countBlank()

countBlank(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.countBlank

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:123 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Inherited from

BaseValueObject.dispose

Defined in

packages/engine-formula/src/basics/object-class-type.ts:20 (opens in a new tab)

divided()

divided(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.divided

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1365 (opens in a new tab)

dividedBy()

dividedBy(value): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.dividedBy

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:234 (opens in a new tab)

exp()

exp(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.exp

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:417 (opens in a new tab)

floor()

floor(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.floor

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:437 (opens in a new tab)

floorInverse()

floorInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.floorInverse

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:442 (opens in a new tab)

getArrayValue()

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

Returns

Nullable<BaseValueObject>[][]

Inherited from

BaseValueObject.getArrayValue

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:62 (opens in a new tab)

getNegative()

getNegative(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.getNegative

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:127 (opens in a new tab)

getPattern()

getPattern(): string

Returns

string

Inherited from

BaseValueObject.getPattern

Defined in

packages/engine-formula/src/basics/object-class-type.ts:24 (opens in a new tab)

getReciprocal()

getReciprocal(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.getReciprocal

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:131 (opens in a new tab)

getValue()

getValue(): string

Returns

string

Overrides

BaseValueObject.getValue

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1331 (opens in a new tab)

isArray()

isArray(): boolean

Returns

boolean

Inherited from

BaseValueObject.isArray

Defined in

packages/engine-formula/src/basics/object-class-type.ts:52 (opens in a new tab)

isAsyncArrayObject()

isAsyncArrayObject(): boolean

Returns

boolean

Inherited from

BaseValueObject.isAsyncArrayObject

Defined in

packages/engine-formula/src/basics/object-class-type.ts:44 (opens in a new tab)

isAsyncObject()

isAsyncObject(): boolean

Returns

boolean

Inherited from

BaseValueObject.isAsyncObject

Defined in

packages/engine-formula/src/basics/object-class-type.ts:40 (opens in a new tab)

isBoolean()

isBoolean(): boolean

Returns

boolean

Inherited from

BaseValueObject.isBoolean

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:87 (opens in a new tab)

isCube()

isCube(): boolean

Returns

boolean

Inherited from

BaseValueObject.isCube

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:75 (opens in a new tab)

isEqual()

isEqual(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isEqual

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:185 (opens in a new tab)

isEqualType()

isEqualType(object): boolean

Parameters

Returns

boolean

Inherited from

BaseValueObject.isEqualType

Defined in

packages/engine-formula/src/basics/object-class-type.ts:60 (opens in a new tab)

isError()

isError(): boolean

Returns

boolean

Inherited from

BaseValueObject.isError

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:95 (opens in a new tab)

isGreaterThan()

isGreaterThan(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isGreaterThan

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:205 (opens in a new tab)

isGreaterThanOrEqual()

isGreaterThanOrEqual(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isGreaterThanOrEqual

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:193 (opens in a new tab)

isLambda()

isLambda(): boolean

Returns

boolean

Inherited from

BaseValueObject.isLambda

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:91 (opens in a new tab)

isLessThan()

isLessThan(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isLessThan

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:201 (opens in a new tab)

isLessThanOrEqual()

isLessThanOrEqual(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isLessThanOrEqual

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:197 (opens in a new tab)

isNotEqual()

isNotEqual(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.isNotEqual

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:189 (opens in a new tab)

isNull()

isNull(): boolean

Returns

boolean

Inherited from

BaseValueObject.isNull

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:99 (opens in a new tab)

isNumber()

isNumber(): boolean

Returns

boolean

Inherited from

BaseValueObject.isNumber

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:83 (opens in a new tab)

isReferenceObject()

isReferenceObject(): boolean

Returns

boolean

Inherited from

BaseValueObject.isReferenceObject

Defined in

packages/engine-formula/src/basics/object-class-type.ts:48 (opens in a new tab)

isString()

isString(): boolean

Returns

boolean

Overrides

BaseValueObject.isString

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1335 (opens in a new tab)

isValueObject()

isValueObject(): boolean

Returns

boolean

Inherited from

BaseValueObject.isValueObject

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:40 (opens in a new tab)

log()

log(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.log

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:407 (opens in a new tab)

log10()

log10(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.log10

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:412 (opens in a new tab)

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

packages/engine-formula/src/engine/value-object/base-value-object.ts:165 (opens in a new tab)

mapValue()

mapValue(callbackFn): BaseValueObject

return every value in the array after the callback function

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.mapValue

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:175 (opens in a new tab)

max()

max(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.max

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:107 (opens in a new tab)

mean()

mean(): BaseValueObject

Calculate the mean of the entire array.

reference https://numpy.org/doc/stable/reference/generated/numpy.mean.html#numpy.mean (opens in a new tab)

Returns

BaseValueObject

Inherited from

BaseValueObject.mean

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:371 (opens in a new tab)

median()

median(): BaseValueObject

Calculate the median of the entire array.

reference https://numpy.org/doc/stable/reference/generated/numpy.median.html (opens in a new tab)

Returns

BaseValueObject

Inherited from

BaseValueObject.median

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:382 (opens in a new tab)

min()

min(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.min

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:111 (opens in a new tab)

minus()

minus(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.minus

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1357 (opens in a new tab)

minusBy()

minusBy(value): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.minusBy

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:224 (opens in a new tab)

mod()

mod(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.mod

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:155 (opens in a new tab)

modInverse()

modInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.modInverse

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:239 (opens in a new tab)

multiply()

multiply(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.multiply

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1361 (opens in a new tab)

multiplyBy()

multiplyBy(value): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.multiplyBy

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:229 (opens in a new tab)

plus()

plus(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.plus

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1353 (opens in a new tab)

plusBy()

plusBy(value): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.plusBy

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:219 (opens in a new tab)

pow()

pow(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.pow

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:275 (opens in a new tab)

powInverse()

powInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.powInverse

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:280 (opens in a new tab)

round()

round(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.round

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:427 (opens in a new tab)

roundInverse()

roundInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.roundInverse

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:432 (opens in a new tab)

setArrayValue()

setArrayValue(value): void

Parameters

Returns

void

Inherited from

BaseValueObject.setArrayValue

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:71 (opens in a new tab)

setPattern()

setPattern(pattern): void

Only used in NumberValueObject

Parameters

Returns

void

Inherited from

BaseValueObject.setPattern

Defined in

packages/engine-formula/src/basics/object-class-type.ts:32 (opens in a new tab)

setValue()

setValue(value): void

Parameters

Returns

void

Inherited from

BaseValueObject.setValue

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:67 (opens in a new tab)

sin()

sin(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.sin

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:315 (opens in a new tab)

sinh()

sinh(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.sinh

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:320 (opens in a new tab)

sqrt()

sqrt(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.sqrt

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:285 (opens in a new tab)

std()

std(): BaseValueObject

Calculate the standard deviation of the entire array.

reference https://numpy.org/doc/stable/reference/generated/numpy.std.html (opens in a new tab)

Returns

BaseValueObject

Inherited from

BaseValueObject.std

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:402 (opens in a new tab)

sum()

sum(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.sum

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:103 (opens in a new tab)

tan()

tan(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.tan

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:335 (opens in a new tab)

tanh()

tanh(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.tanh

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:340 (opens in a new tab)

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

packages/engine-formula/src/engine/value-object/base-value-object.ts:44 (opens in a new tab)

var()

var(): BaseValueObject

Calculate the variance of the entire array.

reference https://numpy.org/doc/stable/reference/generated/numpy.var.html (opens in a new tab)

Returns

BaseValueObject

Inherited from

BaseValueObject.var

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:392 (opens in a new tab)

create()

static create(value): StringValueObject

Parameters

Returns

StringValueObject

Defined in

packages/engine-formula/src/engine/value-object/primitive-object.ts:1316 (opens in a new tab)