diff --git a/docs/ref/contrib/gis/functions.txt b/docs/ref/contrib/gis/functions.txt index fe8239d4675..84f699f9cb2 100644 --- a/docs/ref/contrib/gis/functions.txt +++ b/docs/ref/contrib/gis/functions.txt @@ -38,8 +38,9 @@ Measurement Relationships Operations Editors .. class:: Area(expression, **extra) -*Availability*: MySQL, Oracle, -`PostGIS `__, SpatiaLite +*Availability*: `MySQL +`__, +Oracle, `PostGIS `__, SpatiaLite Accepts a single geographic field or expression and returns the area of the field as an :class:`~django.contrib.gis.measure.Area` measure. @@ -52,8 +53,9 @@ geographic SRSes. .. class:: AsGeoJSON(expression, bbox=False, crs=False, precision=8, **extra) -*Availability*: MySQL (≥ 5.7.5), `PostGIS -`__, SpatiaLite +*Availability*: `MySQL +`__ (≥ 5.7.5), +`PostGIS `__, SpatiaLite Accepts a single geographic field or expression and returns a `GeoJSON `_ representation of the geometry. Note that the result is @@ -198,8 +200,9 @@ The ``num_seg`` parameter is used only on PostGIS. .. class:: Centroid(expression, **extra) -*Availability*: MySQL, `PostGIS `__, -Oracle, SpatiaLite +*Availability*: `MySQL +`__, +`PostGIS `__, Oracle, SpatiaLite Accepts a single geographic field or expression and returns the ``centroid`` value of the geometry. @@ -209,8 +212,9 @@ value of the geometry. .. class:: Difference(expr1, expr2, **extra) -*Availability*: MySQL, `PostGIS -`__, Oracle, SpatiaLite +*Availability*: `MySQL +`__, +`PostGIS `__, Oracle, SpatiaLite Accepts two geographic fields or expressions and returns the geometric difference, that is the part of geometry A that does not intersect with @@ -221,8 +225,9 @@ geometry B. .. class:: Distance(expr1, expr2, spheroid=None, **extra) -*Availability*: MySQL, `PostGIS `__, -Oracle, SpatiaLite +*Availability*: `MySQL +`__, +`PostGIS `__, Oracle, SpatiaLite Accepts two geographic fields or expressions and returns the distance between them, as a :class:`~django.contrib.gis.measure.Distance` object. On MySQL, a raw @@ -266,8 +271,9 @@ queryset is calculated:: .. class:: Envelope(expression, **extra) -*Availability*: MySQL, `PostGIS `__, -SpatiaLite +*Availability*: `MySQL +`__, +`PostGIS `__, SpatiaLite Accepts a single geographic field or expression and returns the geometry representing the bounding box of the geometry. @@ -306,8 +312,9 @@ right-hand rule. .. class:: GeoHash(expression, precision=None, **extra) -*Availability*: MySQL (≥ 5.7.5), `PostGIS -`__, SpatiaLite (LWGEOM) +*Availability*: `MySQL +`__ (≥ 5.7.5), +`PostGIS `__, SpatiaLite (LWGEOM) Accepts a single geographic field or expression and returns a `GeoHash`__ representation of the geometry. @@ -326,8 +333,9 @@ __ https://en.wikipedia.org/wiki/Geohash .. class:: Intersection(expr1, expr2, **extra) -*Availability*: MySQL, `PostGIS -`__, Oracle, SpatiaLite +*Availability*: `MySQL +`__, +`PostGIS `__, Oracle, SpatiaLite Accepts two geographic fields or expressions and returns the geometric intersection between them. @@ -337,8 +345,9 @@ intersection between them. .. class:: IsValid(expr) -*Availability*: MySQL (≥ 5.7.5), `PostGIS -`__, Oracle, SpatiaLite (LWGEOM) +*Availability*: `MySQL +`__ (≥ 5.7.5), +`PostGIS `__, Oracle, SpatiaLite (LWGEOM) Accepts a geographic field or expression and tests if the value is well formed. Returns ``True`` if its value is a valid geometry and ``False`` otherwise. @@ -352,8 +361,9 @@ Returns ``True`` if its value is a valid geometry and ``False`` otherwise. .. class:: Length(expression, spheroid=True, **extra) -*Availability*: MySQL, Oracle, `PostGIS -`__, SpatiaLite +*Availability*: `MySQL +`__, +Oracle, `PostGIS `__, SpatiaLite Accepts a single geographic linestring or multilinestring field or expression and returns its length as a :class:`~django.contrib.gis.measure.Distance` @@ -407,8 +417,10 @@ Accepts a single geographic field or expression and returns the memory size .. class:: NumGeometries(expression, **extra) -*Availability*: MySQL, `PostGIS -`__, Oracle, SpatiaLite +*Availability*: `MySQL +`__, +`PostGIS `__, Oracle, +SpatiaLite Accepts a single geographic field or expression and returns the number of geometries if the geometry field is a collection (e.g., a ``GEOMETRYCOLLECTION`` @@ -421,8 +433,9 @@ On MySQL, returns ``None`` for single geometries. .. class:: NumPoints(expression, **extra) -*Availability*: MySQL, `PostGIS `__, -Oracle, SpatiaLite +*Availability*: `MySQL +`__, +`PostGIS `__, Oracle, SpatiaLite Accepts a single geographic field or expression and returns the number of points in a geometry. @@ -499,8 +512,10 @@ Number of Arguments Description .. class:: SymDifference(expr1, expr2, **extra) -*Availability*: MySQL, `PostGIS -`__, Oracle, SpatiaLite +*Availability*: `MySQL +`__, +`PostGIS `__, Oracle, +SpatiaLite Accepts two geographic fields or expressions and returns the geometric symmetric difference (union without the intersection) between the given @@ -541,8 +556,9 @@ parameters. .. class:: Union(expr1, expr2, **extra) -*Availability*: MySQL, `PostGIS `__, -Oracle, SpatiaLite +*Availability*: `MySQL +`__, +`PostGIS `__, Oracle, SpatiaLite Accepts two geographic fields or expressions and returns the union of both geometries.