@univerjs/core v0.1.17 • Docs
Interface: IUniverInstanceService
IUniverInstanceService holds all the current univer instances and provides a set of methods to add and remove univer instances.
It also manages the focused univer instance.
Properties
Property | Type | Description | Defined in |
---|---|---|---|
focused$ | Observable <Nullable <string >> | - | submodules/univer/packages/core/src/services/instance/instance.service.ts:52 (opens in a new tab) |
unitAdded$ | Observable <UnitModel <object , number >> | Omits value when a new UnitModel is created. | submodules/univer/packages/core/src/services/instance/instance.service.ts:40 (opens in a new tab) |
unitDisposed$ | Observable <UnitModel <object , number >> | Omits value when a UnitModel is disposed. | submodules/univer/packages/core/src/services/instance/instance.service.ts:48 (opens in a new tab) |
Methods
changeDoc()
changeDoc(unitId, doc): void
Parameters
Parameter | Type |
---|---|
unitId | string |
doc | DocumentDataModel |
Returns
void
Deprecated
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:70 (opens in a new tab)
createUnit()
createUnit<T, U>(type, data): U
Create a unit with snapshot info.
Type Parameters
Type Parameter |
---|
T |
U extends UnitModel <object , number > |
Parameters
Parameter | Type |
---|---|
type | number |
data | Partial <T > |
Returns
U
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:63 (opens in a new tab)
disposeUnit()
disposeUnit(unitId): boolean
Dispose a unit
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
boolean
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:65 (opens in a new tab)
focusUnit()
focusUnit(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | null | string |
Returns
void
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:53 (opens in a new tab)
getAllUnitsForType()
getAllUnitsForType<T>(type): T[]
Type Parameters
Type Parameter |
---|
T |
Parameters
Parameter | Type |
---|---|
type | number |
Returns
T
[]
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:73 (opens in a new tab)
getCurrentTypeOfUnit$()
getCurrentTypeOfUnit$<T>(type): Observable<Nullable<T>>
Type Parameters
Type Parameter |
---|
T extends UnitModel <object , number > |
Parameters
Parameter | Type |
---|---|
type | number |
Returns
Observable
<Nullable
<T
>>
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:60 (opens in a new tab)
getCurrentUnitForType()
getCurrentUnitForType<T>(type): Nullable<T>
Type Parameters
Type Parameter |
---|
T extends UnitModel <object , number > |
Parameters
Parameter | Type |
---|---|
type | number |
Returns
Nullable
<T
>
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:57 (opens in a new tab)
getCurrentUniverDocInstance()
getCurrentUniverDocInstance(): Nullable<DocumentDataModel>
Returns
Deprecated
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:81 (opens in a new tab)
getFocusedUnit()
getFocusedUnit(): Nullable<UnitModel<object, number>>
Returns
Nullable
<UnitModel
<object
, number
>>
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:55 (opens in a new tab)
getTypeOfUnitAdded$()
getTypeOfUnitAdded$<T>(type): Observable<T>
Subscribe to curtain type of units' creation.
Type Parameters
Type Parameter |
---|
T extends UnitModel <object , number > |
Parameters
Parameter | Type |
---|---|
type | number |
Returns
Observable
<T
>
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:42 (opens in a new tab)
getTypeOfUnitDisposed$()
getTypeOfUnitDisposed$<T>(type): Observable<T>
Subscribe to curtain type of units' disposing.
Type Parameters
Type Parameter |
---|
T extends UnitModel <object , number > |
Parameters
Parameter | Type |
---|---|
type | number |
Returns
Observable
<T
>
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:50 (opens in a new tab)
getUnit()
getUnit<T>(id, type?): Nullable<T>
Type Parameters
Type Parameter |
---|
T extends UnitModel <object , number > |
Parameters
Parameter | Type |
---|---|
id | string |
type ? | number |
Returns
Nullable
<T
>
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:72 (opens in a new tab)
getUnitType()
getUnitType(unitId): number
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
number
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:74 (opens in a new tab)
getUniverDocInstance()
getUniverDocInstance(unitId): Nullable<DocumentDataModel>
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
Deprecated
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:79 (opens in a new tab)
getUniverSheetInstance()
getUniverSheetInstance(unitId): Nullable<Workbook>
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
Deprecated
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:77 (opens in a new tab)
registerCtorForType()
registerCtorForType<T>(type, ctor): IDisposable
Type Parameters
Type Parameter |
---|
T extends UnitModel <object , number > |
Parameters
Parameter | Type |
---|---|
type | number |
ctor | (...args ) => T |
Returns
IDisposable
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:67 (opens in a new tab)
setCurrentUnitForType()
setCurrentUnitForType(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:58 (opens in a new tab)