@esri/solutions-components 0.7.23 → 0.7.24

package/dist/collection/components/feature-list/feature-list.js

@@ -0,0 +1,303 @@
+/*!
+ * Copyright 2022 Esri
+ * Licensed under the Apache License, Version 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
+ */
+/** @license
+ * Copyright 2022 Esri
+ *
+ * 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.
+ */
+import { h } from "@stencil/core";
+import { PopupUtils } from "../../utils/popupUtils";
+import { getFeatureLayerView, getLayerOrTable, highlightFeatures } from "../../utils/mapViewUtils";
+import { getLocaleComponentStrings } from "../../utils/locale";
+export class FeatureList {
+    constructor() {
+        this.selectedLayerId = undefined;
+        this.mapView = undefined;
+        this.noFeaturesFoundMsg = undefined;
+        this.pageSize = 100;
+        this.highlightOnMap = false;
+        this._featureItems = [];
+        this._featuresCount = 0;
+        this._isLoading = false;
+        this._translations = undefined;
+    }
+    //--------------------------------------------------------------------------
+    //
+    //  Functions (lifecycle)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * StencilJS: Called once just after the component is first connected to the DOM.
+     * @returns Promise when complete
+     */
+    async componentWillLoad() {
+        await this._getTranslations();
+        this._isLoading = true;
+        this._popupUtils = new PopupUtils();
+        this._selectedLayer = await getLayerOrTable(this.mapView, this.selectedLayerId);
+    }
+    /**
+     * StencilJS: Called once just after the component is fully loaded and the first render() occurs.
+     */
+    async componentDidLoad() {
+        if (this._selectedLayer) {
+            this._featureItems = await this.queryPage(0);
+            this._featuresCount = await this._selectedLayer.queryFeatureCount();
+            this._isLoading = false;
+        }
+    }
+    /**
+     * Renders the component.
+     */
+    render() {
+        return (h("calcite-panel", { "full-height": true, "full-width": true }, this._isLoading && h("calcite-loader", { scale: "m" }), this._featureItems.length === 0 && !this._isLoading && h("calcite-notice", { class: "error-msg", icon: "feature-details", kind: "info", open: true }, h("div", { slot: "message" }, this.noFeaturesFoundMsg ? this.noFeaturesFoundMsg : this._translations.featureErrorMsg)), h("calcite-list", { "selection-appearance": "border", "selection-mode": "single" }, !this._isLoading && this._featureItems.length > 0 && this._featureItems), this._featuresCount > this.pageSize &&
+            h("div", { class: "width-full", slot: "footer" }, h("calcite-pagination", { class: "pagination", "full-width": true, onCalcitePaginationChange: this.pageChanged.bind(this), "page-size": this.pageSize, "start-item": "1", "total-items": this._featuresCount }))));
+    }
+    //--------------------------------------------------------------------------
+    //
+    //  Functions (protected)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * On page change get the next updated feature list
+     * @param event page change event
+     * @protected
+     */
+    async pageChanged(event) {
+        this._isLoading = true;
+        if (this._highlightHandle) {
+            this._highlightHandle.remove();
+            this._highlightHandle = null;
+        }
+        const page = event.target.startItem - 1;
+        this._featureItems = await this.queryPage(page);
+        this._isLoading = false;
+    }
+    /**
+     * On feature click in feature list highlight the feature on the map
+     * @param event feature clicked event
+     * @protected
+     */
+    async featureClicked(event, selectedFeature) {
+        //clear previous highlight and remove the highlightHandle
+        if (this.highlightOnMap && this._highlightHandle) {
+            this._highlightHandle.remove();
+            this._highlightHandle = null;
+        }
+        //highlight on map only if it is selected item
+        if (event.target.selected) {
+            if (this.highlightOnMap) {
+                const selectedFeatureObjectId = Number(event.target.value);
+                const selectedLayerView = await getFeatureLayerView(this.mapView, this.selectedLayerId);
+                this._highlightHandle = await highlightFeatures([selectedFeatureObjectId], selectedLayerView, this.mapView, true);
+            }
+            this.featureSelect.emit(selectedFeature);
+        }
+    }
+    /**
+     * Query the selected feature layer, in descending order of object id's
+     * @param page 0th page number in the pagination item
+     * @returns List of features items to be rendered
+     * @protected
+     */
+    async queryPage(page) {
+        const featureLayer = this._selectedLayer;
+        const query = {
+            start: page,
+            num: this.pageSize,
+            outFields: ["*"],
+            orderByFields: [featureLayer.objectIdField + " DESC"],
+            returnGeometry: true,
+            where: featureLayer.definitionExpression
+        };
+        const featureSet = await featureLayer.queryFeatures(query);
+        return await this.createFeatureItem(featureSet);
+    }
+    /**
+     * Creates list of items using the popup titles
+     * @param featureSet Queried FeatureSet
+     * @returns List of features items to be rendered
+     * @protected
+     */
+    async createFeatureItem(featureSet) {
+        const currentFeatures = featureSet === null || featureSet === void 0 ? void 0 : featureSet.features;
+        const items = currentFeatures.map(async (feature) => {
+            const popupTitle = await this._popupUtils.getPopupTitle(feature);
+            return this.getFeatureItem(feature, popupTitle);
+        });
+        return Promise.all(items);
+    }
+    /**
+     * Get each feature item
+     * @param selectedFeature Each individual feature instance to be listed
+     * @param popupTitle feature popup title
+     * @returns individual feature item to be rendered
+     * @protected
+     */
+    getFeatureItem(selectedFeature, popupTitle) {
+        //get the object id value of the feature
+        const oId = selectedFeature.attributes[this._selectedLayer.objectIdField].toString();
+        //use object id if popupTitle is null or undefined
+        popupTitle = popupTitle !== null && popupTitle !== void 0 ? popupTitle : oId;
+        return (h("calcite-list-item", { onCalciteListItemSelect: (e) => { void this.featureClicked(e, selectedFeature); }, value: oId }, h("div", { class: "popup-title", slot: "content-start" }, popupTitle), h("calcite-icon", { icon: "chevron-right", scale: "s", slot: "content-end" })));
+    }
+    /**
+     * Fetches the component's translations
+     * @returns Promise when complete
+     * @protected
+     */
+    async _getTranslations() {
+        const messages = await getLocaleComponentStrings(this.el);
+        this._translations = messages[0];
+    }
+    static get is() { return "feature-list"; }
+    static get originalStyleUrls() {
+        return {
+            "$": ["feature-list.css"]
+        };
+    }
+    static get styleUrls() {
+        return {
+            "$": ["feature-list.css"]
+        };
+    }
+    static get properties() {
+        return {
+            "selectedLayerId": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "string: Layer id of the feature layer to show the list"
+                },
+                "attribute": "selected-layer-id",
+                "reflect": false
+            },
+            "mapView": {
+                "type": "unknown",
+                "mutable": false,
+                "complexType": {
+                    "original": "__esri.MapView",
+                    "resolved": "MapView",
+                    "references": {
+                        "___esri": {
+                            "location": "global",
+                            "id": "global::___esri"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html"
+                }
+            },
+            "noFeaturesFoundMsg": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": "string: Message to be displayed when features are not found"
+                },
+                "attribute": "no-features-found-msg",
+                "reflect": false
+            },
+            "pageSize": {
+                "type": "number",
+                "mutable": false,
+                "complexType": {
+                    "original": "number",
+                    "resolved": "number",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": "number: Number features to be fetched per page, by default 100 features will be fetched"
+                },
+                "attribute": "page-size",
+                "reflect": false,
+                "defaultValue": "100"
+            },
+            "highlightOnMap": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": "boolean: Highlight feature on map optional (default false) boolean to indicate if we should highlight and zoom to the extent of the feature geometry"
+                },
+                "attribute": "highlight-on-map",
+                "reflect": false,
+                "defaultValue": "false"
+            }
+        };
+    }
+    static get states() {
+        return {
+            "_featureItems": {},
+            "_featuresCount": {},
+            "_isLoading": {},
+            "_translations": {}
+        };
+    }
+    static get events() {
+        return [{
+                "method": "featureSelect",
+                "name": "featureSelect",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Emitted on demand when feature is selected using the list"
+                },
+                "complexType": {
+                    "original": "__esri.Graphic",
+                    "resolved": "Graphic",
+                    "references": {
+                        "___esri": {
+                            "location": "global",
+                            "id": "global::___esri"
+                        }
+                    }
+                }
+            }];
+    }
+    static get elementRef() { return "el"; }
+}

