@esri/solutions-components 0.8.5 → 0.8.6-6.2

package/dist/types/assets/arcgis-pdf-creator/PDFLabels.d.ts

@@ -0,0 +1,218 @@
+/** @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 * as PDFCreator from "./PDFCreator";
+/**
+ * Properties of a page of labels.
+ */
+export interface ILabel {
+    /**
+     * User-interface description of label type.
+     */
+    descriptionPDF: ILabelDescription;
+    /**
+     * Properties describing page dimensions of labels sheet.
+     */
+    labelSpec: ILabelSpec;
+}
+/**
+ * User-interface description of label type.
+ */
+export interface ILabelDescription {
+    /**
+     * Width of label for display, e.g., "2-5/8"
+     */
+    labelWidthDisplay: string;
+    /**
+     * Height of label for display, e.g., "1"
+     */
+    labelHeightDisplay: string;
+    /**
+     * Number of labels on page, e.g., "30"
+     */
+    labelsPerPageDisplay: string;
+    /**
+     * Avery® part number, e.g., "*60"
+     */
+    averyPartNumber: string;
+}
+/**
+ * Properties describing page dimensions of labels sheet.
+ */
+export interface ILabelSpec {
+    /**
+     * Flag indicating the nature of the label product, e.g., "AVERY", "CSV"
+     */
+    type: string;
+    /**
+     * Properties describing page dimensions in doc units.
+     */
+    pageProperties: PDFCreator.IPageProperties;
+    /**
+     * Count of labels across the width of the page
+     */
+    numLabelsAcross: number;
+    /**
+     * Count of labels down the length of the page
+     */
+    numLabelsDown: number;
+    /**
+     * Width of a label in doc units
+     */
+    labelWidth: number;
+    /**
+     * Height of a label in doc units
+     */
+    labelHeight: number;
+    /**
+     * Gap between each column of labels in doc units
+     */
+    horizGapIn: number;
+    /**
+     * Gap between each row of labels in doc units
+     */
+    vertGapIn: number;
+    /**
+     * Amount of padding within labels in doc units
+     */
+    labelPadding: number;
+    /**
+     * Font size for text put in each label in pixels
+     */
+    fontSizePx: number;
+    /**
+     * Maximum number of lines that a label is permitted to hold; subsequent lines will not be written
+     */
+    maxNumLabelLines: number;
+}
+/**
+ * Function signature for reporting progress in function addLabelsToDoc.
+ *
+ */
+export type IAddLabelsToDocProgressCallback = (
+/**
+ * Percent done; range 0..100
+ */
+percentDone: number) => void;
+export declare class PDFLabels {
+    PDFCreator: PDFCreator.PDFCreator;
+    labelFormats: ILabel[];
+    /**
+     * Add labels to a PDF doc, starting at the beginning of the specified PDF doc page.
+     *
+     * @param labels Array of labels; each label consists of one or more line strings
+     * @param labelSpec Properties describing page dimensions of labels sheet
+     * @param startingPageNum The 1-based page number to start printing labels into; page is assumed to be blank & to exist
+     * @param heading Line to add at top of label page outside of labels
+     * @param progressCallback Callback with percent done in range 0..100
+     * @returns Promise which, when resolved, returns the 1-based page number of the last page containing labels
+     *
+     * @class PDFLabels
+     */
+    addLabelsToDoc(labels: string[][], labelSpec: ILabelSpec, startingPageNum: number, heading?: string, progressCallback?: IAddLabelsToDocProgressCallback): Promise<number>;
+    drawLabelGuidelines(labelSpec: ILabelSpec, labelBoundaryLinesProperties?: PDFCreator.ILineProperties): void;
+    /**
+     * Draws supplemental text such as a heading or footer.
+     *
+     * @param text Text to draw
+     * @param left Offset from left edge of document to left edge of text
+     * @param top Offset from top of document to top of text
+     */
+    drawSupplementalText(text: string, left: number, top: number): void;
+    /**
+     * Returns the UI descriptions of the label formats.
+     *
+     * @returns List of label format descriptions
+     *
+     * @class PDFLabels
+     */
+    getAvailableLabelFormats(): ILabelDescription[];
+    /**
+     * Returns the format of the specified label.
+     *
+     * @param averyPartNumber Avery® label base part number, e.g., "*60" (versus actual part numbers "5160", "8160",
+     * "8460", "48160"--all of which are 1" x 2-5/8" rectangular labels)
+     * @returns List of label format descriptions
+     *
+     * @class PDFLabels
+     */
+    getLabelFormat(averyPartNumber: string): ILabel;
+    /**
+     * Loads language font file and label formats into a jsPDF `doc` object.
+     *
+     * @param PDFCreator PDF-drawing library
+     * @throws TypeError "startPDFLabelDoc is stomping on labelFormats property" if the `labelFormats` property
+     * is found in doc before the label formats are loaded into the doc.
+     *
+     * @class PDFLabels
+     */
+    initialize(PDFCreator: PDFCreator.PDFCreator): Promise<void>;
+    /**
+     * Removes duplicates and empties, trims label lines, and returns a sorted list.
+     *
+     * @class PDFLabels
+     */
+    removeDuplicates(labels: string[][]): string[][];
+    /**
+     * Calculates the baseline position of the first line of text in a label.
+     *
+     * @param labelTop Offset from top of document to top of label
+     * @param labelHeight Height of each label in doc units
+     * @param numLabelLines Number of lines to be drawn in the label
+     * @param fontHeight Height of text in doc units
+     * @param verticalFontGap Spacing between lines of text in doc units
+     * @returns Baseline position
+     *
+     * @class PDFLabels
+     * @private
+     */
+    _calculateLabelFirstLineBase(labelTop: number, labelHeight: number, numLabelLines: number, fontHeight: number, verticalFontGap: number): number;
+    /**
+     * Trims a set of text lines to fit within specified bounds.
+     *
+     * @param lines Text lines to be trimmed
+     * @param maxTextWidth The maximum width permitted for the drawing of the text in doc units
+     * @param fontSize Text size in points
+     * @returns A copy of lines trimmed as necessary
+     *
+     * @class PDFLabels
+     * @private
+     */
+    _clipOverlongLines(lines: string[], maxTextWidth: number, fontSize: number): string[];
+    /**
+     * Trims a set of text lines to fit within specified bounds.
+     *
+     * @param lines Text lines to be checked
+     * @param maxTextWidth The maximum width permitted for the drawing of the text in doc units
+     * @param preferredFontSize Initial text size in points
+     * @param minimumFontSize The smallest acceptable font size in points
+     * @returns The maximum of `minimumFontSize` and the font size in points that should help all lines
+     * of the label to fit on the label
+     *
+     * @class PDFLabels
+     * @private
+     */
+    _getFontSizeForOverlongLines(lines: string[], maxTextWidth: number, preferredFontSize: number, minimumFontSize: number): number;
+    /**
+     * Loads the label formats.
+     *
+     * @param dataPath Path to the library's data files
+     * @returns Promise resolving to the label formats JSON
+     *
+     * @class PDFLabels
+     * @private
+     */
+    _loadLabelFormats(dataPath: string): Promise<ILabel[]>;
+}

