@univerjs/engine-formula v0.4.2 • Docs
Interface: IDefinedNamesService
Properties
| Property | Type | Defined in |
|---|---|---|
currentRange$ | Observable<IUnitRange> | packages/engine-formula/src/services/defined-names.service.ts:68 (opens in a new tab) |
focusRange$ | Observable<IDefinedNamesServiceFocusParam> | packages/engine-formula/src/services/defined-names.service.ts:72 (opens in a new tab) |
update$ | Observable<unknown> | packages/engine-formula/src/services/defined-names.service.ts:70 (opens in a new tab) |
Methods
focusRange()
focusRange(unitId, id): voidParameters
| Parameter | Type |
|---|---|
unitId | string |
id | string |
Returns
void
Defined in
packages/engine-formula/src/services/defined-names.service.ts:74 (opens in a new tab)
getCurrentRange()
getCurrentRange(): IUnitRangeReturns
Defined in
packages/engine-formula/src/services/defined-names.service.ts:64 (opens in a new tab)
getCurrentRangeForString()
getCurrentRangeForString(): stringReturns
string
Defined in
packages/engine-formula/src/services/defined-names.service.ts:66 (opens in a new tab)
getDefinedNameMap()
getDefinedNameMap(unitId): Nullable<IDefinedNameMapItem>Parameters
| Parameter | Type |
|---|---|
unitId | string |
Returns
Defined in
packages/engine-formula/src/services/defined-names.service.ts:50 (opens in a new tab)
getValueById()
getValueById(unitId, id): Nullable<IDefinedNamesServiceParam>Parameters
| Parameter | Type |
|---|---|
unitId | string |
id | string |
Returns
Nullable<IDefinedNamesServiceParam>
Defined in
packages/engine-formula/src/services/defined-names.service.ts:54 (opens in a new tab)
getValueByName()
getValueByName(unitId, name): Nullable<IDefinedNamesServiceParam>Parameters
| Parameter | Type |
|---|---|
unitId | string |
name | string |
Returns
Nullable<IDefinedNamesServiceParam>
Defined in
packages/engine-formula/src/services/defined-names.service.ts:52 (opens in a new tab)
getWorksheetByRef()
getWorksheetByRef(unitId, ref): Nullable<Worksheet>Parameters
| Parameter | Type |
|---|---|
unitId | string |
ref | string |
Returns
Defined in
packages/engine-formula/src/services/defined-names.service.ts:76 (opens in a new tab)
hasDefinedName()
hasDefinedName(unitId): booleanParameters
| Parameter | Type |
|---|---|
unitId | string |
Returns
boolean
Defined in
packages/engine-formula/src/services/defined-names.service.ts:60 (opens in a new tab)
registerDefinedName()
registerDefinedName(unitId, param): voidParameters
| Parameter | Type |
|---|---|
unitId | string |
param | IDefinedNamesServiceParam |
Returns
void
Defined in
packages/engine-formula/src/services/defined-names.service.ts:46 (opens in a new tab)
registerDefinedNames()
registerDefinedNames(unitId, params): voidParameters
| Parameter | Type |
|---|---|
unitId | string |
params | IDefinedNameMapItem |
Returns
void
Defined in
packages/engine-formula/src/services/defined-names.service.ts:48 (opens in a new tab)
removeDefinedName()
removeDefinedName(unitId, name): voidParameters
| Parameter | Type |
|---|---|
unitId | string |
name | string |
Returns
void
Defined in
packages/engine-formula/src/services/defined-names.service.ts:56 (opens in a new tab)
removeUnitDefinedName()
removeUnitDefinedName(unitId): voidParameters
| Parameter | Type |
|---|---|
unitId | string |
Returns
void
Defined in
packages/engine-formula/src/services/defined-names.service.ts:58 (opens in a new tab)
setCurrentRange()
setCurrentRange(range): voidParameters
| Parameter | Type |
|---|---|
range | IUnitRange |
Returns
void
Defined in
packages/engine-formula/src/services/defined-names.service.ts:62 (opens in a new tab)