Class Operator

Deactivates the control and its associated elements (data field, operator and search).

Example

const filterControl = ix.api.dom.getControl("<CONTROL-GUID>");
filterControl.disable();
Copy

Activates the control and its associated elements (data field, operator and search).

Example

const filterControl = ix.api.dom.getControl("<CONTROL-GUID>");
filterControl.enable();
Copy

Retrieves the current value of the search field in the filter.

Example

const filterControl = ix.api.dom.getControl("<CONTROL-GUID>");
const searchValue = filterControl.getSearchValue();
Copy

Retrieves the GUIDs of the selected data fields.

This method returns an array of GUIDs corresponding to the selected data fields in the filter.

Example

const filterControl = ix.api.dom.getControl("<CONTROL-GUID>");
const selectedDatafields = filterControl.getSelectedDatafields();
Copy

Retrieves the key of the selected comparative operator.

Example

const filterControl = ix.api.dom.getControl("<CONTROL-GUID>");
const selectedOperator = filterControl.getSelectedOperator();
Copy

Retrieves the selected comparative operator.

This method returns the operator option corresponding to the current operator key. If the operator key is null, it returns undefined.

Example

const filterControl = ix.api.dom.getControl("<CONTROL-GUID>");
const selectedOperatorObject = filterControl.getSelectedOperatorObject();
Copy

Checks if the control is enabled or disabled.

This method returns a boolean indicating the status of the control. If the control is enabled, it returns true. If the control is disabled, it returns false.

Example

const filterControl = ix.api.dom.getControl("<CONTROL-GUID>");
const isEnabled = filterControl.isEnabled();
Copy

Sets the selected data fields using their GUIDs.

This method accepts an array of GUIDs and updates the selected data fields in the filter accordingly. If multiple GUIDs are provided but multiple selection is not allowed, only the first GUID is used. The method also rebuilds the UI and sets the operators if the selected data fields have changed.

Example

const filterControl = ix.api.dom.getControl("<CONTROL-GUID>");
filterControl.selectDatafields(["<DATAFIELD1-GUID>", "<DATAFIELD2-GUID>"]);
Copy

Selects a comparative operator by its key.

This method accepts an optional key for an operator. If the provided key differs from the current operator key, it updates the operator key, rebuilds the operator UI, and rebuilds the search UI.

Example

const filterControl = ix.api.dom.getControl("<CONTROL-GUID>");
filterControl.selectOperator("=");
Copy

Sets the search value.

This asynchronous method updates the search value of the filter.

Example

const filterControl = ix.api.dom.getControl("<CONTROL-GUID>");
filterControl.setSearchValue("search term").then((success) => {
   console.log(success);
});
Copy

Triggers the 'change' event.

This asynchronous method fires the 'onchange' event associated with the control. By default, the event is only fired if the control is valid (i.e., duly completed). However, you can force the event to fire regardless of the control's validity by setting the forceEvent parameter to true.

Example

const filterControl = ix.api.dom.getControl("<CONTROL-GUID>");

// Fire 'onchange' event if control is valid
filterControl.triggerOnchange().then(() => {
    console.log("onchange event fired");
});

// Fire 'onchange' event regardless of control's validity
filterControl.triggerOnchange(true).then(() => {
    console.log("onchange event forced")
});
Copy