@univerjs/engine-formula v0.1.17 • Docs
Class: DefinedNamesService
Extends
Implements
Constructors
new DefinedNamesService()
new DefinedNamesService(): DefinedNamesService
Returns
Overrides
Defined in
packages/engine-formula/src/services/defined-names.service.ts:100 (opens in a new tab)
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
_disposed | protected | boolean | false | Disposable ._disposed | packages/core/src/shared/lifecycle.ts:93 (opens in a new tab) |
currentRange$ | readonly | Observable <IUnitRange > | undefined | - | packages/engine-formula/src/services/defined-names.service.ts:95 (opens in a new tab) |
focusRange$ | readonly | Observable <IDefinedNamesServiceFocusParam > | undefined | - | packages/engine-formula/src/services/defined-names.service.ts:98 (opens in a new tab) |
update$ | readonly | Observable <unknown > | undefined | - | packages/engine-formula/src/services/defined-names.service.ts:83 (opens in a new tab) |
Methods
dispose()
dispose(): void
Returns
void
Overrides
Defined in
packages/engine-formula/src/services/defined-names.service.ts:105 (opens in a new tab)
disposeWithMe()
protected disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
IDisposable
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)
focusRange()
focusRange(unitId, id): void
Parameters
Parameter | Type |
---|---|
unitId | string |
id | string |
Returns
void
Implementation of
IDefinedNamesService
.focusRange
Defined in
packages/engine-formula/src/services/defined-names.service.ts:109 (opens in a new tab)
getCurrentRange()
getCurrentRange(): IUnitRange
Returns
Implementation of
IDefinedNamesService
.getCurrentRange
Defined in
packages/engine-formula/src/services/defined-names.service.ts:122 (opens in a new tab)
getCurrentRangeForString()
getCurrentRangeForString(): string
Returns
string
Implementation of
IDefinedNamesService
.getCurrentRangeForString
Defined in
packages/engine-formula/src/services/defined-names.service.ts:126 (opens in a new tab)
getDefinedNameMap()
getDefinedNameMap(unitId): IDefinedNameMapItem
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
Implementation of
IDefinedNamesService
.getDefinedNameMap
Defined in
packages/engine-formula/src/services/defined-names.service.ts:156 (opens in a new tab)
getValueById()
getValueById(unitId, id): IDefinedNamesServiceParam
Parameters
Parameter | Type |
---|---|
unitId | string |
id | string |
Returns
Implementation of
IDefinedNamesService
.getValueById
Defined in
packages/engine-formula/src/services/defined-names.service.ts:170 (opens in a new tab)
getValueByName()
getValueByName(unitId, name): null | IDefinedNamesServiceParam
Parameters
Parameter | Type |
---|---|
unitId | string |
name | string |
Returns
null
| IDefinedNamesServiceParam
Implementation of
IDefinedNamesService
.getValueByName
Defined in
packages/engine-formula/src/services/defined-names.service.ts:160 (opens in a new tab)
hasDefinedName()
hasDefinedName(unitId): boolean
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
boolean
Implementation of
IDefinedNamesService
.hasDefinedName
Defined in
packages/engine-formula/src/services/defined-names.service.ts:174 (opens in a new tab)
registerDefinedName()
registerDefinedName(unitId, param): void
Parameters
Parameter | Type |
---|---|
unitId | string |
param | IDefinedNamesServiceParam |
Returns
void
Implementation of
IDefinedNamesService
.registerDefinedName
Defined in
packages/engine-formula/src/services/defined-names.service.ts:135 (opens in a new tab)
registerDefinedNames()
registerDefinedNames(unitId, params): void
Parameters
Parameter | Type |
---|---|
unitId | string |
params | IDefinedNameMapItem |
Returns
void
Implementation of
IDefinedNamesService
.registerDefinedNames
Defined in
packages/engine-formula/src/services/defined-names.service.ts:130 (opens in a new tab)
removeDefinedName()
removeDefinedName(unitId, id): void
Parameters
Parameter | Type |
---|---|
unitId | string |
id | string |
Returns
void
Implementation of
IDefinedNamesService
.removeDefinedName
Defined in
packages/engine-formula/src/services/defined-names.service.ts:146 (opens in a new tab)
removeUnitDefinedName()
removeUnitDefinedName(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Implementation of
IDefinedNamesService
.removeUnitDefinedName
Defined in
packages/engine-formula/src/services/defined-names.service.ts:151 (opens in a new tab)
setCurrentRange()
setCurrentRange(range): void
Parameters
Parameter | Type |
---|---|
range | IUnitRange |
Returns
void
Implementation of
IDefinedNamesService
.setCurrentRange
Defined in
packages/engine-formula/src/services/defined-names.service.ts:117 (opens in a new tab)