Class IgxCircularProgressBarComponent

Hierarchy

Hierarchy

  • BaseProgressDirective
    • IgxCircularProgressBarComponent

Implements

  • AfterContentInit

Constructors

Properties

animationDuration: number = 2000

Sets/Gets progressbar animation duration. By default, it is 2000ms.

<igx-linear-bar [animationDuration]="3000"></igx-linear-bar>
<igx-circular-bar [animationDuration]="3000"></igx-linear-bar>
id: string = ...

Sets the value of id attribute. If not provided it will be automatically generated.

<igx-circular-bar [id]="'igx-circular-bar-55'"></igx-circular-bar>
progressChanged: EventEmitter<IChangeProgressEventArgs> = ...

An event, which is triggered after progress is changed.

public progressChange(event) {
alert("Progress made!");
}
//...
<igx-circular-bar (progressChanged)="progressChange($event)"></igx-circular-bar>
<igx-linear-bar (progressChanged)="progressChange($event)"></igx-linear-bar>
textVisibility: boolean = true

Sets the text visibility. By default, it is set to true.

<igx-circular-bar [textVisibility]="false"></igx-circular-bar>
type: string = 'default'

Set type of the IgxCircularProgressBarComponent. Possible options - default, success, info, warning, and error.

<igx-circular-bar [type]="'error'"></igx-circular-bar>

Accessors

  • get animate(): boolean

    Returns whether the progress bar has animation true/false.

    @ViewChild("MyProgressBar")
    public progressBar: IgxLinearProgressBarComponent | IgxCircularBarComponent;
    public animationStatus(event) {
    let animationStatus = this.progressBar.animate;
    alert(animationStatus);
    }

    Returns boolean

  • set animate(animate: boolean): void

    Animating the progress. By default, it is set to true.

    <igx-linear-bar [animate]="false"></igx-linear-bar>
    <igx-circular-bar [animate]="false"></igx-circular-bar>

    Parameters

    • animate: boolean

    Returns void

  • get indeterminate(): boolean

    Gets the current state of the progress bar:

    • true if in the indeterminate state (no progress value displayed),
    • false if the progress bar shows the actual progress.
    const isIndeterminate = progressBar.indeterminate;
    

    Returns boolean

  • set indeterminate(isIndeterminate: boolean): void

    Sets progressbar in indeterminate. By default, it is set to false.

    <igx-linear-bar [indeterminate]="true"></igx-linear-bar>
    <igx-circular-bar [indeterminate]="true"></igx-circular-bar>

    Parameters

    • isIndeterminate: boolean

    Returns void

  • get max(): number

    Returns the maximum progress value of the progress bar.

    @ViewChild("MyProgressBar")
    public progressBar: IgxLinearProgressBarComponent | IgxCircularBarComponent;
    public maxValue(event) {
    let max = this.progressBar.max;
    alert(max);
    }

    Returns number

  • set max(maxNum: number): void

    Set maximum value that can be passed. By default it is set to 100.

    <igx-linear-bar [max]="200"></igx-linear-bar>
    <igx-circular-bar [max]="200"></igx-circular-bar>

    Parameters

    • maxNum: number

    Returns void

  • get step(): number

    Returns the value which update the progress indicator of the progress bar.

    @ViewChild("MyProgressBar")
    public progressBar: IgxLinearProgressBarComponent | IgxCircularBarComponent;
    public stepValue(event) {
    let step = this.progressBar.step;
    alert(step);
    }

    Returns number

  • set step(val: number): void

    Sets the value by which progress indicator is updated. By default, it is 1.

    <igx-linear-bar [step]="1"></igx-linear-bar>
    <igx-circular-bar [step]="1"></igx-circular-bar>

    Parameters

    • val: number

    Returns void

  • get value(): number

    Returns value that indicates the current IgxLinearProgressBarComponent/IgxCircularProgressBarComponent position.

    @ViewChild("MyProgressBar")
    public progressBar: IgxLinearProgressBarComponent / IgxCircularProgressBarComponent;
    public getValue(event) {
    let value = this.progressBar.value;
    alert(value);
    }

    Returns number

  • set value(val: number): void

    Set value that indicates the current IgxLinearProgressBarComponent / IgxCircularProgressBarComponent position.

    <igx-linear-bar [value]="50"></igx-linear-bar>
    <igx-circular-bar [value]="50"></igx-circular-bar>

    Parameters

    • val: number

    Returns void

  • get valueInPercent(): number

    Returns the IgxLinearProgressBarComponent/IgxCircularProgressBarComponent value in percentage.

    @ViewChild("MyProgressBar")
    public progressBar: IgxLinearProgressBarComponent / IgxCircularProgressBarComponent
    public valuePercent(event){
    let percentValue = this.progressBar.valueInPercent;
    alert(percentValue);
    }

    Returns number

Methods