projects/components/widgets/input/rating/src/rating.component.doc.ts
The wmRating component defines the rating widget.
Methods |
Inputs |
| onChange | ||||||||||||||||||||
onChange($event: MouseEvent, widget: any, newVal: any, oldVal: any)
|
||||||||||||||||||||
|
Callback function which will be triggered when the widget is clicked or when datavalue has changed.
Parameters :
Returns :
void
|
| class |
Type : string
|
|
Class of the widget. |
| datafield |
Type : string
|
|
This property sets the dataValue to be returned by the rating widget when the rating is populated using the dataSet property. |
| datavalue |
Type : Array<any>
|
|
This property defines the initial selected value of the rating widget. Bindable: |
| displayexpression |
Type : string
|
|
This is an advanced property that gives more control over what is displayed as the rating caption.
A Display Expression uses a JavaScript expression to format exactly what is shown Bindable: |
| displayfield |
Type : string
|
|
This property sets the displayValue to show in the rating widget when the list is populated using the dataSet property. |
| iconcolor |
Type : string
|
|
This property specifies the icon color. |
| iconsize |
Type : string
|
|
This property specifies the icon size |
| maxvalue |
Type : number
|
Default value : 5
|
|
This property specifies the max number of stars to be displayed. It should be less than or equal to 10. |
| name |
Type : string
|
|
Name of the rating widget. |
| readonly |
Type : boolean
|
|
This property will be used to make the rating widget non-editable. Bindable: |
| show |
Type : boolean
|
Default value : true
|
|
This property will be used to show/hide the rating widget. Bindable: |
| showcaptions |
Type : boolean
|
Default value : true
|
|
Captions will be visible on mouse hover or on selection, if set to true |
| tabindex |
Type : number
|
Default value : 0
|
|
This property specifies the tab order of the rating widget. |