FieldFilterPickerGroup

Sets the text displayed in the 'add filter' button if one is present.

Optional array of field names that are allowed as selectable properties for filters. This should be a subset of the field names found in the store. When supplied, only the named fields will be shown in the property selector combo.

Optional predicate that returns whether a given filter can be deleted. When canDeleteFilter is provided, it will be called for each filter and will not show the delete button for those for which the function returns false.

Optional predicate that returns whether a given filter can be managed by this widget. When canManageFilter is provided, it will be used to decide whether to display filters found in the configured store.

The date format string used to display dates when using the 'is one of' / 'is not one of' operators with a date field. Defaults to the current locale's FieldFilterPicker.dateFormat value.

Whether the picker group is 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  : { text: 'Age', type: 'number' },
    role : { text: 'Role', type: 'string' }
}

Array of CollectionFilter configuration objects. One FieldFilterPicker will be created for each object in the array.

When store is provided, any filters in the store will be automatically added and do not need to be provided explicitly.

Example:

filters: [{
    // Filter properties should exist among field names configured
    // via `fields` or `store`
    property: 'age',
    operator: '<',
    value: 30
},{
    property: 'title',
    operator: 'startsWith',
    value: 'Director'
}]

Optional function that returns FieldFilterPicker configuration properties for a given filter. When getFieldFilterPickerConfig is provided, it will be called for each filter and the returned object will be merged with the configuration properties for the individual FieldFilterPicker representing that filter.

The supplied function should accept a single argument, the CollectionFilter whose picker is being created.

When limitToProperty is set to the name of an available field (as specified either explicitly in fields or implicitly in the store's model), it has the following effects:

• the picker group will only show filters defined on the specified property
• it will automatically set the property to the specified property for all newly added filters where the property is not already set
• the property selector is made read-only

When specified, overrides the built-in list of available operators. See operators.

Whether the picker group is read-only.

Example: fields: [ { name: 'age', type: 'number' }, { name: 'title', type: 'string' } ]

Show a button at the bottom of the group that adds a new, blank filter to the group.

The Store whose records will be filtered. The store's modelClass will be used to determine field types.

This store will be kept in sync with the filters defined in the picker group, and new filters added to the store via other means will appear in this filter group when they are able to be modified by it. (Some types of filters, like arbitrary filter functions, cannot be managed through this widget.)

As a corollary, multiple FieldFilterPickerGroups configured with the same store will stay in sync, showing the same filters as the store's filters change.

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.

Returns the array of filter configuration objects currently represented by this picker group.

Sets all current filters to enabled and checks their checkboxes.

Appends a filter at the bottom of the list.

Sets all current filters to disabled and clears their checkboxes.

Return the FieldFilterPicker for the filter at the specified index.

Get the configuration object for one child FieldFilterPicker.

Remove the filter at the given index.