File

projects/components/widgets/input/default/src/radioset/radioset.component.doc.ts

Description

The wmRadioset component defines the radioset 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 radioset widget

newVal any No

datavalue of the radioset widget

oldVal any No

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

Returns : void

Inputs

class
Type : string

Class of the widget.

datafield
Type : string

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

dataset
Type : Array<any> | Object
Default value : 'Option 1, Option 2, Option 3'

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

Bindable: true

datavalue
Type : any

This property defines the initial selected value of the radioset widget.

Bindable: true

disabled
Type : boolean

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

Bindable: true

displayexpression
Type : string

This is an advanced property that gives more control over what is displayed as the label for radio option. A Display Expression uses a JavaScript expression to format exactly what is shown

Bindable: true

displayfield
Type : string

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

itemclass
Type : string

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

Default Options: list-group, media-list

layout
Type : string
Default value : 'stacked'

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

Allowed Values: inline, stacked

inline: radioboxes are aligned inline.

stacked: radioboxes are aligned as stacks.

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: list-group-item, media

name
Type : string

Name of the radioset 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 radioset widget non-editable.

Bindable: true

required
Type : boolean

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

Bindable: true

show
Type : boolean
Default value : true

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

Bindable: true

tabindex
Type : number
Default value : 0

This property specifies the tab order of the radioset widget.

usekeys
Type : boolean

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

result-matching ""

    No results matching ""