@esri/solutions-components 0.6.6 → 0.6.8

package/dist/types/components/map-search/map-search.d.ts

@@ -0,0 +1,107 @@
+/** @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.
+ */
+/// <reference types="arcgis-js-api" />
+import { ISearchConfiguration } from "../../utils/interfaces";
+export declare class MapSearch {
+  /**
+   * esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+   */
+  mapView: __esri.MapView;
+  /**
+   * boolean: When true the selected feature popup will be shown when serach result is found
+   */
+  popupEnabled: boolean;
+  /**
+   * boolean: When true a graphic will be added for the search result
+   */
+  resultGraphicEnabled: boolean;
+  /**
+   * ISearchConfiguration: Configuration details for the Search widget
+   */
+  searchConfiguration: ISearchConfiguration;
+  /**
+   * string: Text entered by the end user.
+   * Used to search against the locator.
+   */
+  searchTerm: string;
+  /**
+   * esri/widgets/Search: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html
+   */
+  searchWidget: __esri.widgetsSearch;
+  /**
+   * esri/layers/FeatureLayer: https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html
+   */
+  protected FeatureLayer: typeof import("esri/layers/FeatureLayer");
+  /**
+   * esri/widgets/Search: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html
+   */
+  protected Search: typeof import("esri/widgets/Search");
+  /**
+   * HTMLElement: The container div for the search widget
+   */
+  protected _searchElement: HTMLElement;
+  /**
+   * An array of objects representing the results of search
+   */
+  protected _searchResult: any;
+  /**
+   * Called each time the searchConfiguration prop is changed.
+   *
+   * @returns Promise when complete
+   */
+  watchSearchConfigurationHandler(): Promise<void>;
+  /**
+   * Called each time the mapView prop is changed.
+   *
+   * @returns Promise when complete
+   */
+  mapViewWatchHandler(): Promise<void>;
+  /**
+   * StencilJS: Called once just after the component is first connected to the DOM.
+   */
+  componentWillLoad(): Promise<void>;
+  /**
+   * StencilJS: Called once just after the component is fully loaded and the first render() occurs.
+   */
+  componentDidLoad(): Promise<void>;
+  /**
+   * Renders the component.
+   */
+  render(): any;
+  /**
+   * Load esri javascript api modules
+   *
+   * @returns Promise resolving when function is done
+   *
+   * @protected
+   */
+  protected _initModules(): Promise<void>;
+  /**
+   * Initialize the search widget
+   *
+   * @protected
+   */
+  protected _initSearchWidget(): void;
+  /**
+   * Initialize the search widget based on user defined configuration
+   *
+   * @param searchConfiguration search configuration defined by the user
+   * @param view the current map view
+   *
+   * @protected
+   */
+  protected _getSearchConfig(searchConfiguration: ISearchConfiguration, view: __esri.MapView): ISearchConfiguration;
+}

package/dist/types/components/map-tools/map-tools.d.ts

@@ -16,7 +16,7 @@
 /// <reference types="arcgis-js-api" />
 import { EventEmitter, VNode } from '../../stencil-public-runtime';
 import MapTools_T9n from "../../assets/t9n/map-tools/resources.json";
