You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/src/functions/scalar/st_buffer.md
+42-1
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,35 @@
33
33
"type": "INTEGER"
34
34
}
35
35
]
36
+
},
37
+
{
38
+
"returns": "GEOMETRY",
39
+
"parameters": [
40
+
{
41
+
"name": "geom",
42
+
"type": "GEOMETRY"
43
+
},
44
+
{
45
+
"name": "distance",
46
+
"type": "DOUBLE"
47
+
},
48
+
{
49
+
"name": "num_triangles",
50
+
"type": "INTEGER"
51
+
},
52
+
{
53
+
"name": "cap_style",
54
+
"type": "STRING"
55
+
}
56
+
{
57
+
"name": "join_style",
58
+
"type": "STRING"
59
+
}
60
+
{
61
+
"name": "mitre_limit",
62
+
"type": "DOUBLE"
63
+
}
64
+
]
36
65
}
37
66
],
38
67
"summary": "Returns a buffer around the input geometry at the target distance"
@@ -41,7 +70,19 @@
41
70
42
71
### Description
43
72
44
-
TODO
73
+
`geom` is the input geometry.
74
+
75
+
`distance` is the target distance for the buffer, using the same units as the input geometry.
76
+
77
+
`num_triangles` represents how many triangles that will be produced to approximate a quarter circle. The larger the number, the smoother the resulting geometry. The default value is 8.
78
+
79
+
`join_style` must be one of "JOIN_ROUND", "JOIN_MITRE", "JOIN_BEVEL". This parameter is case-insensitive.
80
+
81
+
`cap_style` must be one of "CAP_ROUND", "CAP_FLAT", "CAP_SQUARE". This parameter is case-insensitive.
82
+
83
+
`mite_limit` only applies when `join_style` is "JOIN_MITRE". It is the ratio of the distance from the corner to the miter point to the corner radius. The default value is 1.0.
84
+
85
+
This is a planar operation and will not take into account the curvature of the earth.
0 commit comments