@univerjs/sheets-formula v0.5.4

Interface: IDescriptionService

Defined in: submodules/univer/packages/sheets-formula/src/services/description.service.ts:52

Methods

getDescriptions()

getDescriptions(): Map<IFunctionNames, IFunctionInfo>

Defined in: submodules/univer/packages/sheets-formula/src/services/description.service.ts:56

get all descriptions

Returns

Map<IFunctionNames, IFunctionInfo>

getFunctionInfo()

getFunctionInfo(searchText): 
  | undefined
  | IFunctionInfo

Defined in: submodules/univer/packages/sheets-formula/src/services/description.service.ts:64

get function info by name

Parameters

Returns

| undefined | IFunctionInfo

getSearchListByName()

getSearchListByName(searchText): ISearchItem[]

Defined in: submodules/univer/packages/sheets-formula/src/services/description.service.ts:71

get search list by name

Parameters

Returns

ISearchItem[]

getSearchListByNameFirstLetter()

getSearchListByNameFirstLetter(searchText): ISearchItem[]

Defined in: submodules/univer/packages/sheets-formula/src/services/description.service.ts:78

get search list by name, from first letter

Parameters

Returns

ISearchItem[]

getSearchListByType()

getSearchListByType(type): ISearchItem[]

Defined in: submodules/univer/packages/sheets-formula/src/services/description.service.ts:85

get search list by type, if type is -1, return all

Parameters

Returns

ISearchItem[]

hasDefinedNameDescription()

hasDefinedNameDescription(name): boolean

Defined in: submodules/univer/packages/sheets-formula/src/services/description.service.ts:109

check if has defined name description

Parameters

Returns

boolean

hasDescription()

hasDescription(name): boolean

Defined in: submodules/univer/packages/sheets-formula/src/services/description.service.ts:103

check if has description

Parameters

Returns

boolean

hasFunction()

hasFunction(searchText): boolean

Defined in: submodules/univer/packages/sheets-formula/src/services/description.service.ts:58

Parameters

Returns

boolean

isFormulaDefinedName()

isFormulaDefinedName(name): boolean

Defined in: submodules/univer/packages/sheets-formula/src/services/description.service.ts:115

check if is formula defined name

Parameters

Returns

boolean

registerDescriptions()

registerDescriptions(functionList): IDisposable

Defined in: submodules/univer/packages/sheets-formula/src/services/description.service.ts:91

register descriptions

Parameters

Returns

IDisposable

unregisterDescriptions()

unregisterDescriptions(functionNames): void

Defined in: submodules/univer/packages/sheets-formula/src/services/description.service.ts:97

unregister descriptions

Parameters

Returns

void