@esri/solutions-components 0.5.1 → 0.5.2

package/dist/components/downloadUtils.js

@@ -24,32 +24,19 @@ import { e as queryFeaturesByID } from './queryUtils.js';
  * limitations under the License.
  */
 //#region Public functions
-/**
- * Export a csv of the attributes from the features that match the provided ids
- *
- * @param labels Labels to write
- */
-function exportCSV(labels) {
-  // Format values to string so it doesn't get tripped up when a value has a comma
-  // another option could be to export with a different delimiter
-  const outputLines = labels.map(label => Object.values(label).map(v => `"${v}"`).join(",") + "\r\n");
-  _downloadCSVFile(outputLines, `notify-${Date.now().toString()}`);
-}
-//#endregion
-//#region Private functions
 /**
  * Download the CSV file
  *
+ * @param title Title (without file extension) to use for file; defaults to "export"
  * @param outputLines Lines of output to write to file
- * @param fileTitle Title (without file extension) to use for file; defaults to "export"
  *
  * @see {@link https://medium.com/@danny.pule/export-json-to-csv-file-using-javascript-a0b7bc5b00d2}
  */
-function _downloadCSVFile(outputLines, fileTitle) {
+function downloadCSVFile(title, outputLines) {
   const link = document.createElement("a");
   if (link.download !== undefined) {
     link.href = URL.createObjectURL(new Blob(outputLines, { type: "text/csv;charset=utf-8;" }));
-    link.download = `${fileTitle}.csv` || "export.csv";
+    link.download = `${title}.csv` || "export.csv";
     link.style.visibility = "hidden";
     document.body.appendChild(link);
     link.click();
@@ -58,6 +45,37 @@ function _downloadCSVFile(outputLines, fileTitle) {
 }
 //#endregion
 
+/** @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.
+ */
+//#endregion
+//#region Public functions
+/**
+ * Export a csv of the attributes from the features that match the provided ids
+ *
+ * @param title Title to use for file
+ * @param labels Labels to write
+ */
+function exportCSV(title, labels) {
+  // Format values to string so it doesn't get tripped up when a value has a comma
+  // another option could be to export with a different delimiter
+  const outputLines = labels.map(label => Object.values(label).map(v => `"${v}"`).join(",") + "\r\n");
+  downloadCSVFile(title, outputLines);
+}
+//#endregion
+
 var _typeof_1 = createCommonjsModule(function (module) {
 function _typeof(obj) {
   "@babel/helpers - typeof";
@@ -1124,7 +1142,7 @@ function(t){t.__bidiEngine__=t.prototype.__bidiEngine__=function(t){var r,n,i,a,
 
 /* @preserve
 * arcgis-pdf-creator v0.0.1
-* Fri Feb 03 2023 09:47:02 GMT-0800 (Pacific Standard Time)
+* Tue Mar 21 2023 10:44:29 GMT-0700 (Pacific Daylight Time)
 */
 /** @license
  * Copyright 2022 Esri
@@ -1399,13 +1417,16 @@ class PDFCreator {
      *
      * @param text String to estimate
      * @param fontSize Text size in points
-     * @returns Estimated width of text in doc units
+     * @returns Estimated width of text using (points x 1/72 inches/point) * 0.6;
+     * need to override this generalized function with a specific PDF generator;
+     * the 0.6 width:height ratio comes from https://www.fhwa.dot.gov/publications/research/safety/98057/ch03.cfm#width
      *
      * @class PDFCreator
      */
     getTextWidth(text, fontSize) {
+        const ratioWidthToHeight = 0.6;
         // Return a value for testing
-        return text.length * fontSize;
+        return text.length * fontSize * this.fontProps.fontResolutionInchesPerPoint * ratioWidthToHeight;
     }
     /**
      * @class PDFCreator
@@ -1513,7 +1534,7 @@ class PDFCreator {
 
 /* @preserve
 * arcgis-pdf-creator v0.0.1
-* Fri Feb 03 2023 09:47:02 GMT-0800 (Pacific Standard Time)
+* Tue Mar 21 2023 10:44:29 GMT-0700 (Pacific Daylight Time)
 */
 
 /** @license
@@ -1741,7 +1762,7 @@ class PDFCreator_jsPDF extends PDFCreator {
 
 /* @preserve
 * arcgis-pdf-creator v0.0.1
-* Fri Feb 03 2023 09:47:02 GMT-0800 (Pacific Standard Time)
+* Tue Mar 21 2023 10:44:29 GMT-0700 (Pacific Daylight Time)
 */
 /** @license
  * Copyright 2022 Esri
@@ -1804,7 +1825,7 @@ function drawGridOfBoxes(PDFCreator, options = {
 
 /* @preserve
 * arcgis-pdf-creator v0.0.1
-* Fri Feb 03 2023 09:47:02 GMT-0800 (Pacific Standard Time)
+* Tue Mar 21 2023 10:44:29 GMT-0700 (Pacific Daylight Time)
 */
 
 /** @license
@@ -1831,12 +1852,13 @@ class PDFLabels {
      * @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, labelSpec, startingPageNum, progressCallback) {
+    addLabelsToDoc(labels, labelSpec, startingPageNum, heading, progressCallback) {
         return new Promise((resolve) => {
             const labelsPerPageDisplay = labelSpec.numLabelsAcross * labelSpec.numLabelsDown;
             let column;
@@ -1847,6 +1869,9 @@ class PDFLabels {
             // Draw
             let currentPageNum = startingPageNum;
             const topOfFirstLabel = labelSpec.pageProperties.topMargin - this.PDFCreator.pageOptions.topMargin;
+            if (heading) {
+                this._drawSupplementalText(heading, 0, -0.1);
+            }
             for (let iLabel = 0, iNonBlankLabel = 0; iLabel < labels.length; iLabel++) {
                 if (progressCallback) {
                     progressCallback(Math.round(iLabel / labels.length * 100));
@@ -1862,6 +1887,9 @@ class PDFLabels {
                         // Advance to next page
                         this.PDFCreator.addPage();
                         ++currentPageNum;
+                        if (heading) {
+                            this._drawSupplementalText(heading, 0, -0.1);
+                        }
                     }
                     // Prep the new page
                     column = 0;
@@ -1874,11 +1902,14 @@ class PDFLabels {
                     row = 0;
                 }
                 // Draw the label
+                const minimumFontSize = 4;
                 // Temporarily reduce the font size if we have more lines than the label can hold
                 let fontPoints = labelSpec.fontSizePx;
                 if (labelSpec.maxNumLabelLines < labelLines.length) {
-                    fontPoints = Math.floor(labelSpec.maxNumLabelLines / labelLines.length * labelSpec.fontSizePx);
+                    fontPoints = Math.max(Math.floor(labelSpec.maxNumLabelLines / labelLines.length * labelSpec.fontSizePx), minimumFontSize);
                 }
+                // Temporarily reduce the font size farther if label lines are too long
+                fontPoints = this._getFontSizeForOverlongLines(labelLines, maxLabelTextWidth, fontPoints, minimumFontSize);
                 // Clip overlong lines; append ellipses to clipped lines
                 labelLines = this._clipOverlongLines(labelLines, maxLabelTextWidth, fontPoints);
                 const labelLineHeight = this.PDFCreator.fontAscenderDescenderHeight(fontPoints);
@@ -2040,6 +2071,47 @@ class PDFLabels {
         });
         return trimmedLines;
     }
+    /**
+     * 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, left, top) {
+        const fontPoints = 6;
+        this.PDFCreator.drawText(text, {
+            left,
+            top,
+            fontPoints,
+            fontColor: "000000"
+        });
+    }
+    /**
+     * 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, maxTextWidth, preferredFontSize, minimumFontSize) {
+        let fontSize = preferredFontSize;
+        lines.forEach(line => {
+            line = line.trim();
+            if (this.PDFCreator.getTextWidth(line, fontSize) > maxTextWidth) {
+                do {
+                    --fontSize;
+                } while (this.PDFCreator.getTextWidth(line, fontSize) > maxTextWidth && fontSize > minimumFontSize);
+            }
+        });
+        return fontSize;
+    }
     /**
      * Loads the label formats.
      *
@@ -2076,31 +2148,34 @@ class PDFLabels {
 /**
  * Exports a PDF of labels.
  *
+ * @param title Title to use for file
  * @param labels Labels to write
  * @param labelPageDescription Page format to use for labels
  */
-function exportPDF(labels, labelPageDescription) {
-  _downloadPDFFile(labels, labelPageDescription, `notify-${Date.now().toString()}`);
+function exportPDF(title, labels, labelPageDescription) {
+  downloadPDFFile(title, labels, labelPageDescription);
 }
 //#endregion
 //#region Private functions
 /**
  * Downloads the PDF file.
  *
+ * @param title Title (without file extension) to use for file; defaults to "export"
  * @param labels Labels to write
  * @param labelPageDescription Page format to use for labels
- * @param fileTitle Title (without file extension) to use for file; defaults to "export"
  */
-function _downloadPDFFile(labels, labelPageDescription, fileTitle) {
+function downloadPDFFile(title, labels, labelPageDescription) {
   const pdfLib = new PDFCreator_jsPDF();
   pdfLib.initialize({
     pageType: "ANSI_A"
-  }, getAssetPath(`../assets/arcgis-pdf-creator/`), "en", fileTitle, false)
+  }, getAssetPath(`../assets/arcgis-pdf-creator/`), "en", title)
     .then(() => {
     const labeller = new PDFLabels();
     labeller.initialize(pdfLib)
       .then(async () => {
-      await labeller.addLabelsToDoc(labels, labelPageDescription.labelSpec, 1);
+      await labeller.addLabelsToDoc(labels, labelPageDescription.labelSpec, 1, // startingPageNum
+      title // heading
+      );
       pdfLib.save();
     });
   });
@@ -2138,10 +2213,8 @@ const lineSeparatorChar = "|";
  * @returns Promise resolving when function is done
  */
 async function downloadCSV(selectionSetNames, layer, ids, formatUsingLayerPopup, removeDuplicates = false, addColumnTitle = false) {
-  console.log("downloadCSV using selectionSetNames " + JSON.stringify(selectionSetNames)); //???
-  console.log("downloadCSV removeDuplicates", removeDuplicates); //???
   const labels = await _prepareLabels(layer, ids, removeDuplicates, formatUsingLayerPopup, addColumnTitle);
-  exportCSV(labels);
+  exportCSV(_createTitle(selectionSetNames), labels);
   return Promise.resolve();
 }
 /**
@@ -2155,15 +2228,13 @@ async function downloadCSV(selectionSetNames, layer, ids, formatUsingLayerPopup,
  * @returns Promise resolving when function is done
  */
 async function downloadPDF(selectionSetNames, layer, ids, removeDuplicates, labelPageDescription) {
-  console.log("downloadPDF using selectionSetNames " + JSON.stringify(selectionSetNames)); //???
-  console.log("downloadPDF removeDuplicates", removeDuplicates); //???
   let labels = await _prepareLabels(layer, ids, removeDuplicates);
   labels =
     // Remove empty lines in labels
     labels.map(labelLines => labelLines.filter(line => line.length > 0))
       // Remove empty labels
       .filter(label => label.length > 0);
-  exportPDF(labels, labelPageDescription);
+  exportPDF(_createTitle(selectionSetNames), labels, labelPageDescription);
   return Promise.resolve();
 }
 //#endregion
@@ -2200,17 +2271,25 @@ function _convertPopupTextToLabelSpec(popupInfo) {
   popupInfo = popupInfo.replace(/<p[^>]*>/gi, lineSeparatorChar).trim().replace(/^\|/, "");
   // Remove </p>
   popupInfo = popupInfo.replace(/<\/p>/gi, "");
-  // Remove \n
-  popupInfo = popupInfo.replace(/\n/gi, "");
-  // Remove remaining HTML tags, replace 0xA0 that popup uses for spaces, and replace some char representations,
-  // and split the label back into individual lines
-  const labelSpec = popupInfo
+  // Replace \n with the line separator character
+  popupInfo = popupInfo.replace(/\n/gi, "|");
+  // Remove remaining HTML tags, replace 0xA0 that popup uses for spaces, and replace some char representations
+  let labelSpec = popupInfo
     .replace(/<[\s.]*[^<>]*\/?>/gi, "")
     .replace(/\xA0/gi, " ")
     .replace(/&lt;/gi, "<")
     .replace(/&gt;/gi, ">")
     .replace(/&nbsp;/gi, " ");
-  return labelSpec;
+  // Trim each line
+  labelSpec = labelSpec.replace(/\s*\|\s*/g, "|");
+  // Remove empty lines
+  while (labelSpec.match(/\|\|/)) {
+    labelSpec = labelSpec.replace(/\|\|/, "|");
+  }
+  // Remove leading and trailing line feeds
+  labelSpec = labelSpec.replace(/^\|/, "");
+  labelSpec = labelSpec.replace(/\|$/, "");
+  return labelSpec.trim();
 }
 /**
  * Extracts Arcade expressions from the lines of a label format and creates an Arcade executor for each
@@ -2274,6 +2353,18 @@ async function _createArcadeExecutors(labelFormat, layer) {
     return arcadeExecutors;
   });
 }
+/**
+ * Creates a title from a list of selection set names.
+ *
+ * @param selectionSetNames Names to use in title
+ * @return Title composed of the selectionSetNames separated by commas; if there are no
+ * selection set names supplied, "download" is returned
+ */
+function _createTitle(selectionSetNames) {
+  // Windows doesn't permit the characters \/:*?"<>|
+  const title = selectionSetNames.length > 0 ? selectionSetNames.join(", ") : "download";
+  return title;
+}
 /**
  * Prepares an attribute's value by applying domain and type information.
  *

package/dist/components/interfaces3.js

@@ -18,6 +18,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var ELayoutMode;
+(function (ELayoutMode) {
+  ELayoutMode["GRID"] = "GRID";
+  ELayoutMode["HORIZONTAL"] = "HORIZONTAL";
+  ELayoutMode["VERTICAL"] = "VERTICAL";
+})(ELayoutMode || (ELayoutMode = {}));
 /**
  * Resource update types
  */
@@ -77,4 +83,4 @@ var EExpandType;
   EExpandType["COLLAPSE"] = "COLLAPSE";
 })(EExpandType || (EExpandType = {}));
 
-export { EExpandType as E, EPageType as a, ESketchType as b, EWorkflowType as c, EExportType as d, ESelectionMode as e, ERefineMode as f, ESelectionType as g, EUpdateType as h };
+export { ELayoutMode as E, EPageType as a, ESketchType as b, EWorkflowType as c, EExportType as d, EExpandType as e, ESelectionMode as f, ERefineMode as g, ESelectionType as h, EUpdateType as i };