@esri/solutions-components 0.6.7 → 0.6.8

package/dist/types/components/map-layer-picker/map-layer-picker.d.ts

@@ -1,160 +1,160 @@
-/** @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 { EventEmitter, VNode } from "../../stencil-public-runtime";
-export declare class MapLayerPicker {
-  el: HTMLMapLayerPickerElement;
-  /**
-   * "transparent" | "solid": controls the button appearance when using the "dropdown" type
-   */
-  appearance: "transparent" | "solid";
-  /**
-   * string[]: Optional list of enabled layer ids
-   *  If empty all layers will be available
-   */
-  enabledLayerIds: string[];
-  /**
-   * string[]: Optional list of enabled table ids
-   *  If empty all tables will be available
-   */
-  enabledTableIds: string[];
-  /**
-   * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
-   */
-  mapView: __esri.MapView;
-  /**
-   * string: optional placeholder icon used with "combobox" type
-   */
-  placeholderIcon: string;
-  /**
-   * string[]: list of layer ids that have been selected by the end user
-   */
-  selectedIds: string[];
-  /**
-   * "s" | "m" | "l": scale to render the component
-   */
-  scale: "s" | "m" | "l";
-  /**
-   * boolean: when true standalone tables will also be available
-   */
-  showTables: boolean;
-  /**
-   * "select" | "combobox" | "dropdown": type of component to leverage
-   */
-  type: "select" | "combobox" | "dropdown";
-  /**
-   * string[]: list of layer and table (if showTables is true) ids from the map
-   */
-  ids: string[];
-  /**
-   * string: lcurrent layer name to display when using "dropdown" type
-   */
-  selectedName: string;
-  /**
-   * HTMLCalciteSelectElement: The html element for selecting layers
-   */
-  protected _layerElement: HTMLCalciteSelectElement | HTMLCalciteComboboxElement;
-  /**
-   * Called each time the mapView prop is changed.
-   *
-   */
-  mapViewWatchHandler(): Promise<void>;
-  /**
-   * Emitted on demand when a layer is selected
-   *
-   */
-  layerSelectionChange: EventEmitter<string[]>;
-  /**
-   * StencilJS: Called once just after the component is first connected to the DOM.
-   */
-  componentWillLoad(): Promise<void>;
-  /**
-   * Renders the component.
-   */
-  render(): VNode;
-  /**
-   * StencilJS: Called once just after the component is fully loaded and the first render() occurs.
-   */
-  componentDidLoad(): Promise<void>;
-  /**
-   * Create a list of layers from the map
-   *
-   * Used for selecting a single layer.
-   *
-   * @returns Calcite Select component with the ids of the layers from the map
-   */
-  _getSelect(): VNode;
-  /**
-   * Create a list of layer ids from the map
-   *
-   * Used for selecting multiple layers
-   *
-   * @returns Calcite ComboBox component with the ids of the layers from the map
-   */
-  _getCombobox(): VNode;
-  /**
-   * Hydrate a dropdown component with items to display the layer names
-   *
-   * @returns Array of Dropdown items with layer names
-   */
-  _getDropdown(): VNode;
-  /**
-   * Get the appropriate type of dom nodes for each valid layer or table
-   *
-   * @returns Array of dom nodes with the names of the layers and optionally of the tables
-   */
-  _getMapLayerOptions(): VNode[];
-  /**
-   * Get the appropriate type of dom node for the current layer or table id
-   *
-   * @returns A dom node with the name of the layer or table
-   */
-  _getItem(id: string, itemType: "layer" | "table"): VNode;
-  /**
-   * Store the layer name based on the user selection
-   */
-  _setSelectedLayer(id: string, type: "layer" | "table"): void;
-  /**
-   * Fetch the ids of the layers from the map
-   *
-   * @returns Promise when the operation has completed
-   */
-  _setLayers(): Promise<void>;
-  /**
-   * Create a layer id:title hash for layer name display
-   *
-   * @returns Promise when the operation has completed
-   */
-  protected _initStateHash(): Promise<void>;
-  /**
-   * Evaluate if the id exists in the current hash and verify if it should be excluded
-   *
-   * @returns boolean when true the layer will be used in the current layer picker type
-   */
-  protected _validLayer(id: string): boolean;
-  /**
-   * Evaluate if the id exists in the current hash and verify if it should be excluded
-   *
-   * @returns boolean when true the table will be used in the current layer picker type
-   */
-  protected _validTable(id: string): boolean;
-  /**
-   * Fetch the ids of the layers from the map
-   *
-   * @returns Promise when the operation has completed
-   */
-  _layerSelectionChange(): void;
-}
+/** @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 { EventEmitter, VNode } from "../../stencil-public-runtime";
+export declare class MapLayerPicker {
+  el: HTMLMapLayerPickerElement;
+  /**
+   * "transparent" | "solid": controls the button appearance when using the "dropdown" type
+   */
+  appearance: "transparent" | "solid";
+  /**
+   * string[]: Optional list of enabled layer ids
+   *  If empty all layers will be available
+   */
+  enabledLayerIds: string[];
+  /**
+   * string[]: Optional list of enabled table ids
+   *  If empty all tables will be available
+   */
+  enabledTableIds: string[];
+  /**
+   * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+   */
+  mapView: __esri.MapView;
+  /**
+   * string: optional placeholder icon used with "combobox" type
+   */
+  placeholderIcon: string;
+  /**
+   * string[]: list of layer ids that have been selected by the end user
+   */
+  selectedIds: string[];
+  /**
+   * "s" | "m" | "l": scale to render the component
+   */
+  scale: "s" | "m" | "l";
+  /**
+   * boolean: when true standalone tables will also be available
+   */
+  showTables: boolean;
+  /**
+   * "select" | "combobox" | "dropdown": type of component to leverage
+   */
+  type: "select" | "combobox" | "dropdown";
+  /**
+   * string[]: list of layer and table (if showTables is true) ids from the map
+   */
+  ids: string[];
+  /**
+   * string: lcurrent layer name to display when using "dropdown" type
+   */
+  selectedName: string;
+  /**
+   * HTMLCalciteSelectElement: The html element for selecting layers
+   */
+  protected _layerElement: HTMLCalciteSelectElement | HTMLCalciteComboboxElement;
+  /**
+   * Called each time the mapView prop is changed.
+   *
+   */
+  mapViewWatchHandler(): Promise<void>;
+  /**
+   * Emitted on demand when a layer is selected
+   *
+   */
+  layerSelectionChange: EventEmitter<string[]>;
+  /**
+   * StencilJS: Called once just after the component is first connected to the DOM.
+   */
+  componentWillLoad(): Promise<void>;
+  /**
+   * Renders the component.
+   */
+  render(): VNode;
+  /**
+   * StencilJS: Called once just after the component is fully loaded and the first render() occurs.
+   */
+  componentDidLoad(): Promise<void>;
+  /**
+   * Create a list of layers from the map
+   *
+   * Used for selecting a single layer.
+   *
+   * @returns Calcite Select component with the ids of the layers from the map
+   */
+  _getSelect(): VNode;
+  /**
+   * Create a list of layer ids from the map
+   *
+   * Used for selecting multiple layers
+   *
+   * @returns Calcite ComboBox component with the ids of the layers from the map
+   */
+  _getCombobox(): VNode;
+  /**
+   * Hydrate a dropdown component with items to display the layer names
+   *
+   * @returns Array of Dropdown items with layer names
+   */
+  _getDropdown(): VNode;
+  /**
+   * Get the appropriate type of dom nodes for each valid layer or table
+   *
+   * @returns Array of dom nodes with the names of the layers and optionally of the tables
+   */
+  _getMapLayerOptions(): VNode[];
+  /**
+   * Get the appropriate type of dom node for the current layer or table id
+   *
+   * @returns A dom node with the name of the layer or table
+   */
+  _getItem(id: string, itemType: "layer" | "table"): VNode;
+  /**
+   * Store the layer name based on the user selection
+   */
+  _setSelectedLayer(id: string, type: "layer" | "table"): void;
+  /**
+   * Fetch the ids of the layers from the map
+   *
+   * @returns Promise when the operation has completed
+   */
+  _setLayers(): Promise<void>;
+  /**
+   * Create a layer id:title hash for layer name display
+   *
+   * @returns Promise when the operation has completed
+   */
+  protected _initStateHash(): Promise<void>;
+  /**
+   * Evaluate if the id exists in the current hash and verify if it should be excluded
+   *
+   * @returns boolean when true the layer will be used in the current layer picker type
+   */
+  protected _validLayer(id: string): boolean;
+  /**
+   * Evaluate if the id exists in the current hash and verify if it should be excluded
+   *
+   * @returns boolean when true the table will be used in the current layer picker type
+   */
+  protected _validTable(id: string): boolean;
+  /**
+   * Fetch the ids of the layers from the map
+   *
+   * @returns Promise when the operation has completed
+   */
+  _layerSelectionChange(): void;
+}

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

