Add new constrainResolution option to olx.interaction.DefaultsOptions

changelog/upgrade-notes.md

@@ -2,6 +2,16 @@
 
 ### Next release
 
+#### Simpler `constrainResolution` configuration
+
+The `constrainResolution` configuration for `ol.interaction.PinchZoom` and `ol.interaction.MouseWheelZoom`
+can now be set directly with an option in `ol.interaction.defaults`:
+```js
+ol.interaction.defaults({
+  constrainResolution: true
+});
+```
+
 ### v4.0.0
 
 #### Simpler `ol.source.Zoomify` `url` configuration

externs/olx.js

@@ -2398,7 +2398,9 @@ olx.interaction;
 
 /**
  * Interactions for the map. Default is `true` for all options.
- * @typedef {{altShiftDragRotate: (boolean|undefined),
+ * @typedef {{
+ *     altShiftDragRotate: (boolean|undefined),
+ *     constrainResolution: (boolean|undefined),
  *     doubleClickZoom: (boolean|undefined),
  *     keyboard: (boolean|undefined),
  *     mouseWheelZoom: (boolean|undefined),
@@ -2407,7 +2409,8 @@ olx.interaction;
  *     pinchRotate: (boolean|undefined),
  *     pinchZoom: (boolean|undefined),
  *     zoomDelta: (number|undefined),
- *     zoomDuration: (number|undefined)}}
+ *     zoomDuration: (number|undefined)
+ * }}
  */
 olx.interaction.DefaultsOptions;
 
@@ -2420,6 +2423,15 @@ olx.interaction.DefaultsOptions;
 olx.interaction.DefaultsOptions.prototype.altShiftDragRotate;
 
 
+/**
+ * Zoom to the closest integer zoom level after the wheel/trackpad or
+ * pinch gesture ends. Default is `false`.
+ * @type {boolean|undefined}
+ * @api
+ */
+olx.interaction.DefaultsOptions.prototype.constrainResolution;
+
+
 /**
  * Whether double click zoom is desired. Default is `true`.
  * @type {boolean|undefined}

src/ol/interaction.js

@@ -75,6 +75,7 @@ ol.interaction.defaults = function(opt_options) {
   var pinchZoom = options.pinchZoom !== undefined ? options.pinchZoom : true;
   if (pinchZoom) {
     interactions.push(new ol.interaction.PinchZoom({
+      constrainResolution: options.constrainResolution,
       duration: options.zoomDuration
     }));
   }
@@ -92,6 +93,7 @@ ol.interaction.defaults = function(opt_options) {
       options.mouseWheelZoom : true;
   if (mouseWheelZoom) {
     interactions.push(new ol.interaction.MouseWheelZoom({
+      constrainResolution: options.constrainResolution,
       duration: options.zoomDuration
     }));
   }

test/spec/ol/map.test.js

@@ -378,12 +378,37 @@ describe('ol.Map', function() {
         var interactions = ol.interaction.defaults(options);
         expect(interactions.getLength()).to.eql(1);
         expect(interactions.item(0)).to.be.a(ol.interaction.MouseWheelZoom);
+        expect(interactions.item(0).constrainResolution_).to.eql(false);
         expect(interactions.item(0).useAnchor_).to.eql(true);
         interactions.item(0).setMouseAnchor(false);
         expect(interactions.item(0).useAnchor_).to.eql(false);
       });
     });
 
+    describe('create pinchZoom interaction', function() {
+      it('creates pinchZoom interaction', function() {
+        options.pinchZoom = true;
+        var interactions = ol.interaction.defaults(options);
+        expect(interactions.getLength()).to.eql(1);
+        expect(interactions.item(0)).to.be.a(ol.interaction.PinchZoom);
+        expect(interactions.item(0).constrainResolution_).to.eql(false);
+      });
+    });
+
+    describe('set constrainResolution option', function() {
+      it('set constrainResolution option', function() {
+        options.pinchZoom = true;
+        options.mouseWheelZoom = true;
+        options.constrainResolution = true;
+        var interactions = ol.interaction.defaults(options);
+        expect(interactions.getLength()).to.eql(2);
+        expect(interactions.item(0)).to.be.a(ol.interaction.PinchZoom);
+        expect(interactions.item(0).constrainResolution_).to.eql(true);
+        expect(interactions.item(1)).to.be.a(ol.interaction.MouseWheelZoom);
+        expect(interactions.item(1).constrainResolution_).to.eql(true);
+      });
+    });
+
     describe('create double click interaction', function() {
 
       beforeEach(function() {