From d3a7826c0c667fd3312b1690cd26f9aaf9689d2a Mon Sep 17 00:00:00 2001 From: Sandro Santilli Date: Wed, 24 Jun 2009 13:04:16 +0000 Subject: [PATCH] Document third ST_Buffer signature (the one taking parameters as string). git-svn-id: http://svn.osgeo.org/postgis/trunk@4205 b70326c6-7e19-0410-871a-916f4a2858ee --- doc/reference.xml | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/doc/reference.xml b/doc/reference.xml index 2f54a2eef..5a6862f52 100644 --- a/doc/reference.xml +++ b/doc/reference.xml @@ -11457,9 +11457,8 @@ SELECT ST_Buffer(ST_GeomFromText('POINT(50 50)'), 20) As smallc, 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. The optional - third parameter sets the number of segments used to approximate a - quarter circle (defaults to 8). + are in the Spatial Reference System of this Geometry. + @@ -11477,6 +11476,13 @@ SELECT ST_Buffer(ST_GeomFromText('POINT(50 50)'), 20) As smallc, integer num_seg_quarter_circle + + geometry ST_Buffer + geometry g1 + float radius_of_buffer + string parameters + + @@ -11485,11 +11491,27 @@ SELECT ST_Buffer(ST_GeomFromText('POINT(50 50)'), 20) As smallc, 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. The optional - third parameter sets the number of segments used to approximate a - quarter circle (defaults to 8). + are in the Spatial Reference System of this Geometry. - Units are always measured in units of the spatial reference system. + +The optional third parameter can either specify number of segments used to approximate a quarter circle (integer case, defaults to 8) or a list of blank-separated key=value pairs (string case) to tweak operations as follows: + + +'quad_segs=#' : number of segments used to approximate a quarter circle (defaults to 8). + + +'endcap=round|flat|square' : endcap style (defaults to "round", needs GEOS-3.2 or higher for a different value). + + +'join=round|mitre|bevel' : join style (defaults to "round", needs GEOS-3.2 or higher for a different value). + + +'mitre_limit=#.#' : mitre ratio limit (only affects mitred join style). + + + + + Units of radius are measured in units of the spatial reference system. The inputs can be POINTS, MULTIPOINTS, LINESTRINGS, MULTILINESTRINGS, POLYGONS, MULTIPOLYGONS, and GeometryCollections. This function ignores the third dimension (z) and will always give a 2-d buffer even when presented with a 3d-geometry. -- 2.49.0