Skip to content
Permalink
Browse files

Merge pull request #38405 from olivierdalang/refFunctionsRebase

[feature][expression] refFunction port to core
  • Loading branch information
m-kuhn committed Sep 11, 2020
2 parents 24a605a + 6f759f3 commit a46acb416976c8eae0e2b8be2f4ac1ff10a0883b
@@ -0,0 +1,49 @@
{
"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 a different 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"
},
{
"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": "cache",
"description": "set this to true to build a local spatial index (most of the time, this is unwanted, unless you are working with a particularly slow data provider)",
"optional": true,
"default": false
}
],
"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']"
}
]
}
@@ -0,0 +1,50 @@
{
"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 a different 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
},
{
"arg": "cache",
"description": "set this to true to build a local spatial index (most of the time, this is unwanted, unless you are working with a particularly slow data provider)",
"optional": true,
"default": false
}
],
"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']"
}
]
}
@@ -0,0 +1,50 @@
{
"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 a different 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
},
{
"arg": "cache",
"description": "set this to true to build a local spatial index (most of the time, this is unwanted, unless you are working with a particularly slow data provider)",
"optional": true,
"default": false
}
],
"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']"
}
]
}
@@ -0,0 +1,49 @@
{
"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 a different 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
},
{
"arg": "cache",
"description": "set this to true to build a local spatial index (most of the time, this is unwanted, unless you are working with a particularly slow data provider)",
"optional": true,
"default": false
}
],
"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']"
}
]
}
@@ -0,0 +1,50 @@
{
"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 a different 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
},
{
"arg": "cache",
"description": "set this to true to build a local spatial index (most of the time, this is unwanted, unless you are working with a particularly slow data provider)",
"optional": true,
"default": false
}
],
"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']"
}
]
}
@@ -0,0 +1,55 @@
{
"name": "geometry_overlay_nearest",
"type": "function",
"description": "This returns an array of results of an expression evaluated on features from a different layer ordered BY DISTANCE to the current feature, or, if no expression if provided, simply returns whether at least one feature from the other layer was found. Note : this function can be slow and consume a lot of memory for large layers.",
"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, only the nearest feature will be returned)",
"optional": true
},
{
"arg": "max_distance",
"description": "an optional maximum distance to limit the number of matching features (if not set, only the nearest feature will be returned)",
"optional": true
},
{
"arg": "cache",
"description": "set this to true to build a local spatial index (most of the time, this is unwanted, unless you are working with a particularly slow data provider)",
"optional": true,
"default": false
}
],
"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']"
}
]
}
@@ -0,0 +1,50 @@
{
"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 a different 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
},
{
"arg": "cache",
"description": "set this to true to build a local spatial index (most of the time, this is unwanted, unless you are working with a particularly slow data provider)",
"optional": true,
"default": false
}
],
"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']"
}
]
}

0 comments on commit a46acb4

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