projects/components/widgets/data/form/src/live-filter/live-filter.component.doc.ts
The wmLivefilter widget defines a live filter in the layout.
Methods |
Inputs |
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 :
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 :
Returns :
void
|
onSuccess | ||||||||
onSuccess($data: any)
|
||||||||
This event handler is called whenever the filter call is success.
Parameters :
Returns :
void
|
autocomplete |
Type : boolean
|
Default value : false
|
Enabling this property turns on auto-completion in the editor. As the user types the choices in the drop-down select editor change dynamically. |
autoupdate |
Type : boolean
|
Default value : false
|
Set this property to true, if you want to trigger the filter automatically on change of any input field inside the live filter. |
captionalign |
Type : string
|
Default value : 'left'
|
Defines the alignment of the caption elements of widgets inside the form. Allowed Values:
|
captionposition |
Type : string
|
Default value : 'left'
|
Defines the position of the caption elements of widgets inside the form. Allowed Values:
|
class |
Type : string
|
Class of the widget. |
collapsible |
Type : boolean
|
Default value : false
|
Enable control for collapsing and expanding the widget. |
dataset |
Type : any
|
This property specifies the datasource to which values of form are submitted. Bindable: |
enableemptyfilter |
Type : string
|
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:
|
expanded |
Type : boolean
|
Default value : false
|
Set the default state of the form whether it is expanded or collapsed. |
iconclass |
Type : string
|
Default value : 'wi wi-filter-list'
|
CSS class of the icon showed in form header. Bindable: |
name |
Type : string
|
Name of the Live Filter widget. |
pagesize |
Type : number
|
Default value : 20
|
This property sets the number of records to be fetched by the live filter |
show |
Type : boolean
|
This property will be used to show/hide the live filter widget on the web page. Bindable: |
subheading |
Type : string
|
This property defines the sub heading or title for the widget. Bindable: |
tabindex |
Type : number
|
Default value : 0
|
This property specifies the tab order of the Live Filter Widget. |
title |
Type : string
|
Title of the Live Filter. Bindable: |