@univerjs/sheets-formula v0.1.17 • Docs

Interface: IDescriptionService

Methods

getDescriptions()

getDescriptions(): Map<IFunctionNames, IFunctionInfo>

get all descriptions

Returns

Map<IFunctionNames, IFunctionInfo>

Defined in

packages/sheets-formula/src/services/description.service.ts:55 (opens in a new tab)

getFunctionInfo()

getFunctionInfo(searchText): undefined | IFunctionInfo

get function info by name

Parameters

Returns

undefined | IFunctionInfo

Defined in

packages/sheets-formula/src/services/description.service.ts:63 (opens in a new tab)

getSearchListByName()

getSearchListByName(searchText): ISearchItem[]

get search list by name

Parameters

Returns

ISearchItem[]

Defined in

packages/sheets-formula/src/services/description.service.ts:70 (opens in a new tab)

getSearchListByNameFirstLetter()

getSearchListByNameFirstLetter(searchText): ISearchItem[]

get search list by name, from first letter

Parameters

Returns

ISearchItem[]

Defined in

packages/sheets-formula/src/services/description.service.ts:77 (opens in a new tab)

getSearchListByType()

getSearchListByType(type): ISearchItem[]

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

Parameters

Returns

ISearchItem[]

Defined in

packages/sheets-formula/src/services/description.service.ts:84 (opens in a new tab)

hasDefinedNameDescription()

hasDefinedNameDescription(name): boolean

check if has defined name description

Parameters

Returns

boolean

Defined in

packages/sheets-formula/src/services/description.service.ts:108 (opens in a new tab)

hasDescription()

hasDescription(name): boolean

check if has description

Parameters

Returns

boolean

Defined in

packages/sheets-formula/src/services/description.service.ts:102 (opens in a new tab)

hasFunction()

hasFunction(searchText): boolean

Parameters

Returns

boolean

Defined in

packages/sheets-formula/src/services/description.service.ts:57 (opens in a new tab)

isFormulaDefinedName()

isFormulaDefinedName(name): boolean

check if is formula defined name

Parameters

Returns

boolean

Defined in

packages/sheets-formula/src/services/description.service.ts:114 (opens in a new tab)

registerDescriptions()

registerDescriptions(functionList): IDisposable

register descriptions

Parameters

Returns

IDisposable

Defined in

packages/sheets-formula/src/services/description.service.ts:90 (opens in a new tab)

unregisterDescriptions()

unregisterDescriptions(functionNames): void

unregister descriptions

Parameters

Returns

void

Defined in

packages/sheets-formula/src/services/description.service.ts:96 (opens in a new tab)