package/dist/types/components/create-feature/create-feature.d.ts

@@ -15,6 +15,7 @@
  */
 /// <reference types="arcgis-js-api" />
 import { EventEmitter } from "../../stencil-public-runtime";
+import { ISearchConfiguration } from "../../utils/interfaces";
 export declare class CreateFeature {
     el: HTMLCreateFeatureElement;
     /**
@@ -30,6 +31,18 @@ export declare class CreateFeature {
      * This will hide the header and footer elements of the editor and user needs to execute the submit method manually.
      */
     customizeSubmit?: boolean;
+    /**
+     * ISearchConfiguration: Configuration details for the Search widget
+     */
+    searchConfiguration: ISearchConfiguration;
+    /**
+     * boolean: When true a loading indicator will be shown while the editor loads
+     */
+    _editorLoading: boolean;
+    /**
+     * boolean: When true the search widget will shown
+     */
+    _showSearchWidget: boolean;
     /**
      * esri/widgets/Editor: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html
      * The Editor constructor
@@ -40,6 +53,21 @@ export declare class CreateFeature {
      * The Editor instance
      */
     protected _editor: __esri.Editor;
+    /**
+     * https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html
+     * The Feature layer instance
+     */
+    protected FeatureLayer: typeof import("esri/layers/FeatureLayer");
+    /**
+     * "esri/widgets/Search": https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html
+     * The Search instance
+     */
+    protected Search: typeof import("esri/widgets/Search");
+    /**
+     * "esri/widgets/Search": https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html
+     * The Search instance
+     */
+    protected _search: __esri.widgetsSearch;
     /**
      * esri/core/reactiveUtils: https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html
      */
@@ -49,9 +77,21 @@ export declare class CreateFeature {
      */
     protected _addingAttachment: boolean;
     /**
-    * Called each time the mapView prop is changed.
-    */
+     * HTMLDivElement: The node the editor will be added to
+     */
+    protected _container: HTMLDivElement;
+    /**
+     * boolean: Flag to maintain form submission using submit button
+     */
+    protected _isSubmitBtnClicked: boolean;
+    /**
+     * Called each time the mapView prop is changed.
+     */
     mapViewWatchHandler(): Promise<void>;
+    /**
+     * When _editorLoading is true the container node will be hidden while starting the create workflow
+     */
+    _editorLoadingWatchHandler(v: boolean): Promise<void>;
     /**
      * Destroy the Editor widget instance
      * @returns Promise that resolves when the operation is complete
@@ -78,6 +118,10 @@ export declare class CreateFeature {
     * Emitted on demand when editing attachments
     */
     editingAttachment: EventEmitter<boolean>;
+    /**
+     * Emitted on demand when editor panel changes
+     */
+    progressStatus: EventEmitter<number>;
     /**
      * StencilJS: Called once just after the component is first connected to the DOM.
      * @returns Promise when complete
@@ -92,7 +136,7 @@ export declare class CreateFeature {
      */
     render(): any;
     /**
-     * Init Editor widget and starts the create workflow
+     * Init Editor widget and Search widget
      */
     protected init(): Promise<void>;
     /**
@@ -111,15 +155,35 @@ export declare class CreateFeature {
      * @protected
      */
     protected startCreate(): Promise<void>;
+    /**
+     * Display search widget to search location
+     * @protected
+     */
+    protected createSearchWidget(): Promise<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;
     /**
      * Hides the elements of editor widget
      * @protected
      */
-    protected hideEditorsElements(): void;
+    protected hideEditorsElements(): Promise<void>;
     /**
      * On creation of feature emit the event that the feature is created
      * @param evt feature submit event
      * @protected
      */
     protected submitted(evt: any): Promise<void>;
+    /**
+     * call setTimeout in Promise wrapper
+     * @param delay The time, in milliseconds that the timer should wait before the promise is resolved
+     * @protected
+     */
+    protected timeout(delay: number): Promise<void>;
 }

package/dist/types/components/create-related-feature/create-related-feature.d.ts

@@ -0,0 +1,155 @@
+/** @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 } from '../../stencil-public-runtime';
+export declare class CreateRelatedFeature {
+    el: HTMLCreateRelatedFeatureElement;
+    /**
+     * esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+     */
+    mapView: __esri.MapView;
+    /**
+   *  __esri.FeatureLayer: https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html
+   */
+    table: __esri.FeatureLayer;
+    /**
+   *  __esri.Graphic: https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html
+   */
+    selectedFeature: __esri.Graphic;
+    /**
+     * boolean: Set this to true when have a custom submit button in the app.
+     * This will hide the header and footer elements of the editor and user needs to execute the submit method manually.
+     */
+    customizeSubmit?: boolean;
+    /**
+     * boolean: When true a loading indicator will be shown while the editor loads
+     */
+    _editorLoading: boolean;
+    /**
+     * esri/widgets/Editor: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html
+     * The Editor constructor
+     */
+    protected Editor: typeof import("esri/widgets/Editor");
+    /**
+   * esri/widgets/Editor: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html
+   * The Editor instance
+   */
+    protected _editor: __esri.Editor;
+    /**
+     * esri/core/reactiveUtils: https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html
+     */
+    protected reactiveUtils: typeof import("esri/core/reactiveUtils");
+    /**
+     * HTMLDivElement: The node the editor will be added to
+     */
+    protected _container: HTMLDivElement;
+    /**
+     * boolean: Flag to maintain the add attachment
+     */
+    protected _addingAttachment: boolean;
+    /**
+     * boolean: Flag to maintain form submission using submit button
+     */
+    protected _isSubmitBtnClicked: boolean;
+    /**
+    * Called each time the mapView prop is changed.
+    */
+    mapViewWatchHandler(): Promise<void>;
+    /**
+     * When _editorLoading is true the container node will be hidden while starting the create workflow
+     */
+    _editorLoadingWatchHandler(v: boolean): Promise<void>;
+    /**
+     * Destroy the Editor widget instance
+     */
+    close(): Promise<void>;
+    /**
+     * Submit the comment
+     */
+    submit(): Promise<void>;
+    /**
+     * Emitted on demand when the comment is submitted successfully
+     */
+    success: EventEmitter<void>;
+    /**
+     * Emitted on demand when the comment submission is failed
+     */
+    fail: EventEmitter<Error>;
+    /**
+     * Emitted on demand when any action is pending or completed
+     */
+    isActionPending: EventEmitter<boolean>;
+    /**
+     * Emitted on demand when form is ready
+     */
+    formReady: EventEmitter<void>;
+    /**
+     * StencilJS: Called once just after the component is first connected to the DOM.
+     * @returns Promise when complete
+     */
+    componentWillLoad(): Promise<void>;
+    /**
+     * Init Editor widget and starts the create workflow
+     */
+    protected init(): Promise<void>;
+    /**
+     * Load esri javascript api modules
+     * @returns Promise resolving when function is done
+     * @protected
+     */
+    protected initModules(): Promise<void>;
+    render(): any;
+    /**
+     * StencilJS: Called once just after the component is fully loaded and the first render() occurs.
+     */
+    componentDidLoad(): Promise<void>;
+    /**
+     * Display editor widget to create the new feature
+     * @protected
+     */
+    protected createEditorWidget(): Promise<void>;
+    /**
+     * Start creating the feature feature form
+     * @protected
+     */
+    protected startCreate(): Promise<void>;
+    /**
+     * Hides the elements of editor widget
+     * @protected
+     */
+    protected hideEditorsElements(): Promise<void>;
+    /**
+     * Makes attributes for related feature
+     * @param parentFeature Parent feature
+     * @param parentRelationship Parent relationship
+     * @param childRelationship Child relationship
+     * @returns Attributes for related feature
+     * @protected
+     */
+    protected makeAttributesForRelatedFeature(parentFeature: __esri.Graphic, parentRelationship: __esri.Relationship, childRelationship: __esri.Relationship): object;
+    /**
+     * On creation of feature emit the event that the feature is created
+     * @param evt feature submit event
+     * @protected
+     */
+    protected submitted(evt: any): Promise<void>;
+    /**
+     * call setTimeout in Promise wrapper
+     * @param delay The time, in milliseconds that the timer should wait before the promise is resolved
+     * @protected
+     */
+    protected timeout(delay: number): Promise<void>;
+}

