@univerjs/engine-formula v0.4.2 • Docs

Class: BaseFunction

Extended by

CustomFunction

Constructors

new BaseFunction()

new BaseFunction(_name): BaseFunction

Parameters

Parameter	Type
`_name`	`IFunctionNames`

Returns

BaseFunction

Defined in

packages/engine-formula/src/functions/base-function.ts:79 (opens in a new tab)

Properties

Property	Type	Default value	Description	Defined in
`maxParams`	`number`	`-1`	Maximum number of parameters	packages/engine-formula/src/functions/base-function.ts:77 (opens in a new tab)
`minParams`	`number`	`-1`	Minimum number of parameters	packages/engine-formula/src/functions/base-function.ts:72 (opens in a new tab)
`needsExpandParams`	`boolean`	`false`	Whether the function needs to expand the parameters	packages/engine-formula/src/functions/base-function.ts:52 (opens in a new tab)
`needsLocale`	`boolean`	`false`	Whether the function needs handle locale	packages/engine-formula/src/functions/base-function.ts:62 (opens in a new tab)
`needsReferenceObject`	`boolean`	`false`	Whether the function needs to pass in reference object	packages/engine-formula/src/functions/base-function.ts:57 (opens in a new tab)
`needsSheetsInfo`	`boolean`	`false`	Whether the function needs sheets info	packages/engine-formula/src/functions/base-function.ts:67 (opens in a new tab)

Accessors

column

get column(): number

Returns

number

Defined in

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

name

get name(): IFunctionNames

Returns

IFunctionNames

Defined in

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

row

get row(): number

Returns

number

Defined in

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

subUnitId

get subUnitId(): Nullable<string>

Returns

Nullable<string>

Defined in

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

unitId

get unitId(): Nullable<string>

Returns

Nullable<string>

Defined in

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

Methods

binarySearch()

binarySearch(
   value, 
   searchArray, 
   resultArray, 
   searchType?, 
   matchType?): BaseValueObject

Parameters

Parameter	Type
`value`	`BaseValueObject`
`searchArray`	`ArrayValueObject`
`resultArray`	`ArrayValueObject`
`searchType`?	`ArrayBinarySearchType`
`matchType`?	`ArrayOrderSearchType`

Returns

BaseValueObject

Defined in

packages/engine-formula/src/functions/base-function.ts:294 (opens in a new tab)

binarySearchExpand()

binarySearchExpand(
   value, 
   searchArray, 
   resultArray, 
   axis, 
   searchType?, 
   matchType?): undefined | ErrorValueObject | ArrayValueObject

Parameters

Parameter	Type	Default value
`value`	`BaseValueObject`	`undefined`
`searchArray`	`ArrayValueObject`	`undefined`
`resultArray`	`ArrayValueObject`	`undefined`
`axis`	`number`	`0`
`searchType`?	`ArrayBinarySearchType`	`undefined`
`matchType`?	`ArrayOrderSearchType`	`undefined`

Returns

undefined | ErrorValueObject | ArrayValueObject

Defined in

packages/engine-formula/src/functions/base-function.ts:380 (opens in a new tab)

calculate()

calculate(...arg): NodeValueType

Parameters

Parameter	Type
...`arg`	`BaseValueObject`[]

Returns

NodeValueType

Defined in

packages/engine-formula/src/functions/base-function.ts:178 (opens in a new tab)

calculateCustom()

calculateCustom(...arg): PrimitiveValueType | PrimitiveValueType[][]

Parameters

Parameter	Type
...`arg`	(`PrimitiveValueType` \| `PrimitiveValueType`[][])[]

Returns

PrimitiveValueType | PrimitiveValueType[][]

Defined in

packages/engine-formula/src/functions/base-function.ts:172 (opens in a new tab)

checkArrayType()

checkArrayType(variant): boolean

Parameters

Parameter	Type
`variant`	`FunctionVariantType`

Returns

boolean

Defined in

packages/engine-formula/src/functions/base-function.ts:182 (opens in a new tab)

createReferenceObject()

createReferenceObject(reference, range): ErrorValueObject | BaseReferenceObject

Parameters

Parameter	Type
`reference`	`BaseReferenceObject`
`range`	`IRange`

Returns

ErrorValueObject | BaseReferenceObject

Defined in

packages/engine-formula/src/functions/base-function.ts:539 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Defined in

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

