Vector Map with Restrictions In this tutorial you will learn how a mashup different technologies in an interactive rendering app. It will allow to display a map and visualize clickable truck restrictions like weight limits or truck-bans in inner cities. To concentrate on the basic principles, all other important features like error treatment are neglected. The aim of the code example is to illustrate how to combine Leaflet and MapLibre with the PTV Developer Vector Maps API and PTV Developer Raster Maps API.

Prerequisites

  • Basic knowledge of JavaScript.
  • helpful: Basic knowledge of Leaflet and MapLibre.

Getting started

  • Request an API key:
    • Register and login at myptv.com
    • Activate PTV Developer
    • Create your API key
  • Download an editor like Visual Studio Code or Atom to work on HTML and JavaScript.

Create an HTML page

Create a new HTML file called index.html and include all libraries we will use: leaflet, maplibre-gl-leaflet and leaflet-ptv-developer.

                
                    

<html> <head> <meta charset='utf-8' /> <title>PTV Vector Map Restrictions Tutorial</title> <meta name='viewport' content='initial-scale=1,maximum-scale=1,user-scalable=no' /> <link rel="stylesheet" type="text/css" href="https://unpkg.com/leaflet@1.7.1/dist/leaflet.css" /> <link rel="stylesheet" type="text/css" href="https://unpkg.com/maplibre-gl@2.1.9/dist/maplibre-gl.css" /> <style> body { margin:0; padding:0; } #map { position:absolute; top:0; bottom:0; width:100%; } </style> </head> <body> <div id="map"></div> <script type="text/javascript" src="https://unpkg.com/leaflet@1.7.1/dist/leaflet.js" ></script> <script type="text/javascript" src="https://unpkg.com/maplibre-gl@2.1.7/dist/maplibre-gl.js" ></script> <script type="text/javascript" src="https://unpkg.com/@maplibre/maplibre-gl-leaflet@0.0.15/leaflet-maplibre-gl.js" ></script> <script type="text/javascript" src="https://unpkg.com/leaflet-ptv-developer@1.0.1/dist/leaflet-ptv-developer.js" ></script> <script type="text/javascript"> /* The JS code below goes here */ </script> </body> </html>

Initialize the map framework

First let's initialize the Leaflet map control and set the api key. Add the code below and replace the string "YOUR_API_KEY" with your PTV Developer API key.

  
                

                var API_KEY = 'YOUR_API_KEY';
            
                var coordinates = L.latLng(49.012, 8.4044); // Karlsruhe, Germany
                var map = L.map('map', {
                    fullscreenControl: true
                }).setView(coordinates, 17);

                maplibregl.setRTLTextPlugin(
                    'https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-rtl-text/v0.2.3/mapbox-gl-rtl-text.js',
                    null,
                    true 
                );
                
            

The right-to-left text plugin makes sure that languages such as Arabic and Hebrew are displayed correctly.

Add the vector map as base

Now let's use the vector tiles with MapLibre as our base layer. After loading the index.html file into a web browser, you should see a panable and zoomable map.




                    var vectorLayer = L.maplibreGL({
                        attribution: '&copy; ' + new Date().getFullYear() + ' PTV Group, HERE',
                        interactive:false,
                        maxZoom: 18,
                        style: 'https://vectormaps-resources.myptv.com/styles/latest/standard.json',
                        transformRequest: (url, resourceType) => {
                            if (resourceType === 'Tile' && url.startsWith('https://api.myptv.com')) {
                                return {
                                    url: url + '?apiKey=' + API_KEY
                                }
                            }
                        }
                    }).addTo(map);

                    

The transformRequest function adds your apiKey to the request url automatically.

Add a Raster Map layer with restrictions

Now it's time to implement the visualization of truck restrictions. We create a new pane to add a clickable restriction layer using the leaflet extension leaflet-ptv-developer. To do so add the following JavaScript code below the already existing one.


                    
                    map.createPane('clickableTiles');
                    map.getPane('clickableTiles').style.zIndex = 500;

                    var restrictionsLayer = L.tileLayer.ptvDeveloper(
                        'https://api.myptv.com/rastermaps/v1/data-tiles/{z}/{x}/{y}' +
                        '?apiKey={token}&layers={layers}', {
                            layers: 'restrictions',
                            token: API_KEY,
                            maxZoom: 18,
                            opacity: 0.5,
                            pane: 'clickableTiles'
                        }).addTo(map);

                

Add a layer control

Finally let's add a control to toggle the restrictions layer.



                    var layers = {
                        "Vector Base Map":  vectorLayer,
                        "Restrictions": restrictionsLayer,

                    };
                    L.control.layers({}, layers, {
                        position: 'bottomleft',
                        autoZIndex: false
                    }).addTo(map);