QGIS/resources/function_help/json/geometry_overlay_nearest

{
  "name": "geometry_overlay_nearest",
  "type": "function",
  "description": "TODO",
  "arguments": [
    {
      "arg": "layer",
      "description": "the other layer"
    },
    {
      "arg": "expression",
      "description": "an optional expression to evaluate on the features from the other layer (if not set, the function will just return a boolean indicating whether there is at least one match)",
      "optional": true
    },
    {
      "arg": "filter",
      "description": "an optional expression to filter the matching features (if not set, all features will be returned)",
      "optional": true
    },
    {
      "arg": "limit",
      "description": "an optional integer to limit the number of matching features (if not set, all features will be returned)",
      "optional": true
    },
    {
      "arg": "neighbour",
      "description": "TODO",
      "optional": true
    },
    {
      "arg": "max_distance",
      "description": "TODO",
      "optional": true
    }
  ],
  "examples": [
    {
      "expression": "geometry_overlay_nearest('regions')",
      "returns": "True"
    },
    {
      "expression": "geometry_overlay_nearest('regions', name)",
      "returns": "['South Africa', 'Africa', 'World']"
    },
    {
      "expression": "geometry_overlay_nearest('regions', name, name != 'World')",
      "returns": "['South Africa', 'Africa']"
    },
    {
      "expression": "geometry_overlay_nearest('regions', name, limit:=1)",
      "returns": "['South Africa']"
    }
  ]
}