@open-pioneer/selection 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# @open-pioneer/selection
+
+## 0.1.0
+
+### Minor Changes
+
+-   ee7c2d4: Update runtime version.
+-   61d3e0e: Initial release.
+-   0456500: Add interface `BaseFeature` to Map API.
+-   35be8ef: Introduction of `SelectionSourceFactory` for creating selection sources of an OpenLayers VectorLayer.
+
+### Patch Changes
+
+-   Updated dependencies [ee7c2d4]
+-   Updated dependencies [a582e5e]
+-   Updated dependencies [0456500]
+-   Updated dependencies [762e7b9]
+    -   @open-pioneer/map@0.3.0
+    -   @open-pioneer/notifier@0.3.0
+    -   @open-pioneer/react-utils@0.2.1

package/DragController.d.ts

@@ -0,0 +1,45 @@
+import { Resource } from "@open-pioneer/core/resources";
+import OlMap from "ol/Map";
+import Geometry from "ol/geom/Geometry";
+import PointerInteraction from "ol/interaction/Pointer";
+interface InteractionResource extends Resource {
+    interaction: PointerInteraction;
+}
+export declare class DragController {
+    private tooltip;
+    private interactionResources;
+    private olMap;
+    private isActive;
+    private tooltipMessage;
+    private tooltipDisabledMessage;
+    constructor(olMap: OlMap, selectMethode: string, tooltipMessage: string, tooltipDisabledMessage: string, onExtentSelected: (geometry: Geometry) => void);
+    initViewport(olMap: OlMap): HTMLElement;
+    /**
+     * Method for destroying the controller when it is no longer needed
+     */
+    destroy(): void;
+    setActive(isActive: boolean): void;
+    /**
+     * Method to create a simple extent-selection
+     */
+    private createDragBox;
+    /**
+     * Method to activate pan with right-mouse-click
+     */
+    private createDrag;
+    /**
+     * Method to generate a tooltip on the mouse cursor
+     */
+    private createHelpTooltip;
+    /**
+     * Method for testing purposes only
+     * @returns InteractionResource of class DragBox
+     */
+    getDragboxInteraction(): InteractionResource | undefined;
+    /**
+     * Method for testing purposes only
+     * @returns InteractionResource of class DragPan
+     */
+    getDragPanInteraction(): InteractionResource | undefined;
+}
+export {};

package/DragController.js

