Object

ProgressCategory

ProgressCategory class

Properties

Name	Type	Access	Description
	String	readonly	Get the unique category id of the progress category.

→ Boolean

Cancel all jobs being reported under this progress category.

→ Object

Create a new progress item with the given title.

title String

→ Object

Create a new progress item with the given title and reference id.

title String

referenceId Object

→ String

Get the icon of the progress category as base64 encoded svg.

→ Object

Get a progress item that represents all the progress in this category encapsulated in a single item.

→ Object

Retrieve a progress item by it's reference ID. The returned object can be null in case there is no progress item under this reference id.

referenceGuid Object

→ Array

Get all the progress items in this progress category.

→ String

Get the title of the progress category.

→ Number

Counts all progress items registered in this category.

→ Number

Get the cumulative progress value of the progress category.

→ Boolean

Check if the progress category has any completed progress items.

→ Boolean

Check if the progress category has any pending jobs.

→ Boolean

Check progress category has progress item that has been configured as unknown progress.

→ Boolean

Remove the cancelled and failed progress items from the progress category.

→ Boolean

Remove the completed progress items from the progress category.

→ Boolean

Remove the specified progress item from the progress category.

inProgressItem Object

→ Boolean

Indicates that this progress category will be shown in the header bar progress panel

→ Boolean

Indicates that this progress category will only show the status column.

→ Boolean

Check if the progress category can be cancelled.