Merge pull request #12 from heremaps/via_waypoint_fix

updated notebooks and docs
heremaps · Jun 19, 2021 · 3892a08 · 3892a08
2 parents 40bc5da + e16e693
commit 3892a08
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 17 deletions.
diff --git a/docs/notebooks/routing.ipynb b/docs/notebooks/routing.ipynb
@@ -30,7 +30,7 @@
     "from datetime import datetime\n",
     "\n",
     "from here_location_services import LS\n",
-    "from here_location_services.config.routing_config import ROUTING_RETURN\n",
+    "from here_location_services.config.routing_config import ROUTING_RETURN, Via\n",
     "from here_location_services.config.matrix_routing_config import Truck, SHIPPED_HAZARDOUS_GOODS\n",
     "from here_map_widget import Map, Marker, GeoJSON, DomMarker, DomIcon"
    ]
@@ -133,7 +133,7 @@
     "result = ls.car_route(\n",
     "    origin=[52.51375, 13.42462],\n",
     "    destination=[52.52332, 13.42800],\n",
-    "    via=[(52.52426, 13.43000)],\n",
+    "    via=[Via(lat=52.52426, lng=13.43000)],\n",
     "    return_results=[\n",
     "        ROUTING_RETURN.polyline,\n",
     "        ROUTING_RETURN.elevation,\n",

diff --git a/docs/source/bicycle_route.rst b/docs/source/bicycle_route.rst
@@ -44,12 +44,10 @@ Attribute                       Type
 ============================    =======================================================================================    ===
 origin                          list                                                                                       A list of ``latitude`` and ``longitude`` of ``origin`` point of route.
 destination                     list                                                                                       A list of ``latitude`` and ``longitude`` of ``destination`` point of route.
-via                             list                                                                                       A list of tuples of ``latitude`` and ``longitude`` of ``via`` points.
+via                             list                                                                                       A list of :class:`here_location_services.config.routing_config.Via` objects.
 origin_place_options            :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optinal place options for ``origin``.
 destination_place_options       :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optional place options for ``destination``.
-via_place_options               :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optinal place options for ``via``.
 destination_waypoint_options    :class:`WayPointOptions <here_location_services.config.routing_config.WayPointOptions>`    optional way point options for ``destination``.
-via_waypoint_options            :class:`WayPointOptions <here_location_services.config.routing_config.WayPointOptions>`    optional way point options for ``via``.
 departure_time                  :func:`datetime.datetime`                                                                  optional departure time.
 routing_mode                    string                                                                                     optional routing mode is defined in  :attr:`ROUTING_MODE <here_location_services.config.routing_config.ROUTING_MODE>`
 alternatives                    int                                                                                        optional number of alternative routes to return aside from the optimal route. default value is ``0`` and maximum is ``6``.

diff --git a/docs/source/car_route.rst b/docs/source/car_route.rst
@@ -44,12 +44,10 @@ Attribute                       Type
 ============================    =======================================================================================    ===
 origin                          list                                                                                       A list of ``latitude`` and ``longitude`` of ``origin`` point of route.
 destination                     list                                                                                       A list of ``latitude`` and ``longitude`` of ``destination`` point of route.
-via                             list                                                                                       A list of tuples of ``latitude`` and ``longitude`` of ``via`` points.
+via                             list                                                                                       A list of :class:`here_location_services.config.routing_config.Via` objects.
 origin_place_options            :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optinal place options for ``origin``.
 destination_place_options       :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optional place options for ``destination``.
-via_place_options               :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optinal place options for ``via``.
 destination_waypoint_options    :class:`WayPointOptions <here_location_services.config.routing_config.WayPointOptions>`    optional way point options for ``destination``.
-via_waypoint_options            :class:`WayPointOptions <here_location_services.config.routing_config.WayPointOptions>`    optional way point options for ``via``.
 departure_time                  :func:`datetime.datetime`                                                                  optional departure time.
 routing_mode                    string                                                                                     optional routing mode is defined in  :attr:`ROUTING_MODE <here_location_services.config.routing_config.ROUTING_MODE>`
 alternatives                    int                                                                                        optional number of alternative routes to return aside from the optimal route. default value is ``0`` and maximum is ``6``.