@@ -0,0 +1,175 @@
+import { unByKey } from 'ol/Observable';
+import Overlay from 'ol/Overlay';
+import { mouseActionButton } from 'ol/events/condition';
+import { SelectionMethods } from './Selection.js';
+import { DragBox, DragPan } from 'ol/interaction';
+
+const ACTIVE_CLASS = "selection-active";
+const INACTIVE_CLASS = "selection-inactive";
+class DragController {
+  tooltip;
+  interactionResources = [];
+  olMap;
+  isActive = true;
+  tooltipMessage;
+  tooltipDisabledMessage;
+  constructor(olMap, selectMethode, tooltipMessage, tooltipDisabledMessage, onExtentSelected) {
+    let viewPort;
+    switch (selectMethode) {
+      case SelectionMethods.extent:
+      default:
+        viewPort = this.initViewport(olMap);
+        this.interactionResources.push(
+          this.createDragBox(olMap, onExtentSelected, viewPort, this.interactionResources)
+        );
+        this.interactionResources.push(
+          this.createDrag(olMap, viewPort, this.interactionResources)
+        );
+        break;
+    }
+    this.tooltip = this.createHelpTooltip(olMap, tooltipMessage);
+    this.olMap = olMap;
+    this.tooltipMessage = tooltipMessage;
+    this.tooltipDisabledMessage = tooltipDisabledMessage;
+  }
+  initViewport(olMap) {
+    const viewPort = olMap.getViewport();
+    viewPort.classList.add(ACTIVE_CLASS);
+    viewPort.oncontextmenu = (e) => {
+      e.preventDefault();
+      return false;
+    };
+    return viewPort;
+  }
+  /**
+   * Method for destroying the controller when it is no longer needed
+   */
+  destroy() {
+    this.tooltip.destroy();
+    this.interactionResources.forEach((interaction) => {
+      interaction.destroy();
+    });
+  }
+  setActive(isActive) {
+    if (this.isActive === isActive)
+      return;
+    const viewPort = this.olMap.getViewport();
+    if (isActive) {
+      this.interactionResources.forEach(
+        (interaction) => this.olMap.addInteraction(interaction.interaction)
+      );
+      this.tooltip.element.textContent = this.tooltipMessage;
+      viewPort.classList.remove(INACTIVE_CLASS);
+      viewPort.classList.add(ACTIVE_CLASS);
+      this.isActive = true;
+    } else {
+      this.interactionResources.forEach(
+        (interaction) => this.olMap.removeInteraction(interaction.interaction)
+      );
+      this.tooltip.element.textContent = this.tooltipDisabledMessage;
+      viewPort.classList.remove(ACTIVE_CLASS);
+      viewPort.classList.add(INACTIVE_CLASS);
+      this.isActive = false;
+    }
+  }
+  /**
+   * Method to create a simple extent-selection
+   */
+  createDragBox(olMap, onExtentSelected, viewPort, interactionResources) {
+    const dragBox = new DragBox({
+      className: "selection-drag-box",
+      condition: mouseActionButton
+    });
+    olMap.addInteraction(dragBox);
+    dragBox.on("boxend", function() {
+      onExtentSelected(dragBox.getGeometry());
+    });
+    const interactionResource = {
+      interaction: dragBox,
+      destroy() {
+        olMap.removeInteraction(dragBox);
+        interactionResources.splice(interactionResources.indexOf(this));
+        dragBox.dispose();
+        viewPort.classList.remove(ACTIVE_CLASS);
+        viewPort.classList.remove(INACTIVE_CLASS);
+        viewPort.oncontextmenu = null;
+      }
+    };
+    return interactionResource;
+  }
+  /**
+   * Method to activate pan with right-mouse-click
+   */
+  createDrag(olMap, viewPort, interactionResources) {
+    const condition = function(mapBrowserEvent) {
+      const originalEvent = (
+        /** @type {MouseEvent} */
+        mapBrowserEvent.originalEvent
+      );
+      return originalEvent.button == 2;
+    };
+    const drag = new DragPan({
+      condition
+    });
+    olMap.addInteraction(drag);
+    const interactionResource = {
+      interaction: drag,
+      destroy() {
+        olMap.removeInteraction(drag);
+        interactionResources.splice(interactionResources.indexOf(this));
+        drag.dispose();
+        viewPort.classList.remove(ACTIVE_CLASS);
+        viewPort.classList.remove(INACTIVE_CLASS);
+        viewPort.oncontextmenu = null;
+      }
+    };
+    return interactionResource;
+  }
+  /**
+   * Method to generate a tooltip on the mouse cursor
+   */
+  createHelpTooltip(olMap, message) {
+    const element = document.createElement("div");
+    element.className = "selection-tooltip";
+    element.textContent = message;
+    const overlay = new Overlay({
+      element,
+      offset: [15, 0],
+      positioning: "center-left"
+    });
+    const pointHandler = olMap.on("pointermove", (evt) => {
+      overlay.setPosition(evt.coordinate);
+    });
+    olMap.addOverlay(overlay);
+    return {
+      overlay,
+      element,
+      destroy() {
+        olMap.removeOverlay(overlay);
+        overlay.dispose();
+        unByKey(pointHandler);
+      }
+    };
+  }
+  /**
+   * Method for testing purposes only
+   * @returns InteractionResource of class DragBox
+   */
+  getDragboxInteraction() {
+    return this.interactionResources.find(
+      (interactionResource) => interactionResource.interaction instanceof DragBox
+    );
+  }
+  /**
+   * Method for testing purposes only
+   * @returns InteractionResource of class DragPan
+   */
+  getDragPanInteraction() {
+    return this.interactionResources.find(
+      (interactionResource) => interactionResource.interaction instanceof DragPan
+    );
+  }
+}
+
+export { DragController };
+//# sourceMappingURL=DragController.js.map

