[refFunctions] add help texts

qgis · Aug 20, 2020 · afd3c59 · afd3c59
1 parent a393ad9
commit afd3c59
Show file tree

Hide file tree

Showing 8 changed files with 330 additions and 2 deletions.
diff --git a/resources/function_help/json/geometry_overlay_contains b/resources/function_help/json/geometry_overlay_contains
@@ -1,8 +1,7 @@
 {
   "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": [
+  "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 CONTAINS the current feature, or, if no expression if provided, simply returns whether at least one feature from the other layer CONTAINS the current feature.",  "arguments": [
     {
       "arg": "layer",
       "description": "the other layer"
@@ -24,9 +23,21 @@
     }
   ],
   "examples": [
+    {
+      "expression": "geometry_overlay_contains('regions')",
+      "returns": "True"
+    },
     {
       "expression": "geometry_overlay_contains('regions', name)",
       "returns": "['South Africa', 'Africa', 'World']"
+    },
+    {
+      "expression": "geometry_overlay_contains('regions', name, name != 'World')",
+      "returns": "['South Africa', 'Africa']"
+    },
+    {
+      "expression": "geometry_overlay_contains('regions', name, limit:=1)",
+      "returns": "['South Africa']"
     }
   ]
 }
diff --git a/resources/function_help/json/geometry_overlay_crosses b/resources/function_help/json/geometry_overlay_crosses
@@ -0,0 +1,44 @@
+{
+  "name": "geometry_overlay_crosses",
+  "type": "function",
+  "description": "Performs a spatial join of type CROSSES. This returns an array of results of an expression evaluated on features from an other layer that CROSSES the current feature, or, if no expression if provided, simply returns whether at least one feature from the other layer CROSSES 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_crosses('regions')",
+      "returns": "True"
+    },
+    {
+      "expression": "geometry_overlay_crosses('regions', name)",
+      "returns": "['South Africa', 'Africa', 'World']"
+    },
+    {
+      "expression": "geometry_overlay_crosses('regions', name, name != 'World')",
+      "returns": "['South Africa', 'Africa']"
+    },
+    {
+      "expression": "geometry_overlay_crosses('regions', name, limit:=1)",
+      "returns": "['South Africa']"
+    }
+  ]
+}
diff --git a/resources/function_help/json/geometry_overlay_disjoint b/resources/function_help/json/geometry_overlay_disjoint
@@ -0,0 +1,44 @@
+{
+  "name": "geometry_overlay_disjoint",
+  "type": "function",
+    "description": "Performs a spatial join of type DISJOINT. This returns an array of results of an expression evaluated on features from an other layer that DISJOINT the current feature, or, if no expression if provided, simply returns whether at least one feature from the other layer DISJOINT 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_disjoint('regions')",
+      "returns": "True"
+    },
+    {
+      "expression": "geometry_overlay_disjoint('regions', name)",
+      "returns": "['South Africa', 'Africa', 'World']"
+    },
+    {
+      "expression": "geometry_overlay_disjoint('regions', name, name != 'World')",
+      "returns": "['South Africa', 'Africa']"
+    },
+    {
+      "expression": "geometry_overlay_disjoint('regions', name, limit:=1)",
+      "returns": "['South Africa']"
+    }
+  ]
+}
diff --git a/resources/function_help/json/geometry_overlay_equals b/resources/function_help/json/geometry_overlay_equals
@@ -0,0 +1,43 @@
+{
+  "name": "geometry_overlay_equals",
+  "type": "function",
+    "description": "Performs a spatial join of type EQUALS. This returns an array of results of an expression evaluated on features from an other layer that EQUALS the current feature, or, if no expression if provided, simply returns whether at least one feature from the other layer EQUALS 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_equals('regions')",
+      "returns": "True"
+    },
+    {
+      "expression": "geometry_overlay_equals('regions', name)",
+      "returns": "['South Africa', 'Africa', 'World']"
+    },
+    {
+      "expression": "geometry_overlay_equals('regions', name, name != 'World')",
+      "returns": "['South Africa', 'Africa']"
+    },
+    {
+      "expression": "geometry_overlay_equals('regions', name, limit:=1)",
+      "returns": "['South Africa']"
+    }
+  ]
+}
diff --git a/resources/function_help/json/geometry_overlay_intersects b/resources/function_help/json/geometry_overlay_intersects
@@ -0,0 +1,44 @@
+{
+  "name": "geometry_overlay_intersects",
+  "type": "function",
+    "description": "Performs a spatial join of type INTERSECTS. This returns an array of results of an expression evaluated on features from an other layer that INTERSECTS the current feature, or, if no expression if provided, simply returns whether at least one feature from the other layer INTERSECTS 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_intersects('regions')",
+      "returns": "True"
+    },
+    {
+      "expression": "geometry_overlay_intersects('regions', name)",
+      "returns": "['South Africa', 'Africa', 'World']"
+    },
+    {
+      "expression": "geometry_overlay_intersects('regions', name, name != 'World')",
+      "returns": "['South Africa', 'Africa']"
+    },
+    {
+      "expression": "geometry_overlay_intersects('regions', name, limit:=1)",
+      "returns": "['South Africa']"
+    }
+  ]
+}
diff --git a/resources/function_help/json/geometry_overlay_nearest b/resources/function_help/json/geometry_overlay_nearest
@@ -0,0 +1,54 @@
+{
+  "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']"
+    }
+  ]
+}
diff --git a/resources/function_help/json/geometry_overlay_touches b/resources/function_help/json/geometry_overlay_touches
@@ -0,0 +1,44 @@
+{
+  "name": "geometry_overlay_touches",
+  "type": "function",
+    "description": "Performs a spatial join of type TOUCHES. This returns an array of results of an expression evaluated on features from an other layer that TOUCHES the current feature, or, if no expression if provided, simply returns whether at least one feature from the other layer TOUCHES 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_touches('regions')",
+      "returns": "True"
+    },
+    {
+      "expression": "geometry_overlay_touches('regions', name)",
+      "returns": "['South Africa', 'Africa', 'World']"
+    },
+    {
+      "expression": "geometry_overlay_touches('regions', name, name != 'World')",
+      "returns": "['South Africa', 'Africa']"
+    },
+    {
+      "expression": "geometry_overlay_touches('regions', name, limit:=1)",
+      "returns": "['South Africa']"
+    }
+  ]
+}
diff --git a/resources/function_help/json/geometry_overlay_within b/resources/function_help/json/geometry_overlay_within
@@ -0,0 +1,44 @@
+{
+  "name": "geometry_overlay_within",
+  "type": "function",
+    "description": "Performs a spatial join of type WITHIN. This returns an array of results of an expression evaluated on features from an other layer that are WITHIN the current feature, or, if no expression if provided, simply returns whether at least one feature from the other layer is WITHIN 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_within('regions')",
+      "returns": "True"
+    },
+    {
+      "expression": "geometry_overlay_within('regions', name)",
+      "returns": "['South Africa', 'Africa', 'World']"
+    },
+    {
+      "expression": "geometry_overlay_within('regions', name, name != 'World')",
+      "returns": "['South Africa', 'Africa']"
+    },
+    {
+      "expression": "geometry_overlay_within('regions', name, limit:=1)",
+      "returns": "['South Africa']"
+    }
+  ]
+}