Skip to content
Permalink
Browse files

Replace geom parameter with geometry, for harmonization

  • Loading branch information
DelazJ authored and nyalldawson committed Jul 30, 2020
1 parent 813ee5a commit 490c8ff8d2cc2019717af8eb803c6ca8eb9d64fc
@@ -3,7 +3,7 @@
"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"} ],
"arguments": [ {"arg":"geometry","description":"a geometry"} ],
"examples": [ { "expression":"bounds($geometry)", "returns":"bounding box of $geometry"}]
}

@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the height of the bounding box of a geometry. Calculations are in the Spatial Reference System of this geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"bounds_height($geometry)", "returns":"height of bounding box of $geometry"}]
}

@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the width of the bounding box of a geometry. Calculations are in the Spatial Reference System of this geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"bounds_width($geometry)", "returns":"width of bounding box of $geometry"}]
}

@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns a geometry that represents all points whose distance from this geometry is less than or equal to distance. Calculations are in the Spatial Reference System of this geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"},
"arguments": [ {"arg":"geometry","description":"a geometry"},
{"arg":"distance","description":"buffer distance in layer units"},
{"arg":"segments","optional":true,"default":"8","description":"number of segments to use to represent a quarter circle when a round join style is used. A larger number results in a smoother buffer with more nodes."}],
"examples": [ { "expression":"buffer($geometry, 10.5)", "returns":"polygon of $geometry buffered by 10.5 units"}]
@@ -3,6 +3,6 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the geometric center of a geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"centroid($geometry)", "returns":"a point geometry"}]
}
@@ -3,6 +3,6 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns a line string representing the exterior ring of a polygon geometry. If the geometry is not a polygon then the result will be NULL.",
"arguments": [ {"arg":"geom","description":"a polygon geometry"}],
"arguments": [ {"arg":"geometry","description":"a polygon geometry"}],
"examples": [ { "expression":"geom_to_wkt(exterior_ring(geom_from_wkt('POLYGON((-1 -1, 4 0, 4 2, 0 2, -1 -1),( 0.1 0.1, 0.1 0.2, 0.2 0.2, 0.2, 0.1, 0.1 0.1))')))", "returns":"'LineString (-1 -1, 4 0, 4 2, 0 2, -1 -1)'"}]
}
@@ -4,7 +4,7 @@
"groups": ["GeometryGroup"],
"description": "Returns an extruded version of the input (Multi-)Curve or (Multi-)Linestring geometry with an extension specified by x and y.",
"arguments": [
{"arg":"geom","description":"a polygon geometry"},
{"arg":"geometry","description":"a polygon geometry"},
{"arg":"x","description":"x extension, numeric value"},
{"arg":"y","description":"y extension, numeric value"}
],
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns a copy of the geometry with the x and y coordinates swapped. Useful for repairing geometries which have had their latitude and longitude values reversed.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"geom_to_wkt(flip_coordinates(make_point(1, 2)))", "returns":"Point (2 1)"}
]
}
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Forces a geometry to respect the Right-Hand-Rule, in which the area that is bounded by a polygon is to the right of the boundary. In particular, the exterior ring is oriented in a clockwise direction and the interior rings in a counter-clockwise direction.",
"arguments": [ {"arg":"geom","description":"a geometry. Any non-polygon geometries are returned unchanged."}],
"arguments": [ {"arg":"geometry","description":"a geometry. Any non-polygon geometries are returned unchanged."}],
"examples": [ { "expression":"geom_to_wkt(force_rhr(geometry:=geom_from_wkt('POLYGON((-1 -1, 4 0, 4 2, 0 2, -1 -1))')))", "returns":"Polygon ((-1 -1, 0 2, 4 2, 4 0, -1 -1))"}]
}

@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns true if a line string is closed (start and end points are coincident), or false if a line string is not closed. If the geometry is not a line string then the result will be NULL.",
"arguments": [ {"arg":"geom","description":"a line string geometry"}],
"arguments": [ {"arg":"geometry","description":"a line string geometry"}],
"examples": [ { "expression":"is_closed(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)'))", "returns":"false"},
{ "expression":"is_closed(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2, 0 0)'))", "returns":"true"}]
}
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns true if a geometry is empty (without coordinates), false if the geometry is not empty and NULL if there is no geometry. See also is_empty_or_null.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"is_empty(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)'))", "returns":"false"},
{ "expression":"is_empty(geom_from_wkt('LINESTRING EMPTY'))", "returns":"true"},
{ "expression":"is_empty(geom_from_wkt('POINT(7 4)'))", "returns":"false"},
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns true if a geometry is NULL or empty (without coordinates) or false otherwise. This function is like the expression '$geometry IS NULL or is_empty($geometry)'",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"is_empty_or_null(NULL)", "returns":"true"},
{ "expression":"is_empty_or_null(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)'))", "returns":"false"},
{ "expression":"is_empty_or_null(geom_from_wkt('LINESTRING EMPTY'))", "returns":"true"},
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns true if a geometry is valid; if it is well-formed in 2D according to the OGC rules.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"is_valid(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2, 0 0)'))", "returns":"true"},
{ "expression":"is_valid(geom_from_wkt('LINESTRING(0 0)'))", "returns":"false"}]
}
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the m value of a point geometry.",
"arguments": [ {"arg":"geom","description":"a point geometry"}],
"arguments": [ {"arg":"geometry","description":"a point geometry"}],
"examples": [ { "expression":"m( geom_from_wkt( 'POINTM(2 5 4)' ) )", "returns":"4"}
]
}
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the number of vertices in a geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"num_points($geometry)", "returns":"number of vertices in $geometry"}]
}

