@univerjs/sheets-formula v0.4.2 • Docs

Class: DescriptionService

Implements

• IDescriptionService
• IDisposable

Constructors

new DescriptionService()

new DescriptionService(
   _functionService, 
   _localeService, 
   _configService): DescriptionService

Parameters

Returns

DescriptionService

Defined in

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

Methods

dispose()

dispose(): void

Returns

void

Implementation of

IDisposable.dispose

Defined in

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

getDescriptions()

getDescriptions(): Map<IFunctionNames, IFunctionInfo>

get all descriptions

Returns

Map<IFunctionNames, IFunctionInfo>

Implementation of

IDescriptionService.getDescriptions

Defined in

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

getFunctionInfo()

getFunctionInfo(searchText): undefined | IFunctionInfo

get function info by name

Parameters

Returns

undefined | IFunctionInfo

Implementation of

IDescriptionService.getFunctionInfo

Defined in

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

getSearchListByName()

getSearchListByName(searchText): ISearchItem[]

get search list by name

Parameters

Returns

ISearchItem[]

Implementation of

IDescriptionService.getSearchListByName

Defined in

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

getSearchListByNameFirstLetter()

getSearchListByNameFirstLetter(searchText): ISearchItem[]

get search list by name, from first letter

Parameters

Returns

ISearchItem[]

Implementation of

IDescriptionService.getSearchListByNameFirstLetter

Defined in

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

getSearchListByType()

getSearchListByType(type): ISearchItem[]

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

Parameters

Returns

ISearchItem[]

Implementation of

IDescriptionService.getSearchListByType

Defined in

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

hasDefinedNameDescription()

hasDefinedNameDescription(name): boolean

check if has defined name description

Parameters

Returns

boolean

Implementation of

IDescriptionService.hasDefinedNameDescription

Defined in

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

hasDescription()

hasDescription(name): boolean

check if has description

Parameters

Returns

boolean

Implementation of

IDescriptionService.hasDescription

Defined in

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

hasFunction()

hasFunction(searchText): boolean

Parameters

Returns

boolean

Implementation of

IDescriptionService.hasFunction

Defined in

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

isFormulaDefinedName()

isFormulaDefinedName(name): boolean

check if is formula defined name

Parameters

Returns

boolean

Implementation of

IDescriptionService.isFormulaDefinedName

Defined in

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

registerDescriptions()

registerDescriptions(description): IDisposable

register descriptions

Parameters

Returns

IDisposable

Implementation of

IDescriptionService.registerDescriptions

Defined in

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

unregisterDescriptions()

unregisterDescriptions(functionNames): void

unregister descriptions

Parameters

Returns

void

Implementation of

IDescriptionService.unregisterDescriptions

Defined in

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