QueryBuilder JAVASCRIPT UI Component API

QueryBuilder Javascript API

Class

QueryBuilder

QueryBuilder allows you to build dynamically queries for filtering.

Properties

allowDragboolean

Enables the dragging of conditions inside a group or between groups.

Default value

false

Try a demo showcasing the allowDrag property.

Example

Set the allowDrag property.

 <smart-query-builder allow-drag></smart-query-builder>

Set the allowDrag property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.allowDrag = false;

Get the allowDrag property.

 const querybuilder = document.querySelector('smart-query-builder');

 let allowDrag = querybuilder.allowDrag;

animation"none" | "simple" | "advanced"

Sets or gets the animation mode. Animation is disabled when the property is set to 'none'

Allowed Values

"none" - animation is disabled
"simple" - ripple animation is disabled
"advanced" - all animations are enabled

Default value

"advanced"

Example

Set the animation property.

 <smart-query-builder animation='none'></smart-query-builder>

Set the animation property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.animation = 'simple';

Get the animation property.

 const querybuilder = document.querySelector('smart-query-builder');

 let animation = querybuilder.animation;

applyMode"change" | "immediately"

Determines when the value of the element is updated with the new changes.

Allowed Values

"change" - The value of the element is updated when a change event is fired form one of the editors.
"immediately" - The value of the element is updated immediately after an editor's value is changed.

Default value

"change"

Example

Set the applyMode property.

 <smart-query-builder apply-mode='immediately'></smart-query-builder>

Set the applyMode property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.applyMode = 'change';

Get the applyMode property.

 const querybuilder = document.querySelector('smart-query-builder');

 let applyMode = querybuilder.applyMode;

autoApplyValueboolean

When 'applyMode' is set to 'immediately', the default value is applied to the editor's value and the QueryBuilder's value is updated automatically.

Default value

false

Example

Set the autoApplyValue property.

 <smart-query-builder auto-apply-value></smart-query-builder>

Set the autoApplyValue property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.autoApplyValue = false;

Get the autoApplyValue property.

 const querybuilder = document.querySelector('smart-query-builder');

 let autoApplyValue = querybuilder.autoApplyValue;

Determines whether QueryBuilder will automatically prompt the user to enter a condition value when a new condition is created. When 'applyMode' is set to 'immediately', the operation field is automatically populated if empty when the selected condition operator is changed. The input field prompts the user when the operation or operator of the condition is changed.

Default value

false

Example

Set the autoPrompt property.

 <smart-query-builder auto-prompt></smart-query-builder>

Set the autoPrompt property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.autoPrompt = false;

Get the autoPrompt property.

 const querybuilder = document.querySelector('smart-query-builder');

 let autoPrompt = querybuilder.autoPrompt;

customOperations{label: string, name: string, editorTemplate: function, valueTemplate: function, handleValue: function, hideValue: boolean, expressionTemplate: string, expressionReaderCallback: function, expressionBuilderCallback: function}[]

Adds more operations that can be used to the query bilder's conditions structure. Each custom operation can have the following fields:

Properties

labelstring

label to be displayed in the operator box. Multiple operations with the same label can exist

Default value

Get the label property.

 const querybuilder = document.querySelector('smart-query-builder');

 let label = querybuilder.customOperations[0].label;

namestring

A unique name for the operation.

Default value

Get the name property.

 const querybuilder = document.querySelector('smart-query-builder');

 let name = querybuilder.customOperations[0].name;

editorTemplatefunction

A callback function that creates a custom value editor. Takes three arguemnts:

fieldType - the type of the field for the operation.
value - the value of the condition.
fieldData - the field object.

Get the editorTemplate property.

 const querybuilder = document.querySelector('smart-query-builder');

 let editorTemplate = querybuilder.customOperations[0].editorTemplate;

valueTemplatefunction

A callback function that displays the value after the edior has been closed. Takes two argument:

editor - the custom editor element
value - the condition value.

Get the valueTemplate property.

 const querybuilder = document.querySelector('smart-query-builder');

 let valueTemplate = querybuilder.customOperations[0].valueTemplate;

handleValuefunction

