Angular FilterBuilder Events

This section describes the events this widget raises.

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	FilterBuilder	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only when using Knockout.

Main article: onContentReady.

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	FilterBuilder	The widget instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.

Main article: onDisposing

editorPrepared

Raised after an editor is created.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	FilterBuilder	The widget's instance.
dataField	String	The data field's name.
disabled	Boolean	Indicates whether the editor is disabled.
editorElement	HTMLElement \| jQuery	The editor's container. It is an HTML Element or a jQuery Element when you use jQuery.
editorName	String	The editor's name.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
filterOperation	String	The applied filter operation.
model	Object	The model data. Available only if you use Knockout.
readOnly	Boolean	Indicates whether the editor is read-only.
rtlEnabled	Boolean	Indicates whether the editor uses right-to-left representation.
setValue(newValue)	any	A method that you need to call to change the field's value after the editor's value changes.
updateValueTimeout	Number	Gets and sets the delay between when a user stops typing the field value and when it is applied.
value	any	The editor's value.
width	Number	The editor's width.

Main article: onEditorPrepared

editorPreparing

Raised before an editor is created.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
cancel	Boolean	Allows you to cancel the creation of the editor. Set it to true and implement a custom editor if required.
component	FilterBuilder	The widget's instance.
dataField	String	The data field's name.
disabled	Boolean	Indicates whether the editor is disabled.
editorElement	HTMLElement \| jQuery	The editor's container. It is an HTML Element or a jQuery Element when you use jQuery.
editorName	String	Allows you to change the editor. Accepts names of DevExtreme widgets only, for example, "dxTextBox". Import a new editor's module when using DevExtreme modules.
editorOptions	Object	Gets and sets the editor configuration.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
filterOperation	String	The applied filter operation.
model	Object	The model data. Available only if you use Knockout.
readOnly	Boolean	Indicates whether the editor is read-only.
rtlEnabled	Boolean	Indicates whether the editor uses right-to-left representation.
setValue(newValue)	any	A method that you should call to change the field's value after the editor's value changes
updateValueTimeout	Number	Gets and sets the delay between when a user stops typing the field's value and when it is applied.
value	any	The editor's value.
width	Number	The editor's width.

Main article: onEditorPreparing

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	FilterBuilder	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Main article: onInitialized

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
model	Object	The model data. Available only if you use Knockout.
fullName	String	The path to the modified option that includes all parent options.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	FilterBuilder	The widget's instance.
name	String	The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.
value	any	The modified option's new value.

Main article: onOptionChanged

valueChanged

Raised after the widget's value is changed.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	FilterBuilder	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
previousValue	Object	The widget's previous value.
value	Object	The widget's new value.

Main article: onValueChanged

Angular FilterBuilder Events

See Also

contentReady

See Also

disposing

See Also

editorPrepared

See Also

editorPreparing

See Also

initialized

See Also

optionChanged

See Also

valueChanged

See Also