Harrissou Sant-anna ae8ea31a0f More updates of expression help
- Expose default values of args
- Fix args name or description
- Fix/add more examples (to show various possibilities of a function or so
that functions that relate have examples that relate)
2020-08-21 13:02:35 +10:00

22 lines
826 B
Plaintext

{
"name": "extrude",
"type": "function",
"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":"geometry","description":"a polygon geometry"},
{"arg":"x","description":"x extension, numeric value"},
{"arg":"y","description":"y extension, numeric value"}
],
"examples": [
{
"expression":"geom_to_wkt(extrude(geom_from_wkt('LineString(1 2, 3 2, 4 3)'), 1, 2))",
"returns":"'Polygon ((1 2, 3 2, 4 3, 5 5, 4 4, 2 4, 1 2))'"
},
{
"expression":"geom_to_wkt(extrude(geom_from_wkt('MultiLineString((1 2, 3 2), (4 3, 8 3))'), 1, 2))",
"returns":"'MultiPolygon (((1 2, 3 2, 4 4, 2 4, 1 2)),((4 3, 8 3, 9 5, 5 5, 4 3)))'"
}
]
}