equalSearch()

equalSearch(
   value, 
   searchArray, 
   resultArray, 
   isFirst): BaseValueObject

Parameters

Parameter	Type	Default value
`value`	`BaseValueObject`	`undefined`
`searchArray`	`ArrayValueObject`	`undefined`
`resultArray`	`ArrayValueObject`	`undefined`
`isFirst`	`boolean`	`true`

Returns

BaseValueObject

Defined in

packages/engine-formula/src/functions/base-function.ts:338 (opens in a new tab)

equalSearchExpand()

equalSearchExpand(
   value, 
   searchArray, 
   resultArray, 
   isFirst, 
   axis): undefined | ErrorValueObject | ArrayValueObject

Parameters

Parameter	Type	Default value
`value`	`BaseValueObject`	`undefined`
`searchArray`	`ArrayValueObject`	`undefined`
`resultArray`	`ArrayValueObject`	`undefined`
`isFirst`	`boolean`	`true`
`axis`	`number`	`0`

Returns

undefined | ErrorValueObject | ArrayValueObject

Defined in

packages/engine-formula/src/functions/base-function.ts:400 (opens in a new tab)

flattenArray()

flattenArray(variants, ignoreLogicalValuesAndText): BaseValueObject | ArrayValueObject

Parameters

Parameter	Type	Default value
`variants`	`BaseValueObject`[]	`undefined`
`ignoreLogicalValuesAndText`	`boolean`	`true`

Returns

BaseValueObject | ArrayValueObject

Defined in

packages/engine-formula/src/functions/base-function.ts:474 (opens in a new tab)

fuzzySearch()

fuzzySearch(
   value, 
   searchArray, 
   resultArray, 
   isFirst): BaseValueObject

Parameters

Parameter	Type	Default value
`value`	`BaseValueObject`	`undefined`
`searchArray`	`ArrayValueObject`	`undefined`
`resultArray`	`ArrayValueObject`	`undefined`
`isFirst`	`boolean`	`true`

Returns

BaseValueObject

Defined in

packages/engine-formula/src/functions/base-function.ts:348 (opens in a new tab)

fuzzySearchExpand()

fuzzySearchExpand(
   value, 
   searchArray, 
   resultArray, 
   isFirst, 
   axis): undefined | ErrorValueObject | ArrayValueObject

Parameters

Parameter	Type	Default value
`value`	`BaseValueObject`	`undefined`
`searchArray`	`ArrayValueObject`	`undefined`
`resultArray`	`ArrayValueObject`	`undefined`
`isFirst`	`boolean`	`true`
`axis`	`number`	`0`

Returns

undefined | ErrorValueObject | ArrayValueObject

Defined in

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

getDefinedName()

getDefinedName(name): null | IDefinedNamesServiceParam

In Excel, to inject a defined name into a function that has positioning capabilities, such as using the INDIRECT function to reference a named range, you can write it as follows: =INDIRECT("DefinedName1")

Parameters

Parameter	Type
`name`	`string`

Returns

null | IDefinedNamesServiceParam

Defined in

packages/engine-formula/src/functions/base-function.ts:113 (opens in a new tab)

getIndexNumValue()

getIndexNumValue(indexNum, defaultValue): number | ErrorValueObject

Starting with 1 For instance, The column number (starting with 1 for the left-most column of table_array) that contains the return value. https://support.microsoft.com/en-us/office/vlookup-function-0bbc8083-26fe-4963-8ab8-93a18ad188a1 (opens in a new tab)

Parameters

Parameter	Type	Default value
`indexNum`	`BaseValueObject`	`undefined`
`defaultValue`	`number`	`1`

Returns

number | ErrorValueObject

Defined in

packages/engine-formula/src/functions/base-function.ts:192 (opens in a new tab)

getLocale()

getLocale(): LocaleType

Returns

LocaleType

Defined in

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

getMatchTypeValue()

getMatchTypeValue(logicValueObject?): undefined | number

A logical value that specifies 1/TRUE , 0/FALSE, -1, default 1. The difference from getZeroOrOneByOneDefault is that we need to get -1

Parameters

Parameter	Type
`logicValueObject`?	`BaseValueObject`

Returns

undefined | number

Defined in

packages/engine-formula/src/functions/base-function.ts:266 (opens in a new tab)

getSheetsInfo()