A callback function that handles the value returned by the editor when it is closed. The callback takes one arguemnt - the custom editor element. If the dataType is 'object' the expected result from the function should contain a 'label' and 'value' attributes. Where the label will be used for displaying purposes while 'value' will be used as the actual value.

Get the handleValue property.

 const querybuilder = document.querySelector('smart-query-builder');

 let handleValue = querybuilder.customOperations[0].handleValue;

hideValueboolean

A boolean condition that specifies whether the operation requires a value or not.

Default value

false

Get the hideValue property.

 const querybuilder = document.querySelector('smart-query-builder');

 let hideValue = querybuilder.customOperations[0].hideValue;

validateValuefunction

A callback that is executed when QueryBuilder validation is triggered. The callback takes one argument, the value of the condition. The function should return true or false to determine whether the conditon is valid or not.

Get the validateValue property.

 const querybuilder = document.querySelector('smart-query-builder');

 let validateValue = querybuilder.customOperations[0].validateValue;

onEditorOpenfunction

A callback that is called when the custom editor is rendered, visible inside the DOM and ready to be opened. The callback has one parameter - the custom editor element.

Get the onEditorOpen property.

 const querybuilder = document.querySelector('smart-query-builder');

 let onEditorOpen = querybuilder.customOperations[0].onEditorOpen;

expressionTemplatestring

A string representing a custom Linq expression template. If the value of the element is a string it will be considered as a Linq expression and it will be checked against all expressionTemplates to find a match.

Default value

"null"

Get the expressionTemplate property.

 const querybuilder = document.querySelector('smart-query-builder');

 let expressionTemplate = querybuilder.customOperations[0].expressionTemplate;

expressionReaderCallbackfunction

A callback that is used to specify which arguments from the expression are used for the fieldName and value. Used when converting a Linq expression to QueryBuilder value. Takes two arguments:

expression - the LinQ expression defined in the expressionTemplate of the customOperator. Type string
bindings - an array of expression parameters based on the expression template of the customOperator. Type string[]

Get the expressionReaderCallback property.

 const querybuilder = document.querySelector('smart-query-builder');

 let expressionReaderCallback = querybuilder.customOperations[0].expressionReaderCallback;

expressionBuilderCallbackfunction

A callback function that is used to specify which arguments from the Linq expression are used for the fieldName and value when building the Linq expression from the current value of the element. Takes three arguments:

name - the name of the dataField. Type string.
operation - the name of the operation. Type string
value - the value of the operation. Type any( depends on the dataField).

Get the expressionBuilderCallback property.

 const querybuilder = document.querySelector('smart-query-builder');

 let expressionBuilderCallback = querybuilder.customOperations[0].expressionBuilderCallback;

Try a demo showcasing the customOperations property.

Example

Set the customOperations property.

 <smart-query-builder custom-operations='[{ label: "Matches /^\d{7}$/g", name: "/^\d{7}$/g", hideValue: true }, { label: "Similar to", name: "similar" }]'></smart-query-builder>

Set the customOperations property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.customOperations = [{ label: 'Is valid', name: 'isvalid' }];

Get the customOperations property.

 const querybuilder = document.querySelector('smart-query-builder');

 let customOperations = querybuilder.customOperations;

disabledboolean

Enables or disables the element.

Default value

false

Example

Set the disabled property.

 <smart-query-builder disabled></smart-query-builder>

Set the disabled property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.disabled = false;

Get the disabled property.

 const querybuilder = document.querySelector('smart-query-builder');

 let disabled = querybuilder.disabled;

dropDownWidthstring

Sets or gets the dropdown width of the property and operator editors.

Default value

"100%"

Example

Set the dropDownWidth property.

 <smart-query-builder drop-down-width='300'></smart-query-builder>

Set the dropDownWidth property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.dropDownWidth = '80%';

Get the dropDownWidth property.

 const querybuilder = document.querySelector('smart-query-builder');

 let dropDownWidth = querybuilder.dropDownWidth;

fields{label: string, dataField: string, dataType: string, dataType: string, format: any, filterOperations: string[]}[]

Array with filter fields and their settings. The available field settings are:

