@maptrip/map-tiles 1.0.8 → 1.1.1

package/README.md

@@ -47,10 +47,10 @@ Install [LeafletJS](https://leafletjs.com/) with `npm install leaflet@~1.9.x`. T
 you create an instance of `MapTripLeafletGridLayer` and add it to the layers of a map:
 
 ```js
-import { MapTripLeafletGridLayer } from "dist/map-tiles.js";
+import { MapTripLeafletGridLayer } from "@maptrip/map-tiles";
 
-import L from 'leaflet';
-import 'leaflet/dist/leaflet.css';
+import L from "leaflet";
+import "leaflet/dist/leaflet.css";
 
 const layer = new MapTripLeafletGridLayer({
   provider: "TomTom",
@@ -79,7 +79,7 @@ Install [OpenLayers](https://openlayers.org/) with `npm install ol@~8.2.x`. To c
 and MapTrip map tiles, you create an instance of `MapTripOpenLayersSource` and add it to the layers of a map:
 
 ```js
-import { MapTripOpenLayersSource } from "dist/map-tiles.js";
+import { MapTripOpenLayersSource } from "@maptrip/map-tiles";
 
 import Map from "ol/Map.js";
 import View from "ol/View.js";
@@ -117,7 +117,7 @@ Install the [Google Maps JavaScript API](https://developers.google.com/maps/docu
 JS loader with `npm install @googlemaps/js-api-loader@~1.16.x`.
 
 ```js
-import { MapTripGoogleMapType } from "dist/map-tiles.js";
+import { MapTripGoogleMapType } from "@maptrip/map-tiles";
 import { Loader } from "@googlemaps/js-api-loader";
 
 new Loader({
@@ -160,6 +160,8 @@ This function will be called with the x, y and z indexes of all tiles. To create
 you can use our factory class. This is initialized with the map provider you want to use:
 
 ```js
+import { VectorTileFactory } from "@maptrip/map-tiles";
+
 const factory = VectorTileFactory.createFactory({ provider: "TomTom" });
 ```
 
@@ -193,6 +195,37 @@ const factory = VectorTileFactory.createFactory({
 Which data you are allowed to use depends on your MapTrip license.
 If in doubt, please contact our [support team](mailto:support@infoware.de).
 
+## MapTrip Detour Profiles
+
+You can use the [MapTrip Detour Editor](https://editor.maptrip.de/detour/) to create your own profiles that change the map data. For example, you can block or prioritize roads and even delete or add new roads.
+
+Deleting or adding new roads affect the map when you specify your profile: Deleted roads are no longer visible and newly created roads are shown in the map.
+
+Use the endpoint `GET /detour/file/all` of the [MapTrip Server API](https://api.maptrip.de/) to query the profile string of all your Detour files created in the editor or with the API.
+
+Let's assume the response looks like this:
+
+```json
+[
+  {
+    "id": 12345,
+    "name": "My Detour File",
+    "version": 10,
+    "profile": "olrclient_MapTrip_xxxxx_56789_My Detour File"
+  }
+]
+```
+
+In this case you have to provide the profile `olrclient_MapTrip_xxxxx_56789_My Detour File` to show it in the map:
+
+```js
+const layer = new MapTripLeafletGridLayer({
+  provider: "TomTom",
+  detourProfile: "olrclient_MapTrip_xxxxx_56789_My Detour File",
+  token: "Insert your MapTrip token here",
+});
+```
+
 ## Properties
 
 You can specify a third parameter with properties when creating the factory. These values are available:
@@ -204,6 +237,7 @@ You can specify a third parameter with properties when creating the factory. The
 | traffic           | Add traffic flows to the map tiles (only available for TomTom and HERE maps)                      | false                    |
 | timeout           | Load timeout for tiles in milliseconds. Increase this if you have a very slow internet connection | 5000                     |
 | parallelDownloads | The number of tiles that are loaded in parallel                                                   | 12                       |
+| detourProfile     | The name of a MapTrip Detour Profile, see _MapTrip Detour_                                        |                          |
 | renderingConfig   | Set a custom rendering configuration to customize layers, colors, line widths etc.                | RENDERING_CONFIG_DEFAULT |
 
 This factory initializes a factory with TomTom data and traffic flows:
@@ -237,3 +271,9 @@ const factory = VectorTileFactory.createFactory({
 
 It will create tiles which have a transparent background and semi-transparent traffic flows.
 To use them, you mapping API has to be able to use both base layers and overlays.
+
+## History
+
+- 1.1.1: Added rendering config for foot_path layer
+- 1.1.0: Added MapTrip detour profiles
+- 1.0.8: First public version