@vertigis/viewer-spec/messaging/schema/web-filter-builder-command-definitions.md

VertiGIS Viewer Specification

# command: filter-builder.display-filter
Description: Sets the current filter criteria in the filter builder and also activates the component. Web only.

Inputs: `SetFilterArgs`

SetFilterArgs properties:
```json
{
  "filterBuilder": {
    "description": "The filter builder component that will be targeted. If not specified, all active filter builder components in the layout will be targeted."
  },
  "layers": {
    "description": "Alias of `source`, to facilitate command chaining. If multiple layers are present, only the first will be used as the source. One of `source` or `layers` is required."
  },
  "source": {
    "description": "The feature source to filter. One of `source` or `layers` is required."
  },
  "where": {
    "description": "The where clause to filter by.",
    "type": "string"
  }
}
```

---
# command: filter-builder.set-filter
Description: Sets the current filter criteria in the filter builder. Web only.

Inputs: `SetFilterArgs`

SetFilterArgs properties:
```json
{
  "filterBuilder": {
    "description": "The filter builder component that will be targeted. If not specified, all active filter builder components in the layout will be targeted."
  },
  "layers": {
    "description": "Alias of `source`, to facilitate command chaining. If multiple layers are present, only the first will be used as the source. One of `source` or `layers` is required."
  },
  "source": {
    "description": "The feature source to filter. One of `source` or `layers` is required."
  },
  "where": {
    "description": "The where clause to filter by.",
    "type": "string"
  }
}
```

---