Skip to main content

GeomWithin

How to use the GeomWithin operator​

The Geomwithin operator returns the items for which the specified geometry attribute is within the provided geometry (GeoJSON Specifications) in its entirety.

Allowed Children​

Attributes nodes of type geometry and Geometry nodes

Requirements​

Must have 2 children of geometry type, one on the item and one as a primitive

Return Type​

Item Ids Set

Example: Simple polygon query​

Find items with a geometry attribute that are within a specified polygon:

{
  "type": "Query",
  "properties": {
    "dodiCode": "designs_exampleJobs",
    "attributes": ["all"]
  },
  "children": [
    {
      "type": "GeomWithin",
      "children": [
        {
          "type": "Attribute",
          "properties": {
            "attributeCode": "attributes_jobsSiteLocation"
          }
        },
        {
          "type": "Geometry",
          "properties": {
            "value": {
              "type": "Polygon",
              "coordinates": [
                [
                  [10, 12],
                  [12, 12],
                  [12, 10],
                  [10, 10]
                ]
              ]
            }
          }
        }
      ]
    }
  ]
}