projects/components/widgets/input/default/src/checkboxset/checkboxset.component.doc.ts
The wmCheckboxset component defines the checkboxset 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
|
onClick | ||||||||||||
onClick($event: MouseEvent, widget: any)
|
||||||||||||
Callback function which will be triggered when the widget is clicked.
Parameters :
Returns :
void
|
onMouseenter | ||||||||||||
onMouseenter($event: MouseEvent, widget: any)
|
||||||||||||
Callback function which will be triggered when the mouse enters the widget.
Parameters :
Returns :
void
|
onMouseleave | ||||||||||||
onMouseleave($event: MouseEvent, widget: any)
|
||||||||||||
Callback function which will be triggered when the mouse leaves the widget.
Parameters :
Returns :
void
|
onTap | ||||||||||||
onTap($event: TouchEvent, widget: any)
|
||||||||||||
Callback function which will be triggered when the tap event is triggered on a widget.
Parameters :
Returns :
void
|
toggleAllHeaders |
toggleAllHeaders()
|
This can be invoked only when groupby and collapsible properties are set. This method is available on widget instance. This method toggles all the list items inside the each list group i.e. all the group lists can be collapsed or expanded.
Returns :
void
|
class |
Type : string
|
Class of the widget. |
collapsible |
Type : boolean
|
Enable control for collapsing and expanding the widget when groupby property is set. |
datafield |
Type : string
|
This property sets the dataValue to be returned by the checkboxset widget when the list is populated using the dataSet property. |
datavalue |
Type : Array<any>
|
This property defines the initial selected value of the checkboxset widget. Returns array of values. Bindable: |
dateformat |
Type : string
|
This property determines the date format to be applied on the group heading |
disabled |
Type : boolean
|
This property will be used to disable the checkboxset widget.
If the disabled property is true (checked), the widget becomes display-only. Bindable: |
displayexpression |
Type : string
|
This is an advanced property that gives more control over what is displayed as the checkbox label.
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 checkboxset widget when the list is populated using the dataSet property. |
groupby |
Type : string
|
This property allows for grouping the list of rows in the variable bound to a dataset by selecting one of the field names from the drop-down list. This can also be bound to a JavaScript function. |
itemclass |
Type : string
|
This property allows user to select a pre-defined list class name from the view-list drop down on the right. Default Options: |
layout |
Type : string
|
Default value : 'stacked'
|
This property controls how contained checkboxes are displayed within the widget container. Allowed Values:
|
listclass |
Type : string
|
This property allows user to select a pre-defined list class name from the view-list drop down on the right. Default Options: |
match |
Type : string
|
When "Group as" property is set to
|
name |
Type : string
|
Name of the checkboxset widget. |
orderby |
Type : string
|
Allows to display the data in asc or desc order based on this property |
readonly |
Type : boolean
|
This property will be used to make the checkboxset widget non-editable. Bindable: |
required |
Type : boolean
|
This property will be used to validate the state of the checkboxset widget when used inside a form widget. Bindable: |
show |
Type : boolean
|
Default value : true
|
This property will be used to show/hide the checkboxset widget. Bindable: |
showcount |
Type : boolean
|
Count of checkbox items in list group will be shown, if set to true |
tabindex |
Type : number
|
Default value : 0
|
This property specifies the tab order of the checkboxset widget. |
usekeys |
Type : boolean
|
If set to true, use the keys of the dataset object as checkboxset options. |