Skip to content
Permalink
Browse files

Add groups to function_help files

  • Loading branch information
SrNetoChan authored and nyalldawson committed Jul 2, 2020
1 parent e170b71 commit d097adeacd828d0c66df4afccb642d6ebecec0f4
Showing 314 changed files with 314 additions and 0 deletions.
@@ -1,6 +1,7 @@
{
"name": "$area",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the area of the current feature. The area calculated by this function respects both the current project's ellipsoid setting and area unit settings. For example, if an ellipsoid has been set for the project then the calculated area will be ellipsoidal, and if no ellipsoid is set then the calculated area will be planimetric.",
"examples": [ { "expression":"$area", "returns":"42"}]
}
@@ -1,6 +1,7 @@
{
"name": "$currentfeature",
"type": "function",
"groups": ["Record and Attributes"],
"description": "Returns the current feature being evaluated. This can be used with the 'attribute' function to evaluate attribute values from the current feature.",
"examples": [
{ "expression":"attribute( $currentfeature, 'name' )", "returns":"value stored in 'name' attribute for the current feature"}
@@ -1,6 +1,7 @@
{
"name": "$geometry",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the geometry of the current feature. Can be used for processing with other functions.",
"examples": [ { "expression":"geomToWKT( $geometry )", "returns":"POINT(6 50)"}
]
@@ -1,6 +1,7 @@
{
"name": "$id",
"type": "function",
"groups": ["Record and Attributes"],
"description": "Returns the feature id of the current row.",
"examples": [ { "expression":"$id", "returns":"42"}
]
@@ -1,6 +1,7 @@
{
"name": "$length",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the length of a linestring. If you need the length of a border of a polygon, use $perimeter instead. The length calculated by this function respects both the current project's ellipsoid setting and distance unit settings. For example, if an ellipsoid has been set for the project then the calculated length will be ellipsoidal, and if no ellipsoid is set then the calculated length will be planimetric.",
"examples": [
{ "expression":"$length", "returns":"42.4711"}
@@ -1,6 +1,7 @@
{
"name": "$perimeter",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the perimeter length of the current feature. The perimeter calculated by this function respects both the current project's ellipsoid setting and distance unit settings. For example, if an ellipsoid has been set for the project then the calculated perimeter will be ellipsoidal, and if no ellipsoid is set then the calculated perimeter will be planimetric.",
"examples": [ { "expression":"$perimeter", "returns":"42"}
]
@@ -1,6 +1,7 @@
{
"name": "$scale",
"type": "function",
"groups": ["deprecated"],
"description": "Returns the current scale denominator of the map canvas.<br><br>Note: This function is only available in some contexts and will be 0 otherwise.",
"examples": [
{ "expression":"$scale", "returns":"10000"}
@@ -1,6 +1,7 @@
{
"name": "$x",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the x coordinate of the current feature.",
"examples": [ { "expression":"$x", "returns":"42"}
]
@@ -1,6 +1,7 @@
{
"name": "$x_at",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Retrieves a x coordinate of the current feature's geometry.",
"arguments": [ {"arg":"i","description":"index of point of a line (indices start at 0; negative values apply from the last index, starting at -1)"}],
"examples": [ { "expression":"$x_at(1)", "returns":"5"}
@@ -1,6 +1,7 @@
{
"name": "$y",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the y coordinate of the current feature.",
"examples": [ { "expression":"$y", "returns":"42"}
]
@@ -1,6 +1,7 @@
{
"name": "$y_at",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Retrieves a y coordinate of the current feature's geometry.",
"arguments": [ {"arg":"i","description":"index of point of a line (indices start at 0; negative values apply from the last index, starting at -1)"}],
"examples": [ { "expression":"$y_at(1)", "returns":"2"}
@@ -1,6 +1,7 @@
{
"name": "abs",
"type": "function",
"groups": ["Math"],
"description": "Returns the absolute value of a number.",
"arguments": [ {"arg":"value","description":"a number"}],
"examples": [ { "expression":"abs(-2)", "returns":"2"}]
@@ -1,6 +1,7 @@
{
"name": "acos",
"type": "function",
"groups": ["Math"],
"description": "Returns the inverse cosine of a value in radians.",
"arguments": [ {"arg":"value","description":"cosine of an angle in radians"} ],
"examples": [ { "expression":"acos(0.5)", "returns":"1.0471975511966"}]
@@ -1,6 +1,7 @@
{
"name": "age",
"type": "function",
"groups": ["Date and Time"],
"description": "Returns the difference between two dates or datetimes.<br>The difference is returned as a <code>Interval</code> and needs to be used with one of the following functions in order to extract useful information:<br /><ul><li><code>year</code><li><code>month</code><li><code>week</code><li><code>day</code><li><code>hour</code><li><code>minute</code><li><code>second</code></ul>",
"arguments": [ {"arg":"datetime1","description":"a string, date or datetime representing the later date"},
{"arg":"datetime2","description":"a string, date or datetime representing the earlier date"}],
@@ -1,6 +1,7 @@
{
"name": "aggregate",
"type": "function",
"groups": ["Aggregates"],
"description": "Returns an aggregate value calculated using features from another layer.",
"arguments": [
{"arg":"layer", "description":"a string, representing either a layer name or layer ID"},
@@ -1,6 +1,7 @@
{
"name": "angle_at_vertex",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the bisector angle (average angle) to the geometry for a specified vertex on a linestring geometry. Angles are in degrees clockwise from north.",
"arguments": [ {"arg":"geometry","description":"a linestring geometry"},
{"arg":"vertex","description":"vertex index, starting from 0; if the value is negative, the selected vertex index will be its total count minus the absolute value"}],
@@ -1,6 +1,7 @@
{
"name": "area",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the area of a geometry polygon object. Calculations are always planimetric in the Spatial Reference System (SRS) of this geometry, and the units of the returned area will match the units for the SRS. This differs from the calculations performed by the $area function, which will perform ellipsoidal calculations based on the project's ellipsoid and area unit settings.",
"arguments": [ {"arg":"geometry","description":"polygon geometry object"}],
"examples": [ { "expression":"area(geom_from_wkt('POLYGON((0 0, 4 0, 4 2, 0 2, 0 0))'))", "returns":"8.0"}]
@@ -1,6 +1,7 @@
{
"name": "array",
"type": "function",
"groups": ["Arrays"],
"description": "Returns an array containing all the values passed as parameter.",
"variableLenArguments": true,
"arguments": [
@@ -1,6 +1,7 @@
{
"name": "array_agg",
"type": "function",
"groups": ["Aggregates"],
"description": "Returns an array of aggregated values from a field or expression.",
"arguments": [
{"arg": "expression", "description": "sub expression of field to aggregate"},
@@ -1,6 +1,7 @@
{
"name": "array_all",
"type": "function",
"groups": ["Arrays"],
"description": "Returns true if an array contains all the values of a given array.",
"arguments": [ {"arg":"array_a","description":"an array"},
{"arg":"array_b","description":"the array of values to search"}],
@@ -1,6 +1,7 @@
{
"name": "array_append",
"type": "function",
"groups": ["Arrays"],
"description": "Returns an array with the given value added at the end.",
"arguments": [ {"arg":"array","description":"an array"},
{"arg":"value","description":"the value to add"}],
@@ -1,6 +1,7 @@
{
"name": "array_cat",
"type": "function",
"groups": ["Arrays"],
"description": "Returns an array containing all the given arrays concatenated.",
"variableLenArguments": true,
"arguments": [
@@ -1,6 +1,7 @@
{
"name": "array_contains",
"type": "function",
"groups": ["Arrays"],
"description": "Returns true if an array contains the given value.",
"arguments": [ {"arg":"array","description":"an array"},
{"arg":"value","description":"the value to search"}],
@@ -1,6 +1,7 @@
{
"name": "array_distinct",
"type": "function",
"groups": ["Arrays"],
"description": "Returns an array containing distinct values of the given array.",
"arguments": [
{"arg":"array","description":"an array"}],
@@ -1,6 +1,7 @@
{
"name": "array_filter",
"type": "function",
"groups": ["Arrays"],
"description": "Returns an array with only the items for which the expression evaluates to true.",
"arguments": [
{"arg":"array","description":"an array"},
@@ -1,6 +1,7 @@
{
"name": "array_find",
"type": "function",
"groups": ["Arrays"],
"description": "Returns the index (0 for the first one) of a value within an array. Returns -1 if the value is not found.",
"arguments": [ {"arg":"array","description":"an array"},
{"arg":"value","description":"the value to search"}],
@@ -1,6 +1,7 @@
{
"name": "array_first",
"type": "function",
"groups": ["Arrays"],
"description": "Returns the first value of an array.",
"arguments": [ {"arg":"array","description":"an array"} ],
"examples": [ { "expression":"array_first(array('a','b','c'))", "returns":"'a'"}]
@@ -1,6 +1,7 @@
{
"name": "array_foreach",
"type": "function",
"groups": ["Arrays"],
"description": "Returns an array with the given expression evaluated on each item.",
"arguments": [
{"arg":"array","description":"an array"},
@@ -1,6 +1,7 @@
{
"name": "array_get",
"type": "function",
"groups": ["Arrays"],
"description": "Returns the Nth value (0 for the first one) of an array.",
"arguments": [ {"arg":"array","description":"an array"},
{"arg":"index","description":"the index to get (0 based)"}],
@@ -1,6 +1,7 @@
{
"name": "array_insert",
"type": "function",
"groups": ["Arrays"],
"description": "Returns an array with the given value added at the given position.",
"arguments": [ {"arg":"array","description":"an array"},
{"arg":"pos","description":"the position where to add (0 based)"},
@@ -1,6 +1,7 @@
{
"name": "array_intersect",
"type": "function",
"groups": ["Arrays"],
"description": "Returns true if at least one element of array1 exists in array2.",
"arguments": [ {"arg":"array1","description":"an array"},
{"arg":"array2","description":"another array"}],
@@ -1,6 +1,7 @@
{
"name": "array_last",
"type": "function",
"groups": ["Arrays"],
"description": "Returns the last value of an array.",
"arguments": [ {"arg":"array","description":"an array"} ],
"examples": [ { "expression":"array_last(array('a','b','c'))", "returns":"'c'"}]
@@ -1,6 +1,7 @@
{
"name": "array_length",
"type": "function",
"groups": ["Arrays"],
"description": "Returns the number of elements of an array.",
"arguments": [ {"arg":"array","description":"an array"}],
"examples": [ { "expression":"array_length(array(1,2,3))", "returns":"3"}]
@@ -1,6 +1,7 @@
{
"name": "array_prepend",
"type": "function",
"groups": ["Arrays"],
"description": "Returns an array with the given value added at the beginning.",
"arguments": [ {"arg":"array","description":"an array"},
{"arg":"value","description":"the value to add"}],
@@ -1,6 +1,7 @@
{
"name": "array_remove_all",
"type": "function",
"groups": ["Arrays"],
"description": "Returns an array with all the entries of the given value removed.",
"arguments": [ {"arg":"array","description":"an array"},
{"arg":"value","description":"the values to remove"}],
@@ -1,6 +1,7 @@
{
"name": "array_remove_at",
"type": "function",
"groups": ["Arrays"],
"description": "Returns an array with the given index removed.",
"arguments": [ {"arg":"array","description":"an array"},
{"arg":"pos","description":"the position to remove (0 based)"}],
@@ -1,6 +1,7 @@
{
"name": "array_reverse",
"type": "function",
"groups": ["Arrays"],
"description": "Returns the given array with array values in reversed order.",
"arguments": [ {"arg":"array","description":"an array"} ],
"examples": [ { "expression":"array_reverse(array(2,4,0,10))", "returns":"[ 10, 0, 4, 2 ]"}]
@@ -1,6 +1,7 @@
{
"name": "array_slice",
"type": "function",
"groups": ["Arrays"],
"description": "Returns a portion of the array. The slice is defined by the start_pos and end_pos arguments.",
"arguments": [{
"arg": "array",
@@ -1,6 +1,7 @@
{
"name": "array_sort",
"type": "function",
"groups": ["Arrays"],
"description": "Returns the provided array with its elements sorted.",
"arguments": [ {"arg":"array","description":"an array"},
{"arg":"ascending","optional":true,"default":"true","description":"set this parameter to false to sort the array in descending order"}],
@@ -1,6 +1,7 @@
{
"name": "array_to_string",
"type": "function",
"groups": ["Arrays"],
"description": "Concatenates array elements into a string separated by a delimiter and using optional string for empty values.",
"arguments": [
{"arg":"array", "description":"the input array"},
@@ -1,6 +1,7 @@
{
"name": "ascii",
"type": "function",
"groups": ["String"],
"description": "Returns the unicode code associated with the first character of a string.",
"arguments": [ {"arg":"string","description":"the string to convert to unicode code"}],
"examples": [ { "expression":"ascii('Q')", "returns":"81"} ]
@@ -1,6 +1,7 @@
{
"name": "asin",
"type": "function",
"groups": ["Math"],
"description": "Returns the inverse sine of a value in radians.",
"arguments": [ {"arg":"value","description":"sine of an angle in radians"}],
"examples": [ { "expression":"asin(1.0)", "returns":"1.5707963267949"}]
@@ -1,6 +1,7 @@
{
"name": "atan",
"type": "function",
"groups": ["Math"],
"description": "Returns the inverse tangent of a value in radians.",
"arguments": [ {"arg":"value","description":"tan of an angle in radians"}],
"examples": [ { "expression":"atan(0.5)", "returns":"0.463647609000806"}]
@@ -1,6 +1,7 @@
{
"name": "atan2",
"type": "function",
"groups": ["Math"],
"description": "Returns the inverse tangent of dy/dx by using the signs of the two arguments to determine the quadrant of the result.",
"arguments": [ {"arg":"dy","description":"y coordinate difference"},
{"arg":"dx","description":"x coordinate difference"}],
@@ -1,6 +1,7 @@
{
"name": "attribute",
"type": "function",
"groups": ["Record and Attributes"],
"description": "Returns an attribute from a feature.",
"variants": [
{ "variant": "Variant 1",
@@ -1,6 +1,7 @@
{
"name": "attributes",
"type": "function",
"groups": ["Record and Attributes"],
"description": "Returns a map containing all attributes from a feature, with field names as map keys.",
"variants": [
{ "variant": "Variant 1",
@@ -1,6 +1,7 @@
{
"name": "azimuth",
"type": "function",
"groups": ["Math", "GeometryGroup"],
"description": "Returns the north-based azimuth as the angle in radians measured clockwise from the vertical on point_a to point_b.",
"arguments": [
{"arg":"point_a","description":"point geometry"},
@@ -1,6 +1,7 @@
{
"name": "base_file_name",
"type": "function",
"groups": ["Files and Paths"],
"description": "Returns the base name of the file without the directory or file suffix.",
"arguments": [ {"arg":"path","description":"a file path"}],
"examples": [ { "expression":"base_file_name('/home/qgis/data/country_boundaries.shp')", "returns":"'country_boundaries'"}]
@@ -1,6 +1,7 @@
{
"name": "boundary",
"type": "function",
"groups": ["GeometryGroup"],
"description":"Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon. Some geometry types do not have a defined boundary, e.g., points or geometry collections, and will return null.",
"arguments": [ {"arg":"geometry","description":"a geometry"} ],
"examples": [ { "expression":"geom_to_wkt(boundary(geom_from_wkt('Polygon((1 1, 0 0, -1 1, 1 1))')))", "returns":"'LineString(1 1,0 0,-1 1,1 1)'"}]
@@ -1,6 +1,7 @@
{
"name": "bounds",
"type": "function",
"groups": ["GeometryGroup"],
"description":"Returns a geometry which represents the bounding box of an input geometry. Calculations are in the Spatial Reference System of this geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"} ],
"examples": [ { "expression":"bounds($geometry)", "returns":"bounding box of $geometry"}]

0 comments on commit d097ade

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