Filter

An advanced parameter used for filtering

The list of common settings for parameters is available here.

Specification

options

• Available types:

Type	Specification
array	Left-side operands specified like option objects.
string	An URL of RPC returning the list of left-side operands.
object	Detailed configuration for getting left-side operands.

• Available parameters:

Parameter	Type	Specification
store	array	An array of left-side operands specified like Option object.
store	string	An URL of RPC returning the list of left-side operands.
logic	string	Allowed values: both, and, or. Specifies if only and, or or both types of filters are available.
operators	array	Custom operators. The data structure is the same as the grouped select box.

If the left-side operands field is not filled, it can be filled manually.

Examples

Basic Usage of a Filter

Appearance

Example of Filter Settings

Source

[
	{
		"name": "search",
		"label": "Search criteria",
		"type": "filter",
		"options": [
			{
				"label": "Email",
				"value": "email"
			},
			{
				"label": "Username",
				"value": "username"
			}
		]
	}
]

Output

[
    [
        {
          "a": "username",
          "b": "A",
          "o": "text:startwith"
        },
        {
          "a": "username",
          "b": "B",
          "o": "text:endwith"
        }
    ],
    [
        {
          "a": "username",
          "b": "C",
          "o": "text:endwith"
        }
    ]
]

Custom Operators

Many services have their own search options and syntax. That's why you may need to define your own operators. You can specify them inside the options object. You can create multiple groups of operators.

Appearance

Example of Custom Operators

Source

[
	{
		"name": "search",
		"type": "filter",
		"label": "Search criteria",
		"options": {
			"operators": [
				{
					"label": "Text",
					"options": [
						{
							"label": "Matches",
							"value": "matches"
						},
						{
							"label": "Doesn't match",
							"value": "doesntmatch"
						}
					]
				},
				{
					"label": "Numbers",
					"options": [
						{
							"label": "Three times larger",
							"value": "threetimeslarger"
						}
					]
				}
			]
		}
	}
]

Only and, Only or Logic

You may need to set up only and or only or filter. You can do this by setting the logic option. In this example, you can see how to create the filter parameter with only and logic. For or alternative, just change the keyword.

Appearance

Example of Filter with only AND Operator

Source

[
	{
		"name": "search",
		"type": "filter",
		"label": "Search criteria",
		"options": {
			"logic": "and"
		}
	}
]