@esri/solutions-components 0.8.13 → 0.8.15

package/dist/solutions-components/utils/interfaces.ts

@@ -588,3 +588,8 @@ export interface IReportingOption {
   dislike: boolean;
   dislikeField?: string;
 }
+
+export interface ISortingInfo {
+  field: string;
+  order: 'asc' | 'desc';
+}

package/dist/solutions-components/utils/mapViewUtils.ts

@@ -175,6 +175,24 @@ export async function getAllLayers(
   return layers;
 }
 
+/**
+ * Get all of the tables from the current map when the map and their layerView is ready
+ * @param mapView the map view to fetch the table names from
+ * @returns Promise resolving with an array of all tables
+ *
+ */
+export async function getAllTables(
+  mapView: __esri.MapView
+): Promise<__esri.Layer[]> {
+  const tables = mapView.map.allTables.toArray();
+  let layerViewPromises;
+  await mapView.when(() => {
+    layerViewPromises = tables.map(t => t.load());
+  });
+  await Promise.allSettled(layerViewPromises);
+  return tables;
+}
+
 /**
  * Highlight features by OID
  *
@@ -313,7 +331,7 @@ export async function goToSelection(
   const result = await queryExtent(ids, layerView.layer);
   const goToParams: { target: __esri.Extent; scale?: number; } = { target: result.extent };
   if (result.count === 1 && layerView.layer.geometryType === 'point' && zoomToScale) {
-    goToParams.scale = zoomToScale
+    goToParams.scale = zoomToScale;
   }
   await mapView.goTo(goToParams);
   if (flashFeatures) {

package/dist/solutions-components/utils/pdfUtils.ts

@@ -41,7 +41,7 @@ export function exportPDF(
   title = "",
   initialImageDataUrl = ""
 ): void {
-  downloadPDFFile(filename, labels, labelPageDescription, title, initialImageDataUrl);
+  void downloadPDFFile(filename, labels, labelPageDescription, title, initialImageDataUrl);
 }
 
 //#endregion
@@ -56,15 +56,15 @@ export function exportPDF(
  * @param title Title for each page
  * @param initialImageDataUrl Data URL of image for first page
  */
-function downloadPDFFile(
+async function downloadPDFFile(
   filename: string,
   labels: string[][],
   labelPageDescription: PDFLabels.ILabel,
   title = "",
   initialImageDataUrl = ""
-): void {
+): Promise<void> {
   const pdfLib = new PDFCreator_jsPDF.PDFCreator_jsPDF();
-  pdfLib.initialize(
+  await pdfLib.initialize(
     {
       pageType: "ANSI_A"
     },
@@ -72,52 +72,45 @@ function downloadPDFFile(
     "en",
     filename  // filename without ".pdf"
   )
-  .then(
-    () => {
-      const labeller = new PDFLabels.PDFLabels();
-      labeller.initialize(pdfLib)
-      .then(
-        async () => {
-          const labelSpec = labelPageDescription.labelSpec;
-
-          let startingPageNum = 1;
-
-          // Add the screenshot to the PDF
-          if (initialImageDataUrl) {
-            const pageProperties = labelSpec.pageProperties;
-            const pageSize = PDFCreator.PDFCreator.getPageSize(pageProperties.pageType);
-
-            pdfLib.drawImage(initialImageDataUrl, {
-              x: pageProperties.leftMargin,
-              y: pageProperties.topMargin,
-              width: pageSize.width - pageProperties.leftMargin - pageProperties.rightMargin,
-              height: pageSize.height - pageProperties.topMargin - pageProperties.bottomMargin
-            });
-
-            if (title) {
-              labeller.drawSupplementalText(title, 0, -0.1);
-            }
-
-            if (labels.length > 0) {
-              pdfLib.addPage();
-              ++startingPageNum;
-            }
-          }
-
-          // Add the labels to the PDF
-          await labeller.addLabelsToDoc(
-            labels,
-            labelSpec,
-            startingPageNum,
-            title  // heading
-          );
-
-          pdfLib.save();
-        }
-      );
+
+  const labeller = new PDFLabels.PDFLabels();
+  await labeller.initialize(pdfLib)
+
+  const labelSpec = labelPageDescription.labelSpec;
+
+  let startingPageNum = 1;
+
+  // Add the screenshot to the PDF
+  if (initialImageDataUrl) {
+    const pageProperties = labelSpec.pageProperties;
+    const pageSize = PDFCreator.PDFCreator.getPageSize(pageProperties.pageType);
+
+    pdfLib.drawImage(initialImageDataUrl, {
+      x: pageProperties.leftMargin,
+      y: pageProperties.topMargin,
+      width: pageSize.width - pageProperties.leftMargin - pageProperties.rightMargin,
+      height: pageSize.height - pageProperties.topMargin - pageProperties.bottomMargin
+    });
+
+    if (title) {
+      labeller.drawSupplementalText(title, 0, -0.1);
     }
+
+    if (labels.length > 0) {
+      pdfLib.addPage();
+      ++startingPageNum;
+    }
+  }
+
+  // Add the labels to the PDF
+  await labeller.addLabelsToDoc(
+    labels,
+    labelSpec,
+    startingPageNum,
+    title  // heading
   );
 
+  pdfLib.save();
 }
 
 //#endregion

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-related-feature/create-related-feature.d.ts

@@ -0,0 +1,113 @@
+/// <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;
+    /**
+     * 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");
+    /**
+     * boolean: Flag to maintain the add attachment
+     */
+    protected _addingAttachment: boolean;
+    /**
+    * Called each time the mapView prop is changed.
+    */
+    mapViewWatchHandler(): 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>;
+    /**
+     * 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(): void;
+    /**
+     * Makes attributes for related feature
+     * @param parentFeature Parent feature
+     * @param parentRelationship Parent relationship
+     * @param childRelationship Child relationship
+     * @returns Attributes for related feature
+     */
+    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>;
+}