@univerjs/ui v0.1.17 • Docs

Class: ProgressService

Extends

• Disposable

Implements

• IProgressService
• IDisposable

Constructors

new ProgressService()

new ProgressService(): ProgressService

Returns

ProgressService

Inherited from

Disposable.constructor

Properties

Methods

complete()

complete(): void

Complete loading, hide the progress bar after automatically progressing to 100%

Returns

void

Implementation of

IProgressService.complete

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

Disposable.dispose

Defined in

packages/ui/src/services/progress/progress.service.ts:77 (opens in a new tab)

disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

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

IProgressService.getTaskCount

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

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

Returns

void

Implementation of

IProgressService.pushTask

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

IProgressService.stop

Defined in

packages/ui/src/services/progress/progress.service.ts:136 (opens in a new tab)