boolean
Enables or disables the validation.
Defaults to false
Specifies columns to create filters.
Defaults to {}
string
Defines class or multiple classes, which are separated by a space in the QueryBuilder element. You can add custom styles to the QueryBuilder using the cssClass property.
Defaults to ”
Object[]
| Object
| DataManager
Binds the column name from data source in query-builder.
The dataSource
is an array of JavaScript objects.
Defaults to []
string
Specifies the displayMode as Horizontal or Vertical.
Defaults to ‘Horizontal’
boolean
Enables/Disables the not group condition in query builder.
Defaults to false
boolean
Enable or disable persisting component’s state between page reloads. If enabled, filter states will be persisted.
Defaults to false.
boolean
Enable or disable rendering component in right to left direction.
Defaults to false
DropDownListModel
Specifies the property for field. @default null
string
Specifies the template for the header with any other widgets.
Defaults to null
string
Specifies the height of the query builder.
Defaults to ‘auto’
number
If immediateModeDelay is set by particular number, the rule Change event is triggered after that period.
Defaults to 0
string
Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.
Defaults to ”
boolean
If match case is set to true, the grid filters the records with exact match. if false, it filters case insensitive records (uppercase and lowercase letters treated the same).
Defaults to false
number
Specifies the maximum group count or restricts the group count.
Defaults to 5
DropDownListModel
Specifies the property for operator. @default null
boolean
When set to true, the user interactions on the component are disabled.
Defaults to false
Defines rules in the QueryBuilder. Specifies the initial rule, which is JSON data.
Defaults to {}
string
Specifies the separator string for column.
Defaults to ”
Specifies the showButtons settings of the query builder component. The showButtons can be enable Enables or disables the ruleDelete, groupInsert, and groupDelete buttons.
Defaults to { ruleDelete: true , groupInsert: true, groupDelete: true }
string
Specifies the sort direction of the field names.
Defaults to ‘Default’
boolean
Shows or hides the filtered query.
Defaults to false
Specifies the property for value.
Defaults to null
string
Specifies the width of the query builder.
Defaults to ‘auto’
Adds the handler to the given event listener.
Returns void
Adds single or multiple groups, which contains the collection of rules.
Returns void
Adds single or multiple rules.
Returns void
Appends the control within the given HTML element
Parameter | Type | Description |
---|---|---|
selector (optional) | string | HTMLElement |
Target element where control needs to be appended |
Returns void
When invoked, applies the pending property changes immediately to the component.
Returns void
Deletes the group or groups based on the group ID.
Returns void
Deletes the rule or rules based on the rule ID.
Returns void
Removes the component from the DOM and detaches all its related event handlers. Also it maintains the initial input element from the DOM.
Returns void
Gets the query for Data Manager.
Returns Query
return the Query from current rules collection.
Returns Promise | any
Gets the group.
Returns RuleModel
Returns the persistence data for component
Returns any
return the operator bound to the column.
Returns *Object[]*
Get the predicate from collection of rules.
Returns Predicate
Returns the route element of the component
Returns HTMLElement
Gets the rule.
Returns RuleModel
Gets the rule or rule collection.
Returns RuleModel
Get the rules from SQL query.
Returns RuleModel
Gets the sql query from rules.
Returns string
return the valid rule or rules collection.
Returns RuleModel
return values bound to the column.
Returns any[]
notify the changes to component.
Returns void
Applies all the pending property changes and render the component again.
Returns void
Removes the handler from the given event listener.
Returns void
Clears the rules without root rule.
Returns void
Set the rule or rules collection.
Returns void
Sets the rules from the sql query.
Returns void
Validate the conditions and it display errors for invalid fields.
Returns boolean
Dynamically injects the required modules to the component.
Returns void
Triggers when field, operator, value is change.
Triggers before the condition (And/Or), field, operator, value is changed.
Triggers when changing the condition(AND/OR), field, value, operator is changed.
EmitType<Event>
Triggers when the component is created.
EmitType<Object>
Triggers when dataBound to the Query Builder.
Triggers when changing the condition(AND/OR), field, value, operator is changed