label - the field's label, as it will appear in the field selection drop down
dataField - the field's data field
dataType - the field's data type
filterOperations - an array of the filter operations applicable to the field; if not set, the default filter operations are applied
lookup - an object with settings for customizing the field's respective value selection input. It has the following settings:
- autoCompleteDelay - delay between typing in the input and opening the drop down with available options
- dataSource - an array of available options to choose from (appear in a drop down)
- minLength - minimum number of charactes to type in the input before the options drop down is displayed
- readonly - if set to true, the value selection input acts as a drop down list, otherwise it acts as a combo box

Properties

labelstring

Sets or gets the label.

Default value

Get the label property.

 const querybuilder = document.querySelector('smart-query-builder');

 let label = querybuilder.fields[0].label;

dataFieldstring

Sets or gets the data field

Default value

Get the dataField property.

 const querybuilder = document.querySelector('smart-query-builder');

 let dataField = querybuilder.fields[0].dataField;

dataTypestring

Sets or gets the data type.

Default value

"string"

Get the dataType property.

 const querybuilder = document.querySelector('smart-query-builder');

 let dataType = querybuilder.fields[0].dataType;

formatstring

Sets or gets the filter format.

Default value

Get the format property.

 const querybuilder = document.querySelector('smart-query-builder');

 let format = querybuilder.fields[0].format;

filterOperationsstring[]

Sets or gets the filter operations.

Default value

[]

Get the filterOperations property.

 const querybuilder = document.querySelector('smart-query-builder');

 let filterOperations = querybuilder.fields[0].filterOperations;

Try a demo showcasing the fields property.

Example

Set the fields property.

 <smart-query-builder fields='[{ "label": "id", "dataField": "id", "dataType": "number", "format": null, "filterOperations": ["=", "anyof"] }, { "label": "Product", "dataField": "productName", "dataType": "string", "format": null }]'></smart-query-builder>

Set the fields property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.fields = [{ "label": "id", "dataField": "id", "dataType": "number", "format": null, "filterOperations": ["=", "anyof"] }, { "label": "Product", "dataField": "productName", "dataType": "string", "format": null }];

Get the fields property.

 const querybuilder = document.querySelector('smart-query-builder');

 let fields = querybuilder.fields;

fieldsMode"dynamic" | "static"

Determines whether new fields can be dynamically added by typing in the field (property) box.

Allowed Values

"dynamic" - Allows to dynamically add new fields by typing inside the field input that is located inside a condition.
"static" - Fields are only added statically via the fields property.

Default value

"dynamic"

Example

Set the fieldsMode property.

 <smart-query-builder fields-mode='static'></smart-query-builder>

Set the fieldsMode property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.fieldsMode = 'dynamic';

Get the fieldsMode property.

 const querybuilder = document.querySelector('smart-query-builder');

 let fieldsMode = querybuilder.fieldsMode;

formatStringDatestring

Sets or gets the format string of the editor of fields with type 'date'.

Default value

"dd-MMM-yy"

Example

Set the formatStringDate property.

 <smart-query-builder format-string-date='dddd-MMMM-yyyy'></smart-query-builder>

Set the formatStringDate property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.formatStringDate = 'M/d/yyyy';

Get the formatStringDate property.

 const querybuilder = document.querySelector('smart-query-builder');

 let formatStringDate = querybuilder.formatStringDate;

formatStringDateTimestring

Sets or gets the format string of the editor of fields with type 'dateTime'.

Default value

"dd-MMM-yy HH:mm:ss"

Example

Set the formatStringDateTime property.

 <smart-query-builder format-string-date-time='h:mm:ss tt'></smart-query-builder>

Set the formatStringDateTime property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.formatStringDateTime = 'yyyy-MM-dd hh:mm:ss';

Get the formatStringDateTime property.

 const querybuilder = document.querySelector('smart-query-builder');

 let formatStringDateTime = querybuilder.formatStringDateTime;

getDynamicFieldfunction | null

A callback function called when a field is added dynamically. Used for configuring settings of the new field. Applicable only when fieldsMode is 'dynamic'.

Try a demo showcasing the getDynamicField property.

Example

