File

projects/components/src/widgets/common/checkboxset/checkboxset.component.doc.ts

Description

The wmCheckboxset component defines the checkboxset widget.

Index

Methods
Inputs

Methods

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 :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the checkboxset widget

newVal any No

datavalue of the checkboxset widget

oldVal any No

previously selected datavalue of the checkboxset 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 checkboxset 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 checkboxset 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 checkboxset 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 checkboxset widget

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

Inputs

class

Class of the widget.

Type : string

collapsible

Enable control for collapsing and expanding the widget when groupby property is set.

Type : boolean

datafield

This property sets the dataValue to be returned by the checkboxset widget when the list is populated using the dataSet property.

Type : string

dataset

This property accepts the options to create the checkboxset widget. These options can be array of values, array of objects, object containing key-value pairs.

Bindable: true

Type : Array<any> | Object

Default value : 'Option 1, Option 2, Option 3'

datavalue

This property defines the initial selected value of the checkboxset widget. Returns array of values.

Bindable: true

Type : Array<any>

dateformat

This property determines the date format to be applied on the group heading

Type : string

disabled

This property will be used to disable the checkboxset widget. If the disabled property is true (checked), the widget becomes display-only.

Bindable: true

Type : boolean

displayexpression

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: true

Type : string

displayfield

This property sets the displayValue to show in the checkboxset widget when the list is populated using the dataSet property.

Type : string

groupby

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.

Type : string

itemclass

This property allows user to select a pre-defined list class name from the view-list drop down on the right.

Default Options: list-group, media-list

Type : string

layout

This property controls how contained checkboxes are displayed within the widget container.

Allowed Values: inline, stacked

inline: checkboxes are aligned inline.

stacked: checkboxes are aligned as stacks.

Type : string

Default value : 'stacked'

listclass

This property allows user to select a pre-defined list class name from the view-list drop down on the right.

Default Options: list-group-item, media

Type : string

match

When "Group as" property is set to

  1. alphabetic, the group heading will contain the starting character of the grouped data key
  2. word, the group heading will contain the word.
  3. any of the TIME options, data is grouped based on the time option given

Type : string

name

Name of the checkboxset widget.

Type : string

orderby

Allows to display the data in asc or desc order based on this property

Type : string

readonly

This property will be used to make the checkboxset widget non-editable.

Bindable: true

Type : boolean

required

This property will be used to validate the state of the checkboxset widget when used inside a form widget.

Bindable: true

Type : boolean

show

This property will be used to show/hide the checkboxset widget.

Bindable: true

Type : boolean

Default value : true

showcount

Count of checkbox items in list group will be shown, if set to true

Type : boolean

tabindex

This property specifies the tab order of the checkboxset widget.

Type : number

Default value : 0

usekeys

If set to true, use the keys of the dataset object as checkboxset options.

Type : boolean

result-matching ""

    No results matching ""