Interface ProgressOptions

Value-object describing where and how progress should show.

interface ProgressOptions {
    cancellable?: boolean;
    location: ProgressLocation | {
        viewId: string;
    };
    title?: string;
}

Properties

cancellable? location title?

Properties

Optional cancellable

cancellable?: boolean

Controls if a cancel button should show to allow the user to cancel the long running operation. Note that currently only ProgressLocation.Notification is supporting to show a cancel button.

location

location: ProgressLocation | {
    viewId: string;
}

The location at which progress should show.

Type declaration

  • viewId: string

Optional title

title?: string

A human-readable string which will be used to describe the operation.

Settings

Member Visibility

Theme

On This Page

cancellablelocationtitle