diff --git a/docs/source/pedestrian_route.rst b/docs/source/pedestrian_route.rst
@@ -44,12 +44,10 @@ Attribute                       Type
 ============================    =======================================================================================    ===
 origin                          list                                                                                       A list of ``latitude`` and ``longitude`` of ``origin`` point of route.
 destination                     list                                                                                       A list of ``latitude`` and ``longitude`` of ``destination`` point of route.
-via                             list                                                                                       A list of tuples of ``latitude`` and ``longitude`` of ``via`` points.
+via                             list                                                                                       A list of :class:`here_location_services.config.routing_config.Via` objects.
 origin_place_options            :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optinal place options for ``origin``.
 destination_place_options       :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optional place options for ``destination``.
-via_place_options               :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optinal place options for ``via``.
 destination_waypoint_options    :class:`WayPointOptions <here_location_services.config.routing_config.WayPointOptions>`    optional way point options for ``destination``.
-via_waypoint_options            :class:`WayPointOptions <here_location_services.config.routing_config.WayPointOptions>`    optional way point options for ``via``.
 departure_time                  :func:`datetime.datetime`                                                                  optional departure time.
 routing_mode                    string                                                                                     optional routing mode is defined in  :attr:`ROUTING_MODE <here_location_services.config.routing_config.ROUTING_MODE>`
 alternatives                    int                                                                                        optional number of alternative routes to return aside from the optimal route. default value is ``0`` and maximum is ``6``.

diff --git a/docs/source/scooter_route.rst b/docs/source/scooter_route.rst
@@ -44,12 +44,10 @@ Attribute                       Type
 ============================    =======================================================================================    ===
 origin                          list                                                                                       A list of ``latitude`` and ``longitude`` of ``origin`` point of route.
 destination                     list                                                                                       A list of ``latitude`` and ``longitude`` of ``destination`` point of route.
-via                             list                                                                                       A list of tuples of ``latitude`` and ``longitude`` of ``via`` points.
+via                             list                                                                                       A list of :class:`here_location_services.config.routing_config.Via` objects.
 origin_place_options            :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optinal place options for ``origin``.
 destination_place_options       :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optional place options for ``destination``.
-via_place_options               :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optinal place options for ``via``.
 destination_waypoint_options    :class:`WayPointOptions <here_location_services.config.routing_config.WayPointOptions>`    optional way point options for ``destination``.
-via_waypoint_options            :class:`WayPointOptions <here_location_services.config.routing_config.WayPointOptions>`    optional way point options for ``via``.
 scooter                         :class:`Scooter <here_location_services.config.routing_config.Scooter>`                    optional additional attributes for scooter route.
 departure_time                  :func:`datetime.datetime`                                                                  optional departure time.
 routing_mode                    string                                                                                     optional routing mode is defined in  :attr:`ROUTING_MODE <here_location_services.config.routing_config.ROUTING_MODE>`

diff --git a/docs/source/truck_route.rst b/docs/source/truck_route.rst
@@ -44,12 +44,10 @@ Attribute                       Type
 ============================    =======================================================================================    ===
 origin                          list                                                                                       A list of ``latitude`` and ``longitude`` of ``origin`` point of route.
 destination                     list                                                                                       A list of ``latitude`` and ``longitude`` of ``destination`` point of route.
-via                             list                                                                                       A list of tuples of ``latitude`` and ``longitude`` of ``via`` points.
+via                             list                                                                                       A list of :class:`here_location_services.config.routing_config.Via` objects.
 origin_place_options            :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optinal place options for ``origin``.
 destination_place_options       :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optional place options for ``destination``.
-via_place_options               :class:`PlaceOptions <here_location_services.config.routing_config.PlaceOptions>`          optinal place options for ``via``.
 destination_waypoint_options    :class:`WayPointOptions <here_location_services.config.routing_config.WayPointOptions>`    optional way point options for ``destination``.
-via_waypoint_options            :class:`WayPointOptions <here_location_services.config.routing_config.WayPointOptions>`    optional way point options for ``via``.
 departure_time                  :func:`datetime.datetime`                                                                  optional departure time.
 routing_mode                    string                                                                                     optional routing mode is defined in  :attr:`ROUTING_MODE <here_location_services.config.routing_config.ROUTING_MODE>`
 alternatives                    int                                                                                        optional number of alternative routes to return aside from the optimal route. default value is ``0`` and maximum is ``6``.