refacto(source): deprecate source.heightMapWidth for source.width

iTowns · Dec 14, 2018 · ca920c6 · ca920c6
1 parent caf22c2
commit ca920c6
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 8 deletions.
diff --git a/examples/cubic_planar.html b/examples/cubic_planar.html
@@ -139,7 +139,7 @@
                     version: '1.3.0',
                     name: 'MNT2012_Altitude_10m_CC46',
                     projection: 'EPSG:3946',
-                    heightMapWidth: 256,
+                    width: 256,
                     format: 'image/jpeg',
                     url: 'https://download.data.grandlyon.com/wms/grandlyon',
                 });

diff --git a/examples/layers/JSONLayers/Region.json b/examples/layers/JSONLayers/Region.json
@@ -16,7 +16,7 @@
         "transparent" : true,
         "featureInfoMimeType" : "",
         "dateTime"  : "",
-        "heightMapWidth" : 256,
+        "width" : 256,
         "waterMask"      : false,
         "updateStrategy": {
             "type": 0,

diff --git a/examples/planar.html b/examples/planar.html
@@ -79,7 +79,7 @@
                 url: 'https://download.data.grandlyon.com/wms/grandlyon',
                 name: 'MNT2012_Altitude_10m_CC46',
                 projection: 'EPSG:3946',
-                heightMapWidth: 256,
+                width: 256,
                 format: 'image/jpeg',
             });
 

diff --git a/examples/planar_vector.html b/examples/planar_vector.html
@@ -74,7 +74,7 @@
                 url: 'https://download.data.grandlyon.com/wms/grandlyon',
                 name: 'MNT2012_Altitude_10m_CC46',
                 projection: 'EPSG:3946',
-                heightMapWidth: 256,
+                width: 256,
                 format: 'image/jpeg',
             });
 

diff --git a/src/Source/WMSSource.js b/src/Source/WMSSource.js
@@ -18,8 +18,10 @@ import URLBuilder from 'Provider/URLBuilder';
  * Default value is '1.3.0'.
  * @property {string} style - The style to query on the WMS server. Default
  * value is 'normal'.
- * @property {number} heightMapWidth - The size of the image to fetch, in pixel.
- * Default value is 256.
+ * @property {number} width - The width of the image to fetch, in pixel.
+ * Default value is the height if set or 256.
+ * @property {number} height - The height of the image to fetch, in pixel.
+ * Default value is the width if set or 256.
  * @property {string} axisOrder - The order of the axis, that helps building the
  * BBOX to put in the url requesting a resource. Default value is 'wsen', other
  * value can be 'swne'.
@@ -84,7 +86,15 @@ class WMSSource extends Source {
         this.zoom = source.zoom || { min: 0, max: 21 };
         this.format = this.format || 'image/png';
         this.style = source.style || '';
-        this.width = source.heightMapWidth || 256;
+
+        // TODO: remove in 2.7.0
+        if (source.heightMapWidth) {
+            console.warn('source.heightMapWidth is deprecated, please use source.width instead.');
+            source.width = source.width || source.heightMapWidth;
+        }
+
+        this.width = source.width || source.height || 256;
+        this.height = source.height || source.width || 256;
         this.version = source.version || '1.3.0';
         this.transparent = source.transparent || false;
 
@@ -109,7 +119,7 @@ class WMSSource extends Source {
             this.format}&TRANSPARENT=${
             this.transparent}&BBOX=%bbox&${
             crsPropName}=${
-            this.projection}&WIDTH=${this.width}&HEIGHT=${this.width}`;
+            this.projection}&WIDTH=${this.width}&HEIGHT=${this.height}`;
     }
 
     urlFromExtent(extent) {