Skip to content

Commit 9c616e1

Browse files
added better api documentation for spatial types (#403)
1 parent c4c9bfc commit 9c616e1

File tree

1 file changed

+75
-9
lines changed

1 file changed

+75
-9
lines changed

docs/source/api.rst

Lines changed: 75 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -941,16 +941,27 @@ Path
941941
Spatial Data Types
942942
******************
943943

944-
============= ============================
945-
Cypher Type Python Type
946-
============= ============================
947-
Point :class:`neo4j.spatial.Point`
948-
============= ============================
944+
945+
Cypher has built-in support for handling spatial values (points),
946+
and the underlying database supports storing these point values as properties on nodes and relationships.
947+
948+
https://neo4j.com/docs/cypher-manual/current/syntax/spatial/
949+
950+
951+
================= =====================================
952+
Cypher Type Python Type
953+
================= =====================================
954+
Point :class:`neo4j.spatial.Point`
955+
956+
Point (Cartesian) :class:`neo4j.spatial.CartesianPoint`
957+
Point (WGS-84) :class:`neo4j.spatial.WGS84Point`
958+
================= =====================================
949959

950960

951961
Point
952962
=====
953963

964+
954965
.. autoclass:: neo4j.spatial.Point
955966
:members:
956967

@@ -959,17 +970,72 @@ CartesianPoint
959970
==============
960971

961972
.. autoclass:: neo4j.spatial.CartesianPoint
962-
:members:
963-
:inherited-members:
973+
:show-inheritance:
974+
975+
.. autoproperty:: srid
976+
977+
.. autoproperty:: x
978+
979+
.. autoproperty:: y
980+
981+
.. autoproperty:: z
982+
983+
.. automethod:: count
984+
985+
.. automethod:: index
986+
987+
988+
.. code-block:: python
989+
990+
point=CartesianPoint((1.23, 4.56)
991+
992+
print(point.x, point.y)
993+
994+
995+
.. code-block:: python
996+
997+
point=CartesianPoint((1.23, 4.56, 7.89)
998+
999+
print(point.x, point.y, point.z)
9641000
9651001
9661002
WGS84Point
9671003
==========
9681004
9691005
.. autoclass:: neo4j.spatial.WGS84Point
970-
:members:
971-
:inherited-members:
1006+
:show-inheritance:
1007+
1008+
.. autoproperty:: srid
1009+
1010+
.. autoproperty:: x
1011+
1012+
.. autoproperty:: y
1013+
1014+
.. autoproperty:: z
1015+
1016+
.. autoproperty:: longitude
1017+
1018+
.. autoproperty:: latitude
1019+
1020+
.. autoproperty:: height
1021+
1022+
.. automethod:: count
1023+
1024+
.. automethod:: index
1025+
1026+
1027+
1028+
1029+
.. code-block:: python
1030+
1031+
point=WGS84Point((1.23, 4.56))
1032+
print(point.longitude, point.latitude)
1033+
1034+
1035+
.. code-block:: python
9721036
1037+
point=WGS84Point((1.23, 4.56, 7.89))
1038+
print(point.longitude, point.latitude, point.height)
9731039
9741040
9751041
*******************

0 commit comments

Comments
 (0)