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

Class: ArrayValueObject

Extends

• BaseValueObject

Constructors

new ArrayValueObject()

new ArrayValueObject(rawValue): ArrayValueObject

Parameters

Returns

ArrayValueObject

Overrides

BaseValueObject.constructor

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:164

Properties

Methods

abs()

abs(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.abs

Defined in

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

acos()

acos(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.acos

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1090

acosh()

acosh(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.acosh

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1099

asin()

asin(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.asin

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1126

asinh()

asinh(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.asinh

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1135

atan()

atan(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.atan

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1162

atan2()

atan2(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.atan2

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1180

atan2Inverse()

atan2Inverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.atan2Inverse

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1184

atanh()

atanh(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.atanh

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1171

binarySearch()

binarySearch(
   valueObject, 
   searchType, 
   matchType): undefined | number

Parameters

Returns

undefined | number

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:710

cbrt()

cbrt(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.cbrt

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1063

ceil()

ceil(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.ceil

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1358

ceilInverse()

ceilInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.ceilInverse

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1362

clone()

clone(): ArrayValueObject

Returns

ArrayValueObject

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:186

compare()

compare(
   valueObject, 
   operator, 
   isCaseSensitive?): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.compare

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:980

compareBy()

compareBy(value, operator): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.compareBy

Defined in

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

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/array-value-object.ts:988

concatenateFront()

concatenateFront(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.concatenateFront

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:984

convertToBooleanObjectValue()

convertToBooleanObjectValue(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.convertToBooleanObjectValue

Defined in

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

convertToNumberObjectValue()

convertToNumberObjectValue(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.convertToNumberObjectValue

Defined in

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

cos()

cos(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.cos

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1072

cosh()

cosh(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.cosh

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1081

count()

count(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.count

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:901

countA()

countA(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.countA

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:914

countBlank()

countBlank(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.countBlank

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:927

dispose()

dispose(): void

Returns

void

Overrides

BaseValueObject.dispose

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:170

divided()

divided(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.divided

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:963

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

Overrides

BaseValueObject.exp

Defined in

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

flatten()

flatten(): ArrayValueObject

Flatten a 2D array. https://numpy.org/doc/stable/reference/generated/numpy.chararray.flatten.html#numpy.chararray.flatten

Returns

ArrayValueObject

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:431

flattenPosition()

flattenPosition(): {
  numberArray: BaseValueObject[];
  numberPosition: number[];
  stringArray: BaseValueObject[];
  stringPosition: number[];
}

Flatten a 2D array. In Excel, errors and blank cells are ignored, which results in a binary search that cannot strictly adhere to the number of cells.

Returns

{
  numberArray: BaseValueObject[];
  numberPosition: number[];
  stringArray: BaseValueObject[];
  stringPosition: number[];
}

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:459

floor()

floor(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.floor

Defined in

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

floorInverse()

floorInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.floorInverse

Defined in

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

get()

get(row, column): Nullable<BaseValueObject>

Parameters

Returns

Nullable<BaseValueObject>

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:254

getArrayValue()

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

Returns

Nullable<BaseValueObject>[][]

Overrides

BaseValueObject.getArrayValue

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:237

getColumnCount()

getColumnCount(): number

Returns

number

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:200

getCurrentColumn()

getCurrentColumn(): number

Returns

number

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:233

getCurrentRow()

getCurrentRow(): number

Returns

number

Defined in

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

getFirstCell()

getFirstCell(): BaseValueObject

Returns

BaseValueObject

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:374

getFirstTruePosition()

getFirstTruePosition(): Nullable<{
  column: number;
  row: number;
}>

Returns

Nullable<{ column: number; row: number; }>

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:357

getLastCell()

getLastCell(): BaseValueObject

Returns

BaseValueObject

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:379

getLastTruePosition()

getLastTruePosition(): Nullable<{
  column: number;
  row: number;
}>

Returns

Nullable<{ column: number; row: number; }>

Defined in

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

getNegative()

getNegative(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.getNegative

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:938

getPattern()

getPattern(): string

Returns

string

Inherited from

BaseValueObject.getPattern

Defined in

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

getRangePosition()

getRangePosition(): {
  endColumn: number;
  endRow: number;
  startColumn: number;
  startRow: number;
}

Returns

{
  endColumn: number;
  endRow: number;
  startColumn: number;
  startRow: number;
}

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:294

getRealValue()

getRealValue(row, column): null | BaseValueObject

Parameters

Returns

null | BaseValueObject

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:267

getReciprocal()

getReciprocal(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.getReciprocal

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:943

getRowCount()

getRowCount(): number

Returns

number

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:192

getSheetId()

getSheetId(): string

Returns

string

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:225

getUnitId()

getUnitId(): string

Returns

string

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:217

getValue()

getValue(): string | number | boolean

Returns

string | number | boolean

Inherited from

BaseValueObject.getValue

Defined in

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

getValueOrDefault()

getValueOrDefault(row, column): Nullable<BaseValueObject>

Parameters

Returns

Nullable<BaseValueObject>

Defined in

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

isArray()

isArray(): boolean

Returns

boolean

Overrides

BaseValueObject.isArray

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:246

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

Inherited from

BaseValueObject.isString

Defined in

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

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

iterator()

iterator(callback): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:308

iteratorReverse()

iteratorReverse(callback): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:324

log()

log(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.log

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1296

log10()

log10(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.log10

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1305

map()

map(callbackFn): BaseValueObject

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

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.map

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:992

mapValue()

mapValue(callbackFn): BaseValueObject

return every value in the array after the callback function

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.mapValue

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1007

max()

max(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.max

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:846

mean()

mean(ddof): BaseValueObject

Calculate the mean of the entire array.

reference https://numpy.org/doc/stable/reference/generated/numpy.mean.html#numpy.mean

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.mean

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1193

median()

median(): BaseValueObject

Calculate the median of the entire array.

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

Returns

BaseValueObject

Overrides

BaseValueObject.median

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1202

min()

min(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.min

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:873

minus()

minus(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.minus

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:955

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

Overrides

BaseValueObject.mod

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:967

modInverse()

modInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.modInverse

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:971

multiply()

multiply(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.multiply

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:959

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

orderSearch()

orderSearch(
   valueObject, 
   searchType, 
   isDesc, 
   isFuzzyMatching): null | void | {
  column: number;
  row: number;
}

Due to the inability to effectively utilize the cache, the sequential matching approach is only used for special matches in XLOOKUP and XMATCH. For example, when match_mode is set to 1 and -1 for an exact match. If not found, it returns the next smaller item.

Parameters

Returns

null | void | { column: number; row: number; }

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:630

pick()

pick(takeArray): ArrayValueObject

Referring to matrix calculations, extract the matching values from a true/false matrix based on parameters and store them in a two-dimensional array. implement x[x<10] https://numpy.org/doc/stable/user/basics.indexing.html

Parameters

Returns

ArrayValueObject

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:391

pickRaw()

pickRaw(takeArray): Nullable<BaseValueObject>[][]

Parameters

Returns

Nullable<BaseValueObject>[][]

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:397

plus()

plus(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.plus

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:951

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

Overrides

BaseValueObject.pow

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1036

powInverse()

powInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.powInverse

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1045

round()

round(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.round

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1332

roundInverse()

roundInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.roundInverse

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1336

set()

set(
   row, 
   column, 
   value): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:284

setArrayValue()

setArrayValue(value): void

Parameters

Returns

void

Overrides

BaseValueObject.setArrayValue

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:241

setColumnCount()

setColumnCount(columnCount): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:204

setCurrent()

setCurrent(row, column): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:208

setDefaultValue()

setDefaultValue(value): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:250

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

setRowCount()

setRowCount(rowCount): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:196

setSheetId()

setSheetId(sheetId): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:221

setUnitId()

setUnitId(unitId): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:213

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

Overrides

BaseValueObject.sin

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1108

sinh()

sinh(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.sinh

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1117

slice()

slice(rowParam, columnParam): undefined | ArrayValueObject

I’m looking to perform slicing operations on 2D arrays, similar to the functionality provided by NumPy. https://numpy.org/doc/stable/user/basics.indexing.html

Parameters

Returns

undefined | ArrayValueObject

Row Param

start:stop:step

Column Param

start:stop:step

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:510

sortByColumn()

sortByColumn(index): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:607

sortByRow()

sortByRow(index): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:596

sqrt()

sqrt(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.sqrt

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1054

std()

std(ddof): BaseValueObject

STDEV.P (STDEVP): ddof=0, ignore strings and booleans STDEV.S (STDEV): ddof=1, ignore strings and booleans

STDEVPA: ddof=0, STDEVA: ddof=1,

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.std

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1286

sum()

sum(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.sum

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:826

tan()

tan(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.tan

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1144

tanh()

tanh(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.tanh

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1153

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

toValue()

toValue(): (null | string | number | boolean)[][]

Returns

(null | string | number | boolean)[][]

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1371

transpose()

transpose(): ArrayValueObject

Returns

ArrayValueObject

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:612

var()

var(ddof): BaseValueObject

┌──────────────┬────────────────────────────────┬───────────────────┐ │ Function │ Ignore logical values and text │ Type │ ├──────────────┼────────────────────────────────┼───────────────────┤ │ VAR.S (VAR) │ TRUE │ sample │ │ VAR.P (VARP) │ TRUE │ entire population │ │ VARA │ FALSE │ sample │ │ VARPA │ FALSE │ entire population │ └──────────────┴────────────────────────────────┴───────────────────┘

for VARPA and VARA, strings and FALSE are counted as 0, TRUE is counted as 1 for VAR.S/VAR, or VAR.P/VARP, strings,TRUE and FALSE are ignored Since sum ignores strings and booleans, they are ignored here too, and VAR.S and VAR.P are used more

VAR.S assumes that its arguments are a sample of the population, like numpy.var(data, ddof=1) VAR.P assumes that its arguments are the entire population, like numpy.var(data, ddof=0) numpy.var uses ddof=0 (Delta Degrees of Freedom) by default, so we use ddof=0 here

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.var

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:1244

create()

static create(rawValue): ArrayValueObject

Create an array value object based on the string or IArrayValueObject data.

Parameters

Returns

ArrayValueObject

Defined in

submodules/univer/packages/engine-formula/src/engine/value-object/array-value-object.ts:110

createByArray()

static createByArray(array): ArrayValueObject

Create an array value object based on the array data.

Parameters

Returns

ArrayValueObject

Defined in

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