@esri/solutions-components 0.6.7 → 0.6.8

package/dist/collection/utils/mapViewUtils.js

@@ -1,240 +1,240 @@
-/*!
- * 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 { queryExtent } from "./queryUtils";
-import { EWorkflowType } from "./interfaces";
-/**
- * Gets the layer names from the current map
- *
- * @param mapView the map view to fetch the layer names from
- *
- * @returns Promise resolving with an array of layer names
- *
- */
-export async function getMapLayerHash(mapView) {
-  let layerHash = {};
-  await mapView.when(() => {
-    layerHash = mapView.map.allLayers.toArray().reduce((prev, cur) => {
-      if (cur.type === "feature") {
-        prev[cur.id] = cur.title;
-      }
-      return prev;
-    }, {});
-  });
-  return layerHash;
-}
-/**
- * Gets the table names from the current map
- *
- * @param mapView the map view to fetch the table names from
- *
- * @returns Promise resolving with an array of table names
- *
- */
-export async function getMapTableHash(mapView) {
-  let tableHash = {};
-  await mapView.when(() => {
-    tableHash = mapView.map.allTables.toArray().reduce((prev, cur) => {
-      prev[cur.id] = cur.title;
-      return prev;
-    }, {});
-  });
-  return tableHash;
-}
-/**
- * Gets the layer names from the current map
- *
- * @param mapView the map view to fetch the layer names from
- *
- * @returns Promise resolving with an array of layer names
- *
- */
-export async function getMapLayerIds(mapView) {
-  let layerIds = [];
-  await mapView.when(() => {
-    layerIds = mapView.map.allLayers.toArray().reduce((prev, cur) => {
-      if (cur.type === "feature") {
-        prev.push(cur.id);
-      }
-      return prev;
-    }, []);
-  });
-  return layerIds;
-}
-/**
- * Gets the table names from the current map
- *
- * @param mapView the map view to fetch the table names from
- *
- * @returns Promise resolving with an array of table names
- *
- */
-export async function getMapTableIds(mapView) {
-  // TODO...seems like its the same as the hash...see if I can remove this
-  let tableIds = [];
-  await mapView.when(() => {
-    tableIds = mapView.map.allTables.toArray().reduce((prev, cur) => {
-      prev.push(cur.id);
-      return prev;
-    }, []);
-  });
-  return tableIds;
-}
-/**
- * Get a layer view by id
- *
- * @param mapView the map view to fetch the layer from
- * @param id the id if the layer to fetch
- *
- * @returns Promise resolving with the fetched layer view
- *
- */
-export async function getFeatureLayerView(mapView, id) {
-  const layer = await getLayer(mapView, id);
-  return layer ? await mapView.whenLayerView(layer) : undefined;
-}
-/**
- * Get a layer by id
- *
- * @param mapView the map view to fetch the layer from
- * @param id the id if the layer to fetch
- *
- * @returns Promise resolving with the fetched layer
- *
- */
-export async function getLayer(mapView, id) {
-  let layers = [];
-  await mapView.when(() => {
-    layers = [
-      ...mapView.map.allLayers.toArray(),
-      ...mapView.map.allTables.toArray()
-    ].filter((l) => {
-      return l.id === id;
-    });
-  });
-  return layers.length > 0 ? layers[0] : undefined;
-}
-/**
- * Highlight features by OID
- *
- * @param ids the OIDs from the layer to highlight
- * @param layerView the layer view to highlight
- * @param mapView the map view used if updateExtent is true
- * @param updateExtent optional (default false) boolean to indicate if we should zoom to the extent
- *
- * @returns Promise resolving with the highlight handle
- */
-export async function highlightFeatures(ids, layerView, mapView, updateExtent = false) {
-  if (updateExtent) {
-    await goToSelection(ids, layerView, mapView, false);
-  }
-  return layerView.highlight(ids);
-}
-/**
- * Highlights features from all sets including the refine set
- *
- * @param selectionSets The selection sets to highlight
- *
- * @returns Promise resolving with the highlight handles
- *
- */
-export async function highlightAllFeatures(selectionSets) {
-  const highlightInfos = getIdSets(selectionSets);
-  return Object.keys(highlightInfos).reduce((prev, cur) => {
-    const highlightInfo = highlightInfos[cur];
-    prev.push(highlightInfo.layerView.highlight(highlightInfo.ids));
-    return prev;
-  }, []);
-}
-/**
- * Highlights features from all sets including the refine set
- *
- * @param selectionSets The selection sets to highlight
- *
- * @returns Promise resolving with the highlight handles
- *
- */
-export function getIdSets(selectionSets) {
-  return selectionSets.reduce((prev, cur) => {
-    const lv = cur.layerView;
-    const id = lv === null || lv === void 0 ? void 0 : lv.layer.id;
-    if (id && Object.keys(prev).indexOf(id) > -1) {
-      prev[id].ids = [...new Set([
-          ...cur.selectedIds,
-          ...prev[id].ids
-        ])];
-    }
-    else if (id) {
-      prev[id] = {
-        layerView: lv,
-        ids: cur.selectedIds
-      };
-    }
-    if (cur.workflowType === EWorkflowType.REFINE) {
-      Object.keys(cur.refineInfos).forEach(k => {
-        const refineInfo = cur.refineInfos[k];
-        if (Object.keys(prev).indexOf(k) > -1) {
-          prev[k].ids = [...new Set([
-              ...refineInfo.addIds,
-              ...prev[k].ids
-            ])];
-          prev[k].ids = prev[k].ids.filter(_id => refineInfo.removeIds.indexOf(_id) < 0);
-        }
-      });
-    }
-    return prev;
-  }, {});
-}
-/**
- * Flash features by OID
- *
- * @param ids the OIDs from the layer to highlight
- * @param layerView the layer view to highlight
- *
- * @returns Promise resolving when the operation is complete
- *
- */
-export async function flashSelection(ids, layerView, featureEffect) {
-  const filter = {
-    objectIds: ids
-  };
-  layerView.featureEffect = Object.assign(Object.assign({}, featureEffect), { filter });
-  setTimeout(() => {
-    layerView.featureEffect = undefined;
-  }, 1300);
-}
-/**
- * Zoom to features based on OID
- *
- * @param ids the OIDs from the layer to go to
- * @param layerView the layer view that contains the OIDs
- * @param mapView the map view to show the extent change
- * @param flashFeatures optional (default true) boolean to indicate if we should flash the features
- *
- * @returns Promise resolving when the operation is complete
- *
- */
-export async function goToSelection(ids, layerView, mapView, flashFeatures = true, featureEffect = undefined) {
-  const result = await queryExtent(ids, layerView.layer);
-  await mapView.goTo(result.extent);
-  if (flashFeatures) {
-    await flashSelection(ids, layerView, featureEffect);
-  }
-}
+/*!
+ * 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 { queryExtent } from "./queryUtils";
+import { EWorkflowType } from "./interfaces";
+/**
+ * Gets the layer names from the current map
+ *
+ * @param mapView the map view to fetch the layer names from
+ *
+ * @returns Promise resolving with an array of layer names
+ *
+ */
+export async function getMapLayerHash(mapView) {
+  let layerHash = {};
+  await mapView.when(() => {
+    layerHash = mapView.map.allLayers.toArray().reduce((prev, cur) => {
+      if (cur.type === "feature") {
+        prev[cur.id] = cur.title;
+      }
+      return prev;
+    }, {});
+  });
+  return layerHash;
+}
+/**
+ * Gets the table names from the current map
+ *
+ * @param mapView the map view to fetch the table names from
+ *
+ * @returns Promise resolving with an array of table names
+ *
+ */
+export async function getMapTableHash(mapView) {
+  let tableHash = {};
+  await mapView.when(() => {
+    tableHash = mapView.map.allTables.toArray().reduce((prev, cur) => {
+      prev[cur.id] = cur.title;
+      return prev;
+    }, {});
+  });
+  return tableHash;
+}
+/**
+ * Gets the layer names from the current map
+ *
+ * @param mapView the map view to fetch the layer names from
+ *
+ * @returns Promise resolving with an array of layer names
+ *
+ */
+export async function getMapLayerIds(mapView) {
+  let layerIds = [];
+  await mapView.when(() => {
+    layerIds = mapView.map.allLayers.toArray().reduce((prev, cur) => {
+      if (cur.type === "feature") {
+        prev.push(cur.id);
+      }
+      return prev;
+    }, []);
+  });
+  return layerIds;
+}
+/**
+ * Gets the table names from the current map
+ *
+ * @param mapView the map view to fetch the table names from
+ *
+ * @returns Promise resolving with an array of table names
+ *
+ */
+export async function getMapTableIds(mapView) {
+  // TODO...seems like its the same as the hash...see if I can remove this
+  let tableIds = [];
+  await mapView.when(() => {
+    tableIds = mapView.map.allTables.toArray().reduce((prev, cur) => {
+      prev.push(cur.id);
+      return prev;
+    }, []);
+  });
+  return tableIds;
+}
+/**
+ * Get a layer view by id
+ *
+ * @param mapView the map view to fetch the layer from
+ * @param id the id if the layer to fetch
+ *
+ * @returns Promise resolving with the fetched layer view
+ *
+ */
+export async function getFeatureLayerView(mapView, id) {
+  const layer = await getLayer(mapView, id);
+  return layer ? await mapView.whenLayerView(layer) : undefined;
+}
+/**
+ * Get a layer by id
+ *
+ * @param mapView the map view to fetch the layer from
+ * @param id the id if the layer to fetch
+ *
+ * @returns Promise resolving with the fetched layer
+ *
+ */
+export async function getLayer(mapView, id) {
+  let layers = [];
+  await mapView.when(() => {
+    layers = [
+      ...mapView.map.allLayers.toArray(),
+      ...mapView.map.allTables.toArray()
+    ].filter((l) => {
+      return l.id === id;
+    });
+  });
+  return layers.length > 0 ? layers[0] : undefined;
+}
+/**
+ * Highlight features by OID
+ *
+ * @param ids the OIDs from the layer to highlight
+ * @param layerView the layer view to highlight
+ * @param mapView the map view used if updateExtent is true
+ * @param updateExtent optional (default false) boolean to indicate if we should zoom to the extent
+ *
+ * @returns Promise resolving with the highlight handle
+ */
+export async function highlightFeatures(ids, layerView, mapView, updateExtent = false) {
+  if (updateExtent) {
+    await goToSelection(ids, layerView, mapView, false);
+  }
+  return layerView.highlight(ids);
+}
+/**
+ * Highlights features from all sets including the refine set
+ *
+ * @param selectionSets The selection sets to highlight
+ *
+ * @returns Promise resolving with the highlight handles
+ *
+ */
+export async function highlightAllFeatures(selectionSets) {
+  const highlightInfos = getIdSets(selectionSets);
+  return Object.keys(highlightInfos).reduce((prev, cur) => {
+    const highlightInfo = highlightInfos[cur];
+    prev.push(highlightInfo.layerView.highlight(highlightInfo.ids));
+    return prev;
+  }, []);
+}
+/**
+ * Highlights features from all sets including the refine set
+ *
+ * @param selectionSets The selection sets to highlight
+ *
+ * @returns Promise resolving with the highlight handles
+ *
+ */
+export function getIdSets(selectionSets) {
+  return selectionSets.reduce((prev, cur) => {
+    const lv = cur.layerView;
+    const id = lv === null || lv === void 0 ? void 0 : lv.layer.id;
+    if (id && Object.keys(prev).indexOf(id) > -1) {
+      prev[id].ids = [...new Set([
+          ...cur.selectedIds,
+          ...prev[id].ids
+        ])];
+    }
+    else if (id) {
+      prev[id] = {
+        layerView: lv,
+        ids: cur.selectedIds
+      };
+    }
+    if (cur.workflowType === EWorkflowType.REFINE) {
+      Object.keys(cur.refineInfos).forEach(k => {
+        const refineInfo = cur.refineInfos[k];
+        if (Object.keys(prev).indexOf(k) > -1) {
+          prev[k].ids = [...new Set([
+              ...refineInfo.addIds,
+              ...prev[k].ids
+            ])];
+          prev[k].ids = prev[k].ids.filter(_id => refineInfo.removeIds.indexOf(_id) < 0);
+        }
+      });
+    }
+    return prev;
+  }, {});
+}
+/**
+ * Flash features by OID
+ *
+ * @param ids the OIDs from the layer to highlight
+ * @param layerView the layer view to highlight
+ *
+ * @returns Promise resolving when the operation is complete
+ *
+ */
+export async function flashSelection(ids, layerView, featureEffect) {
+  const filter = {
+    objectIds: ids
+  };
+  layerView.featureEffect = Object.assign(Object.assign({}, featureEffect), { filter });
+  setTimeout(() => {
+    layerView.featureEffect = undefined;
+  }, 1300);
+}
+/**
+ * Zoom to features based on OID
+ *
+ * @param ids the OIDs from the layer to go to
+ * @param layerView the layer view that contains the OIDs
+ * @param mapView the map view to show the extent change
+ * @param flashFeatures optional (default true) boolean to indicate if we should flash the features
+ *
+ * @returns Promise resolving when the operation is complete
+ *
+ */
+export async function goToSelection(ids, layerView, mapView, flashFeatures = true, featureEffect = undefined) {
+  const result = await queryExtent(ids, layerView.layer);
+  await mapView.goTo(result.extent);
+  if (flashFeatures) {
+    await flashSelection(ids, layerView, featureEffect);
+  }
+}