@univerjs/core v0.1.17 • Docs
Class: UniverInstanceService
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.
Extends
Implements
Constructors
new UniverInstanceService()
new UniverInstanceService(_injector, _contextService): UniverInstanceService
Parameters
Parameter | Type |
---|---|
_injector | Injector |
_contextService | IContextService |
Returns
Overrides
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:88 (opens in a new tab)
Properties
Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
---|---|---|---|---|---|---|
_disposed | protected | boolean | false | - | Disposable ._disposed | submodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab) |
currentUnits$ | readonly | Observable <Map <number , Nullable <UnitModel <object , number >>>> | undefined | - | - | submodules/univer/packages/core/src/services/instance/instance.service.ts:124 (opens in a new tab) |
focused$ | readonly | Observable <Nullable <string >> | undefined | - | - | submodules/univer/packages/core/src/services/instance/instance.service.ts:213 (opens in a new tab) |
unitAdded$ | readonly | Observable <UnitModel <object , number >> | undefined | Omits value when a new UnitModel is created. | - | submodules/univer/packages/core/src/services/instance/instance.service.ts:147 (opens in a new tab) |
unitDisposed$ | readonly | Observable <UnitModel <object , number >> | undefined | Omits value when a UnitModel is disposed. | - | submodules/univer/packages/core/src/services/instance/instance.service.ts:173 (opens in a new tab) |
Accessors
focused
get focused(): Nullable<UnitModel<object, number>>
Returns
Nullable
<UnitModel
<object
, number
>>
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:214 (opens in a new tab)
Methods
__setCreateHandler()
__setCreateHandler(handler): void
Parameters
Parameter | Type |
---|---|
handler | (type , data , ctor ) => UnitModel <object , number > |
Returns
void
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:102 (opens in a new tab)
changeDoc()
changeDoc(unitId, doc): void
Parameters
Parameter | Type |
---|---|
unitId | string |
doc | DocumentDataModel |
Returns
void
Implementation of
IUniverInstanceService
.changeDoc
Deprecated
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:200 (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 | T |
Returns
U
Implementation of
IUniverInstanceService
.createUnit
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:106 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Overrides
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:95 (opens in a new tab)
disposeUnit()
disposeUnit(unitId): boolean
Dispose a unit
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
boolean
Implementation of
IUniverInstanceService
.disposeUnit
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:250 (opens in a new tab)
disposeWithMe()
protected disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
IDisposable
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)
focusUnit()
focusUnit(id): void
Parameters
Parameter | Type |
---|---|
id | null | string |
Returns
void
Implementation of
IUniverInstanceService
.focusUnit
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:221 (opens in a new tab)
getAllUnitsForType()
getAllUnitsForType<T>(type): T[]
Type Parameters
Type Parameter |
---|
T |
Parameters
Parameter | Type |
---|---|
type | number |
Returns
T
[]
Implementation of
IUniverInstanceService
.getAllUnitsForType
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:196 (opens in a new tab)
getCurrentTypeOfUnit$()
getCurrentTypeOfUnit$<T>(type): Observable<Nullable<T>>
Type Parameters
Type Parameter |
---|
T |
Parameters
Parameter | Type |
---|---|
type | number |
Returns
Observable
<Nullable
<T
>>
Implementation of
IUniverInstanceService
.getCurrentTypeOfUnit$
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:125 (opens in a new tab)
getCurrentUnitForType()
getCurrentUnitForType<T>(type): Nullable<T>
Type Parameters
Type Parameter |
---|
T |
Parameters
Parameter | Type |
---|---|
type | number |
Returns
Nullable
<T
>
Implementation of
IUniverInstanceService
.getCurrentUnitForType
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:129 (opens in a new tab)
getCurrentUniverDocInstance()
getCurrentUniverDocInstance(): Nullable<DocumentDataModel>
Returns
Implementation of
IUniverInstanceService
.getCurrentUniverDocInstance
Deprecated
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:184 (opens in a new tab)
getFocusedUnit()
getFocusedUnit(): Nullable<UnitModel<object, number>>
Returns
Nullable
<UnitModel
<object
, number
>>
Implementation of
IUniverInstanceService
.getFocusedUnit
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:239 (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
>
Implementation of
IUniverInstanceService
.getTypeOfUnitAdded$
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:148 (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 | UniverInstanceType |
Returns
Observable
<T
>
Implementation of
IUniverInstanceService
.getTypeOfUnitDisposed$
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:174 (opens in a new tab)
getUnit()
getUnit<T>(id, type?): Nullable<T>
Type Parameters
Type Parameter | Default type |
---|---|
T extends UnitModel <object , number > | UnitModel <object , number > |
Parameters
Parameter | Type |
---|---|
id | string |
type ? | number |
Returns
Nullable
<T
>
Implementation of
IUniverInstanceService
.getUnit
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:178 (opens in a new tab)
getUnitType()
getUnitType(unitId): UniverInstanceType
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
Implementation of
IUniverInstanceService
.getUnitType
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:243 (opens in a new tab)
getUniverDocInstance()
getUniverDocInstance(unitId): Nullable<DocumentDataModel>
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
Implementation of
IUniverInstanceService
.getUniverDocInstance
Deprecated
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:188 (opens in a new tab)
getUniverSheetInstance()
getUniverSheetInstance(unitId): Nullable<Workbook>
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
Implementation of
IUniverInstanceService
.getUniverSheetInstance
Deprecated
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:192 (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 | () => T |
Returns
IDisposable
Implementation of
IUniverInstanceService
.registerCtorForType
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:112 (opens in a new tab)
setCurrentUnitForType()
setCurrentUnitForType(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Implementation of
IUniverInstanceService
.setCurrentUnitForType
Defined in
submodules/univer/packages/core/src/services/instance/instance.service.ts:133 (opens in a new tab)