File

projects/components/src/widgets/common/form/live-filter/live-filter.component.doc.ts

Description

The wmLivefilter widget defines a live filter in the layout.

Index

Methods
Inputs

Methods

clearFilter
clearFilter()

This method is used to clear the filter values and trigger the filter call.

Returns : void
filter
filter()

This method is used to trigger the filter call.

Returns : void
onBeforeservicecall
onBeforeservicecall($data: any)

Callback is triggered on save of form and before sending service call. This callback can be used to validate or modify data.

Parameters :
Name Type Optional Description
$data any No

Input data collected from the filter widget

Returns : void | boolean

if the callback returns false, filter call is stopped. Anything else, filter call continues with modified data.

onError
onError($data: any)

This event handler is called whenever the filter call returns an error.

Parameters :
Name Type Optional Description
$data any No

response returned from the service call

Returns : void
onSuccess
onSuccess($data: any)

This event handler is called whenever the filter call is success.

Parameters :
Name Type Optional Description
$data any No

response returned from the service call

Returns : void

Inputs

autocomplete

Enabling this property turns on auto-completion in the editor. As the user types the choices in the drop-down select editor change dynamically.

Type : boolean

Default value : false

autoupdate

Set this property to true, if you want to trigger the filter automatically on change of any input field inside the live filter.

Type : boolean

Default value : false

captionalign

Defines the alignment of the caption elements of widgets inside the form.

Allowed Values: left, center, right

left: Caption is aligned to left.

center: Caption is aligned in center.

right: Caption is aligned to right.

Type : string

Default value : 'left'

captionposition

Defines the position of the caption elements of widgets inside the form.

Allowed Values: left, top, right

left: Caption is positioned to left of form widget.

top: Caption is positioned on top of form widget.

right: Caption is positioned to right of form widget.

Type : string

Default value : 'left'

class

Class of the widget.

Type : string

collapsible

Enable control for collapsing and expanding the widget.

Type : boolean

Default value : false

dataset

This property specifies the datasource to which values of form are submitted.

Bindable: true

Type : any

enableemptyfilter

This property enables 'No Value' option for select and radioset widgets in Live Filter. 'No Value' option can be used for filtering null or empty records.

Allowed Values: NULL, EMPTY, NULL AND EMPTY

NULL:Filtering on 'No Value' returns null records.

EMPTY: Filtering on 'No Value' returns empty records.

NULL AND EMPTY: Filtering on 'No Value' returns both null and empty records.

Type : string

expanded

Set the default state of the form whether it is expanded or collapsed.

Type : boolean

Default value : false

iconclass

CSS class of the icon showed in form header.

Bindable: true

Type : string

Default value : 'wi wi-filter-list'

name

Name of the Live Filter widget.

Type : string

pagesize

This property sets the number of records to be fetched by the live filter

Type : number

Default value : 20

show

This property will be used to show/hide the live filter widget on the web page.

Bindable: true

Type : boolean

subheading

This property defines the sub heading or title for the widget.

Bindable: true

Type : string

tabindex

This property specifies the tab order of the Live Filter Widget.

Type : number

Default value : 0

title

Title of the Live Filter.

Bindable: true

Type : string

result-matching ""

    No results matching ""