package/DragController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DragController.js","sources":["DragController.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { Resource } from \"@open-pioneer/core/resources\";\nimport OlMap from \"ol/Map\";\nimport { unByKey } from \"ol/Observable\";\nimport Overlay from \"ol/Overlay\";\nimport { mouseActionButton } from \"ol/events/condition\";\nimport Geometry from \"ol/geom/Geometry\";\nimport { SelectionMethods } from \"./Selection\";\nimport { DragBox, DragPan } from \"ol/interaction\";\nimport PointerInteraction from \"ol/interaction/Pointer\";\n\ninterface InteractionResource extends Resource {\n    interaction: PointerInteraction;\n}\n/** Represents a tooltip rendered on the OpenLayers map. */\ninterface Tooltip extends Resource {\n    overlay: Overlay;\n    element: HTMLDivElement;\n}\n\nconst ACTIVE_CLASS = \"selection-active\";\nconst INACTIVE_CLASS = \"selection-inactive\";\n\nexport class DragController {\n    private tooltip: Tooltip;\n    private interactionResources: InteractionResource[] = [];\n    private olMap: OlMap;\n    private isActive: boolean = true;\n    private tooltipMessage: string;\n    private tooltipDisabledMessage: string;\n\n    constructor(\n        olMap: OlMap,\n        selectMethode: string,\n        tooltipMessage: string,\n        tooltipDisabledMessage: string,\n        onExtentSelected: (geometry: Geometry) => void\n    ) {\n        let viewPort;\n        /**\n         * Notice for Projectdeveloper\n         * Add cases for more Selectionmethods\n         */\n        switch (selectMethode) {\n            case SelectionMethods.extent:\n            default:\n                viewPort = this.initViewport(olMap);\n                this.interactionResources.push(\n                    this.createDragBox(olMap, onExtentSelected, viewPort, this.interactionResources)\n                );\n                this.interactionResources.push(\n                    this.createDrag(olMap, viewPort, this.interactionResources)\n                );\n                break;\n        }\n\n        this.tooltip = this.createHelpTooltip(olMap, tooltipMessage);\n        this.olMap = olMap;\n        this.tooltipMessage = tooltipMessage;\n        this.tooltipDisabledMessage = tooltipDisabledMessage;\n    }\n\n    initViewport(olMap: OlMap) {\n        const viewPort = olMap.getViewport();\n        viewPort.classList.add(ACTIVE_CLASS);\n\n        viewPort.oncontextmenu = (e) => {\n            e.preventDefault();\n            return false;\n        };\n        return viewPort;\n    }\n\n    /**\n     * Method for destroying the controller when it is no longer needed\n     */\n    destroy() {\n        this.tooltip.destroy();\n        this.interactionResources.forEach((interaction) => {\n            interaction.destroy();\n        });\n    }\n\n    setActive(isActive: boolean) {\n        if (this.isActive === isActive) return;\n        const viewPort = this.olMap.getViewport();\n        if (isActive) {\n            this.interactionResources.forEach((interaction) =>\n                this.olMap.addInteraction(interaction.interaction)\n            );\n            this.tooltip.element.textContent = this.tooltipMessage;\n            viewPort.classList.remove(INACTIVE_CLASS);\n            viewPort.classList.add(ACTIVE_CLASS);\n            this.isActive = true;\n        } else {\n            this.interactionResources.forEach((interaction) =>\n                this.olMap.removeInteraction(interaction.interaction)\n            );\n            this.tooltip.element.textContent = this.tooltipDisabledMessage;\n            viewPort.classList.remove(ACTIVE_CLASS);\n            viewPort.classList.add(INACTIVE_CLASS);\n            this.isActive = false;\n        }\n    }\n\n    /**\n     * Method to create a simple extent-selection\n     */\n    private createDragBox(\n        olMap: OlMap,\n        onExtentSelected: (geometry: Geometry) => void,\n        viewPort: HTMLElement,\n        interactionResources: InteractionResource[]\n    ): InteractionResource {\n        const dragBox = new DragBox({\n            className: \"selection-drag-box\",\n            condition: mouseActionButton\n        });\n\n        olMap.addInteraction(dragBox);\n        dragBox.on(\"boxend\", function () {\n            onExtentSelected(dragBox.getGeometry());\n        });\n\n        const interactionResource: InteractionResource = {\n            interaction: dragBox,\n            destroy() {\n                olMap.removeInteraction(dragBox);\n                interactionResources.splice(interactionResources.indexOf(this));\n                dragBox.dispose();\n                viewPort.classList.remove(ACTIVE_CLASS);\n                viewPort.classList.remove(INACTIVE_CLASS);\n                viewPort.oncontextmenu = null;\n            }\n        };\n        return interactionResource;\n    }\n\n    /**\n     * Method to activate pan with right-mouse-click\n     */\n    private createDrag(\n        olMap: OlMap,\n        viewPort: HTMLElement,\n        interactionResources: InteractionResource[]\n    ): InteractionResource {\n        const condition = function (mapBrowserEvent: {\n            originalEvent: MouseEvent;\n            dragging: unknown;\n        }) {\n            const originalEvent = /** @type {MouseEvent} */ mapBrowserEvent.originalEvent;\n            return originalEvent.button == 2;\n        };\n        const drag = new DragPan({\n            condition: condition\n        });\n\n        olMap.addInteraction(drag);\n\n        const interactionResource: InteractionResource = {\n            interaction: drag,\n            destroy() {\n                olMap.removeInteraction(drag);\n                interactionResources.splice(interactionResources.indexOf(this));\n                drag.dispose();\n                viewPort.classList.remove(ACTIVE_CLASS);\n                viewPort.classList.remove(INACTIVE_CLASS);\n                viewPort.oncontextmenu = null;\n            }\n        };\n\n        return interactionResource;\n    }\n\n    /**\n     * Method to generate a tooltip on the mouse cursor\n     */\n    private createHelpTooltip(olMap: OlMap, message: string) {\n        const element = document.createElement(\"div\");\n        element.className = \"selection-tooltip\";\n        element.textContent = message;\n\n        const overlay = new Overlay({\n            element: element,\n            offset: [15, 0],\n            positioning: \"center-left\"\n        });\n\n        const pointHandler = olMap.on(\"pointermove\", (evt) => {\n            overlay.setPosition(evt.coordinate);\n        });\n\n        olMap.addOverlay(overlay);\n        return {\n            overlay,\n            element,\n            destroy() {\n                olMap.removeOverlay(overlay);\n                overlay.dispose();\n                unByKey(pointHandler);\n            }\n        };\n    }\n\n    /**\n     * Method for testing purposes only\n     * @returns InteractionResource of class DragBox\n     */\n    getDragboxInteraction() {\n        return this.interactionResources.find(\n            (interactionResource) => interactionResource.interaction instanceof DragBox\n        );\n    }\n\n    /**\n     * Method for testing purposes only\n     * @returns InteractionResource of class DragPan\n     */\n    getDragPanInteraction() {\n        return this.interactionResources.find(\n            (interactionResource) => interactionResource.interaction instanceof DragPan\n        );\n    }\n}\n"],"names":[],"mappings":";;;;;;AAqBA,MAAM,YAAe,GAAA,kBAAA,CAAA;AACrB,MAAM,cAAiB,GAAA,oBAAA,CAAA;AAEhB,MAAM,cAAe,CAAA;AAAA,EAChB,OAAA,CAAA;AAAA,EACA,uBAA8C,EAAC,CAAA;AAAA,EAC/C,KAAA,CAAA;AAAA,EACA,QAAoB,GAAA,IAAA,CAAA;AAAA,EACpB,cAAA,CAAA;AAAA,EACA,sBAAA,CAAA;AAAA,EAER,WACI,CAAA,KAAA,EACA,aACA,EAAA,cAAA,EACA,wBACA,gBACF,EAAA;AACE,IAAI,IAAA,QAAA,CAAA;AAKJ,IAAA,QAAQ,aAAe;AAAA,MACnB,KAAK,gBAAiB,CAAA,MAAA,CAAA;AAAA,MACtB;AACI,QAAW,QAAA,GAAA,IAAA,CAAK,aAAa,KAAK,CAAA,CAAA;AAClC,QAAA,IAAA,CAAK,oBAAqB,CAAA,IAAA;AAAA,UACtB,KAAK,aAAc,CAAA,KAAA,EAAO,gBAAkB,EAAA,QAAA,EAAU,KAAK,oBAAoB,CAAA;AAAA,SACnF,CAAA;AACA,QAAA,IAAA,CAAK,oBAAqB,CAAA,IAAA;AAAA,UACtB,IAAK,CAAA,UAAA,CAAW,KAAO,EAAA,QAAA,EAAU,KAAK,oBAAoB,CAAA;AAAA,SAC9D,CAAA;AACA,QAAA,MAAA;AAAA,KACR;AAEA,IAAA,IAAA,CAAK,OAAU,GAAA,IAAA,CAAK,iBAAkB,CAAA,KAAA,EAAO,cAAc,CAAA,CAAA;AAC3D,IAAA,IAAA,CAAK,KAAQ,GAAA,KAAA,CAAA;AACb,IAAA,IAAA,CAAK,cAAiB,GAAA,cAAA,CAAA;AACtB,IAAA,IAAA,CAAK,sBAAyB,GAAA,sBAAA,CAAA;AAAA,GAClC;AAAA,EAEA,aAAa,KAAc,EAAA;AACvB,IAAM,MAAA,QAAA,GAAW,MAAM,WAAY,EAAA,CAAA;AACnC,IAAS,QAAA,CAAA,SAAA,CAAU,IAAI,YAAY,CAAA,CAAA;AAEnC,IAAS,QAAA,CAAA,aAAA,GAAgB,CAAC,CAAM,KAAA;AAC5B,MAAA,CAAA,CAAE,cAAe,EAAA,CAAA;AACjB,MAAO,OAAA,KAAA,CAAA;AAAA,KACX,CAAA;AACA,IAAO,OAAA,QAAA,CAAA;AAAA,GACX;AAAA;AAAA;AAAA;AAAA,EAKA,OAAU,GAAA;AACN,IAAA,IAAA,CAAK,QAAQ,OAAQ,EAAA,CAAA;AACrB,IAAK,IAAA,CAAA,oBAAA,CAAqB,OAAQ,CAAA,CAAC,WAAgB,KAAA;AAC/C,MAAA,WAAA,CAAY,OAAQ,EAAA,CAAA;AAAA,KACvB,CAAA,CAAA;AAAA,GACL;AAAA,EAEA,UAAU,QAAmB,EAAA;AACzB,IAAA,IAAI,KAAK,QAAa,KAAA,QAAA;AAAU,MAAA,OAAA;AAChC,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,KAAA,CAAM,WAAY,EAAA,CAAA;AACxC,IAAA,IAAI,QAAU,EAAA;AACV,MAAA,IAAA,CAAK,oBAAqB,CAAA,OAAA;AAAA,QAAQ,CAAC,WAC/B,KAAA,IAAA,CAAK,KAAM,CAAA,cAAA,CAAe,YAAY,WAAW,CAAA;AAAA,OACrD,CAAA;AACA,MAAK,IAAA,CAAA,OAAA,CAAQ,OAAQ,CAAA,WAAA,GAAc,IAAK,CAAA,cAAA,CAAA;AACxC,MAAS,QAAA,CAAA,SAAA,CAAU,OAAO,cAAc,CAAA,CAAA;AACxC,MAAS,QAAA,CAAA,SAAA,CAAU,IAAI,YAAY,CAAA,CAAA;AACnC,MAAA,IAAA,CAAK,QAAW,GAAA,IAAA,CAAA;AAAA,KACb,MAAA;AACH,MAAA,IAAA,CAAK,oBAAqB,CAAA,OAAA;AAAA,QAAQ,CAAC,WAC/B,KAAA,IAAA,CAAK,KAAM,CAAA,iBAAA,CAAkB,YAAY,WAAW,CAAA;AAAA,OACxD,CAAA;AACA,MAAK,IAAA,CAAA,OAAA,CAAQ,OAAQ,CAAA,WAAA,GAAc,IAAK,CAAA,sBAAA,CAAA;AACxC,MAAS,QAAA,CAAA,SAAA,CAAU,OAAO,YAAY,CAAA,CAAA;AACtC,MAAS,QAAA,CAAA,SAAA,CAAU,IAAI,cAAc,CAAA,CAAA;AACrC,MAAA,IAAA,CAAK,QAAW,GAAA,KAAA,CAAA;AAAA,KACpB;AAAA,GACJ;AAAA;AAAA;AAAA;AAAA,EAKQ,aACJ,CAAA,KAAA,EACA,gBACA,EAAA,QAAA,EACA,oBACmB,EAAA;AACnB,IAAM,MAAA,OAAA,GAAU,IAAI,OAAQ,CAAA;AAAA,MACxB,SAAW,EAAA,oBAAA;AAAA,MACX,SAAW,EAAA,iBAAA;AAAA,KACd,CAAA,CAAA;AAED,IAAA,KAAA,CAAM,eAAe,OAAO,CAAA,CAAA;AAC5B,IAAQ,OAAA,CAAA,EAAA,CAAG,UAAU,WAAY;AAC7B,MAAiB,gBAAA,CAAA,OAAA,CAAQ,aAAa,CAAA,CAAA;AAAA,KACzC,CAAA,CAAA;AAED,IAAA,MAAM,mBAA2C,GAAA;AAAA,MAC7C,WAAa,EAAA,OAAA;AAAA,MACb,OAAU,GAAA;AACN,QAAA,KAAA,CAAM,kBAAkB,OAAO,CAAA,CAAA;AAC/B,QAAA,oBAAA,CAAqB,MAAO,CAAA,oBAAA,CAAqB,OAAQ,CAAA,IAAI,CAAC,CAAA,CAAA;AAC9D,QAAA,OAAA,CAAQ,OAAQ,EAAA,CAAA;AAChB,QAAS,QAAA,CAAA,SAAA,CAAU,OAAO,YAAY,CAAA,CAAA;AACtC,QAAS,QAAA,CAAA,SAAA,CAAU,OAAO,cAAc,CAAA,CAAA;AACxC,QAAA,QAAA,CAAS,aAAgB,GAAA,IAAA,CAAA;AAAA,OAC7B;AAAA,KACJ,CAAA;AACA,IAAO,OAAA,mBAAA,CAAA;AAAA,GACX;AAAA;AAAA;AAAA;AAAA,EAKQ,UAAA,CACJ,KACA,EAAA,QAAA,EACA,oBACmB,EAAA;AACnB,IAAM,MAAA,SAAA,GAAY,SAAU,eAGzB,EAAA;AACC,MAAM,MAAA,aAAA;AAAA;AAAA,QAA0C,eAAgB,CAAA,aAAA;AAAA,OAAA,CAAA;AAChE,MAAA,OAAO,cAAc,MAAU,IAAA,CAAA,CAAA;AAAA,KACnC,CAAA;AACA,IAAM,MAAA,IAAA,GAAO,IAAI,OAAQ,CAAA;AAAA,MACrB,SAAA;AAAA,KACH,CAAA,CAAA;AAED,IAAA,KAAA,CAAM,eAAe,IAAI,CAAA,CAAA;AAEzB,IAAA,MAAM,mBAA2C,GAAA;AAAA,MAC7C,WAAa,EAAA,IAAA;AAAA,MACb,OAAU,GAAA;AACN,QAAA,KAAA,CAAM,kBAAkB,IAAI,CAAA,CAAA;AAC5B,QAAA,oBAAA,CAAqB,MAAO,CAAA,oBAAA,CAAqB,OAAQ,CAAA,IAAI,CAAC,CAAA,CAAA;AAC9D,QAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;AACb,QAAS,QAAA,CAAA,SAAA,CAAU,OAAO,YAAY,CAAA,CAAA;AACtC,QAAS,QAAA,CAAA,SAAA,CAAU,OAAO,cAAc,CAAA,CAAA;AACxC,QAAA,QAAA,CAAS,aAAgB,GAAA,IAAA,CAAA;AAAA,OAC7B;AAAA,KACJ,CAAA;AAEA,IAAO,OAAA,mBAAA,CAAA;AAAA,GACX;AAAA;AAAA;AAAA;AAAA,EAKQ,iBAAA,CAAkB,OAAc,OAAiB,EAAA;AACrD,IAAM,MAAA,OAAA,GAAU,QAAS,CAAA,aAAA,CAAc,KAAK,CAAA,CAAA;AAC5C,IAAA,OAAA,CAAQ,SAAY,GAAA,mBAAA,CAAA;AACpB,IAAA,OAAA,CAAQ,WAAc,GAAA,OAAA,CAAA;AAEtB,IAAM,MAAA,OAAA,GAAU,IAAI,OAAQ,CAAA;AAAA,MACxB,OAAA;AAAA,MACA,MAAA,EAAQ,CAAC,EAAA,EAAI,CAAC,CAAA;AAAA,MACd,WAAa,EAAA,aAAA;AAAA,KAChB,CAAA,CAAA;AAED,IAAA,MAAM,YAAe,GAAA,KAAA,CAAM,EAAG,CAAA,aAAA,EAAe,CAAC,GAAQ,KAAA;AAClD,MAAQ,OAAA,CAAA,WAAA,CAAY,IAAI,UAAU,CAAA,CAAA;AAAA,KACrC,CAAA,CAAA;AAED,IAAA,KAAA,CAAM,WAAW,OAAO,CAAA,CAAA;AACxB,IAAO,OAAA;AAAA,MACH,OAAA;AAAA,MACA,OAAA;AAAA,MACA,OAAU,GAAA;AACN,QAAA,KAAA,CAAM,cAAc,OAAO,CAAA,CAAA;AAC3B,QAAA,OAAA,CAAQ,OAAQ,EAAA,CAAA;AAChB,QAAA,OAAA,CAAQ,YAAY,CAAA,CAAA;AAAA,OACxB;AAAA,KACJ,CAAA;AAAA,GACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,qBAAwB,GAAA;AACpB,IAAA,OAAO,KAAK,oBAAqB,CAAA,IAAA;AAAA,MAC7B,CAAC,mBAAwB,KAAA,mBAAA,CAAoB,WAAuB,YAAA,OAAA;AAAA,KACxE,CAAA;AAAA,GACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,qBAAwB,GAAA;AACpB,IAAA,OAAO,KAAK,oBAAqB,CAAA,IAAA;AAAA,MAC7B,CAAC,mBAAwB,KAAA,mBAAA,CAAoB,WAAuB,YAAA,OAAA;AAAA,KACxE,CAAA;AAAA,GACJ;AACJ;;;;"}

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,117 @@
+# @open-pioneer/selection
+
+This package provides a UI component to perform a selection on given selection sources from the map.
+
+## Usage
+
+To add the component to your app, import `Selection` from `@open-pioneer/selection`. The `@open-pioneer/notifier` package is required too.
+
+The mandatory properties are `mapId` and `sources` (layer source to be selected on).
+The limit per selection is 10.000 items.
+
+```tsx
+<Selection mapId={MAP_ID} sources={selectionsources} />
+```
+
+### Listening to events
+
+To listen to the events `onSelectionComplete` and `onSelectionSourceChanged`, provide optional callback functions to the component.
+
+In case of the `onSelectionComplete` event, you can access the selection result (and its source) from the parameter `SelectionCompleteEvent`.
+In case of the `onSelectionSourceChanged` event, you can access the selected selection source from the parameter `SelectionSourceChangedEvent`.
+
+```tsx
+import { Search, SearchSelectEvent } from "@open-pioneer/search";
+<Selection
+    mapId={MAP_ID}
+    sources={datasources}
+    onSelectionComplete={(event: SelectionCompleteEvent) => {
+        // do something
+    }}
+    onSelectionSourceChanged={(event: SelectionSourceChangedEvent) => {
+        // do something
+    }}
+/>;
+```
+
+### Implementing a selection source
+
+To provide the selection sources that are used by the selection-UI component, implement the function `select` for each selection source:
+
+```tsx
+import {
+    Selection,
+    SelectionResult,
+    SelectionSource,
+    SelectionSourceStatus
+} from "@open-pioneer/selection";
+import { MAP_ID } from "./MapConfigProviderImpl";
+
+class MySelectionSource implements SelectionSource {
+    // The label of this source, used as a title for this source's results.
+    label = "My sample REST-Service";
+
+    // The optional status of this source. If there is no status defined, it is assumed that the source is always available.
+    status?: SelectionSourceStatus;
+
+    // The reason that the source is not available. If it is not defined, the i18n value for "sourceNotAvailable" will be displayed
+    unavailableStatusReason?: string;
+
+    // Performs a selection with a given selectionKind and returns a list of selection results.
+    // see the API documentation of `SelectionSource`.
+    select(selectionKind: SelectionKind, options: SelectionOptions): Promise<SelectionResult[]> {}
+}
+
+const selectionsources: SelectionSource[] = [new MySelectionSource()];
+
+// In your JSX template:
+<Selection mapId={MAP_ID} sources={selectionsources} />;
+```
+
+### VectorLayer as selection source
+
+To use an OpenLayers VectorLayer with an OpenLayers VectorSource (e.g. layer of the map) as a selection source,
+the provided service `VectorSelectionSourceFactory` can be used to create an instance of `VectorLayerSelectionSource`.
+
+Key features of this selection source implementation are:
+
+-   using only the extent as selection kind
+-   listening to layer visibility changes and updating the status of the source
+-   limiting the number of returned selection results to the corresponding selection option
+-   throwing an event `changed:status` when the status updates
+
+Inject the selection source factory by referencing `"selection.VectorSelectionSourceFactory"`:
+
+```js
+// build.config.mjs
+import { defineBuildConfig } from "@open-pioneer/build-support";
+
+export default defineBuildConfig({
+    services: {
+        YourService: {
+            // ...
+            references: {
+                vectorSelectionSourceFactory: "selection.VectorSelectionSourceFactory"
+            }
+        }
+    }
+});
+```
+
+and create a selection source instance:
+
+```ts
+const vectorSelectionSourceFactory = this._vectorSelectionSourceFactory; // injected
+const layerSelectionSource = vectorSelectionSourceFactory.createSelectionSource({
+    vectorLayer: vectorLayer,
+    label: "My Vector Layer Title shown in UI"
+});
+
+const eventHandler = layerSelectionSource.on("changed:status", () => {
+    // do something (e.g. like removing map highlighting if unavailable)
+});
+```
+
+## License
+
+Apache-2.0 (see `LICENSE` file)

