summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSergey Fedoseev <fedoseev.sergey@gmail.com>2017-04-02 00:02:09 +0500
committerTim Graham <timograham@gmail.com>2017-04-01 15:02:09 -0400
commitede4f6d48c1fe060c239b2477c00df6bbfd4fd7c (patch)
tree953aa4ddd3692a0bf5141bfeb7cb4b1a4fb454ce /docs
parent7b53041420009ad430035116c25f36804e714cd5 (diff)
Fixed #12410 -- Added LineLocatePoint GIS function.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/gis/db-api.txt1
-rw-r--r--docs/ref/contrib/gis/functions.txt13
-rw-r--r--docs/releases/2.0.txt3
3 files changed, 17 insertions, 0 deletions
diff --git a/docs/ref/contrib/gis/db-api.txt b/docs/ref/contrib/gis/db-api.txt
index d0555ec145..c3d7003636 100644
--- a/docs/ref/contrib/gis/db-api.txt
+++ b/docs/ref/contrib/gis/db-api.txt
@@ -386,6 +386,7 @@ Function PostGIS Oracle MySQL Spat
:class:`Intersection` X X X (≥ 5.6.1) X
:class:`IsValid` X X X (≥ 5.7.5) X (LWGEOM)
:class:`Length` X X X X
+:class:`LineLocatePoint` X X
:class:`MakeValid` X X (LWGEOM)
:class:`MemSize` X
:class:`NumGeometries` X X X X
diff --git a/docs/ref/contrib/gis/functions.txt b/docs/ref/contrib/gis/functions.txt
index b54feb03a1..4bf1994ea6 100644
--- a/docs/ref/contrib/gis/functions.txt
+++ b/docs/ref/contrib/gis/functions.txt
@@ -358,6 +358,19 @@ resource-intensive) with the ``spheroid`` keyword argument.
In older versions, a raw value was returned on MySQL when used on
projected SRS.
+``LineLocatePoint``
+===================
+
+.. class:: LineLocatePoint(linestring, point, **extra)
+
+.. versionadded:: 2.0
+
+*Availability*: `PostGIS <https://postgis.net/docs/ST_LineLocatePoint.html>`__,
+SpatiaLite
+
+Returns a float between 0 and 1 representing the location of the closest point on
+``linestring`` to the given ``point``, as a fraction of the 2D line length.
+
``MakeValid``
=============
diff --git a/docs/releases/2.0.txt b/docs/releases/2.0.txt
index 0006ef4c45..33f969d443 100644
--- a/docs/releases/2.0.txt
+++ b/docs/releases/2.0.txt
@@ -68,6 +68,9 @@ Minor features
:class:`~django.contrib.gis.db.models.functions.IsValid` function, and
:lookup:`isvalid` lookup.
+* Added the :class:`~django.contrib.gis.db.models.functions.LineLocatePoint`
+ function, supported on PostGIS and SpatiaLite.
+
:mod:`django.contrib.messages`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~