Set the getDynamicField property.

 <smart-query-builder get-dynamic-field='getDynamicFieldFunction'></smart-query-builder>

Set the getDynamicField property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.getDynamicField = function (field) { return { dataField: field.toLowerCase(), dataType: 'number', filterOperations: ['<', '>'] }; };

Get the getDynamicField property.

 const querybuilder = document.querySelector('smart-query-builder');

 let getDynamicField = querybuilder.getDynamicField;

iconsany

Defines CSS classes to be applied to each of the built-in operations. Icons for these classes are applied in the smart-query-builder style sheet. This property is applicable only if showIcons is set to true.

Default value

{ '=': 'equals', '<>': 'notequals', '>': 'greaterthan', '>=': 'greaterthanorequal', '<': 'lessthan', '<=': 'lessthanorequal', 'startswith': 'startswith', 'endswith': 'endswith', 'contains': 'contains', 'notcontains': 'notcontains', 'isblank': 'isblank', 'isnotblank': 'isnotblank' }

Example

Set the icons property.

 <smart-query-builder icons='{ "=": "equals", "<>": "notequals", ">": "greaterthan", ">=": "greaterthanorequal", "<": "lessthan", "<=": "lessthanorequal", "startswith": "startswith", "endswith": "endswith", "contains": "contains", "notcontains": "notcontains", "isblank": "blank", "isnotblank": "notblank" }'></smart-query-builder>

Set the icons property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.icons = { '=': 'equals', '<>': 'notequals', '>': 'greaterthan', '>=': 'greaterthanorequal', '<': 'lessthan', '<=': 'lessthanorequal', 'startswith': 'startswith', 'endswith': 'endswith', 'contains': 'contains', 'notcontains': 'notcontains', 'isblank': 'blank', 'isnotblank': 'notblank' };

Get the icons property.

 const querybuilder = document.querySelector('smart-query-builder');

 let icons = querybuilder.icons;

localestring

Sets or gets the language. Used in conjunction with the property messages.

Default value

"en"

Example

Set the locale property.

 <smart-query-builder locale='de'></smart-query-builder>

Set the locale property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.locale = 'fr';

Get the locale property.

 const querybuilder = document.querySelector('smart-query-builder');

 let locale = querybuilder.locale;

localizeFormatFunctionfunction | null

Callback used to customize the format of the messages that are returned from the Localization Module.

Example

Set the localizeFormatFunction property.

 <smart-query-builder localize-format-function='function(defaultMessage, message, messageArguments){return '...'}'></smart-query-builder>

Set the localizeFormatFunction property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.localizeFormatFunction = function(defaultMessage, message, messageArguments){return '...'};

Get the localizeFormatFunction property.

 const querybuilder = document.querySelector('smart-query-builder');

 let localizeFormatFunction = querybuilder.localizeFormatFunction;

messagesobject

Defines field names of the filtered element.

Default value

"en": {

"propertyUnknownType": "'{{name}}' property is with undefined 'type' member!",

"propertyInvalidValue": "Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!",

"propertyInvalidValueType": "Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!",

"elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",

"moduleUndefined": "Module is undefined.",

"missingReference": "{{elementType}}: Missing reference to {{files}}.",

"htmlTemplateNotSuported": "{{elementType}}: Browser doesn't support HTMLTemplate elements.",

"invalidTemplate": "{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM.",

"add": "Add",

"addCondition": "Add Condition",

"addGroup": "Add Group",

"and": "And",

"notand": "Not And",

"or": "Or",

"notor": "Not Or",

"=": "Equals",

"<>": "Does not equal",

">": "Greater than",

">=": "Greater than or equal to",

"<": "Less than",

"<=": "Less than or equal to",

"startswith": "Starts with",

"endswith": "Ends with",

"contains": "Contains",

"notcontains": "Does not contain",

"isblank": "Is blank",

"isnotblank": "Is not blank",

"wrongParentGroupIndex": "{{elementType}}: Wrong parent group index in '{{method}}' method.",

"missingFields": "{{elementType}}: Fields are required for proper condition's adding. Set \"fields\" source and then conditions will be added as expected.",

"wrongElementNode": "{{elementType}}: Incorect node / node Id in '{{method}}' method.",

"invalidDataStructure": "{{elementType}}: Used invalid data structure in updateCondition/updateGroup method.",

"dateTabLabel": "DATE",

"timeTabLabel": "TIME",

"queryLabel": "Query"

}