package/Selection.d.ts

@@ -0,0 +1,48 @@
+import { CommonComponentProps } from "@open-pioneer/react-utils";
+import { FC } from "react";
+import { SelectionResult, SelectionSource } from "./api";
+/**
+ * Properties supported by the {@link Selection} component.
+ */
+export interface SelectionProps extends CommonComponentProps {
+    /**
+     * The id of the map.
+     */
+    mapId: string;
+    /**
+     * Array of selection sources available for spatial selection.
+     */
+    sources: SelectionSource[];
+    /**
+     * This handler is called whenever the user has successfully selected
+     * some items.
+     */
+    onSelectionComplete?(event: SelectionCompleteEvent): void;
+    /**
+     * This handler is called whenever the user has changed the selected source
+     */
+    onSelectionSourceChanged?(event: SelectionSourceChangedEvent): void;
+}
+export interface SelectionCompleteEvent {
+    /** The source that returned the {@link results}. */
+    source: SelectionSource;
+    /** Results selected by the user. */
+    results: SelectionResult[];
+}
+export interface SelectionSourceChangedEvent {
+    /** The new selected source */
+    source: SelectionSource | undefined;
+}
+/**
+ * Supported selection methods
+ */
+export declare enum SelectionMethods {
+    extent = "EXTENT",
+    polygon = "POLYGON",
+    free = "FREEPOLYGON",
+    circle = "CIRCLE"
+}
+/**
+ * A component that allows the user to perform a spatial selection on a given set of {@link SelectionSource}.
+ */
+export declare const Selection: FC<SelectionProps>;