@@ -4,7 +4,7 @@
"groups": ["GeometryGroup"],
"description": "Orders the parts of a MultiGeometry by a given criteria",
"arguments": [
{"arg":"geom","description":"a multi-type geometry"},
{"arg":"geometry","description":"a multi-type geometry"},
{"arg":"orderby","description":"an expression string defining the order criteria"},
{"arg":"ascending","description":"boolean, True for ascending, False for descending"}
],
@@ -3,6 +3,6 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns a point guaranteed to lie on the surface of a geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"point_on_surface($geometry)", "returns":"a point geometry"}]
}
@@ -3,6 +3,6 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Reverses the direction of a line string by reversing the order of its vertices.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"geom_to_wkt(reverse(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)')))", "returns":"'LINESTRING(2 2, 1 1, 0 0)'"}]
}
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns a rotated version of a geometry. Calculations are in the Spatial Reference System of this geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"},
"arguments": [ {"arg":"geometry","description":"a geometry"},
{"arg":"rotation","description":"clockwise rotation in degrees"},
{"arg":"point", "optional":true,"description":"rotation center point. If not specified, the center of the geometry's bounding box is used."}
],
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the geometry transformed from a source CRS to a destination CRS.",
"arguments": [ {"arg":"geom","description":"a geometry"},
"arguments": [ {"arg":"geometry","description":"a geometry"},
{"arg":"source_auth_id","description":"the source auth CRS ID"},
{"arg":"dest_auth_id","description":"the destination auth CRS ID"}
],
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns a translated version of a geometry. Calculations are in the Spatial Reference System of this geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"},
"arguments": [ {"arg":"geometry","description":"a geometry"},
{"arg":"dx","description":"delta x"},
{"arg":"dy","description":"delta y"}
],
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the x coordinate of a point geometry, or the x coordinate of the centroid for a non-point geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"x( geom_from_wkt( 'POINT(2 5)' ) )", "returns":"2"},
{ "expression":"x( $geometry )", "returns":"x coordinate of the current feature's centroid"}
]
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the maximum x coordinate of a geometry. Calculations are in the spatial reference system of this geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"x_max( geom_from_wkt( 'LINESTRING(2 5, 3 6, 4 8)') )", "returns":"4"}
]
}
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the minimum x coordinate of a geometry. Calculations are in the spatial reference system of this geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"x_min( geom_from_wkt( 'LINESTRING(2 5, 3 6, 4 8)') )", "returns":"2"}
]
}
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the y coordinate of a point geometry, or the y coordinate of the centroid for a non-point geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"y( geom_from_wkt( 'POINT(2 5)' ) )", "returns":"5"},
{ "expression":"y( $geometry )", "returns":"y coordinate of the current feature's centroid"}
]
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the maximum y coordinate of a geometry. Calculations are in the spatial reference system of this geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"y_max( geom_from_wkt( 'LINESTRING(2 5, 3 6, 4 8)') )", "returns":"8"}
]
}
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the minimum y coordinate of a geometry. Calculations are in the spatial reference system of this geometry.",
"arguments": [ {"arg":"geom","description":"a geometry"}],
"arguments": [ {"arg":"geometry","description":"a geometry"}],
"examples": [ { "expression":"y_min( geom_from_wkt( 'LINESTRING(2 5, 3 6, 4 8)') )", "returns":"5"}
]
}
@@ -3,7 +3,7 @@
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the z coordinate of a point geometry, or NULL if the geometry has no z value.",
"arguments": [ {"arg":"geom","description":"a point geometry"}],
"arguments": [ {"arg":"geometry","description":"a point geometry"}],
"examples": [ { "expression":"z( geom_from_wkt( 'POINTZ(2 5 7)' ) )", "returns":"7"}
]
}

0 comments on commit 490c8ff

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