@esri/solutions-components 0.11.12 → 0.11.14

package/dist/collection/components/map-select-tools/map-select-tools.js

@@ -26,38 +26,6 @@ import { EWorkflowType } from "../../utils/interfaces";
 import state from "../../utils/publicNotificationStore";
 import { getComponentClosestLanguage, getLocaleComponentStrings } from "../../utils/locale";
 export class MapSelectTools {
-    constructor() {
-        this.bufferColor = [227, 139, 79, 0.8];
-        this.bufferOutlineColor = [255, 255, 255];
-        this.customLabelEnabled = undefined;
-        this.enabledLayerIds = [];
-        this.enableLayerFeatures = true;
-        this.enableLayerFeaturesOnLoad = false;
-        this.enableSearchDistance = true;
-        this.enableSearchDistanceOnLoad = false;
-        this.enableSketchTools = true;
-        this.defaultBufferDistance = undefined;
-        this.defaultBufferUnit = undefined;
-        this.geometries = [];
-        this.isUpdate = false;
-        this.layerViews = [];
-        this.locale = undefined;
-        this.mapView = undefined;
-        this.noResultText = undefined;
-        this.searchConfiguration = undefined;
-        this.selectionSet = undefined;
-        this.selectionLayerIds = [];
-        this.selectLayerView = undefined;
-        this.sketchLineSymbol = undefined;
-        this.sketchPointSymbol = undefined;
-        this.sketchPolygonSymbol = undefined;
-        this.searchDistanceEnabled = false;
-        this.useLayerFeaturesEnabled = false;
-        this._numSelected = 0;
-        this._searchTerm = undefined;
-        this._selectionLoading = false;
-        this._translations = undefined;
-    }
     //--------------------------------------------------------------------------
     //
     //  Host element access
@@ -66,6 +34,144 @@ export class MapSelectTools {
     el;
     //--------------------------------------------------------------------------
     //
+    //  Properties (public)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * string | number[] |  object with r, g, b, a: https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html
+     */
+    bufferColor = [227, 139, 79, 0.8];
+    /**
+     * string | number[] | object with r, g, b, a: https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html
+     */
+    bufferOutlineColor = [255, 255, 255];
+    /**
+     * boolean: When true the user can define a name for each notification list
+     */
+    customLabelEnabled;
+    /**
+     * string[]: Optional list of enabled layer ids
+     *  If empty all layers will be available
+     */
+    enabledLayerIds = [];
+    /**
+     * boolean: When true users will be allowed to optionally use features from a layer as the selection geometry
+     */
+    enableLayerFeatures = true;
+    /**
+     * boolean: When true the use features from a layer options will be enabled when the component loads
+     */
+    enableLayerFeaturesOnLoad = false;
+    /**
+     * boolean: When true users will be allowed to optionally create a buffer around the selection geometry
+     */
+    enableSearchDistance = true;
+    /**
+     * boolean: When true the serach distance options will be enabled when the component loads
+     */
+    enableSearchDistanceOnLoad = false;
+    /**
+     * boolean: When true sketch tools will be provided to allow users to draw a selection geometry
+     */
+    enableSketchTools = true;
+    /**
+     * number: The default value to show for the buffer distance
+     */
+    defaultBufferDistance;
+    /**
+     * number: The default value to show for the buffer unit
+     */
+    defaultBufferUnit;
+    /**
+     * esri/geometry: https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html
+     */
+    geometries = [];
+    /**
+     * boolean: When true a new label is not generated for the stored selection set
+     */
+    isUpdate = false;
+    /**
+     * esri/views/layers/FeatureLayerView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html
+     */
+    layerViews = [];
+    /**
+     * string: The current user locale.
+     */
+    locale;
+    /**
+     * esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+     */
+    mapView;
+    /**
+     * string: The value to show for no results
+     * when left empty the default text "0 selected features from {layerTitle}" will be shown
+     */
+    noResultText;
+    /**
+     * ISearchConfiguration: Configuration details for the Search widget
+     */
+    searchConfiguration;
+    /**
+     * utils/interfaces/ISelectionSet: Used to store key details about any selections that have been made.
+     */
+    selectionSet;
+    /**
+     * string[]: List of layer ids that should be shown as potential selection layers
+     * when skectching with "Use layer features" option
+     */
+    selectionLayerIds = [];
+    /**
+     * esri/views/layers/FeatureLayerView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html
+     */
+    selectLayerView;
+    /**
+     * esri/symbols/SimpleLineSymbol | JSON representation : https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html
+     *
+     */
+    sketchLineSymbol;
+    /**
+     * esri/symbols/SimpleMarkerSymbol | JSON representation: https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html
+     *
+     */
+    sketchPointSymbol;
+    /**
+     * esri/symbols/SimpleFillSymbol | JSON representation: https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html
+     *
+     */
+    sketchPolygonSymbol;
+    /**
+     * boolean: when true buffer tools controls are enabled
+     */
+    searchDistanceEnabled = false;
+    /**
+     * boolean: when true drawn graphics will be used to select features
+     */
+    useLayerFeaturesEnabled = false;
+    //--------------------------------------------------------------------------
+    //
+    //  State (internal)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * number: The number of selected features
+     */
+    _numSelected = 0;
+    /**
+     * string: Text entered by the end user.
+     * Used to search against the locator.
+     */
+    _searchTerm;
+    /**
+     * boolean: When true a loading indicator will be shown in place of the number of selected features
+     */
+    _selectionLoading = false;
+    /**
+     * Contains the translations for this component.
+     * All UI strings should be defined here.
+     */
+    _translations;
+    //--------------------------------------------------------------------------
+    //
     //  Properties (protected)
     //
     //--------------------------------------------------------------------------

package/dist/collection/components/map-tools/map-tools.js

@@ -22,33 +22,6 @@ import { Host, h } from "@stencil/core";
 import { getLocaleComponentStrings } from "../../utils/locale";
 import { loadModules } from "../../utils/loadModules";
 export class MapTools {
-    constructor() {
-        this.basemapConfig = undefined;
-        this.enableLegend = undefined;
-        this.enableFloorFilter = undefined;
-        this.enableFullscreen = undefined;
-        this.enableSearch = undefined;
-        this.enableBasemap = undefined;
-        this.enableHome = undefined;
-        this.enableSingleExpand = undefined;
-        this.homeZoomToolsSize = "m";
-        this.layout = "vertical";
-        this.locale = undefined;
-        this.mapView = undefined;
-        this.mapWidgetsSize = "m";
-        this.position = "top-right";
-        this.searchConfiguration = undefined;
-        this.stackTools = true;
-        this.toolOrder = undefined;
-        this._hasFloorInfo = false;
-        this._translations = undefined;
-        this._showTools = true;
-        this._showBasemapWidget = false;
-        this._showFloorFilter = false;
-        this._showFullscreen = false;
-        this._showLegendWidget = false;
-        this._showSearchWidget = false;
-    }
     //--------------------------------------------------------------------------
     //
     //  Host element access
@@ -57,6 +30,121 @@ export class MapTools {
     el;
     //--------------------------------------------------------------------------
     //
+    //  Properties (public)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * IBasemapConfig: List of any basemaps to filter out from the basemap widget
+     */
+    basemapConfig;
+    /**
+     * boolean: when true the legend widget will be available
+     */
+    enableLegend;
+    /**
+     * boolean: when true the floor filter widget will be available
+     */
+    enableFloorFilter;
+    /**
+     * boolean: when true the fullscreen widget will be available
+     */
+    enableFullscreen;
+    /**
+     * boolean: when true the search widget will be available
+     */
+    enableSearch;
+    /**
+     * boolean: when true the basemap widget will be available
+     */
+    enableBasemap;
+    /**
+     * boolean: when true the home widget will be available
+     */
+    enableHome;
+    /**
+     * boolean: when true map tools will be displayed within a single expand/collapse widget
+     * when false widgets will be loaded individually into expand widgets
+     */
+    enableSingleExpand;
+    /**
+     * "s" | "m" | "l": Used for Zoom and Home tools
+     */
+    homeZoomToolsSize = "m";
+    /**
+     * "horizontal" | "vertical": used to control the orientation of the tools
+     */
+    layout = "vertical";
+    /**
+     * string: Locale to use for translation of stings in the UI
+     */
+    locale;
+    /**
+     * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+     */
+    mapView;
+    /**
+     * "s" | "m" | "l": Used for optional map tool widget
+     */
+    mapWidgetsSize = "m";
+    /**
+     * __esri.UIPosition: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#UIPosition
+     * The position details for the tools
+     */
+    position = "top-right";
+    /**
+     * ISearchConfiguration: Configuration details for the Search widget
+     */
+    searchConfiguration;
+    /**
+     * boolean: When true the map widget tools will have no margin between them.
+     * When false the map widget tools will have a margin between them.
+     */
+    stackTools = true;
+    /**
+     *
+     * Valid tools: "legend", "search", "fullscreen", "basemap", "floorfilter"
+     */
+    toolOrder;
+    //--------------------------------------------------------------------------
+    //
+    //  State (internal)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * When true the map supports floor awareness
+     */
+    _hasFloorInfo = false;
+    /**
+     * Contains the translations for this component.
+     * All UI strings should be defined here.
+     */
+    _translations;
+    /**
+     * When true the tool action bar will be displayed
+     */
+    _showTools = true;
+    /**
+     * When true the basemap picker will be displayed
+     */
+    _showBasemapWidget = false;
+    /**
+     * When true the floor filter widget will be displayed
+     */
+    _showFloorFilter = false;
+    /**
+     * When true the map will be displayed in fullscreen mode
+     */
+    _showFullscreen = false;
+    /**
+     * When true the legend widget will be displayed
+     */
+    _showLegendWidget = false;
+    /**
+     * When true the search widget will be displayed
+     */
+    _showSearchWidget = false;
+    //--------------------------------------------------------------------------
+    //
     //  Properties (protected)
     //
     //--------------------------------------------------------------------------

package/dist/collection/components/pci-calculator/pci-calculator.js

@@ -26,9 +26,6 @@
 import { Host, h } from "@stencil/core";
 import { calculatePCI } from "../../utils/pciUtils";
 export class PciCalculator {
-    constructor() {
-        this.showAddDeduct = false;
-    }
     //--------------------------------------------------------------------------
     //
     //  Host element access
@@ -37,6 +34,20 @@ export class PciCalculator {
     el;
     //--------------------------------------------------------------------------
     //
+    //  Properties (public)
+    //
+    //--------------------------------------------------------------------------
+    //--------------------------------------------------------------------------
+    //
+    //  State (internal)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * Boolean: Show/Hide the calculate deduct value UI
+     */
+    showAddDeduct = false;
+    //--------------------------------------------------------------------------
+    //
     //  Properties (protected)
     //
     //--------------------------------------------------------------------------

package/dist/collection/components/pdf-download/pdf-download.js

@@ -24,12 +24,6 @@ import { loadModules } from "../../utils/loadModules";
 import { Host, h } from "@stencil/core";
 import { getLocaleComponentStrings } from "../../utils/locale";
 export class PdfDownload {
-    constructor() {
-        this.defaultNumLabelsPerPage = undefined;
-        this.disabled = false;
-        this.locale = undefined;
-        this._translations = undefined;
-    }
     //--------------------------------------------------------------------------
     //
     //  Host element access
@@ -38,6 +32,33 @@ export class PdfDownload {
     el;
     //--------------------------------------------------------------------------
     //
+    //  Properties (public)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * number: The default number of labels per page to export
+     */
+    defaultNumLabelsPerPage;
+    /**
+     * boolean: Controls the enabled/disabled state of download
+     */
+    disabled = false;
+    /**
+     * string: Locale to use for translation of stings in the UI
+     */
+    locale;
+    //--------------------------------------------------------------------------
+    //
+    //  State (internal)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * Contains the translations for this component.
+     * All UI strings should be defined here.
+     */
+    _translations;
+    //--------------------------------------------------------------------------
+    //
     //  Properties (protected)
     //
     //--------------------------------------------------------------------------

package/dist/collection/components/public-notification/public-notification.js

@@ -27,47 +27,6 @@ import { getLocaleComponentStrings } from "../../utils/locale";
 import { consolidateLabels, removeDuplicateLabels } from "../../utils/downloadUtils";
 import { getAssetPath } from "@stencil/core";
 export class PublicNotification {
-    constructor() {
-        this.addresseeLayerIds = [];
-        this.bufferColor = [227, 139, 79, 0.8];
-        this.bufferOutlineColor = [255, 255, 255];
-        this.customLabelEnabled = undefined;
-        this.defaultBufferDistance = undefined;
-        this.defaultBufferUnit = undefined;
-        this.defaultExportTitle = "";
-        this.defaultNumLabelsPerPage = 6;
-        this.enableLayerFeatures = true;
-        this.enableLayerFeaturesOnLoad = false;
-        this.enableSearchDistance = true;
-        this.enableSearchDistanceOnLoad = false;
-        this.enableSketchTools = true;
-        this.featureEffect = undefined;
-        this.featureHighlightEnabled = undefined;
-        this.locale = undefined;
-        this.mapView = undefined;
-        this.noResultText = undefined;
-        this.initialNotice = "";
-        this.searchConfiguration = undefined;
-        this.selectionLayerIds = [];
-        this.showRefineSelection = false;
-        this.showSearchSettings = true;
-        this.sketchLineSymbol = undefined;
-        this.sketchPointSymbol = undefined;
-        this.sketchPolygonSymbol = undefined;
-        this._exportGraphics = false;
-        this._addMap = false;
-        this._addResults = true;
-        this._addTitle = false;
-        this._downloadActive = true;
-        this._exportType = EExportType.PDF;
-        this._fetchingData = false;
-        this._isMobile = undefined;
-        this._numDuplicates = 0;
-        this._pageType = EPageType.LIST;
-        this._saveEnabled = false;
-        this._selectionSets = [];
-        this._translations = undefined;
-    }
     //--------------------------------------------------------------------------
     //
     //  Host element access
@@ -76,6 +35,195 @@ export class PublicNotification {
     el;
     //--------------------------------------------------------------------------
     //
+    //  Properties (public)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * string[]: List of layer ids that should be shown as potential addressee layers
+     */
+    addresseeLayerIds = [];
+    /**
+     * string | number[] |  object with r, g, b, a: https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html
+     */
+    bufferColor = [227, 139, 79, 0.8];
+    /**
+     * string | number[] | object with r, g, b, a: https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html
+     */
+    bufferOutlineColor = [255, 255, 255];
+    /**
+     * boolean: When true the user can define a name for each notification list
+     */
+    customLabelEnabled;
+    /**
+     * number: The default value to show for the buffer distance
+     */
+    defaultBufferDistance;
+    /**
+     * number: The default value to show for the buffer unit ("feet"|"meters"|"miles"|"kilometers")
+     */
+    defaultBufferUnit;
+    /**
+     * string: The default value to use for the export title
+     */
+    defaultExportTitle = "";
+    /**
+     * number: The default number of labels per page to export
+     */
+    defaultNumLabelsPerPage = 6;
+    /**
+     * boolean: When true users will be allowed to optionally use features from a layer as the selection geometry
+     */
+    enableLayerFeatures = true;
+    /**
+     * boolean: When true the use features from a layer options will be enabled when the component loads
+     */
+    enableLayerFeaturesOnLoad = false;
+    /**
+     * boolean: When true users will be allowed to optionally create a buffer around the selection geometry
+     */
+    enableSearchDistance = true;
+    /**
+     * boolean: When true the serach distance options will be enabled when the component loads
+     */
+    enableSearchDistanceOnLoad = false;
+    /**
+     * boolean: When true sketch tools will be provided to allow users to draw a selection geometry
+     */
+    enableSketchTools = true;
+    /**
+     * 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;
+    /**
+     * boolean: When enabled features will be highlighted when their notification list item is clicked.
+     */
+    featureHighlightEnabled;
+    /**
+     * string: The current user locale.
+     */
+    locale;
+    /**
+     * esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+     */
+    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: The value to show in the initial notice to help with on boarding the user.
+     * When left empty the selectLayerAndAdd text from the nls will be used.
+     */
+    initialNotice = "";
+    /**
+     * ISearchConfiguration: Configuration details for the Search widget
+     */
+    searchConfiguration;
+    /**
+     * string[]: List of layer ids that should be shown as potential selection layers
+     * when skectching with "Use layer features" option
+     */
+    selectionLayerIds = [];
+    /**
+     * boolean: When true the refine selection workflow will be included in the UI
+     */
+    showRefineSelection = false;
+    /**
+     * boolean: When false no buffer distance or unit controls will be exposed
+     */
+    showSearchSettings = true;
+    /**
+     * esri/symbols/SimpleLineSymbol | JSON representation : https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html
+     *
+     * A JSON representation of the instance in the ArcGIS format.
+     * See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
+     * https://developers.arcgis.com/documentation/common-data-types/symbol-objects.htm
+     */
+    // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
+    sketchLineSymbol;
+    /**
+     * esri/symbols/SimpleMarkerSymbol | JSON representation: https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html
+     *
+     * A JSON representation of the instance in the ArcGIS format.
+     * See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
+     * https://developers.arcgis.com/documentation/common-data-types/symbol-objects.htm
+     */
+    // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
+    sketchPointSymbol;
+    /**
+     * esri/symbols/SimpleFillSymbol | JSON representation: https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html
+     *
+     * A JSON representation of the instance in the ArcGIS format.
+     * See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
+     * https://developers.arcgis.com/documentation/common-data-types/symbol-objects.htm
+     */
+    // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
+    sketchPolygonSymbol;
+    //--------------------------------------------------------------------------
+    //
+    //  State (internal)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * boolean: When true a graphics will be added to the map on export
+     */
+    _exportGraphics = false;
+    /**
+     * boolean: When true a map will be added on export
+     */
+    _addMap = false;
+    /**
+     * boolean: When true the selected results will be added on export
+     */
+    _addResults = true;
+    /**
+     * boolean: When true a title will be added above the map on export
+     */
+    _addTitle = false;
+    /**
+     * 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.
+     */
+    _downloadActive = true;
+    /**
+     * utils/interfaces/EExportType: PDF or CSV
+     */
+    _exportType = EExportType.PDF;
+    /**
+     * boolean: Flag that will control a loading indicator on the export button
+     */
+    _fetchingData = false;
+    /**
+     * boolean: When window size is 600px or less this value will be true
+     */
+    _isMobile;
+    /**
+     * number: The number of duplicate labels from all selection sets
+     */
+    _numDuplicates = 0;
+    /**
+     * utils/interfaces/EPageType: LIST | SELECT | EXPORT | REFINE
+     */
+    _pageType = EPageType.LIST;
+    /**
+     * boolean: Save is enabled when we have 1 or more selected features
+     */
+    _saveEnabled = false;
+    /**
+     * utils/interfaces/ISelectionSet: An array of user defined selection sets
+     */
+    _selectionSets = [];
+    /**
+     * Contains the translations for this component.
+     * All UI strings should be defined here.
+     */
+    _translations;
+    //--------------------------------------------------------------------------
+    //
     //  Properties (protected)
     //
     //--------------------------------------------------------------------------