Example

Set the messages property.

 <smart-query-builder messages='{"de":{"propertyUnknownType":"Die Eigenschaft '{{name}}' hat ein nicht definiertes 'type'-Member!","propertyInvalidValue":"Ungultiger Eigenschaftswert '{{name}}'! Aktueller Wert: {{actualValue}}, Erwarteter Wert: {{value}}!","propertyInvalidValueType":"Ungultiger Eigenschaftswert '{{name}}'! Aktueller Wert: {{actualType}}, Erwarteter Wert: {{type}}!","elementNotInDOM":"Element existiert nicht in DOM! Bitte fugen Sie das Element zum DOM hinzu, bevor Sie eine Methode aufrufen.","moduleUndefined":"Modul ist nicht definiert.","missingReference":"{{elementType}}: Fehlender Verweis auf {{files}}.","htmlTemplateNotSuported":"{{elementType}}: Browser unterstutzt keine HTMLTemplate-Elemente.","invalidTemplate":"{{elementType}}: '{{property}}' Die Eigenschaft akzeptiert eine Zeichenfolge, die mit der ID eines HTMLTemplate-Elements aus dem DOM ubereinstimmen muss.","add":"Hinzufügen", "addCondition":"Bedingung hinzufugen","addGroup":"Gruppe hinzufugen","and":"Und","notand":"Nicht und","or":"Oder","notor":"Nicht oder","=":"Gleich","<>":"Ist nicht gleich",">":"Greusser als",">=":"Greusser als oder gleich wie","<":"Weniger als","<=":"Weniger als oder gleich","startswith":"Beginnt mit","endswith":"Endet mit","contains":"Enthalt","notcontains":"Beinhaltet nicht","isblank":"Ist leer","isnotblank":"Ist nicht leer","wrongParentGroupIndex":"{{elementType}}: Falscher ubergeordneter Gruppenindex in der Methode '{{method}}'.","missingFields":"{{elementType}}: Felder sind fur das Hinzufugen der richtigen Bedingung erforderlich. Legen Sie die Quelle fur \"Felder\" fest, und die Bedingungen werden wie erwartet hinzugefugt.","wrongElementNode":"{{elementType}}: Falsche Knoten- / Knoten-ID in der Methode '{{method}}'.","invalidDataStructure":"{{elementType}}: In der Methode updateCondition / updateGroup wurde eine ungultige Datenstruktur verwendet.", "dateTabLabel":"DATUM", "timeTabLabel":"ZEIT", "queryLabel":"Abfrage"}}'></smart-query-builder>

Set the messages property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.messages = {"en":{"propertyUnknownType":"'{{name}}' property is with undefined 'type' member!","propertyInvalidValue":"Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!","propertyInvalidValueType":"Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!","elementNotInDOM":"Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.","moduleUndefined":"Module is undefined.","missingReference":"{{elementType}}: Missing reference to {{files}}.","htmlTemplateNotSuported":"{{elementType}}: Browser doesn't support HTMLTemplate elements.","invalidTemplate":"{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM.","add":"Add","addCondition":"Add Condition","addGroup":"Add Group","and":"And","notand":"Not And","or":"Or","notor":"Not Or","=":"Equals","<>":"Does not equal",">":"Greater than",">=":"Greater than or equal to","<":"Less than","<=":"Less than or equal to","startswith":"Starts with","endswith":"Ends with","contains":"Contains","notcontains":"Does not contain","isblank":"Is blank","isnotblank":"Is not blank","wrongParentGroupIndex":"{{elementType}}: Wrong parent group index in '{{method}}' method.","missingFields":"{{elementType}}: Fields are required for proper condition's adding. Set \"fields\" source and then conditions will be added as expected.","wrongElementNode":"{{elementType}}: Incorect node / node Id in '{{method}}' method.","invalidDataStructure":"{{elementType}}: Used invalid data structure in updateCondition/updateGroup method.", "dateTabLabel":"DATE", "timeTabLabel":"TIME", "queryLabel":"Query"}};

