Class IgxCircularProgressBarComponent

Hierarchy

Constructors

constructor

Properties

id

id: string = `igx-circular-bar-${NEXT_CIRCULAR_ID++}`

An @Input property that sets the value of id attribute. If not provided it will be automatically generated.

<igx-circular-bar [id]="'igx-circular-bar-55'" [value]="50"></igx-circular-bar>

indeterminate

indeterminate: boolean = false

An @Input property that sets the value of the indeterminate attribute. If not provided it will be automatically set to false.

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

onProgressChanged

onProgressChanged: EventEmitter<IChangeProgressEventArgs> = new EventEmitter<IChangeProgressEventArgs>()

An event, which is triggered after a progress is changed.

public progressChange(event) {
   alert("Progress made!");
}
//...
<igx-circular-bar [value]="currentValue" (onProgressChanged)="progressChange($event)"></igx-circular-bar>

text

text: string

Sets/gets the text to be displayed inside the igxCircularBar.

<igx-circular-bar text="Progress"></igx-circular-bar>
let text = this.circularBar.text;

textTemplate

textVisibility

textVisibility: boolean = true

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

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

Accessors

animate

  • get animate(): boolean
  • set animate(animate: boolean): void
  • Returns whether the IgxCircularProgressBarComponent has animation true/false.

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

    Returns boolean

  • Animation on progress IgxCircularProgressBarComponent. By default it is set to true.

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

    Parameters

    • animate: boolean

    Returns void

max

  • get max(): number
  • set max(maxNum: number): void
  • Returns the the maximum progress value of the IgxCircularProgressBarComponent.

    @ViewChild("MyProgressBar")
    public progressBar: IgxCircularProgressBarComponent;
    public maxValue(event) {
       let max = this.progressBar.max;
       alert(max);
    }
    <igx-circular-bar [max]="245" [animate]="false" [value]="currentValue"></igx-circular-bar>

    Returns number

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

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

    Parameters

    • maxNum: number

    Returns void

step

  • get step(): number
  • set step(val: number): void
  • Returns the value which update the progress indicator of the IgxCircularProgressBarComponent.

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

    Returns number

  • Sets the value by which progress indicator is updated. By default it is 1% of the maximum value.

    <igx-circular-bar [striped]="false" [max]="200" [value]="0" [step]="1"></igx-circular-bar>

    Parameters

    • val: number

    Returns void

value

  • get value(): number
  • set value(val: number): void
  • Returns value that indicates the current IgxCircularProgressBarComponent position.

    @ViewChild("MyProgressBar")
    public progressBar: IgxCircularProgressBarComponent;
    public getValue(event) {
       let value = this.progressBar.value;
       alert(value);
    }
    <button igxButton="fab" igxRipple="" (click)="getValue()">Click</button>

    Returns number

  • Set value that indicates the current IgxCircularProgressBarComponent position.

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

    Parameters

    • val: number

    Returns void

valueInPercent

  • get valueInPercent(): number
  • set valueInPercent(value: number): void
  • 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

  • Sets the IgxLinearProgressBarComponent/IgxCircularProgressBarComponent value in percentage.

    @ViewChild("MyProgressBar")
    public progressBar: IgxLinearProgressBarComponent; // IgxCircularProgressBarComponent
       public setValue(event){
       this.progressBar.valueInPercent = 56;
    }
    //...
    <button igxButton="fab" igxRipple="" (click)="setValue()">setValue</button>

    Parameters

    • value: number

    Returns void