API Reference
@univerjs
@univerjs/engine-formula
interfaces
Idefinednamesservice

@univerjs/engine-formula v0.1.17Docs


Interface: IDefinedNamesService

Properties

PropertyTypeDefined in
currentRange$Observable<IUnitRange>packages/engine-formula/src/services/defined-names.service.ts:69 (opens in a new tab)
focusRange$Observable<IDefinedNamesServiceFocusParam>packages/engine-formula/src/services/defined-names.service.ts:73 (opens in a new tab)
update$Observable<unknown>packages/engine-formula/src/services/defined-names.service.ts:71 (opens in a new tab)

Methods

focusRange()

focusRange(unitId, id): void

Parameters

ParameterType
unitIdstring
idstring

Returns

void

Defined in

packages/engine-formula/src/services/defined-names.service.ts:75 (opens in a new tab)


getCurrentRange()

getCurrentRange(): IUnitRange

Returns

IUnitRange

Defined in

packages/engine-formula/src/services/defined-names.service.ts:65 (opens in a new tab)


getCurrentRangeForString()

getCurrentRangeForString(): string

Returns

string

Defined in

packages/engine-formula/src/services/defined-names.service.ts:67 (opens in a new tab)


getDefinedNameMap()

getDefinedNameMap(unitId): Nullable<IDefinedNameMapItem>

Parameters

ParameterType
unitIdstring

Returns

Nullable<IDefinedNameMapItem>

Defined in

packages/engine-formula/src/services/defined-names.service.ts:51 (opens in a new tab)


getValueById()

getValueById(unitId, id): Nullable<IDefinedNamesServiceParam>

Parameters

ParameterType
unitIdstring
idstring

Returns

Nullable<IDefinedNamesServiceParam>

Defined in

packages/engine-formula/src/services/defined-names.service.ts:55 (opens in a new tab)


getValueByName()

getValueByName(unitId, name): Nullable<IDefinedNamesServiceParam>

Parameters

ParameterType
unitIdstring
namestring

Returns

Nullable<IDefinedNamesServiceParam>

Defined in

packages/engine-formula/src/services/defined-names.service.ts:53 (opens in a new tab)


hasDefinedName()

hasDefinedName(unitId): boolean

Parameters

ParameterType
unitIdstring

Returns

boolean

Defined in

packages/engine-formula/src/services/defined-names.service.ts:61 (opens in a new tab)


registerDefinedName()

registerDefinedName(unitId, param): void

Parameters

ParameterType
unitIdstring
paramIDefinedNamesServiceParam

Returns

void

Defined in

packages/engine-formula/src/services/defined-names.service.ts:47 (opens in a new tab)


registerDefinedNames()

registerDefinedNames(unitId, params): void

Parameters

ParameterType
unitIdstring
paramsIDefinedNameMapItem

Returns

void

Defined in

packages/engine-formula/src/services/defined-names.service.ts:49 (opens in a new tab)


removeDefinedName()

removeDefinedName(unitId, name): void

Parameters

ParameterType
unitIdstring
namestring

Returns

void

Defined in

packages/engine-formula/src/services/defined-names.service.ts:57 (opens in a new tab)


removeUnitDefinedName()

removeUnitDefinedName(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Defined in

packages/engine-formula/src/services/defined-names.service.ts:59 (opens in a new tab)


setCurrentRange()

setCurrentRange(range): void

Parameters

ParameterType
rangeIUnitRange

Returns

void

Defined in

packages/engine-formula/src/services/defined-names.service.ts:63 (opens in a new tab)


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.