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

VertiGIS Viewer Specification

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

**Example:** Query within an extent, selecting the layer to query by title.

```
{
    "geometry": {
        "xmin": 13871520.850500003,
        "ymin": 3910293.086000003,
        "xmax": 14574034.873400003,
        "ymax": 4686306.161399998,
        "spatialReference": {
            "wkid": 102100,
            "latestWkid": 3857
        }
    },
    "layers": {
        "title": "Buildings"
    },
    "where": "FULL_ADDR = '900 GOVERNMENT ST'"
}
```

Inputs: `SetQueryArgs`

SetQueryArgs properties:
```json
{
  "geometry": {
    "description": "If specified, limits the results to ones that intersect the given geometry. If both `geometry` and `graphics` are specified, only `graphics` will be used."
  },
  "graphics": {
    "description": "Alias of `geometry`, to facilitate command chaining. If both `geometry` and `graphics` are specified, only `graphics` will be used."
  },
  "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."
  },
  "queryBuilder": {
    "description": "The query builder component that will be targeted. If not specified, all active query builder components in the layout will be targeted."
  },
  "source": {
    "description": "The feature source to query. One of `source` or `layers` is required."
  },
  "where": {
    "description": "The where clause to query by.",
    "type": "string"
  }
}
```

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

Inputs: `SetQueryArgs`

SetQueryArgs properties:
```json
{
  "geometry": {
    "description": "If specified, limits the results to ones that intersect the given geometry. If both `geometry` and `graphics` are specified, only `graphics` will be used."
  },
  "graphics": {
    "description": "Alias of `geometry`, to facilitate command chaining. If both `geometry` and `graphics` are specified, only `graphics` will be used."
  },
  "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."
  },
  "queryBuilder": {
    "description": "The query builder component that will be targeted. If not specified, all active query builder components in the layout will be targeted."
  },
  "source": {
    "description": "The feature source to query. One of `source` or `layers` is required."
  },
  "where": {
    "description": "The where clause to query by.",
    "type": "string"
  }
}
```

---