WaveMaker - Widgets API Documentation
  1. Classes
  2. ProgressBar

File

projects/components/widgets/basic/progress/progress-bar/src/progress-bar.component.doc.ts

Description

The wmProgressBar component defines the progress bar widget.

Index

Methods
Inputs

Methods

onBeforeupdate
onBeforeupdate($event: MouseEvent, widget: any)

Callback function which will be triggered on before update of the progress.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the progress bar widget
Returns : void
onClick
onClick($event: MouseEvent, widget: any)

Callback function which will be triggered when the widget is clicked.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the progress bar widget
Returns : void
onComplete
onComplete($event: MouseEvent, widget: any)

Callback function which will be triggered on complete of the progress.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the progress bar widget
Returns : void
onDblclick
onDblclick($event: MouseEvent, widget: any)

Callback function which will be triggered when the widget is double clicked.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the progress bar widget
Returns : void
onDoubletap
onDoubletap($event: TouchEvent, widget: any)

Callback function which will be triggered when the double tap event is triggered on a widget.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered
widget any No

Instance of the progress bar widget
Returns : void
onMouseenter
onMouseenter($event: MouseEvent, widget: any)

Callback function which will be triggered when the mouse enters the widget.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the progress bar widget
Returns : void
onMouseleave
onMouseleave($event: MouseEvent, widget: any)

Callback function which will be triggered when the mouse leaves the widget.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the progress bar widget
Returns : void
onStart
onStart($event: MouseEvent, widget: any)

Callback function which will be triggered on start of the progress.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the progress bar widget
Returns : void
onTap
onTap($event: TouchEvent, widget: any)

Callback function which will be triggered when the tap event is triggered on a widget.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered
widget any No

Instance of the progress bar widget
Returns : void

Inputs

captionplacement
Type : string
Default value : 'hidden'

Placement of progress bar value.

Allowed Values: hidden, inside
class
Type : string

Class of the widget.
dataset
Type : any

This property allows user to bind a variable to populate the list of values to display.

Bindable: true
datavalue
Type : string | number
Default value : 30

This property allows user to set an initial value to the progress bar widget

Bindable: true
displayformat
Type : string
Default value : ''

Format(Absolute/Percentage) in which the progress needs to be displayed.

Allowed Values: 9, 9.9, 9.99, 9.999, 9%, 9.9%, 9.99%, 9.999%
hint
Type : string

Hint text is shown for the progress bar widget on hover.

Bindable: true
maxvalue
Type : number
Default value : 100

This property allows user to set a max value to the progress bar widget

Bindable: true
minvalue
Type : number
Default value : 0

This property allows user to set a min value to the progress bar widget

Bindable: true
name
Type : string

Name of the progress bar widget.
pollinterval
Type : number
Default value : 0

Time interval in milli seconds to poll the service.
show
Type : boolean
Default value : true

This property will be used to show/hide the progress bar widget on the web page.

Bindable: true
tabindex
Type : number

This property specifies the tab order of the progress bar widget.
type
Type : string
Default value : 'default'

Type of the bar to be displayed.

Allowed Values: default, default-striped, success, success-striped, info, info-striped, warning, warning-striped, danger, danger-striped

Bindable: true

results matching ""

    No results matching ""