FieldFilterPicker

The date format string used to display dates in value input fields. Defaults to the current locale's FieldFilterPicker.dateFormat value.

Make the entire picker disabled.

Dictionary of FieldOption representing the fields against which filters can be defined, keyed by field name.

If filtering a Grid, consider using GridFieldFilterPicker, which can be configured with an existing Grid instead of, or in combination with, defining fields manually.

Example:

fields: {
    // Allow filters to be defined against the 'age' and 'role' fields in our data
    age  : { title: 'Age', type: 'number' },
    role : { title: 'Role', type: 'string' }
}

Configuration object for the CollectionFilter displayed and editable in this picker.

Example:

{
    property: 'age',
    operator: '=',
    value: 25
}

Optional function that modifies the configuration of value fields shown for a filter. The default configuration is received as an argument and the returned value will be used as the final configuration. For example:

getValueFieldConfig : (filter, fieldConfig) => {
    return {
        ...fieldConfig,
        title : fieldName    // Override the `title` config for the field
    };
}

The supplied function should accept the following arguments:

Make only the operator selector readOnly.

Overrides the built-in list of operators that are available for selection. Specify operators as an object with data types as keys and lists of operators as values, like this:

operators : {
    string : [
        { value : 'empty', text : 'is empty', argCount : 0 },
        { value : 'notEmpty', text : 'is not empty', argCount : 0 }
    ],
    number : [
        { value : '=', text : 'equals' },
        { value : '!=', text : 'does not equal' }
    ],
    date : [
        { value : '<', text : 'is before' }
    ]
}

Here value is what will be stored in the operator field in the filter when selected, text is the text displayed in the Combo for selection, and argCount is the number of arguments (comparison values) the operator requires. The default argCount if not specified is 1.

Note: The operators config is a subset of valid operators described in CollectionCompareOperator. The use of any other operator apart from these is not supported and will lead to unexpected behavior.

Optional configuration for the property selector Combo.

Make only the property selector readOnly.

Make the entire picker read-only.

Optional {Core.data.Store} against which filters are being defined. This is used to supply options to filter against when using the 'is one of' and 'is not one of' operators.

Whether to raise change events as the user types into a value field. If false, change events will be raised only when the value input field's own change event occurs, for example on field blur.

Optional ValueFieldPlaceholders object specifying custom placeholder text for value input fields.

Make only the value input(s) readOnly.

Return an array of unique values in the data store for the currently selected field. If no store is configured or no field is selected, returns an empty array.