Get the messages property.

 const querybuilder = document.querySelector('smart-query-builder');

 let messages = querybuilder.messages;

operatorPlaceholderstring

Determines the placeholder text used inside the condition's operator box in case an operator is not selected.

Default value

"Operator"

Example

Set the operatorPlaceholder property.

 <smart-query-builder operator-placeholder='Operator not set'></smart-query-builder>

Set the operatorPlaceholder property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.operatorPlaceholder = 'Choose operator...';

Get the operatorPlaceholder property.

 const querybuilder = document.querySelector('smart-query-builder');

 let operatorPlaceholder = querybuilder.operatorPlaceholder;

propertyPlaceholderstring

Determines the placeholder text used inside the condition's field (property) box in case a field is not selected.

Default value

"Property"

Example

Set the propertyPlaceholder property.

 <smart-query-builder property-placeholder='Property not set'></smart-query-builder>

Set the propertyPlaceholder property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.propertyPlaceholder = 'Choose property...';

Get the propertyPlaceholder property.

 const querybuilder = document.querySelector('smart-query-builder');

 let propertyPlaceholder = querybuilder.propertyPlaceholder;

rightToLeftboolean

Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.

Default value

false

Try a demo showcasing the rightToLeft property.

Example

Set the rightToLeft property.

 <smart-query-builder right-to-left></smart-query-builder>

Set the rightToLeft property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.rightToLeft = false;

Get the rightToLeft property.

 const querybuilder = document.querySelector('smart-query-builder');

 let rightToLeft = querybuilder.rightToLeft;

showIconsboolean

Shows/Hides the operator icons shown in the operator selection drop down.

Default value

false

Try a demo showcasing the showIcons property.

Example

Set the showIcons property.

 <smart-query-builder show-icons></smart-query-builder>

Set the showIcons property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.showIcons = false;

Get the showIcons property.

 const querybuilder = document.querySelector('smart-query-builder');

 let showIcons = querybuilder.showIcons;

showFieldNameArrowboolean

Shows/Hides the drop down icon for the operator field name of the conditions.

Default value

false

Example

Set the showFieldNameArrow property.

 <smart-query-builder show-field-name-arrow></smart-query-builder>

Set the showFieldNameArrow property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.showFieldNameArrow = false;

Get the showFieldNameArrow property.

 const querybuilder = document.querySelector('smart-query-builder');

 let showFieldNameArrow = querybuilder.showFieldNameArrow;

themestring

Determines the theme. Theme defines the look of the element

Default value

Example

Set the theme property.

 <smart-query-builder theme='blue'></smart-query-builder>

Set the theme property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.theme = 'red';

Get the theme property.

 const querybuilder = document.querySelector('smart-query-builder');

 let theme = querybuilder.theme;

unfocusableboolean

If is set to true, the element cannot be focused.

Default value

false

Example

Set the unfocusable property.

 <smart-query-builder unfocusable></smart-query-builder>

Set the unfocusable property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.unfocusable = false;

Get the unfocusable property.

 const querybuilder = document.querySelector('smart-query-builder');

 let unfocusable = querybuilder.unfocusable;

validateOnInputboolean

Determines whether the value of the condition is validated on key up or not. By default the value is validated when the user blur's the value input. The validationTimeout determines the time interval after the user has ended typing that triggers the value validation.

Default value

false

Example

Set the validateOnInput property.

 <smart-query-builder validate-on-input></smart-query-builder>

Set the validateOnInput property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.validateOnInput = false;

Get the validateOnInput property.

 const querybuilder = document.querySelector('smart-query-builder');

 let validateOnInput = querybuilder.validateOnInput;

validationTimeoutnumber

Determines the timeout (starting after the user has finished typing in the value field) before the validation is applied to the condition value. This property works along validationOnInput.

Default value

100

Example

Set the validationTimeout property.

 <smart-query-builder validation-timeout='500'></smart-query-builder>

Set the validationTimeout property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.validationTimeout = 200;

Get the validationTimeout property.

 const querybuilder = document.querySelector('smart-query-builder');

 let validationTimeout = querybuilder.validationTimeout;

