TaskBarProgressIndicator

Defined in: src/widgets/progress.ts:13

Extends

• ProgressIndicator

Constructors

Constructor

new TaskBarProgressIndicator(dart): TaskBarProgressIndicator

Defined in: src/entities/misc.ts:233

Parameters

Parameter	Type
dart	any

Returns

TaskBarProgressIndicator

Inherited from

ProgressIndicator.constructor

Properties

Property	Type	Inherited from	Defined in
dart	any	ProgressIndicator.dart	src/entities/misc.ts:231

Accessors

canceled

Get Signature

get canceled(): boolean

Defined in: src/entities/misc.ts:246

Flag indicating whether the operation was canceled by the user.

Returns

boolean

Inherited from

ProgressIndicator.canceled

---

description

Get Signature

get description(): string

Defined in: src/entities/misc.ts:248

Returns

string

Set Signature

set description(s): void

Defined in: src/entities/misc.ts:249

Parameters

Parameter	Type
s	string

Returns

void

Inherited from

ProgressIndicator.description

---

onCanceled

Get Signature

get onCanceled(): Observable<any>

Defined in: src/entities/misc.ts:267

Returns

Observable<any>

Inherited from

ProgressIndicator.onCanceled

---

onLogUpdated

Get Signature

get onLogUpdated(): Observable<any>

Defined in: src/entities/misc.ts:263

Returns

Observable<any>

Inherited from

ProgressIndicator.onLogUpdated

---

onProgressUpdated

Get Signature

get onProgressUpdated(): Observable<any>

Defined in: src/entities/misc.ts:259

Returns

Observable<any>

Inherited from

ProgressIndicator.onProgressUpdated

---

percent

Get Signature

get percent(): number

Defined in: src/entities/misc.ts:241

Returns

number

Inherited from

ProgressIndicator.percent

Methods

close()

close(): any

Defined in: src/widgets/progress.ts:18

Returns

any

---

log()

log(line): void

Defined in: src/entities/misc.ts:255

Parameters

Parameter	Type
line	string

Returns

void

Inherited from

ProgressIndicator.log

---

update()

update(percent, description): void

Defined in: src/entities/misc.ts:251

Parameters

Parameter	Type
percent	number
description	string

Returns

void

Inherited from

ProgressIndicator.update

---

create()

static create(name?, options?): TaskBarProgressIndicator

Defined in: src/widgets/progress.ts:14

Parameters

Parameter	Type
name?	string
options?	{ cancelable?: boolean; pausable?: boolean; spinner?: boolean; }
options.cancelable?	boolean
options.pausable?	boolean
options.spinner?	boolean

Returns

TaskBarProgressIndicator

Overrides

ProgressIndicator.create