@univerjs/engine-formula v0.4.2 • Docs

Class: ArrayValueObject

Extends

• BaseValueObject

Constructors

new ArrayValueObject()

new ArrayValueObject(rawValue): ArrayValueObject

Parameters

Returns

ArrayValueObject

Overrides

BaseValueObject.constructor

Defined in

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

Properties

Methods

abs()

abs(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.abs

Defined in

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

acos()

acos(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.acos

Defined in

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

acosh()

acosh(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.acosh

Defined in

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

asin()

asin(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.asin

Defined in

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

asinh()

asinh(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.asinh

Defined in

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

atan()

atan(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.atan

Defined in

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

atan2()

atan2(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.atan2

Defined in

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

atan2Inverse()

atan2Inverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.atan2Inverse

Defined in

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

atanh()

atanh(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.atanh

Defined in

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

binarySearch()

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

Parameters

Returns

undefined | number

Defined in

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

cbrt()

cbrt(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.cbrt

Defined in

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

ceil()

ceil(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.ceil

Defined in

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

ceilInverse()

ceilInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.ceilInverse

Defined in

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

clone()

clone(): ArrayValueObject

Returns

ArrayValueObject

Defined in

packages/engine-formula/src/engine/value-object/array-value-object.ts:182 (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/array-value-object.ts:976 (opens in a new tab)

compareBy()

compareBy(value, operator): BaseValueObject

Parameters

Returns

BaseValueObject

Inherited from

BaseValueObject.compareBy

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:244 (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/array-value-object.ts:984 (opens in a new tab)

concatenateFront()

concatenateFront(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.concatenateFront

Defined in

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

convertToBooleanObjectValue()

convertToBooleanObjectValue(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.convertToBooleanObjectValue

Defined in

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

convertToNumberObjectValue()

convertToNumberObjectValue(): BaseValueObject

Returns

BaseValueObject

Inherited from

BaseValueObject.convertToNumberObjectValue

Defined in

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

cos()

cos(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.cos

Defined in

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

cosh()

cosh(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.cosh

Defined in

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

count()

count(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.count

Defined in

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

countA()

countA(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.countA

Defined in

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

countBlank()

countBlank(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.countBlank

Defined in

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

dispose()

dispose(): void

Returns

void

Overrides

BaseValueObject.dispose

Defined in

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

divided()

divided(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.divided

Defined in

packages/engine-formula/src/engine/value-object/array-value-object.ts:959 (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

Overrides

BaseValueObject.exp

Defined in

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

flatten()

flatten(): ArrayValueObject

Flatten a 2D array. https://numpy.org/doc/stable/reference/generated/numpy.chararray.flatten.html#numpy.chararray.flatten (opens in a new tab)

Returns

ArrayValueObject

Defined in

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

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

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

floor()

floor(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.floor

Defined in

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

floorInverse()

floorInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.floorInverse

Defined in

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

get()

get(row, column): Nullable<BaseValueObject>

Parameters

Returns

Nullable<BaseValueObject>

Defined in

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

getArrayValue()

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

Returns

Nullable<BaseValueObject>[][]

Overrides

BaseValueObject.getArrayValue

Defined in

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

getColumnCount()

getColumnCount(): number

Returns

number

Defined in

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

getCurrentColumn()

getCurrentColumn(): number

Returns

number

Defined in

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

getCurrentRow()

getCurrentRow(): number

Returns

number

Defined in

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

getFirstCell()

getFirstCell(): BaseValueObject

Returns

BaseValueObject

Defined in

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

getFirstTruePosition()

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

Returns

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

Defined in

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

getLastCell()

getLastCell(): BaseValueObject

Returns

BaseValueObject

Defined in

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

getLastTruePosition()

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

Returns

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

Defined in

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

getNegative()

getNegative(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.getNegative

Defined in

packages/engine-formula/src/engine/value-object/array-value-object.ts:934 (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)

getRangePosition()

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

Returns

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

Defined in

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

getRealValue()

getRealValue(row, column): null | BaseValueObject

Parameters

Returns

null | BaseValueObject

Defined in

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

getReciprocal()

getReciprocal(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.getReciprocal

Defined in

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

getRowCount()

getRowCount(): number

Returns

number

Defined in

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

getSheetId()

getSheetId(): string

Returns

string

Defined in

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

getUnitId()

getUnitId(): string

Returns

string

Defined in

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

getValue()

getValue(): string | number | boolean

Returns

string | number | boolean

Inherited from

BaseValueObject.getValue

Defined in

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

getValueOrDefault()

getValueOrDefault(row, column): Nullable<BaseValueObject>

Parameters

Returns

Nullable<BaseValueObject>

Defined in

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

isArray()

isArray(): boolean

Returns

boolean

Overrides

BaseValueObject.isArray

Defined in

packages/engine-formula/src/engine/value-object/array-value-object.ts:242 (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

Inherited from

BaseValueObject.isString

Defined in

packages/engine-formula/src/engine/value-object/base-value-object.ts:79 (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)

iterator()

iterator(callback): void

Parameters

Returns

void

Defined in

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

iteratorReverse()

iteratorReverse(callback): void

Parameters

Returns

void

Defined in

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

log()

log(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.log

Defined in

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

log10()

log10(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.log10

Defined in

packages/engine-formula/src/engine/value-object/array-value-object.ts:1301 (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

Overrides

BaseValueObject.map

Defined in

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

mapValue()

mapValue(callbackFn): BaseValueObject

return every value in the array after the callback function

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.mapValue

Defined in

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

max()

max(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.max

Defined in

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

mean()

mean(ddof): 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)

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.mean

Defined in

packages/engine-formula/src/engine/value-object/array-value-object.ts:1189 (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

Overrides

BaseValueObject.median

Defined in

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

min()

min(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.min

Defined in

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

minus()

minus(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.minus

Defined in

packages/engine-formula/src/engine/value-object/array-value-object.ts:951 (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

Overrides

BaseValueObject.mod

Defined in

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

modInverse()

modInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.modInverse

Defined in

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

multiply()

multiply(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.multiply

Defined in

packages/engine-formula/src/engine/value-object/array-value-object.ts:955 (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)

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

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

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 (opens in a new tab)

Parameters

Returns

ArrayValueObject

Defined in

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

pickRaw()

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

Parameters

Returns

Nullable<BaseValueObject>[][]

Defined in

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

plus()

plus(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.plus

Defined in

packages/engine-formula/src/engine/value-object/array-value-object.ts:947 (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

Overrides

BaseValueObject.pow

Defined in

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

powInverse()

powInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.powInverse

Defined in

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

round()

round(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.round

Defined in

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

roundInverse()

roundInverse(valueObject): BaseValueObject

Parameters

Returns

BaseValueObject

Overrides

BaseValueObject.roundInverse

Defined in

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

set()

set(
   row, 
   column, 
   value): void

Parameters

Returns

void

Defined in

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

setArrayValue()

setArrayValue(value): void

Parameters

Returns

void

Overrides

BaseValueObject.setArrayValue

Defined in

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

setColumnCount()

setColumnCount(columnCount): void

Parameters

Returns

void

Defined in

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

setCurrent()

setCurrent(row, column): void

Parameters

Returns

void

Defined in

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

setDefaultValue()

setDefaultValue(value): void

Parameters

Returns

void

Defined in

packages/engine-formula/src/engine/value-object/array-value-object.ts:246 (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)

setRowCount()

setRowCount(rowCount): void

Parameters

Returns

void

Defined in

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

setSheetId()

setSheetId(sheetId): void

Parameters

Returns

void

Defined in

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

setUnitId()

setUnitId(unitId): void

Parameters

Returns

void

Defined in

packages/engine-formula/src/engine/value-object/array-value-object.ts:209 (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

Overrides

BaseValueObject.sin

Defined in

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

sinh()

sinh(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.sinh

Defined in

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

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 (opens in a new tab)

Parameters

Returns

undefined | ArrayValueObject

Row Param

start:stop:step

Column Param

start:stop:step

Defined in

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

sortByColumn()

sortByColumn(index): void

Parameters

Returns

void

Defined in

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

sortByRow()

sortByRow(index): void

Parameters

Returns

void

Defined in

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

sqrt()

sqrt(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.sqrt

Defined in

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

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

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

sum()

sum(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.sum

Defined in

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

tan()

tan(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.tan

Defined in

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

tanh()

tanh(): BaseValueObject

Returns

BaseValueObject

Overrides

BaseValueObject.tanh

Defined in

packages/engine-formula/src/engine/value-object/array-value-object.ts:1149 (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)

toValue()

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

Returns

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

Defined in

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

transpose()

transpose(): ArrayValueObject

Returns

ArrayValueObject

Defined in

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

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

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

create()

static create(rawValue): ArrayValueObject

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

Parameters

Returns

ArrayValueObject

Defined in

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

createByArray()

static createByArray(array): ArrayValueObject

Create an array value object based on the array data.

Parameters

Returns

ArrayValueObject

Defined in

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