@univerjs/sheets-formula v0.5.4

Class: DescriptionService

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

Implements

• IDescriptionService
• IDisposable

Constructors

new DescriptionService()

new DescriptionService(
   _functionService, 
   _localeService, 
   _configService): DescriptionService

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

Parameters

Returns

DescriptionService

Methods

dispose()

dispose(): void

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

Returns

void

Implementation of

IDisposable.dispose

getDescriptions()

getDescriptions(): Map<IFunctionNames, IFunctionInfo>

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

get all descriptions

Returns

Map<IFunctionNames, IFunctionInfo>

Implementation of

IDescriptionService.getDescriptions

getFunctionInfo()

getFunctionInfo(searchText): 
  | undefined
  | IFunctionInfo

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

get function info by name

Parameters

Returns

| undefined | IFunctionInfo

Implementation of

IDescriptionService.getFunctionInfo

getSearchListByName()

getSearchListByName(searchText): ISearchItem[]

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

get search list by name

Parameters

Returns

ISearchItem[]

Implementation of

IDescriptionService.getSearchListByName

getSearchListByNameFirstLetter()

getSearchListByNameFirstLetter(searchText): ISearchItem[]

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

get search list by name, from first letter

Parameters

Returns

ISearchItem[]

Implementation of

IDescriptionService.getSearchListByNameFirstLetter

getSearchListByType()

getSearchListByType(type): ISearchItem[]

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

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

Parameters

Returns

ISearchItem[]

Implementation of

IDescriptionService.getSearchListByType

hasDefinedNameDescription()

hasDefinedNameDescription(name): boolean

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

check if has defined name description

Parameters

Returns

boolean

Implementation of

IDescriptionService.hasDefinedNameDescription

hasDescription()

hasDescription(name): boolean

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

check if has description

Parameters

Returns

boolean

Implementation of

IDescriptionService.hasDescription

hasFunction()

hasFunction(searchText): boolean

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

Parameters

Returns

boolean

Implementation of

IDescriptionService.hasFunction

isFormulaDefinedName()

isFormulaDefinedName(name): boolean

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

check if is formula defined name

Parameters

Returns

boolean

Implementation of

IDescriptionService.isFormulaDefinedName

registerDescriptions()

registerDescriptions(description): IDisposable

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

register descriptions

Parameters

Returns

IDisposable

Implementation of

IDescriptionService.registerDescriptions

unregisterDescriptions()

unregisterDescriptions(functionNames): void

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

unregister descriptions

Parameters

Returns

void

Implementation of

IDescriptionService.unregisterDescriptions