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

Class: CustomFunction

Extends

BaseFunction

Constructors

new CustomFunction()

new CustomFunction(_name): CustomFunction

Parameters

Parameter	Type
`_name`	`IFunctionNames`

Returns

CustomFunction

Inherited from

BaseFunction.constructor

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:91

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
`_columnCount`	`protected`	`number`	`-1`	-	`BaseFunction`.`_columnCount`	submodules/univer/packages/engine-formula/src/functions/base-function.ts:49
`_formulaDataModel`	`protected`	`Nullable`<`FormulaDataModel`>	`undefined`	-	`BaseFunction`.`_formulaDataModel`	submodules/univer/packages/engine-formula/src/functions/base-function.ts:47
`_rowCount`	`protected`	`number`	`-1`	-	`BaseFunction`.`_rowCount`	submodules/univer/packages/engine-formula/src/functions/base-function.ts:48
`maxParams`	`public`	`number`	`-1`	Maximum number of parameters	`BaseFunction`.`maxParams`	submodules/univer/packages/engine-formula/src/functions/base-function.ts:89
`minParams`	`public`	`number`	`-1`	Minimum number of parameters	`BaseFunction`.`minParams`	submodules/univer/packages/engine-formula/src/functions/base-function.ts:84
`needsExpandParams`	`public`	`boolean`	`false`	Whether the function needs to expand the parameters	`BaseFunction`.`needsExpandParams`	submodules/univer/packages/engine-formula/src/functions/base-function.ts:54
`needsFormulaDataModel`	`public`	`boolean`	`false`	Whether the function needs function methods in FormulaDataModel	`BaseFunction`.`needsFormulaDataModel`	submodules/univer/packages/engine-formula/src/functions/base-function.ts:74
`needsLocale`	`public`	`boolean`	`false`	Whether the function needs handle locale	`BaseFunction`.`needsLocale`	submodules/univer/packages/engine-formula/src/functions/base-function.ts:64
`needsReferenceObject`	`public`	`boolean`	`false`	Whether the function needs to pass in reference object	`BaseFunction`.`needsReferenceObject`	submodules/univer/packages/engine-formula/src/functions/base-function.ts:59
`needsSheetRowColumnCount`	`public`	`boolean`	`false`	Whether the function needs the number of rows and columns in the sheet	`BaseFunction`.`needsSheetRowColumnCount`	submodules/univer/packages/engine-formula/src/functions/base-function.ts:79
`needsSheetsInfo`	`public`	`boolean`	`false`	Whether the function needs sheets info	`BaseFunction`.`needsSheetsInfo`	submodules/univer/packages/engine-formula/src/functions/base-function.ts:69

Accessors

column

Get Signature

get column(): number

Returns

number

Inherited from

BaseFunction.column

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:111

name

Get Signature

get name(): IFunctionNames

Returns

IFunctionNames

Inherited from

BaseFunction.name

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:95

row

Get Signature

get row(): number

Returns

number

Inherited from

BaseFunction.row

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:107

subUnitId

Get Signature

get subUnitId(): Nullable<string>

Returns

Nullable<string>

Inherited from

BaseFunction.subUnitId

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:103

unitId

Get Signature

get unitId(): Nullable<string>

Returns

Nullable<string>

Inherited from

BaseFunction.unitId

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:99

Methods

binarySearch()

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

Parameters

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

Returns

BaseValueObject

Inherited from

BaseFunction.binarySearch

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:315

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

Inherited from

BaseFunction.binarySearchExpand

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:402

calculate()

calculate(...arg): NodeValueType

Parameters

Parameter	Type
…`arg`	`BaseValueObject`[]

Returns

NodeValueType

Inherited from

BaseFunction.calculate

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:199

calculateCustom()

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

Parameters

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

Returns

PrimitiveValueType | PrimitiveValueType[][]

Inherited from

BaseFunction.calculateCustom

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:193

checkArrayType()

checkArrayType(variant): boolean

Parameters

Parameter	Type
`variant`	`FunctionVariantType`

Returns

boolean

Inherited from

BaseFunction.checkArrayType

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:203

createReferenceObject()

createReferenceObject(reference, range): ErrorValueObject | BaseReferenceObject

Parameters

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

Returns

ErrorValueObject | BaseReferenceObject

Inherited from

BaseFunction.createReferenceObject

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:561

dispose()

dispose(): void

Returns

void

Inherited from

BaseFunction.dispose

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:115

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

Inherited from

BaseFunction.equalSearch

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:360

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

Inherited from

BaseFunction.equalSearchExpand

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:422

flattenArray()

flattenArray(variants, ignoreLogicalValuesAndText): BaseValueObject | ArrayValueObject

Parameters

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

Returns

BaseValueObject | ArrayValueObject

Inherited from

BaseFunction.flattenArray

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:496

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

Inherited from

BaseFunction.fuzzySearch

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:370

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

Inherited from

BaseFunction.fuzzySearchExpand

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:449

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

Inherited from

BaseFunction.getDefinedName

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:125

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

Parameters

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

Returns

number | ErrorValueObject

Inherited from

BaseFunction.getIndexNumValue

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:213

getLocale()

getLocale(): LocaleType

Returns

LocaleType

Inherited from

BaseFunction.getLocale

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:139

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

Inherited from

BaseFunction.getMatchTypeValue

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:287

getSheetsInfo()

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

Returns

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

Name	Type	Defined in
`sheetNameMap`	{}	submodules/univer/packages/engine-formula/src/functions/base-function.ts:150
`sheetOrder`	`string`[]	submodules/univer/packages/engine-formula/src/functions/base-function.ts:149

Inherited from

BaseFunction.getSheetsInfo

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:147

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 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

Parameters

Parameter	Type
`logicValueObject`?	`BaseValueObject`

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

Inherited from

BaseFunction.orderSearch

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:380

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

Inherited from

BaseFunction.orderSearchExpand

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:476

setDefinedNames()

setDefinedNames(definedNames): void

Parameters

Parameter	Type
`definedNames`	`IDefinedNameMapItem`

Returns

void

Inherited from

BaseFunction.setDefinedNames

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:135

setFormulaDataModel()

setFormulaDataModel(_formulaDataModel): void

Parameters

Parameter	Type
`_formulaDataModel`	`FormulaDataModel`

Returns

void

Inherited from

BaseFunction.setFormulaDataModel

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:165

setLocale()

setLocale(locale): void

Parameters

Parameter	Type
`locale`	`LocaleType`

Returns

void

Inherited from

BaseFunction.setLocale

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:143

setRefInfo()

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

Parameters

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

Returns

void

Inherited from

BaseFunction.setRefInfo

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:186

setSheetRowColumnCount()

setSheetRowColumnCount(rowCount, columnCount): void

Parameters

Parameter	Type
`rowCount`	`number`
`columnCount`	`number`

Returns

void

Inherited from

BaseFunction.setSheetRowColumnCount

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:169

setSheetsInfo()

setSheetsInfo(__namedParameters): void

Parameters

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

Returns

void

Inherited from

BaseFunction.setSheetsInfo

Defined in

submodules/univer/packages/engine-formula/src/functions/base-function.ts:154

Calculateformulaservice Definednamesservice