@@ -1,109 +1,109 @@
-/** @license
- * Copyright 2023 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 { EventEmitter, VNode } from '../../stencil-public-runtime';
-import { IMapInfo } from "../../utils/interfaces";
-export declare class MapPicker {
-  el: HTMLMapPickerElement;
-  /**
-   * IMapInfo[]: array of map infos (name and id)
-   */
-  mapInfos: IMapInfo[];
-  /**
-   * boolean: controls the state of the map list
-   */
-  _mapListExpanded: boolean;
-  /**
-   * IMapInfo: id and name of the map to display
-   */
-  _webMapInfo: IMapInfo;
-  /**
-   * HTMLCalciteListElement: this list of map names
-   */
-  protected _list: HTMLCalciteListElement;
-  /**
-   * string: the id of map currently displayed
-   */
-  protected _loadedId: string;
-  /**
-   * Called each time the _webMapInfo prop is changed.
-   */
-  _webMapInfoWatchHandler(v: IMapInfo, oldV: IMapInfo): void;
-  /**
-   * Called each time the mapInfos prop is changed.
-   */
-  mapInfosWatchHandler(v: IMapInfo[], oldV: IMapInfo[]): void;
-  /**
-   * Emitted when a new map is loaded
-   */
-  mapInfoChange: EventEmitter<IMapInfo>;
-  /**
-   * Renders the component.
-   */
-  render(): any;
-  /**
-   * Called after each render
-   */
-  componentDidRender(): Promise<void>;
-  /**
-   * Called once after the component has loaded
-   */
-  componentDidLoad(): void;
-  /**
-   * Get a calcite action group for the map list
-   * Actions do not support multiple icons so this uses a block
-   *
-   * @returns the dom node for the action group
-   *
-   * @protected
-   */
-  protected _getMapPicker(): VNode;
-  /**
-   * Create the toolbar (controls used for map and app interactions)
-   *
-   * @returns The dom node with the toolbar
-   *
-   * @protected
-   */
-  protected _getToolbar(): VNode;
-  /**
-   * Get a pick list for all maps in mapInfos
-   *
-   * @param show boolean to indicate if the list should be shown or hidden
-   *
-   * @returns the dom node for the list of maps
-   *
-   * @protected
-   */
-  protected _getMapNameList(show: boolean): VNode;
-  /**
-   * Fired when the user clicks on the map list
-   *
-   * @param webMapInfo the web map id and name selected from the list
-   *
-   * @returns void
-   *
-   * @protected
-   */
-  protected _webMapSelected(webMapInfo: IMapInfo): void;
-  /**
-   * Toggles the open/close state of the map list
-   *
-   * @returns the dom node for the action group
-   *
-   * @protected
-   */
-  protected _chooseMap(): void;
-}
+/** @license
+ * Copyright 2023 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 { EventEmitter, VNode } from '../../stencil-public-runtime';
+import { IMapInfo } from "../../utils/interfaces";
+export declare class MapPicker {
+  el: HTMLMapPickerElement;
+  /**
+   * IMapInfo[]: array of map infos (name and id)
+   */
+  mapInfos: IMapInfo[];
+  /**
+   * boolean: controls the state of the map list
+   */
+  _mapListExpanded: boolean;
+  /**
+   * IMapInfo: id and name of the map to display
+   */
+  _webMapInfo: IMapInfo;
+  /**
+   * HTMLCalciteListElement: this list of map names
+   */
+  protected _list: HTMLCalciteListElement;
+  /**
+   * string: the id of map currently displayed
+   */
+  protected _loadedId: string;
+  /**
+   * Called each time the _webMapInfo prop is changed.
+   */
+  _webMapInfoWatchHandler(v: IMapInfo, oldV: IMapInfo): void;
+  /**
+   * Called each time the mapInfos prop is changed.
+   */
+  mapInfosWatchHandler(v: IMapInfo[], oldV: IMapInfo[]): void;
+  /**
+   * Emitted when a new map is loaded
+   */
+  mapInfoChange: EventEmitter<IMapInfo>;
+  /**
+   * Renders the component.
+   */
+  render(): any;
+  /**
+   * Called after each render
+   */
+  componentDidRender(): Promise<void>;
+  /**
+   * Called once after the component has loaded
+   */
+  componentDidLoad(): void;
+  /**
+   * Get a calcite action group for the map list
+   * Actions do not support multiple icons so this uses a block
+   *
+   * @returns the dom node for the action group
+   *
+   * @protected
+   */
+  protected _getMapPicker(): VNode;
+  /**
+   * Create the toolbar (controls used for map and app interactions)
+   *
+   * @returns The dom node with the toolbar
+   *
+   * @protected
+   */
+  protected _getToolbar(): VNode;
+  /**
+   * Get a pick list for all maps in mapInfos
+   *
+   * @param show boolean to indicate if the list should be shown or hidden
+   *
+   * @returns the dom node for the list of maps
+   *
+   * @protected
+   */
+  protected _getMapNameList(show: boolean): VNode;
+  /**
+   * Fired when the user clicks on the map list
+   *
+   * @param webMapInfo the web map id and name selected from the list
+   *
+   * @returns void
+   *
+   * @protected
+   */
+  protected _webMapSelected(webMapInfo: IMapInfo): void;
+  /**
+   * Toggles the open/close state of the map list
+   *
+   * @returns the dom node for the action group
+   *
+   * @protected
+   */
+  protected _chooseMap(): void;
+}

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;
+}