Filters

Filters available

By default, Stack9 makes available all entity fields as filters.

Pinned filters

In the fields definition, set displayAsDefaultFilter as true to pin the field as filter when the page is loaded.

{
  "fields": [
    {
      "key": "name",
      "label": "Name",
      "type": "TextField",
      "behaviourOptions": {
        "displayAsDefaultFilter": true
      }
    }
  ]
}

Additional filters (Stack9-core v3.0)

When required to add fields from related entities, use addionalFilters configuration to make them available.

{
  "additionalFilters": [
    "user.email",
    "user.security_role.name",
    "user.is_blocked",
    "single_self_relationship_field.option_set",
  ]
}

note: the additional filter will inherit the properties from the related entity, if the field is set with displayAsDefaultFilter in the parent entity it will be displayed as default in the entity as well.