Skip to content
Permalink
Browse files

[refFunctions] (initial help text)

  • Loading branch information
olivierdalang committed Aug 20, 2020
1 parent 86deebd commit d4f8e2c21f74dc87956984b3053f52b075ac8359
Showing with 32 additions and 0 deletions.
  1. +32 −0 resources/function_help/json/geometry_overlay_contains
@@ -0,0 +1,32 @@
{
"name": "geometry_overlay_contains",
"type": "function",
"description": "Performs a spatial join of type CONTAINS. This returns an array of results of an expression evaluated on features from an other layer that CONTAIN the current feature.",
"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
}
],
"examples": [
{
"expression": "geometry_overlay_contains('regions', name)",
"returns": "['South Africa', 'Africa', 'World']"
}
]
}

0 comments on commit d4f8e2c

Please sign in to comment.
You can’t perform that action at this time.