@univerjs/ui v0.1.17 • Docs
Class: ProgressService
Extends
Implements
IProgressService
IDisposable
Constructors
new ProgressService()
new ProgressService(): ProgressService
Returns
Inherited from
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) |
progressChange$ | readonly | Observable <IProgressStep > | undefined | - | packages/ui/src/services/progress/progress.service.ts:73 (opens in a new tab) |
progressVisible$ | readonly | Observable <boolean > | undefined | - | packages/ui/src/services/progress/progress.service.ts:75 (opens in a new tab) |
Methods
complete()
complete(): void
Complete loading, hide the progress bar after automatically progressing to 100%
Returns
void
Implementation of
Defined in
packages/ui/src/services/progress/progress.service.ts:123 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Implementation of
IDisposable.dispose
Overrides
Defined in
packages/ui/src/services/progress/progress.service.ts:77 (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)
getTaskCount()
getTaskCount(): number
Get the total number of tasks
Returns
number
Implementation of
Defined in
packages/ui/src/services/progress/progress.service.ts:145 (opens in a new tab)
insertTaskCount()
insertTaskCount(count): void
Insert a new number of tasks, do not set the start loading mechanism, when insertTaskCount finds that the original number of tasks is 0, it starts loading
Parameters
Parameter | Type |
---|---|
count | number |
Returns
void
Implementation of
IProgressService
.insertTaskCount
Defined in
packages/ui/src/services/progress/progress.service.ts:111 (opens in a new tab)
pushTask()
pushTask(task): void
Append subtask quantity during loading, when the number of added subtasks reaches the total number of tasks, the loading is completed.
Parameters
Parameter | Type |
---|---|
task | IProgressCount |
Returns
void
Implementation of
Defined in
packages/ui/src/services/progress/progress.service.ts:84 (opens in a new tab)
stop()
stop(): void
Interrupt and hide the progress bar directly
Returns
void
Implementation of
Defined in
packages/ui/src/services/progress/progress.service.ts:136 (opens in a new tab)