package/dist/types/components/crowdsource-manager/crowdsource-manager.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 /// <reference types="arcgis-js-api" />
-import { VNode } from "../../stencil-public-runtime";
+import { VNode, EventEmitter } from "../../stencil-public-runtime";
 import CrowdsourceManager_T9n from "../../assets/t9n/crowdsource-manager/resources.json";
 import { ELayoutMode, IBasemapConfig, IMapChange, IMapInfo, ISearchConfiguration, theme } from "../../utils/interfaces";
 export declare class CrowdsourceManager {
@@ -23,6 +23,16 @@ export declare class CrowdsourceManager {
      * Array of objects containing proxy information for premium platform services.
      */
     appProxies: any;
+    /**
+     * IBasemapConfig: List of any basemaps to filter out from the basemap widget
+     */
+    basemapConfig: IBasemapConfig;
+    /**
+     * boolean: When true a cover page has been enabled in the consuming application.
+     * Also when true a floating button will be shown in the lower right of the window that
+     * will emit an event when clicked that the consuming application can respond to that will open the cover page.
+     */
+    coverPageEnabled: boolean;
     /**
      * string: default center point values for the map
      * ; delimited x;y pair
@@ -48,10 +58,20 @@ export declare class CrowdsourceManager {
      * string: Item ID of the web map that should be selected by default
      */
     defaultWebmap: string;
+    /**
+     * boolean: When true a introduction window has been enabled in the consuming application.
+     * Also when true a floating button will be shown in the lower right of the window that
+     * will emit an event when clicked that the consuming application can respond to that will open the introduction window.
+     */
+    introductionWindowEnabled: boolean;
     /**
      * boolean: when true the layer table will auto refresh the data
      */
     enableAutoRefresh: boolean;
+    /**
+     * boolean: when true the basemap widget will be available
+     */
+    enableBasemap: boolean;
     /**
      * boolean: when true the layer table will support drag/drop of columns to adjust order
      */
@@ -68,6 +88,10 @@ export declare class CrowdsourceManager {
      * boolean: when true the fullscreen widget will be available
      */
     enableFullscreen: boolean;
+    /**
+     * boolean: when true the home widget will be available
+     */
+    enableHome: boolean;
     /**
      * boolean: when true edits can be applied directly within the table
      */
@@ -84,26 +108,14 @@ export declare class CrowdsourceManager {
      * boolean: when true the share widget will be available
      */
     enableShare: boolean;
-    /**
-     * boolean: when true the home widget will be available
-     */
-    enableHome: boolean;
     /**
      * boolean: when true the zoom widget will be available
      */
     enableZoom: boolean;
     /**
-     * boolean: when true the basemap widget will be available
-     */
-    enableBasemap: boolean;
-    /**
-     * IBasemapConfig: List of any basemaps to filter out from the basemap widget
+     * boolean: when true the map will be hidden on load
      */
-    basemapConfig: IBasemapConfig;
-    /**
-     * boolean: when true the table will be sorted by objectid in descending order by default
-     */
-    showNewestFirst: boolean;
+    hideMapOnLoad: boolean;
     /**
      * IMapInfo[]: array of map infos (name and id)
      */
@@ -112,6 +124,22 @@ export declare class CrowdsourceManager {
      * boolean: When true only editable layers that support the update capability will be available
      */
     onlyShowUpdatableLayers: boolean;
+    /**
+     * string: The background color to apply to the popup header
+     */
+    popupHeaderColor: string;
+    /**
+     * string: The color that will be displayed on hover when expanding the popup header
+     */
+    popupHeaderHoverColor: string;
+    /**
+     * string: The font color that will be displayed on hover when expanding the popup header
+     */
+    popupHeaderHoverTextColor: string;
+    /**
+     * string: The font color to apply to the popup header
+     */
+    popupHeaderTextColor: string;
     /**
      * ISearchConfiguration: Configuration details for the Search widget
      */
@@ -124,6 +152,10 @@ export declare class CrowdsourceManager {
      * boolean: When true the share options will include social media sharing
      */
     shareIncludeSocial: boolean;
+    /**
+     * boolean: when true the table will be sorted by objectid in descending order by default
+     */
+    showNewestFirst: boolean;
     /**
      * theme: "light" | "dark" theme to be used
      */
@@ -132,6 +164,10 @@ export declare class CrowdsourceManager {
      * boolean: When true the selected feature will zoomed to in the map and the row will be scrolled to within the table
      */
     zoomAndScrollToSelected: boolean;
+    /**
+     * number: default scale to zoom to when zooming to a single point feature
+     */
+    zoomToScale: number;
     /**
      * When true the info panel with the popup details will take the full height and prevent the map from displaying
      */
@@ -191,6 +227,10 @@ export declare class CrowdsourceManager {
      * MapView.when is not fired when mapView is not currently visible
      */
     protected _defaultLevelHonored: boolean;
+    /**
+     * boolean: When true hideMapOnLoad was honored for the current map
+     */
+    protected _hideMapOnLoadHonored: boolean;
     /**
      * HTMLLayerTableElement: The layer table element
      */
@@ -212,6 +252,18 @@ export declare class CrowdsourceManager {
      * When true the map zoom tools will be available
      */
     enableZoomWatchHandler(): void;
+    /**
+     * When true the map will be hidden on load
+     */
+    hideMapOnLoadWatchHandler(): void;
+    /**
+     * Emitted on demand when a info button is clicked
+     */
+    showIntroductionWindow: EventEmitter<void>;
+    /**
+     * Emitted on demand when a cover page button is clicked
+     */
+    showCoverPage: EventEmitter<void>;
     /**
      * Listen for changes in feature selection and show or hide the map, popup, and table
      */
@@ -240,6 +292,10 @@ export declare class CrowdsourceManager {
      * Get the layer for the provided layer id
      */
     layerSelectionChange(evt: CustomEvent): Promise<void>;
+    /**
+     * Update the state expandPopup when mapInfoChange event occurs
+     */
+    mapInfoChange(): Promise<void>;
     /**
      * StencilJS: Called once just after the component is first connected to the DOM.
      *
@@ -307,6 +363,14 @@ export declare class CrowdsourceManager {
      * @protected
      */
     protected _getBody(layoutMode: ELayoutMode, panelOpen: boolean, hideTable: boolean): VNode;
+    /**
+     * Emit the event when info button clicked
+     */
+    protected infoButtonClick(): void;
+    /**
+   * Emit the event when cover page button clicked
+   */
+    protected coverPageButtonClick(): void;
     /**
      * Get the map and card nodes based for the current layout options
      *