package/dist/collection/components/info-card/info-card.js

@@ -29,6 +29,7 @@ export class InfoCard {
         this.isMobile = undefined;
         this.mapView = undefined;
         this.zoomAndScrollToSelected = undefined;
+        this.allowEditing = true;
         this._alertOpen = false;
         this._count = "";
         this._editRecordOpen = false;
@@ -45,23 +46,7 @@ export class InfoCard {
      * Watch for changes to the graphic and update the feature widget
      */
     async graphicsWatchHandler() {
-        var _a;
-        if (!this._features) {
-            await this._initFeaturesWidget();
-        }
-        if (this.graphics.length > 0) {
-            const featureLayer = (_a = this.graphics[0]) === null || _a === void 0 ? void 0 : _a.layer;
-            this._editEnabled = featureLayer.editingEnabled && featureLayer.capabilities.operations.supportsUpdate;
-            this._mobileTitle = await this._popupUtils.getPopupTitle(this.graphics[0]);
-            this._features.open({
-                features: this.graphics
-            });
-        }
-        else {
-            this._features.clear();
-            this._features.close();
-        }
-        this._count = this._getCount();
+        await this.setGraphics();
     }
     /**
      * Watch for changes to the isMobile prop then init the Features widget
@@ -102,9 +87,12 @@ export class InfoCard {
      * Reset key properties when the layer selection changes
      */
     async layerSelectionChange() {
+        var _a;
         this._showListView = false;
-        this._features.viewModel.featureMenuOpen = false;
-        this._features.close();
+        if ((_a = this._features) === null || _a === void 0 ? void 0 : _a.viewModel) {
+            this._features.viewModel.featureMenuOpen = false;
+            this._features.close();
+        }
     }
     /**
      * Refresh the info-card graphics
@@ -127,11 +115,21 @@ export class InfoCard {
         await this._getTranslations();
         this._popupUtils = new PopupUtils();
     }
+    /**
+     * StencilJS: Called once just after the component is fully loaded and the first render() occurs.
+     * @returns Promise when complete
+     */
+    async componentDidLoad() {
+        var _a;
+        if (((_a = this.graphics) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+            await this.setGraphics();
+        }
+    }
     /**
      * Renders the component.
      */
     render() {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         const loadingClass = this.isLoading ? "" : "display-none";
         const featureNodeClass = this.isLoading || this._editRecordOpen ? "visibility-hidden" : "position-absolute";
         const editClass = !this.isLoading && this._editRecordOpen ? "position-absolute" : "display-none";
@@ -139,7 +137,11 @@ export class InfoCard {
         const nextBackDisabled = ((_b = (_a = this._features) === null || _a === void 0 ? void 0 : _a.features) === null || _b === void 0 ? void 0 : _b.length) < 2;
         const nextBackClass = this.isMobile ? "display-none" : "";
         const shellClass = this.isMobile && !this._editRecordOpen ? "padding-top-46" : "";
-        return (h(Host, null, this.isMobile && !this._editRecordOpen ? (h("calcite-panel", null, h("calcite-action", { class: "end-border", icon: "chevron-left", iconFlipRtl: true, onClick: () => this._closePopup(), scale: "s", slot: "header-actions-start", text: "" }), h("span", { class: "font-bold", slot: "header-content" }, this._mobileTitle))) : undefined, h("calcite-shell", { class: shellClass }, h("calcite-loader", { class: loadingClass, label: this._translations.fetchingData }), h("div", { class: "esri-widget " + featureNodeClass, id: "features-node" }), h("div", { class: `${editButtonClass} width-100`, slot: "footer" }, h("div", { class: "display-flex top-border padding-1-2" }, h("calcite-button", { appearance: "solid", id: "solutions-edit", onClick: () => this._openEditRecord(), width: "full" }, this._translations.edit), this.isMobile ? (h("calcite-button", { appearance: "outline", class: "padding-inline-start-1", id: "solutions-cancel", onClick: () => this._closePopup(), width: "full" }, this._translations.cancel)) : undefined, h("calcite-tooltip", { label: "", placement: "bottom", "reference-element": "solutions-edit" }, h("span", null, this._translations.edit)), this.isMobile ? (h("calcite-tooltip", { label: "", placement: "bottom", "reference-element": "solutions-cancel" }, h("span", null, this._translations.cancel))) : undefined), h("div", { class: `display-flex padding-1-2 button-container top-border ${nextBackClass}` }, h("div", { class: "min-width-100" }, h("calcite-button", { appearance: "outline", disabled: nextBackDisabled, id: "solutions-back", onClick: () => this._back(), width: "full" }, this._translations.back), h("calcite-tooltip", { label: "", placement: "top", "reference-element": "solutions-back" }, h("span", null, this._translations.back))), h("div", null, h("calcite-action", { icon: "list", onClick: () => this._toggleListView(), scale: "s", text: this._count, textEnabled: true })), h("div", { class: "min-width-100" }, h("calcite-button", { appearance: "outline", disabled: nextBackDisabled, id: "solutions-next", onClick: () => this._next(), width: "full" }, this._translations.next), h("calcite-tooltip", { label: "", placement: "top", "reference-element": "solutions-next" }, h("span", null, this._translations.next))))), h("edit-card", { class: editClass, graphicIndex: (_c = this._features) === null || _c === void 0 ? void 0 : _c.selectedFeatureIndex, graphics: this.graphics, mapView: this.mapView, open: this._editRecordOpen }), h("calcite-alert", { icon: "layer-broken", kind: "warning", label: "", onCalciteAlertClose: () => this._alertClosed(), open: this._alertOpen, placement: "top" }, h("div", { slot: "title" }, this._translations.editDisabled), h("div", { slot: "message" }, this._translations.enableEditing)))));
+        const id = (_d = (_c = this._features) === null || _c === void 0 ? void 0 : _c.selectedFeature) === null || _d === void 0 ? void 0 : _d.getObjectId();
+        const ids = parseInt(id === null || id === void 0 ? void 0 : id.toString(), 10) > -1 ? [id] : [];
+        const deleteEnabled = ((_e = this._layer) === null || _e === void 0 ? void 0 : _e.editingEnabled) && ((_h = (_g = (_f = this._layer) === null || _f === void 0 ? void 0 : _f.capabilities) === null || _g === void 0 ? void 0 : _g.operations) === null || _h === void 0 ? void 0 : _h.supportsDelete);
+        return (h(Host, null, this.isMobile && !this._editRecordOpen ? (h("calcite-panel", null, h("calcite-action", { class: "end-border", icon: "chevron-left", iconFlipRtl: true, onClick: () => this._closePopup(), scale: "s", slot: "header-actions-start", text: "" }), h("span", { class: "font-bold", slot: "header-content" }, this._mobileTitle))) : undefined, h("calcite-shell", { class: shellClass }, h("calcite-loader", { class: loadingClass, label: this._translations.fetchingData }), h("div", { class: "esri-widget " + featureNodeClass, id: "features-node" }), h("div", { class: `${editButtonClass} width-100`, slot: "footer" }, this.allowEditing &&
+            h("div", { class: "display-flex top-border padding-1-2" }, h("calcite-button", { appearance: "solid", id: "solutions-edit", onClick: () => this._openEditRecord(), width: "full" }, this._translations.edit), this.isMobile && deleteEnabled ? (h("delete-button", { class: "padding-inline-start-1 width-100", id: "solutions-delete", ids: ids, layer: this._layer, onEditsComplete: () => this._closePopup() })) : undefined, h("calcite-tooltip", { label: "", placement: "bottom", "reference-element": "solutions-edit" }, h("span", null, this._translations.edit)), this.isMobile ? (h("calcite-tooltip", { label: "", placement: "bottom", "reference-element": "solutions-delete" }, h("span", null, this._translations.delete))) : undefined), !nextBackDisabled && h("div", { class: `display-flex padding-1-2 button-container top-border ${nextBackClass}` }, h("div", { class: "min-width-100" }, h("calcite-button", { appearance: "outline", disabled: nextBackDisabled, id: "solutions-back", onClick: () => this._back(), width: "full" }, this._translations.back), h("calcite-tooltip", { label: "", placement: "top", "reference-element": "solutions-back" }, h("span", null, this._translations.back))), h("div", null, h("calcite-action", { icon: "list", onClick: () => this._toggleListView(), scale: "s", text: this._count, textEnabled: true })), h("div", { class: "min-width-100" }, h("calcite-button", { appearance: "outline", disabled: nextBackDisabled, id: "solutions-next", onClick: () => this._next(), width: "full" }, this._translations.next), h("calcite-tooltip", { label: "", placement: "top", "reference-element": "solutions-next" }, h("span", null, this._translations.next))))), h("edit-card", { class: editClass, graphicIndex: (_j = this._features) === null || _j === void 0 ? void 0 : _j.selectedFeatureIndex, graphics: this.graphics, mapView: this.mapView, open: this._editRecordOpen }), h("calcite-alert", { icon: "layer-broken", kind: "warning", label: "", onCalciteAlertClose: () => this._alertClosed(), open: this._alertOpen, placement: "top" }, h("div", { slot: "title" }, this._translations.editDisabled), h("div", { slot: "message" }, this._translations.enableEditing)))));
     }
     //--------------------------------------------------------------------------
     //
@@ -161,6 +163,30 @@ export class InfoCard {
         this.Features = Features;
         this.reactiveUtils = reactiveUtils;
     }
+    /**
+     * Initializes the features widget if not created and updates the feature widget and other required states
+     *
+     * @protected
+     */
+    async setGraphics() {
+        var _a;
+        if (!this._features) {
+            await this._initFeaturesWidget();
+        }
+        if (this.graphics.length > 0) {
+            this._layer = (_a = this.graphics[0]) === null || _a === void 0 ? void 0 : _a.layer;
+            this._editEnabled = this._layer.editingEnabled && this._layer.capabilities.operations.supportsUpdate;
+            this._mobileTitle = await this._popupUtils.getPopupTitle(this.graphics[0]);
+            this._features.open({
+                features: this.graphics
+            });
+        }
+        else {
+            this._features.clear();
+            this._features.close();
+        }
+        this._count = this._getCount();
+    }
     /**
      * Init the Feature widget so we can display the popup content
      *
@@ -378,6 +404,24 @@ export class InfoCard {
                 },
                 "attribute": "zoom-and-scroll-to-selected",
                 "reflect": false
+            },
+            "allowEditing": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": "boolean: If true will show edit button"
+                },
+                "attribute": "allow-editing",
+                "reflect": false,
+                "defaultValue": "true"
             }
         };
     }

package/dist/collection/components/layer-list/layer-list.css

@@ -0,0 +1,28 @@
+/** @license
+ * Copyright 2022 Esri
+ *
+ * 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.
+ */
+
+:host {
+  display: block;
+}
+
+.error-msg {
+  padding: 10px;
+}
+
+.layer-name {
+  font-weight: 500;
+  padding: 10px 12px;
+}