valueany

The value is represented by multidimensional array. The array contains group operators with conditions. Each group can contain multiple conditions.

Try a demo showcasing the value property.

Example

Set the value property.

 <smart-query-builder value='[[["productCode", "/^\d{7}$/g"], "or", ["id", "isvalid", true]]]'></smart-query-builder>

Set the value property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.value = [[['available', '=', true], 'and', ['price', '<', 1300],], 'or', [['produced', '>', new Date(2015, 3, 4)], 'and', ['purchased', '>=', new Date(2020, 4, 23, 15, 33)]]];

Get the value property.

 const querybuilder = document.querySelector('smart-query-builder');

 let value = querybuilder.value;

valueFormatFunctionfunction | null

Callback used to format the content of the condition value fields.

Example

Set the valueFormatFunction property.

 <smart-query-builder value-format-function='function (details) { return details.label + '%'; }'></smart-query-builder>

Set the valueFormatFunction property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.valueFormatFunction = function (details) { return details.label + '$'; };

Get the valueFormatFunction property.

 const querybuilder = document.querySelector('smart-query-builder');

 let valueFormatFunction = querybuilder.valueFormatFunction;

valuePlaceholderstring

Determines the placeholder text used inside the condition's value box in case a value is not set.

Default value

"Value"

Example

Set the valuePlaceholder property.

 <smart-query-builder value-placeholder='Value not set'></smart-query-builder>

Set the valuePlaceholder property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.valuePlaceholder = 'Choose value...';

Get the valuePlaceholder property.

 const querybuilder = document.querySelector('smart-query-builder');

 let valuePlaceholder = querybuilder.valuePlaceholder;

Events

changeCustomEvent

This event is triggered when the query builder's value is changed.

Bubbles Yes
Cancelable No
Interface CustomEvent
Event handler property onChange

Arguments

evCustomEvent

ev.detailObject

ev.detail.item - The item that is being dragged.

ev.detail.data - The data of the item that is being dragged.

ev.detail.originalEvent - The original event.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Try a demo showcasing the change event.

Example

Set up the event handler of change event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('change', function (event) {
    const detail = event.detail,
        item = detail.item,
        data = detail.data,
        originalEvent = detail.originalEvent;

	// event handling code goes here.
})

dragEndCustomEvent

This event is triggered when a dragged condition is dropped. This action can be canceled by calling event.preventDefault() in the event handler function.

Bubbles Yes
Cancelable Yes
Interface CustomEvent
Event handler property onDragEnd

Arguments

evCustomEvent

ev.detailObject

ev.detail.item - The item that is being dragged.

ev.detail.data - The data of the item that is being dragged.

ev.detail.target - The target item.

ev.detail.targetData - the data of the target item.

ev.detail.targetSide - The side of the target item where the dragged item will be dropped.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Example

Set up the event handler of dragEnd event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('dragEnd', function (event) {
    const detail = event.detail,
        item = detail.item,
        data = detail.data,
        target = detail.target,
        targetData = detail.targetData,
        targetSide = detail.targetSide;

	// event handling code goes here.
})

draggingCustomEvent

This event is triggered when a condition is being dragged.

Bubbles Yes
Cancelable Yes
Interface CustomEvent
Event handler property onDragging

Arguments

evCustomEvent

ev.detailObject

ev.detail.item - The item that is being dragged.

ev.detail.data - The data of the item that is being dragged.

ev.detail.originalEvent - The original event.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Example

Set up the event handler of dragging event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('dragging', function (event) {
    const detail = event.detail,
        item = detail.item,
        data = detail.data,
        originalEvent = detail.originalEvent;

	// event handling code goes here.
})

dragStartCustomEvent

This event is triggered when a dragging operation is started in smart-query-builder. This action can be canceled by calling event.preventDefault() in the event handler function.

Bubbles Yes
Cancelable Yes
Interface CustomEvent
Event handler property onDragStart

Arguments

evCustomEvent

ev.detailObject

ev.detail.item - The item is going to be dragged.

ev.detail.data - The data of the item that is going to be dragged.

