import Collection from '../../../../../src/ol/Collection.js'; import Feature from '../../../../../src/ol/Feature.js'; import Interaction from '../../../../../src/ol/interaction/Interaction.js'; import Map from '../../../../../src/ol/Map.js'; import MapBrowserEvent from '../../../../../src/ol/MapBrowserEvent.js'; import MapBrowserEventType from '../../../../../src/ol/MapBrowserEventType.js'; import Polygon from '../../../../../src/ol/geom/Polygon.js'; import Select from '../../../../../src/ol/interaction/Select.js'; import Style from '../../../../../src/ol/style/Style.js'; import VectorLayer from '../../../../../src/ol/layer/Vector.js'; import VectorSource from '../../../../../src/ol/source/Vector.js'; import View from '../../../../../src/ol/View.js'; describe('ol.interaction.Select', function () { let target, map, layer, source; const width = 360; const height = 180; beforeEach(function (done) { target = document.createElement('div'); const style = target.style; style.position = 'absolute'; style.left = '-1000px'; style.top = '-1000px'; style.width = width + 'px'; style.height = height + 'px'; document.body.appendChild(target); const geometry = new Polygon([ [ [0, 0], [0, 40], [40, 40], [40, 0], ], ]); // Four overlapping features, two features of type "foo" and two features // of type "bar". The rendering order is, from top to bottom, foo -> bar // -> foo -> bar. const features = []; features.push( new Feature({ geometry: geometry, type: 'bar', }), new Feature({ geometry: geometry, type: 'foo', }), new Feature({ geometry: geometry, type: 'bar', }), new Feature({ geometry: geometry, type: 'foo', }) ); source = new VectorSource({ features: features, }); layer = new VectorLayer({source: source}); map = new Map({ target: target, layers: [layer], view: new View({ projection: 'EPSG:4326', center: [0, 0], resolution: 1, }), }); map.once('postrender', function () { done(); }); }); afterEach(function () { map.dispose(); document.body.removeChild(target); }); /** * Simulates a browser event on the map viewport. The client x/y location * will be adjusted as if the map were centered at 0,0. * @param {string} type Event type. * @param {number} x Horizontal offset from map center. * @param {number} y Vertical offset from map center. * @param {boolean} [opt_shiftKey] Shift key is pressed. */ function simulateEvent(type, x, y, opt_shiftKey) { const viewport = map.getViewport(); // calculated in case body has top < 0 (test runner with small window) const position = viewport.getBoundingClientRect(); const shiftKey = opt_shiftKey !== undefined ? opt_shiftKey : false; const event = { type: type, target: viewport.firstChild, clientX: position.left + x + width / 2, clientY: position.top + y + height / 2, shiftKey: shiftKey, stopPropagation: () => { event.propagationStopped = true; }, }; map.handleMapBrowserEvent(new MapBrowserEvent(type, map, event)); } describe('constructor', function () { it('creates a new interaction', function () { const select = new Select(); expect(select).to.be.a(Select); expect(select).to.be.a(Interaction); }); describe('user-provided collection', function () { it('uses the user-provided collection', function () { const features = new Collection(); const select = new Select({features: features}); expect(select.getFeatures()).to.be(features); }); }); }); describe('selecting a polygon', function () { let select; beforeEach(function () { select = new Select(); map.addInteraction(select); }); it('select with single-click', function () { const listenerSpy = sinon.spy(function (e) { expect(e.selected).to.have.length(1); }); select.on('select', listenerSpy); simulateEvent('singleclick', 10, -20); expect(listenerSpy.callCount).to.be(1); const features = select.getFeatures(); expect(features.getLength()).to.equal(1); }); it('single-click outside the geometry', function () { const listenerSpy = sinon.spy(function (e) { expect(e.selected).to.have.length(1); }); select.on('select', listenerSpy); simulateEvent(MapBrowserEventType.SINGLECLICK, -10, -10); expect(listenerSpy.callCount).to.be(0); const features = select.getFeatures(); expect(features.getLength()).to.equal(0); }); it('select twice with single-click', function () { const listenerSpy = sinon.spy(function (e) { expect(e.selected).to.have.length(1); }); select.on('select', listenerSpy); simulateEvent(MapBrowserEventType.SINGLECLICK, 10, -20); simulateEvent(MapBrowserEventType.SINGLECLICK, 9, -21); expect(listenerSpy.callCount).to.be(1); const features = select.getFeatures(); expect(features.getLength()).to.equal(1); }); it('select with shift single-click', function () { const listenerSpy = sinon.spy(function (e) { expect(e.selected).to.have.length(1); }); select.on('select', listenerSpy); simulateEvent('singleclick', 10, -20, true); expect(listenerSpy.callCount).to.be(1); const features = select.getFeatures(); expect(features.getLength()).to.equal(1); }); }); describe('multiselecting polygons', function () { let select; beforeEach(function () { select = new Select({ multi: true, }); map.addInteraction(select); }); it('select with single-click', function () { const listenerSpy = sinon.spy(function (e) { expect(e.selected).to.have.length(4); }); select.on('select', listenerSpy); simulateEvent('singleclick', 10, -20); expect(listenerSpy.callCount).to.be(1); const features = select.getFeatures(); expect(features.getLength()).to.equal(4); }); it('select with shift single-click', function () { const listenerSpy = sinon.spy(function (e) { expect(e.selected).to.have.length(4); }); select.on('select', listenerSpy); simulateEvent('singleclick', 10, -20, true); expect(listenerSpy.callCount).to.be(1); let features = select.getFeatures(); expect(features.getLength()).to.equal(4); expect(select.getLayer(features.item(0))).to.equal(layer); // Select again to make sure the style change does not break selection simulateEvent('singleclick', 10, -20); expect(listenerSpy.callCount).to.be(1); features = select.getFeatures(); expect(features.getLength()).to.equal(4); expect(select.getLayer(features.item(0))).to.equal(layer); }); }); describe('toggle selecting polygons', function () { let select; beforeEach(function () { select = new Select({ multi: true, }); map.addInteraction(select); }); it('with SHIFT + single-click', function () { const listenerSpy = sinon.spy(); select.on('select', listenerSpy); simulateEvent('singleclick', 10, -20, true); expect(listenerSpy.callCount).to.be(1); let features = select.getFeatures(); expect(features.getLength()).to.equal(4); map.renderSync(); simulateEvent('singleclick', 10, -20, true); expect(listenerSpy.callCount).to.be(1); features = select.getFeatures(); expect(features.getLength()).to.equal(4); }); }); describe('filter features using the filter option', function () { describe('with multi set to true', function () { it('only selects features that pass the filter', function () { const select = new Select({ multi: true, filter: function (feature, layer) { return feature.get('type') === 'bar'; }, }); map.addInteraction(select); simulateEvent('singleclick', 10, -20); const features = select.getFeatures(); expect(features.getLength()).to.equal(2); expect(features.item(0).get('type')).to.be('bar'); expect(features.item(1).get('type')).to.be('bar'); }); it( 'only selects features that pass the filter ' + 'using shift single-click', function () { const select = new Select({ multi: true, filter: function (feature, layer) { return feature.get('type') === 'bar'; }, }); map.addInteraction(select); simulateEvent('singleclick', 10, -20, true); const features = select.getFeatures(); expect(features.getLength()).to.equal(2); expect(features.item(0).get('type')).to.be('bar'); expect(features.item(1).get('type')).to.be('bar'); } ); }); describe('with multi set to false', function () { it('only selects the first feature that passes the filter', function () { const select = new Select({ multi: false, filter: function (feature, layer) { return feature.get('type') === 'bar'; }, }); map.addInteraction(select); simulateEvent('singleclick', 10, -20); const features = select.getFeatures(); expect(features.getLength()).to.equal(1); expect(features.item(0).get('type')).to.be('bar'); }); it( 'only selects the first feature that passes the filter ' + 'using shift single-click', function () { const select = new Select({ multi: false, filter: function (feature, layer) { return feature.get('type') === 'bar'; }, }); map.addInteraction(select); simulateEvent('singleclick', 10, -20, true); const features = select.getFeatures(); expect(features.getLength()).to.equal(1); expect(features.item(0).get('type')).to.be('bar'); } ); }); }); describe('#getLayer(feature)', function () { let interaction; beforeEach(function () { interaction = new Select(); map.addInteraction(interaction); }); afterEach(function () { map.removeInteraction(interaction); }); it('returns a layer from a selected feature', function () { const listenerSpy = sinon.spy(function (e) { const feature = e.selected[0]; const layer_ = interaction.getLayer(feature); expect(e.selected).to.have.length(1); expect(feature).to.be.a(Feature); expect(layer_).to.be.a(VectorLayer); expect(layer_).to.equal(layer); }); interaction.on('select', listenerSpy); simulateEvent('singleclick', 10, -20); // Select again to make sure the style change does not break selection simulateEvent('singleclick', 10, -20); }); }); describe('#setActive()', function () { let interaction; beforeEach(function () { interaction = new Select(); expect(interaction.getActive()).to.be(true); map.addInteraction(interaction); simulateEvent('singleclick', 10, -20); }); afterEach(function () { map.removeInteraction(interaction); }); describe('#setActive(false)', function () { it('keeps the the selection', function () { interaction.setActive(false); expect(interaction.getFeatures().getLength()).to.equal(1); }); }); describe('#setActive(true)', function () { beforeEach(function () { interaction.setActive(false); }); it('fires change:active', function () { const listenerSpy = sinon.spy(); interaction.on('change:active', listenerSpy); interaction.setActive(true); expect(listenerSpy.callCount).to.be(1); }); }); }); describe('clear event listeners on interaction removal', function () { let firstInteraction, secondInteraction, feature; beforeEach(function () { feature = source.getFeatures()[3]; // top feature is selected const style = new Style({}); const features = new Collection(); firstInteraction = new Select({style, features}); secondInteraction = new Select({style, features}); }); afterEach(function () { map.removeInteraction(secondInteraction); map.removeInteraction(firstInteraction); }); // The base case describe('with a single interaction added', function () { it('changes the selected feature once', function () { map.addInteraction(firstInteraction); const listenerSpy = sinon.spy(); feature.on('change', listenerSpy); simulateEvent('singleclick', 10, -20, false); expect(listenerSpy.callCount).to.be(1); }); }); // The "difficult" case. To prevent regression describe('with a replaced interaction', function () { it('changes the selected feature once', function () { map.addInteraction(firstInteraction); map.removeInteraction(firstInteraction); map.addInteraction(secondInteraction); const listenerSpy = sinon.spy(); feature.on('change', listenerSpy); simulateEvent('singleclick', 10, -20, false); expect(listenerSpy.callCount).to.be(1); }); }); }); describe('supports stop propagation', function () { let firstInteraction, secondInteraction; beforeEach(function () { firstInteraction = new Select(); secondInteraction = new Select(); map.addInteraction(firstInteraction); // note second interaction added to map last map.addInteraction(secondInteraction); }); afterEach(function () { map.removeInteraction(firstInteraction); map.removeInteraction(secondInteraction); }); //base case sanity check describe('without stop propagation', function () { it('both interactions dispatch select', function () { const firstSelectSpy = sinon.spy(); firstInteraction.on('select', firstSelectSpy); const secondSelectSpy = sinon.spy(); secondInteraction.on('select', secondSelectSpy); simulateEvent('singleclick', 10, -20); expect(firstSelectSpy.callCount).to.be(1); expect(secondSelectSpy.callCount).to.be(1); }); }); describe('calling stop propagation', function () { it('only "last" added interaction dispatches select', function () { const firstSelectSpy = sinon.spy(); firstInteraction.on('select', firstSelectSpy); const secondSelectSpy = sinon.spy(function (e) { e.mapBrowserEvent.stopPropagation(); }); secondInteraction.on('select', secondSelectSpy); simulateEvent('singleclick', 10, -20); expect(firstSelectSpy.callCount).to.be(0); expect(secondSelectSpy.callCount).to.be(1); }); }); }); });