Skip to main content

FilterOptionChangesViewModel

A set of filter option changes and details of the filter they belong to.

Properties

Property Type Required Description
filter FilterViewModel true

The filter the option changes belong to.

options array (FilterOptionChangeViewModel) true

The list of filter option changes.

Example schema

{
  "filter": {
    "id": "BRlj4",
    "column": "school_type",
    "label": "School type",
    "hint": "Additional detail about the filter."
  },
  "options": [
    {
      "currentState": {
        "id": "q1g3J",
        "label": "State-funded primary",
        "isAggregate": true
      },
      "previousState": {
        "id": "q1g3J",
        "label": "State-funded primary",
        "isAggregate": true
      }
    }
  ]
}