ev.detail.originalEvent - The original event.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Example

Set up the event handler of dragStart event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('dragStart', function (event) {
    const detail = event.detail,
        item = detail.item,
        data = detail.data,
        originalEvent = detail.originalEvent;

	// event handling code goes here.
})

itemClickCustomEvent

This event is triggered when one of the query builder's building blocks ( oeprator, fieldName, value, close button, etc) is clicked.

Bubbles Yes
Cancelable No
Interface CustomEvent
Event handler property onItemClick

Arguments

evCustomEvent

ev.detailObject

ev.detail.id - The internal id of the clicked item, e.g. '0.1', '1.1', etc.

ev.detail.type - The type of the clicked item ( condition or a group ).

ev.detail.data - The data of the item.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Example

Set up the event handler of itemClick event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('itemClick', function (event) {
    const detail = event.detail,
        id = detail.id,
        type = detail.type,
        data = detail.data;

	// event handling code goes here.
})

propertySelectedCustomEvent

This event is triggered when a field has been selected.

Bubbles Yes
Cancelable No
Interface CustomEvent
Event handler property onPropertySelected

Arguments

evCustomEvent

ev.detailObject

ev.detail.label - The label of the selected property.

ev.detail.value - The value of the selected property.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Example

Set up the event handler of propertySelected event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('propertySelected', function (event) {
    const detail = event.detail,
        label = detail.label,
        value = detail.value;

	// event handling code goes here.
})

validationChangeCustomEvent

This event is triggered when the component validates the input values. This happens when you input a new value and focus another component.

Bubbles Yes
Cancelable No
Interface CustomEvent
Event handler property onValidationChange

Arguments

evCustomEvent

ev.detailObject

ev.detail.oldValue - Old validation status.

ev.detail.newValue - New validation status.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Example

Set up the event handler of validationChange event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('validationChange', function (event) {
    const detail = event.detail,
        oldValue = detail.oldValue,
        newValue = detail.newValue;

	// event handling code goes here.
})

Methods

getLinq(): string

Converts the current value of the element to DynamicLINQ expression.

Returnsstring

Invoke the getLinq method.

const querybuilder = document.querySelector('smart-query-builder');
const result = querybuilder.getLinq();

Try a demo showcasing the getLinq method.

CSS Variables

--smart-query-builder-default-widthvar()

Default value

"auto"

Default width of QueryBuilder.

--smart-query-builder-default-heightvar()

Default value

"auto"

Default height of QueryBuilder.

--smart-query-builder-min-widthvar()

Default value

"100px"

Minimum width of QueryBuilder.

--smart-query-builder-content-paddingvar()

Default value

"5px"

Padding of QueryBuilder.

--smart-query-builder-editor-widthvar()

Default value

"125px"

Width of editors in QueryBuilder.

QueryBuilder Javascript API

allowDragboolean

Default value

Example

animation"none" | "simple" | "advanced"

Default value

Example

applyMode"change" | "immediately"

Default value

Example

autoApplyValueboolean

Default value

Example

autoPromptboolean

Default value

Example

customOperations{label: string, name: string, editorTemplate: function, valueTemplate: function, handleValue: function, hideValue: boolean, expressionTemplate: string, expressionReaderCallback: function, expressionBuilderCallback: function}[]

Properties

labelstring

Default value

namestring

Default value

editorTemplatefunction

valueTemplatefunction

handleValuefunction

hideValueboolean

Default value

validateValuefunction

onEditorOpenfunction

expressionTemplatestring

Default value

expressionReaderCallbackfunction

expressionBuilderCallbackfunction

Example

disabledboolean

Default value

Example

dropDownWidthstring

Default value

Example

fields{label: string, dataField: string, dataType: string, dataType: string, format: any, filterOperations: string[]}[]

Properties

labelstring

Default value

dataFieldstring

Default value

dataTypestring

Default value

formatstring

Default value

filterOperationsstring[]

Default value

Example

fieldsMode"dynamic" | "static"

Default value

Example

formatStringDatestring

Default value

Example

formatStringDateTimestring

Default value

Example

getDynamicFieldfunction | null

Example

iconsany

Default value

Example

localestring

Default value