API Reference
@univerjs
@univerjs/ui
interfaces
Iprogressservice

@univerjs/ui v0.1.17Docs


Interface: IProgressService

Properties

PropertyTypeDefined in
progressChange$Observable<IProgressStep>packages/ui/src/services/progress/progress.service.ts:32 (opens in a new tab)
progressVisible$Observable<boolean>packages/ui/src/services/progress/progress.service.ts:33 (opens in a new tab)

Methods

complete()

complete(): void

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

Returns

void

Defined in

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


getTaskCount()

getTaskCount(): number

Get the total number of tasks

Returns

number

Defined in

packages/ui/src/services/progress/progress.service.ts:60 (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

ParameterType
countnumber

Returns

void

Defined in

packages/ui/src/services/progress/progress.service.ts:45 (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

ParameterType
taskIProgressCount

Returns

void

Defined in

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


stop()

stop(): void

Interrupt and hide the progress bar directly

Returns

void

Defined in

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


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.