Simplify Geoportal.js.

Author: HaudinFlorence

examples/Geoportal.ipynb

@@ -17,35 +17,34 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "id": "119aacd7-fb6b-4bf5-9a97-ac8301eabfed",
    "metadata": {},
-   "outputs": [
-    {
-     "ename": "NameError",
-     "evalue": "name 'layer' is not defined",
-     "output_type": "error",
-     "traceback": [
-      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
-      "\u001b[0;31mNameError\u001b[0m                                 Traceback (most recent call last)",
-      "Input \u001b[0;32mIn [1]\u001b[0m, in \u001b[0;36m<cell line: 5>\u001b[0;34m()\u001b[0m\n\u001b[1;32m      2\u001b[0m \u001b[38;5;28;01mfrom\u001b[39;00m \u001b[38;5;21;01mipyleaflet\u001b[39;00m\u001b[38;5;21;01m.\u001b[39;00m\u001b[38;5;21;01mgeoportal\u001b[39;00m \u001b[38;5;28;01mimport\u001b[39;00m GeoportalWMTS\n\u001b[1;32m      4\u001b[0m m \u001b[38;5;241m=\u001b[39m Map(center\u001b[38;5;241m=\u001b[39m(\u001b[38;5;241m48.85\u001b[39m, \u001b[38;5;241m2.35\u001b[39m), zoom\u001b[38;5;241m=\u001b[39m\u001b[38;5;241m14\u001b[39m, zoom_control\u001b[38;5;241m=\u001b[39m\u001b[38;5;28;01mFalse\u001b[39;00m)\n\u001b[0;32m----> 5\u001b[0m layer \u001b[38;5;241m=\u001b[39m GeoportalWMTS({\u001b[43mlayer\u001b[49m :\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mORTHOIMAGERY.ORTHOPHOTOS\u001b[39m\u001b[38;5;124m\"\u001b[39m,})\n\u001b[1;32m      6\u001b[0m m\u001b[38;5;241m.\u001b[39madd(layer)\n",
-      "\u001b[0;31mNameError\u001b[0m: name 'layer' is not defined"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "from ipyleaflet import *\n",
     "from ipyleaflet.geoportal import GeoportalWMTS\n",
-    "\n",
-    "m = Map(center=(48.85, 2.35), zoom=14, zoom_control=False)\n",
-    "layer = GeoportalWMTS(name=\"ORTHOIMAGERY.ORTHOPHOTOS\")\n",
-    "m.add(layer)"
+    "m1 = Map(center=(48.799999, 2.26667), zoom=10, zoom_control=True)\n",
+    "layer1 = GeoportalWMTS() #default\n",
+    "m1.add(layer1)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "2936c8dc-1546-4f13-8c18-6984aaf1c0e3",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "m2 = Map(center=(44.400002, 3.36667), zoom=8, zoom_control=True)\n",
+    "layer2 = GeoportalWMTS(layer_name = 'ELEVATION.SLOPES', apiKey = 'altimetrie')\n",
+    "m2.add(layer2)"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "85b0340e-4b3b-455c-ae07-8734cd68f765",
+   "id": "24a0dda1-4d07-437e-9c39-396176d5fa53",
    "metadata": {},
    "outputs": [],
    "source": []
@@ -67,7 +66,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.13"
+   "version": "3.10.5"
   }
  },
  "nbformat": 4,

ipyleaflet/geoportal.py

@@ -3,20 +3,42 @@
 #
 
 
-from traitlets import Unicode
+from traitlets import Unicode, List
 from .leaflet import TileLayer
 
 
 
 class GeoportalWMTS(TileLayer):
-    """Geoportal class, with TileLayer as parent class
+    """GeoportalWMTS class, with TileLayer as parent class
 
 
     Attributes
     ----------
+    layer_name: string, default "ORTHOIMAGERY.ORTHOPHOTOS"
+        name of the layer to show.
+    apiKey: string, default "essentiels"
+        key to access a given ressource, detailed correspondances are given here : https://geoservices.ign.fr/documentation/services/tableau_ressources
     """
 
-    _view_name = Unicode('LeafletGeoportalView').tag(sync=True)
-    _model_name = Unicode('LeafletGeoportalModel').tag(sync=True)
-    name = Unicode("ORTHOIMAGERY.ORTHOPHOTOS").tag(sync=True, o=True)
+    _view_name = Unicode('LeafletGeoportalWMTSView').tag(sync=True)
+    _model_name = Unicode('LeafletGeoportalWMTSModel').tag(sync=True)
+    layer_name = Unicode("ORTHOIMAGERY.ORTHOPHOTOS").tag(sync=True, o=True)
+    apiKey = Unicode("essentiels").tag(sync=True, o=True)
 
+
+class GeoportalWMS(TileLayer):
+    """GeoportalWMS class, with TileLayer as parent class
+
+
+    Attributes
+    ----------
+    layer_name: string, default "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2"
+        name of the layer to show.
+    apiKey: string, default "cartes"
+        key to access a given ressource, detailed correspondances are given here : https://geoservices.ign.fr/documentation/services/tableau_ressources
+    """
+
+    _view_name = Unicode('LeafletGeoportalWMSView').tag(sync=True)
+    _model_name = Unicode('LeafletGeoportalWMSModel').tag(sync=True)
+    name = Unicode("GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2").tag(sync=True, o=True)
+    layers = Unicode("essentiels").tag(sync=True, o=True)

js/src/layers/Geoportal.js

@@ -2,50 +2,41 @@
 // Distributed under the terms of the Modified BSD License.
 
 const L = require('../leaflet.js');
-const layer = require('./Layer.js');
+const layer = require('./TileLayer.js');
 const utils = require('../utils');
 
-export class LeafletGeoportalModel extends layer.LeafletLayerModel {
+export class LeafletGeoportalWMTSModel extends layer.LeafletTileLayerModel {
   defaults() {
     return {
       ...super.defaults(),
-      _view_name: 'LeafletGeoportalView',
-      _model_name: 'LeafletGeoportalModel',
-      name : "ORTHOIMAGERY.ORTHOPHOTOS"
+      _view_name: 'LeafletGeoportalWMTSView',
+      _model_name: 'LeafletGeoportalWMTSModel',
+      layer_name : "ORTHOIMAGERY.ORTHOPHOTOS",
+      apiKey : "essentiels"
     };
   }
 }
 
-export class LeafletGeoportalView extends layer.LeafletTileLayerView {
+export class LeafletGeoportalWMTSView extends layer.LeafletTileLayerView {
   create_obj() {
-    var options = this.get_options();
-    options.data = this.model.get('data');
-    this.obj = L.geoportalLayer.WMTS(this.model.get('name'))
+    this.obj = L.geoportalLayer.WMTS({layer : this.model.get('layer_name'), apiKey : this.model.get('apiKey')})
+  }
+}
 
+export class LeafletGeoportalWMSModel extends layer.LeafletTileLayerModel {
+  defaults() {
+    return {
+      ...super.defaults(),
+      _view_name: 'LeafletGeoportalWMSView',
+      _model_name: 'LeafletGeoportalWMSModel',
+      layer_name : "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2",
+      apiKey : "essentiels"
+    };
   }
+}
 
-  model_events() {
-    super.model_events();
-    this.listenTo(
-      this.model,
-      'change:data',
-      function() {
-        const data = this.model.get('data');
-        this.obj.setData(data);
-      },
-      this
-    );
-    // Separate display_options from the options to perform a shallow copy.
-    var key = 'display_options';
-    this.listenTo(
-      this.model,
-      'change:' + key,
-      function() {
-        var options = {};
-        options[utils.camel_case(key)] = { ...this.model.get(key) };
-        L.setOptions(this.obj, options);
-      },
-      this
-    );
+export class LeafletGeoportalWMSView extends layer.LeafletTileLayerView {
+  create_obj() {
+    this.obj = L.geoportalLayer.WMS({layer : this.model.get('layer_name'), apiKey : this.model.get('apiKey')})
   }
 }