@univerjssheets-formulaindexinterfacesIdescriptionservice

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

Interface: IDescriptionService

Methods

getDescriptions()

getDescriptions(): Map<IFunctionNames, IFunctionInfo>

get all descriptions

Returns

Map<IFunctionNames, IFunctionInfo>

Defined in

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

getFunctionInfo()

getFunctionInfo(searchText): undefined | IFunctionInfo

get function info by name

Parameters

ParameterType
searchTextstring

Returns

undefined | IFunctionInfo

Defined in

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

getSearchListByName()

getSearchListByName(searchText): ISearchItem[]

get search list by name

Parameters

ParameterType
searchTextstring

Returns

ISearchItem[]

Defined in

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

getSearchListByNameFirstLetter()

getSearchListByNameFirstLetter(searchText): ISearchItem[]

get search list by name, from first letter

Parameters

ParameterType
searchTextstring

Returns

ISearchItem[]

Defined in

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

getSearchListByType()

getSearchListByType(type): ISearchItem[]

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

Parameters

ParameterType
typenumber

Returns

ISearchItem[]

Defined in

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

hasDefinedNameDescription()

hasDefinedNameDescription(name): boolean

check if has defined name description

Parameters

ParameterType
namestring

Returns

boolean

Defined in

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

hasDescription()

hasDescription(name): boolean

check if has description

Parameters

ParameterType
namestring

Returns

boolean

Defined in

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

hasFunction()

hasFunction(searchText): boolean

Parameters

ParameterType
searchTextstring

Returns

boolean

Defined in

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

isFormulaDefinedName()

isFormulaDefinedName(name): boolean

check if is formula defined name

Parameters

ParameterType
namestring

Returns

boolean

Defined in

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

registerDescriptions()

registerDescriptions(functionList): IDisposable

register descriptions

Parameters

ParameterType
functionListIFunctionInfo[]

Returns

IDisposable

Defined in

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

unregisterDescriptions()

unregisterDescriptions(functionNames): void

unregister descriptions

Parameters

ParameterType
functionNamesstring[]

Returns

void

Defined in

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

IremoteregisterfunctionserviceIformulainfo