-import { EExpandType } from "../../utils/interfaces";
+import { EExpandType, ISearchConfiguration } from "../../utils/interfaces";
 export declare class MapTools {
   el: HTMLMapToolsElement;
   /**
@@ -27,6 +27,10 @@ export declare class MapTools {
    * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
    */
   mapView: __esri.MapView;
+  /**
+   * ISearchConfiguration: Configuration details for the Search widget
+   */
+  searchConfiguration: ISearchConfiguration;
   /**
    * Contains the translations for this component.
    * All UI strings should be defined here.
@@ -39,7 +43,35 @@ export declare class MapTools {
   /**
    * When true the basemap picker will be displayed
    */
-  _showBasemapPicker: boolean;
+  _showBasemapWidget: boolean;
+  /**
+   * When true the search widget will be displayed
+   */
+  _showSearchWidget: boolean;
+  /**
+   * HTMLMapSearchElement: The search element node
+   */
+  protected _basemapElement: HTMLBasemapGalleryElement;
+  /**
+   * esri/geometry/Extent: https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html
+   */
+  protected _homeExtent: __esri.Extent;
+  /**
+   * HTMLMapSearchElement: The search element node
+   */
+  protected _searchElement: HTMLMapSearchElement;
+  /**
+   * Store the home extent when the map view changes
+   */
+  mapViewWatchHandler(): Promise<void>;
+  /**
+   * When the _showBasemapWidget property is true display the basemap gallery
+   */
+  _showBasemapWidgetWatchHandler(v: boolean): Promise<void>;
+  /**
+   * When the _showSearchWidget property is true display the search widget
+   */
+  _showSearchWidgetWatchHandler(v: boolean): Promise<void>;
   /**
    * Emitted when the expand button is clicked
    */
@@ -65,11 +97,42 @@ export declare class MapTools {
    * @protected
    */
   protected _getActionGroup(icon: string, disabled: boolean, tip: string, func: any): VNode;
-  protected _goHome(): void;
+  /**
+   * Go to the exent that was first used when loading the map
+   *
+   * @returns void
+   *
+   * @protected
+   */
+  protected _goHome(): Promise<void>;
   protected _showList(): void;
   protected _search(): void;
-  protected _zoomIn(): void;
-  protected _zoomOut(): void;
+  /**
+   * Fixed zoom in
+   *
+   * @returns void
+   *
+   * @protected
+   */
+  protected _zoomIn(): Promise<void>;
+  /**
+   * Fixed zoom out
+   *
+   * @returns void
+   *
+   * @protected
+   */
+  protected _zoomOut(): Promise<void>;
+  /**
+   * Zoom in/out at the maps current center point
+   *
+   * @param zoom Number to zoom level to go to
+   *
+   * @returns void
+   *
+   * @protected
+   */
+  protected _zoom(zoom: number): Promise<void>;
   /**
    * Show/Hide the basemap picker
    *

package/dist/types/components.d.ts

@@ -10,6 +10,16 @@ import { UserSession } from "@esri/solution-common";
 export { DistanceUnit, EDrawMode, EExpandType, ELayoutMode, IExportInfos, IInventoryItem, IMapInfo, ISearchConfiguration, ISelectionSet, ISketchGraphicsChange, ISolutionSpatialReferenceInfo, ISpatialRefRepresentation, IValueChange } from "./utils/interfaces";
 export { UserSession } from "@esri/solution-common";
 export namespace Components {
+    interface BasemapGallery {
+        /**
+          * esri/widgets/BasemapGallery: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html  BasemapGallery instance
+         */
+        "basemapWidget": __esri.BasemapGallery;
+        /**
+          * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+         */
+        "mapView": __esri.MapView;
+    }
     interface BufferTools {
         /**
           * string: The appearance of display. Can be a "slider" or "text" inputs for distance/value
@@ -76,6 +86,14 @@ export namespace Components {
           * IMapInfo[]: array of map infos (name and id)
          */
         "mapInfos": IMapInfo[];
+        /**
+          * ISearchConfiguration: Configuration details for the Search widget
+         */
+        "searchConfiguration": ISearchConfiguration;
+        /**
+          * boolean: when true the table will be sorted by objectid in descending order by default
+         */
+        "showNewestFirst": boolean;
         /**
           * boolean: When true the selected feature will zoomed to in the map and the row will be scrolled to within the table
          */
@@ -174,6 +192,10 @@ export namespace Components {
           * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
          */
         "mapView": __esri.MapView;
+        /**
+          * boolean: when true the table will be sorted by objectid in descending order by default
+         */
+        "showNewestFirst": boolean;
         /**
           * boolean: When true the selected feature will zoomed to in the map and the row will be scrolled to within the table
          */
@@ -289,6 +311,32 @@ export namespace Components {
          */
         "mapInfos": IMapInfo[];
     }
+    interface MapSearch {
+        /**
+          * esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+         */
+        "mapView": __esri.MapView;
+        /**
+          * boolean: When true the selected feature popup will be shown when serach result is found
+         */
+        "popupEnabled": boolean;
+        /**
+          * boolean: When true a graphic will be added for the search result
+         */
+        "resultGraphicEnabled": boolean;
+        /**
+          * ISearchConfiguration: Configuration details for the Search widget
+         */
+        "searchConfiguration": ISearchConfiguration;
+        /**
+          * string: Text entered by the end user. Used to search against the locator.
+         */
+        "searchTerm": string;
+        /**
+          * esri/widgets/Search: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html
+         */
+        "searchWidget": __esri.widgetsSearch;
+    }
     interface MapSelectTools {
         /**
           * string | number[] |  object with r, g, b, a: https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html
@@ -382,6 +430,10 @@ export namespace Components {
           * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
          */
         "mapView": __esri.MapView;
+        /**
+          * ISearchConfiguration: Configuration details for the Search widget
+         */
+        "searchConfiguration": ISearchConfiguration;
     }
     interface PciCalculator {
     }
@@ -760,6 +812,12 @@ export interface StoreManagerCustomEvent<T> extends CustomEvent<T> {
     target: HTMLStoreManagerElement;
 }
 declare global {
+    interface HTMLBasemapGalleryElement extends Components.BasemapGallery, HTMLStencilElement {
+    }
+    var HTMLBasemapGalleryElement: {
+        prototype: HTMLBasemapGalleryElement;
+        new (): HTMLBasemapGalleryElement;
+    };
     interface HTMLBufferToolsElement extends Components.BufferTools, HTMLStencilElement {
     }
     var HTMLBufferToolsElement: {
@@ -850,6 +908,12 @@ declare global {
         prototype: HTMLMapPickerElement;
         new (): HTMLMapPickerElement;
     };
+    interface HTMLMapSearchElement extends Components.MapSearch, HTMLStencilElement {
+    }
+    var HTMLMapSearchElement: {
+        prototype: HTMLMapSearchElement;
+        new (): HTMLMapSearchElement;
+    };
     interface HTMLMapSelectToolsElement extends Components.MapSelectTools, HTMLStencilElement {
     }
     var HTMLMapSelectToolsElement: {
@@ -959,6 +1023,7 @@ declare global {
         new (): HTMLStoreManagerElement;
     };
     interface HTMLElementTagNameMap {
+        "basemap-gallery": HTMLBasemapGalleryElement;
         "buffer-tools": HTMLBufferToolsElement;
         "card-manager": HTMLCardManagerElement;
         "crowdsource-manager": HTMLCrowdsourceManagerElement;
@@ -974,6 +1039,7 @@ declare global {
         "map-draw-tools": HTMLMapDrawToolsElement;
         "map-layer-picker": HTMLMapLayerPickerElement;
         "map-picker": HTMLMapPickerElement;
+        "map-search": HTMLMapSearchElement;
         "map-select-tools": HTMLMapSelectToolsElement;
         "map-tools": HTMLMapToolsElement;
         "pci-calculator": HTMLPciCalculatorElement;
@@ -995,6 +1061,16 @@ declare global {
     }
 }
 declare namespace LocalJSX {
+    interface BasemapGallery {
+        /**
+          * esri/widgets/BasemapGallery: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html  BasemapGallery instance
+         */
+        "basemapWidget"?: __esri.BasemapGallery;
+        /**
+          * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+         */
+        "mapView"?: __esri.MapView;
+    }
     interface BufferTools {
         /**
           * string: The appearance of display. Can be a "slider" or "text" inputs for distance/value
@@ -1073,6 +1149,14 @@ declare namespace LocalJSX {
           * IMapInfo[]: array of map infos (name and id)
          */
         "mapInfos"?: IMapInfo[];
+        /**
+          * ISearchConfiguration: Configuration details for the Search widget
+         */
+        "searchConfiguration"?: ISearchConfiguration;
+        /**
+          * boolean: when true the table will be sorted by objectid in descending order by default
+         */
+        "showNewestFirst"?: boolean;
         /**
           * boolean: When true the selected feature will zoomed to in the map and the row will be scrolled to within the table
          */
@@ -1157,6 +1241,10 @@ declare namespace LocalJSX {
           * Emitted on demand when a layer is selected
          */
         "onFeatureSelectionChange"?: (event: LayerTableCustomEvent<number[]>) => void;
+        /**
+          * boolean: when true the table will be sorted by objectid in descending order by default
+         */
+        "showNewestFirst"?: boolean;
         /**
           * boolean: When true the selected feature will zoomed to in the map and the row will be scrolled to within the table
          */
@@ -1294,6 +1382,32 @@ declare namespace LocalJSX {
          */
         "onMapInfoChange"?: (event: MapPickerCustomEvent<IMapInfo>) => void;
     }
+    interface MapSearch {
+        /**
+          * esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+         */
+        "mapView"?: __esri.MapView;
+        /**
+          * boolean: When true the selected feature popup will be shown when serach result is found
+         */
+        "popupEnabled"?: boolean;
+        /**
+          * boolean: When true a graphic will be added for the search result
+         */
+        "resultGraphicEnabled"?: boolean;
+        /**
+          * ISearchConfiguration: Configuration details for the Search widget
+         */
+        "searchConfiguration"?: ISearchConfiguration;
+        /**
+          * string: Text entered by the end user. Used to search against the locator.
+         */
+        "searchTerm"?: string;
+        /**
+          * esri/widgets/Search: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html
+         */
+        "searchWidget"?: __esri.widgetsSearch;
+    }
     interface MapSelectTools {
         /**
           * string | number[] |  object with r, g, b, a: https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html
@@ -1385,6 +1499,10 @@ declare namespace LocalJSX {
           * Emitted when the expand button is clicked
          */
         "onExpandMap"?: (event: MapToolsCustomEvent<EExpandType>) => void;
+        /**
+          * ISearchConfiguration: Configuration details for the Search widget
+         */
+        "searchConfiguration"?: ISearchConfiguration;
     }
     interface PciCalculator {
     }
@@ -1666,6 +1784,7 @@ declare namespace LocalJSX {
         "value"?: string;
     }
     interface IntrinsicElements {
+        "basemap-gallery": BasemapGallery;
         "buffer-tools": BufferTools;
         "card-manager": CardManager;
         "crowdsource-manager": CrowdsourceManager;
@@ -1681,6 +1800,7 @@ declare namespace LocalJSX {
         "map-draw-tools": MapDrawTools;
         "map-layer-picker": MapLayerPicker;
         "map-picker": MapPicker;
+        "map-search": MapSearch;
         "map-select-tools": MapSelectTools;
         "map-tools": MapTools;
         "pci-calculator": PciCalculator;
@@ -1705,6 +1825,7 @@ export { LocalJSX as JSX };
 declare module "@stencil/core" {
     export namespace JSX {
         interface IntrinsicElements {
+            "basemap-gallery": LocalJSX.BasemapGallery & JSXBase.HTMLAttributes<HTMLBasemapGalleryElement>;
             "buffer-tools": LocalJSX.BufferTools & JSXBase.HTMLAttributes<HTMLBufferToolsElement>;
             "card-manager": LocalJSX.CardManager & JSXBase.HTMLAttributes<HTMLCardManagerElement>;
             "crowdsource-manager": LocalJSX.CrowdsourceManager & JSXBase.HTMLAttributes<HTMLCrowdsourceManagerElement>;
@@ -1720,6 +1841,7 @@ declare module "@stencil/core" {
             "map-draw-tools": LocalJSX.MapDrawTools & JSXBase.HTMLAttributes<HTMLMapDrawToolsElement>;
             "map-layer-picker": LocalJSX.MapLayerPicker & JSXBase.HTMLAttributes<HTMLMapLayerPickerElement>;
             "map-picker": LocalJSX.MapPicker & JSXBase.HTMLAttributes<HTMLMapPickerElement>;
+            "map-search": LocalJSX.MapSearch & JSXBase.HTMLAttributes<HTMLMapSearchElement>;
             "map-select-tools": LocalJSX.MapSelectTools & JSXBase.HTMLAttributes<HTMLMapSelectToolsElement>;
             "map-tools": LocalJSX.MapTools & JSXBase.HTMLAttributes<HTMLMapToolsElement>;
             "pci-calculator": LocalJSX.PciCalculator & JSXBase.HTMLAttributes<HTMLPciCalculatorElement>;

package/dist/types/preact.d.ts

@@ -6,6 +6,8 @@ declare module "preact/src/jsx" {
   namespace JSXInternal {
     interface IntrinsicElements {
       
+      "basemap-gallery": JSX.SolutionsBasemapGallery & JSXInternal.HTMLAttributes<HTMLSolutionsBasemapGalleryElement>
+
       "buffer-tools": Omit<JSX.SolutionsBufferTools, "onBufferComplete" | "onDistanceChanged" | "onUnitChanged"> & JSXInternal.HTMLAttributes<HTMLSolutionsBufferToolsElement> & {
         "onbufferComplete"?: (event: CustomEvent<any>) => void;
         "ondistanceChanged"?: (event: CustomEvent<any>) => void;
@@ -508,6 +510,8 @@ declare module "preact/src/jsx" {
         "onmapInfoChange"?: (event: CustomEvent<any>) => void;
       }
 
+      "map-search": JSX.SolutionsMapSearch & JSXInternal.HTMLAttributes<HTMLSolutionsMapSearchElement>
+
       "map-select-tools": Omit<JSX.SolutionsMapSelectTools, "onSelectionSetChange"> & JSXInternal.HTMLAttributes<HTMLSolutionsMapSelectToolsElement> & {
         "onselectionSetChange"?: (event: CustomEvent<any>) => void;
       }

package/dist/types/stencil-public-runtime.d.ts

@@ -872,6 +872,8 @@ export declare namespace JSXBase {
     }
     interface ImgHTMLAttributes<T> extends HTMLAttributes<T> {
         alt?: string;
+        crossOrigin?: string;
+        crossorigin?: string;
         decoding?: 'async' | 'auto' | 'sync';
         importance?: 'low' | 'auto' | 'high';
         height?: number | string;

package/dist/types/utils/interfaces.d.ts

@@ -386,6 +386,8 @@ export interface IMediaCardValues {
 export interface IMapInfo {
   id: string;
   name: string;
+  searchConfiguration?: ISearchConfiguration;
+  filters?: any[];
 }
 export interface IExportInfos {
   [key: string]: IExportInfo;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/solutions-components",
-  "version": "0.6.6",
+  "version": "0.6.8",
   "description": "Web Components for Esri's Solutions Applications",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",