@esri/solutions-components 0.3.2 → 0.3.3

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

@@ -19,23 +19,28 @@ import { SelectionMode } from "../../utils/interfaces";
 export declare class MapLayerPicker {
   el: HTMLMapLayerPickerElement;
   /**
-   * string[]: list of layer names from the map
+   * string[]: Optional list of enabled layer ids
+   *  If empty all layers will be available
    */
-  layerNames: string[];
+  enabledLayerIds: string[];
   /**
    * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
    */
   mapView: __esri.MapView;
   /**
-   * string[]: list of layers that have been selected by the end user
+   * string[]: list of layer ids that have been selected by the end user
    */
-  selectedLayers: string[];
+  selectedLayerIds: string[];
   /**
    * SelectionMode: "single" | "multi"
    *
    * Should the component support selection against a single layer or multiple layers.
    */
   selectionMode: SelectionMode;
+  /**
+   * string[]: list of layer ids from the map
+   */
+  layerIds: string[];
   /**
    * HTMLCalciteSelectElement: The html element for selecting layers
    */
@@ -63,31 +68,37 @@ export declare class MapLayerPicker {
    *
    * Used for selecting a single layer.
    *
-   * @returns Calcite Select component with the names of the layers from the map
+   * @returns Calcite Select component with the ids of the layers from the map
    */
   _getSelect(): VNode;
   /**
-   * Create a list of layers from the map
+   * Create a list of layer ids from the map
    *
    * Used for selecting multiple layers
    *
-   * @returns Calcite ComboBox component with the names of the layers from the map
+   * @returns Calcite ComboBox component with the ids of the layers from the map
    */
   _getCombobox(): VNode;
   /**
-   * Hydrate a select or combobox component with the names of the layers in the map
+   * Hydrate a select or combobox component with the ids of the layers in the map
    *
-   * @returns Array of ComboBox items or Select options for the names of the layers
+   * @returns Array of ComboBox items or Select options for the ids of the layers
    */
   _addMapLayersOptions(): VNode[];
   /**
-   * Fetch the names of the layers from the map
+   * Fetch the ids of the layers from the map
    *
    * @returns Promise when the operation has completed
    */
   _setLayers(): Promise<void>;
   /**
-   * Fetch the names of the layers from the map
+   * Create a layer id:title hash for layer name display
+   *
+   * @returns Promise when the operation has completed
+   */
+  protected _initLayerHashState(): Promise<void>;
+  /**
+   * Fetch the ids of the layers from the map
    *
    * @returns Promise when the operation has completed
    */

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

@@ -15,7 +15,7 @@
  */
 /// <reference types="arcgis-js-api" />
 import { EventEmitter, VNode } from "../../stencil-public-runtime";
-import { ISearchResult } from "../../utils/interfaces";
+import { ISearchConfiguration, ISearchResult } from "../../utils/interfaces";
 import MapSearch_T9n from "../../assets/t9n/map-search/resources.json";
 export declare class MapSearch {
   el: HTMLElement;
@@ -23,6 +23,10 @@ export declare class MapSearch {
    * 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;
   /**
    * string: Text entered by the end user.
    * Used to search against the locator.
@@ -33,6 +37,10 @@ export declare class MapSearch {
    * All UI strings should be defined here.
    */
   protected _translations: typeof MapSearch_T9n;
+  /**
+   * 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
    */
@@ -94,6 +102,15 @@ export declare class MapSearch {
    * @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;
   /**
    * Fetches the component's translations
    *

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

@@ -15,10 +15,23 @@
  */
 /// <reference types="arcgis-js-api" />
 import { EventEmitter, VNode } from "../../stencil-public-runtime";
-import { EWorkflowType, ISelectionSet, ESketchType } from "../../utils/interfaces";
+import { DistanceUnit, ISearchConfiguration, EWorkflowType, ISelectionSet, ESketchType } from "../../utils/interfaces";
 import MapSelectTools_T9n from "../../assets/t9n/map-select-tools/resources.json";
 export declare class MapSelectTools {
   el: HTMLMapSelectToolsElement;
+  /**
+   * string[]: Optional list of enabled layer ids
+   *  If empty all layers will be available
+   */
+  enabledLayerIds: string[];
+  /**
+   * number: The default value to show for the buffer distance
+   */
+  defaultBufferDistance: number;
+  /**
+   * number: The default value to show for the buffer unit
+   */
+  defaultBufferUnit: DistanceUnit;
   /**
    * esri/geometry: https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html
    */
@@ -31,6 +44,10 @@ export declare class MapSelectTools {
    * 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;
   /**
    * utils/interfaces/ISelectionSet: Used to store key details about any selections that have been made.
    */
@@ -58,6 +75,10 @@ export declare class MapSelectTools {
    * EWorkflowType: "SEARCH", "SELECT", "SKETCH", "REFINE"
    */
   _workflowType: EWorkflowType;
+  /**
+   * esri/layers/FeatureLayer: https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html
+   */
+  protected FeatureLayer: typeof import("esri/layers/FeatureLayer");
   /**
    * esri/Graphic: https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html
    */
@@ -210,6 +231,15 @@ export declare class MapSelectTools {
    * @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;
   /**
    * Initialize the graphics layer used to store any buffer grapghics
    *

package/dist/types/components/pdf-download/pdf-download.d.ts

@@ -23,6 +23,11 @@ export declare class PdfDownload {
    * boolean: Controls the enabled/disabled state of download
    */
   disabled: boolean;
+  /**
+   * string[]: Optional list of enabled size values for PDF export
+   *  If empty all sizes will be enabled
+   */
+  enabledSizeValues: number[];
   /**
    * esri/views/layers/FeatureLayerView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html
    */
@@ -51,7 +56,7 @@ export declare class PdfDownload {
    * @param removeDuplicates When true a single label is generated when multiple featues have a shared address value
    * @returns Promise resolving when function is done
    */
-  downloadCSV(ids: number[], removeDuplicates: boolean): Promise<void>;
+  downloadCSV(ids: number[], removeDuplicates: boolean, addColumnTitle: boolean): Promise<void>;
   /**
    * StencilJS: Called once just after the component is first connected to the DOM.
    */
@@ -88,7 +93,7 @@ export declare class PdfDownload {
    * @returns Promise that will resolve when the download is complete
    * @protected
    */
-  protected _downloadCSV(ids: number[], removeDuplicates: boolean): Promise<void>;
+  protected _downloadCSV(ids: number[], removeDuplicates: boolean, addColumnTitle: boolean): Promise<void>;
   /**
    * Gets the formatted pdf export size text
    *

package/dist/types/components/public-notification/public-notification.d.ts

@@ -15,22 +15,68 @@
  */
 /// <reference types="arcgis-js-api" />
 import { VNode } from "../../stencil-public-runtime";
-import { EExportType, EPageType, ESketchType, EWorkflowType, ISelectionSet } from "../../utils/interfaces";
+import { DistanceUnit, EExportType, EPageType, ESketchType, EWorkflowType, IExportOptions, ISearchConfiguration, ISelectionSet } from "../../utils/interfaces";
 import NewPublicNotification_T9n from "../../assets/t9n/public-notification/resources.json";
 export declare class PublicNotification {
   el: HTMLPublicNotificationElement;
   /**
-   * esri/views/layers/FeatureLayerView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html
+   * string[]: List of layer ids that should be shown as potential addressee layers
    */
-  addresseeLayer: __esri.FeatureLayerView;
+  addresseeLayerIds: string[];
+  /**
+   * number: The default value to show for the buffer distance
+   */
+  defaultBufferDistance: number;
+  /**
+   * number: The default value to show for the buffer unit ("feet"|"meters"|"miles"|"kilometers")
+   */
+  defaultBufferUnit: DistanceUnit;
+  /**
+   * IExportOptions: Set of options that control export capabilities
+   *  If not provided all export capabilities will be enabled.
+   */
+  exportOptions: IExportOptions;
+  /**
+   * The effect that will be applied when featureHighlightEnabled is true
+   *
+   * esri/layers/support/FeatureEffect: https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html
+   *
+   */
+  featureEffect: __esri.FeatureEffect;
+  /**
+   * boolean: When enabled features will be highlighted when their notification list item is clicked.
+   */
+  featureHighlightEnabled: boolean;
   /**
    * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
    */
   mapView: __esri.MapView;
+  /**
+   * string: The value to show for no results
+   * when left empty the default text "0 selected features from {layerTitle}" will be shown
+   */
+  noResultText: string;
+  /**
+   * ISearchConfiguration: Configuration details for the Search widget
+   */
+  searchConfiguration: ISearchConfiguration;
+  /**
+   * string[]: List of layer ids that should be shown as potential selection layers
+   * when skectching with "Use layer features" option
+   */
+  selectionLayerIds: string[];
   /**
    * boolean: When true the refine selection workflow will be included in the UI
    */
   showRefineSelection: boolean;
+  /**
+   * boolean: When false no buffer distance or unit controls will be exposed
+   */
+  showSearchSettings: boolean;
+  /**
+   * esri/views/layers/FeatureLayerView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html
+   */
+  addresseeLayer: __esri.FeatureLayerView;
   /**
    * boolean: Enabled when we have 1 or more selection sets that is enabled in the download pages.
    * By default all selection sets are enabled for download when they are first created.
@@ -61,6 +107,10 @@ export declare class PublicNotification {
    * utils/interfaces/EWorkflowType: SEARCH | SELECT | SKETCH
    */
   _selectionWorkflowType: EWorkflowType;
+  /**
+   * boolean: When true a modal will be shown to alert users of potential changes to selection sets.
+   */
+  _showLayerSelectionChangeModal: boolean;
   /**
    * Contains the translations for this component.
    * All UI strings should be defined here.
@@ -78,6 +128,10 @@ export declare class PublicNotification {
    * esri/geometry/geometryEngine: https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html
    */
   protected _geometryEngine: __esri.geometryEngine;
+  /**
+   * CustomEvent: Used to prevent default behavior of layer selection change
+   */
+  protected _layerSelectionChangeEvt: CustomEvent;
   /**
    * HTMLCalciteCheckboxElement: When enabled popups will be shown on map click
    */
@@ -162,6 +216,13 @@ export declare class PublicNotification {
    * @protected
    */
   protected _getListPage(): VNode;
+  /**
+   * Create the UI element that will expose the addressee layers
+   *
+   * @returns addressee layer list node
+   * @protected
+   */
+  protected _getMapLayerPicker(): VNode;
   /**
    * Create the selection sets list node for the List page
    *
@@ -169,6 +230,27 @@ export declare class PublicNotification {
    * @protected
    */
   protected _getSelectionSetList(): VNode;
+  /**
+   * Alert the user of the potential change to the selection sets and ask if they would like to proceed.
+   *
+   * @returns the page node
+   * @protected
+   */
+  protected _showModal(open: boolean): VNode;
+  /**
+   * Prevent the default behavior of layer selection change and close the modal.
+   *
+   * @returns the page node
+   * @protected
+   */
+  protected _cancelLayerChange(): void;
+  /**
+   * Allow the default behavior of layer selection change and close the modal.
+   *
+   * @returns the page node
+   * @protected
+   */
+  protected _handleLayerChange(): Promise<void>;
   /**
    * Create the Select page that shows the selection workflows
    *
@@ -310,12 +392,24 @@ export declare class PublicNotification {
    */
   protected _home(): Promise<void>;
   /**
-   * Fetch the layer defined in the selection change event
+   * Fetch the addressee layer from the map if no selection sets exist.
+   * Alert the user of the potential change to the selection sets if they exist.
+   *
+   * @param evt layer selection change event
    *
    * @returns Promise when the function has completed
    * @protected
    */
   protected _layerSelectionChange(evt: CustomEvent): Promise<void>;
+  /**
+   * Fetch the new addressee layer and update the selection sets
+   *
+   * @param id the id of the layer to fetch
+   *
+   * @returns Promise when the function has completed
+   * @protected
+   */
+  protected _updateAddresseeLayer(id: string): Promise<void>;
   /**
    * Update selection sets when the addressee layer changes.
    * Will remove any "refine" selection set.

package/dist/types/components/refine-selection/refine-selection.d.ts

@@ -23,6 +23,11 @@ export declare class RefineSelection {
    * esri/views/layers/FeatureLayerView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html
    */
   addresseeLayer: __esri.FeatureLayerView;
+  /**
+   * string[]: Optional list of enabled layer ids
+   *  If empty all layers will be available
+   */
+  enabledLayerIds: string[];
   /**
    * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
    */

package/dist/types/components/refine-selection-tools/refine-selection-tools.d.ts

@@ -27,6 +27,11 @@ export declare class RefineSelectionTools {
    * boolean: Optionally draw a border around the draw tools
    */
   border: boolean;
+  /**
+   * string[]: Optional list of enabled layer ids
+   *  If empty all layers will be available
+   */
+  enabledLayerIds: string[];
   /**
    * esri/Graphic: https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html
    */
@@ -83,7 +88,7 @@ export declare class RefineSelectionTools {
    */
   protected SketchViewModel: typeof import("esri/widgets/Sketch/SketchViewModel");
   /**
-   * {<layer title>: Graphic[]}: Collection of graphics returned from queries to the layer
+   * {<layer id>: Graphic[]}: Collection of graphics returned from queries to the layer
    */
   protected _featuresCollection: {
     [key: string]: __esri.Graphic[];