File

projects/components/src/widgets/common/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

Class of the widget.

Type : string

datafield

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

Type : string

dataset

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

Type : Array<any> | Object

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

datavalue

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

Bindable: true

Type : any

disabled

This property will be used to disable the radioset 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 label for radio option. 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 radioset widget when the list is populated using the dataSet property.

Type : string

itemclass

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

Type : string

layout

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.

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

name

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

Bindable: true

Type : boolean

required

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

Bindable: true

Type : boolean

show

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

Bindable: true

Type : boolean

Default value : true

tabindex

This property specifies the tab order of the radioset widget.

Type : number

Default value : 0

usekeys

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

Type : boolean

result-matching ""

    No results matching ""