getSheetsInfo(): {
  sheetNameMap: {};
  sheetOrder: string[];
}

Returns

{
  sheetNameMap: {};
  sheetOrder: string[];
}

Name	Type	Defined in
`sheetNameMap`	{}	packages/engine-formula/src/functions/base-function.ts:138 (opens in a new tab)
`sheetOrder`	`string`[]	packages/engine-formula/src/functions/base-function.ts:137 (opens in a new tab)

Defined in

packages/engine-formula/src/functions/base-function.ts:135 (opens in a new tab)

getZeroOrOneByOneDefault()

getZeroOrOneByOneDefault(logicValueObject?): undefined | number

A logical value that specifies 1/TRUE , 0/FALSE, default 1 For instance range_lookup, A logical value that specifies whether you want VLOOKUP to find an approximate or an exact match Approximate match - 1/TRUE Exact match - 0/FALSE https://support.microsoft.com/en-us/office/vlookup-function-0bbc8083-26fe-4963-8ab8-93a18ad188a1 (opens in a new tab) For instance A1, A logical value that specifies what type of reference is contained in the cell ref_text. If a1 is TRUE or omitted, ref_text is interpreted as an A1-style reference. If a1 is FALSE, ref_text is interpreted as an R1C1-style reference. https://support.microsoft.com/zh-cn/office/indirect-%E5%87%BD%E6%95%B0-474b3a3a-8a26-4f44-b491-92b6306fa261 (opens in a new tab)

Parameters

Parameter	Type
`logicValueObject`?	`BaseValueObject`

Returns

undefined | number

Defined in

packages/engine-formula/src/functions/base-function.ts:233 (opens in a new tab)

isAddress()

isAddress(): boolean

Returns

boolean

Defined in

packages/engine-formula/src/functions/base-function.ts:157 (opens in a new tab)

isAsync()

isAsync(): boolean

Returns

boolean

Defined in

packages/engine-formula/src/functions/base-function.ts:153 (opens in a new tab)

isCustom()

isCustom(): boolean

Returns

boolean

Defined in

packages/engine-formula/src/functions/base-function.ts:161 (opens in a new tab)

orderSearch()

orderSearch(
   value, 
   searchArray, 
   resultArray, 
   searchType, 
   isDesc): BaseValueObject

Parameters

Parameter	Type	Default value
`value`	`BaseValueObject`	`undefined`
`searchArray`	`ArrayValueObject`	`undefined`
`resultArray`	`ArrayValueObject`	`undefined`
`searchType`	`ArrayOrderSearchType`	`ArrayOrderSearchType.MIN`
`isDesc`	`boolean`	`false`

Returns

BaseValueObject

Defined in

packages/engine-formula/src/functions/base-function.ts:358 (opens in a new tab)

orderSearchExpand()

orderSearchExpand(
   value, 
   searchArray, 
   resultArray, 
   searchType, 
   isDesc, 
   axis): undefined | ErrorValueObject | ArrayValueObject

Parameters

Parameter	Type	Default value
`value`	`BaseValueObject`	`undefined`
`searchArray`	`ArrayValueObject`	`undefined`
`resultArray`	`ArrayValueObject`	`undefined`
`searchType`	`ArrayOrderSearchType`	`ArrayOrderSearchType.MIN`
`isDesc`	`boolean`	`false`
`axis`	`number`	`0`

Returns

undefined | ErrorValueObject | ArrayValueObject

Defined in

packages/engine-formula/src/functions/base-function.ts:454 (opens in a new tab)

setDefinedNames()

setDefinedNames(definedNames): void

Parameters

Parameter	Type
`definedNames`	`IDefinedNameMapItem`

Returns

void

Defined in

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

setLocale()

setLocale(locale): void

Parameters

Parameter	Type
`locale`	`LocaleType`

Returns

void

Defined in

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

setRefInfo()

setRefInfo(
   unitId, 
   subUnitId, 
   row, 
   column): void

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`row`	`number`
`column`	`number`

Returns

void

Defined in

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

setSheetsInfo()

setSheetsInfo(__namedParameters): void

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.sheetNameMap`	`object`
`__namedParameters.sheetOrder`	`string`[]

Returns

void

Defined in

packages/engine-formula/src/functions/base-function.ts:142 (opens in a new tab)

Asyncobject Basereferenceobject