Skip to main content

FilterOptionViewModel

A filterable option that can be used to filter a data set.

Properties

Property Type Required Description
id string true

The ID of the filter option.

label string true

The human-readable label describing the filter option.

isAggregate boolean false

Whether the filter option is an aggregate (i.e. ‘all’ or a ‘total’) of the other filter options.

Example schema

{
  "id": "q1g3J",
  "label": "State-funded primary",
  "isAggregate": true
}