@arcgis/map-components 5.0.0-next.17 → 5.0.0-next.170

package/dist/chunks/utils2.js

@@ -1,92 +1,51 @@
-import { substitute as o, formatNumber as l } from "@arcgis/core/intl.js";
-import { stripHTML as s } from "@arcgis/core/applications/Components/stringUtils.js";
-/*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
-See https://js.arcgis.com/5.0/esri/copyright.txt for details.
-v5.0.0-next.17 */
-function d(r, t) {
-  return t;
-}
-function u(r, t, i) {
-  if (!t)
+/* COPYRIGHT Esri - https://js.arcgis.com/5.0/LICENSE.txt */
+import { formatNumber as i } from "@arcgis/core/intl.js";
+const p = /* @__PURE__ */ new Map([
+  ["a3-landscape", "a3-landscape"],
+  ["a3-portrait", "a3-portrait"],
+  ["a4-landscape", "a4-landscape"],
+  ["a4-portrait", "a4-portrait"],
+  ["letter-ansi-a-landscape", "ansi-a-landscape"],
+  ["letter-ansi-a-portrait", "ansi-a-portrait"],
+  ["tabloid-ansi-b-landscape", "ansi-b-landscape"],
+  ["tabloid-ansi-b-portrait", "ansi-b-portrait"]
+]), u = /^https:\/\/([a-z\d-]+)(\.maps([^.]*))?\.arcgis\.com/iu;
+function f(a) {
+  if (!a)
     return;
-  if (typeof t == "number")
-    return t;
-  if (typeof t == "string")
-    return s(t);
-  if ("value" in t || "unit" in t)
-    return o(r.dotValue ?? "", t);
-  if ("colorName" in t && "bandName" in t) {
-    const n = r[t.colorName], a = r[t.bandName] || t.bandName;
-    return `${n}: ${a}`;
-  }
-  if ("showCount" in t)
-    return t.showCount ? r.clusterCountTitle : void 0;
-  let e = null;
-  return d(t, i) ? e = t.ratioPercentTotal ? "showRatioPercentTotal" : t.ratioPercent ? "showRatioPercent" : t.ratio ? "showRatio" : t.normField ? "showNormField" : t.field ? "showField" : null : c(t, i) && (e = t.normField ? "showNormField" : t.normByPct ? "showNormPct" : t.field ? "showField" : null), e ? o(e === "showField" ? "{field}" : r[e] ?? "", {
-    field: t.field,
-    normField: t.normField
-  }) : void 0;
-}
-function c(r, t) {
-  return !t;
-}
-function h(r, t) {
-  if (!r.title || typeof r.title == "string")
-    return r.title;
-  const i = r.type === "color-ramp" || r.type === "opacity-ramp", e = r.title, n = u(t, e, i);
-  return c(e, i) && e.title ? `${e.title} (${n})` : n;
-}
-const m = /^-?(\d+(\.\d+)?)\s*((px)|(pt))?$/iu;
-function y(r, t, i) {
-  switch (t) {
-    case "heatmap-ramp":
-      return (i[r.label] || r.label) ?? null;
-    case "stretch-ramp":
-      const e = "value" in r ? r.value : void 0, n = r.label ? i[r.label] : "";
-      return n ? `${n}: ${typeof e == "string" ? e : l(e ?? 0, {
-        style: "decimal",
-        notation: e?.toString().toLowerCase().includes("e") ? "scientific" : "standard"
-      })}` : "";
-    default:
-      return r.label ?? null;
-  }
-}
-function w(r, t) {
-  return !!(t && t === "Stretched" && "version" in r && typeof r.version == "number" && r.version >= 10.3 && r.declaredClass === "esri.layers.ImageryLayer");
-}
-function N(r) {
-  return r ? r / 72 * 96 : 0;
-}
-function b(r) {
-  return r ? r * 72 / 96 : 0;
-}
-function v(r) {
-  if (typeof r == "string") {
-    const t = r.match(m);
-    if (t) {
-      const i = Number(t[1]), e = t[3]?.toLowerCase(), n = r.startsWith("-"), a = e === "px" ? b(i) : i;
-      return n ? -a : a;
-    }
-    return null;
-  }
-  return r;
-}
-function L(r, t) {
-  const i = u(r, t, !1), e = i ? r.previewTemplateAriaLabel : r.previewAriaLabel;
-  return o(e ?? "", { label: i });
-}
-function F(r, t) {
-  if (!t || !r)
+  const t = a.layoutTemplateInfo;
+  if (!t)
     return;
-  (r.querySelector("svg") ?? r.querySelector("canvas") ?? r).setAttribute("aria-label", t);
+  const [e, n] = t.pageSize;
+  return `${i(e)} × ${i(n)} ${a.pageUnits}`;
+}
+function d(a, t) {
+  const { label: e, layout: n, layoutItem: o } = a, r = n && !o && t[n] ? t[n] : null;
+  return r || ((e ?? n ?? o?.id)?.replaceAll("_", " ") ?? t.untitled);
+}
+function g(a) {
+  return p.get(a);
+}
+const b = /* @__PURE__ */ new Map([
+  ["AIX", "aix"],
+  ["EPS", "eps"],
+  ["GIF", "gif"],
+  ["JPG", "jpg"],
+  ["PDF", "pdf"],
+  ["PNG32", "png32"],
+  ["PNG8", "png8"],
+  ["SVG", "svg"],
+  ["SVGZ", "svgz"],
+  ["TIFF", "tiff"]
+]), s = "map-only";
+function m(a) {
+  return a?.toLowerCase() === s;
 }
 export {
-  u as a,
-  h as b,
-  y as c,
-  L as g,
-  w as i,
-  N as p,
-  F as s,
-  v as t
+  f as a,
+  g as b,
+  b as f,
+  d as g,
+  m as i,
+  u as r
 };

package/dist/chunks/visible-element.js

@@ -0,0 +1,7 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.0/LICENSE.txt */
+function n(e) {
+  return e.hidden ? null : e.children;
+}
+export {
+  n as V
+};

package/dist/components/arcgis-area-measurement-2d/customElement.d.ts

@@ -1,115 +1,212 @@
-/// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference path="../../index.d.ts" />
-import { default as AreaMeasurement2D } from '@arcgis/core/widgets/AreaMeasurement2D.js';
-import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
-import { Use } from '@arcgis/lumina/controllers';
-import { ArcgisReferenceElement } from '../../utils/component-utils';
+import type MapView from "@arcgis/core/views/MapView.js";
+import type AreaMeasurementAnalysis from "@arcgis/core/analysis/AreaMeasurementAnalysis.js";
+import type SnappingOptions from "@arcgis/core/views/interactive/snapping/SnappingOptions.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { ArcgisReferenceElement } from "../types.js";
+import type { AreaMeasurement2DState } from "./types.js";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
+import type { Icon as Icon } from "@esri/calcite-components/components/calcite-icon";
+import type { SystemOrAreaUnit } from "@arcgis/core/core/units.js";
 
-declare const useAreaMeasurement2dWidget: (component: LitElement & Pick<AreaMeasurement2D & {
-    viewModel: __esri.Accessor;
-}, "label" | "viewModel" | "icon" | "snappingOptions" | "unit" | "unitOptions"> & {
-    state?: unknown;
-    viewModel?: (__esri.AreaMeasurement2DViewModel & __esri.Accessor) | undefined;
-    closed?: boolean;
-    icon: import('@arcgis/toolkit/type').nil | string;
-    label: import('@arcgis/toolkit/type').nil | string;
-    referenceElement?: ArcgisReferenceElement | string;
-    position?: __esri.UIPosition;
-    arcgisReady: import('@arcgis/lumina').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
-        name: string;
-    }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView | nullish;
-    };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}) => AreaMeasurement2D & {
-    viewModel: __esri.Accessor;
-};
 /**
- * The Area Measurement 2D component calculates and displays the area and perimeter of a polygon only in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+ * The Area Measurement 2D component can be added to an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)
+ * component to calculate and display the area and perimeter of a polygon.
  *
- * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/)
+ * How areas and perimeters are computed depends on the map's spatial reference.
+ *
+ * In **geographic coordinate systems** (GCS), and in **Web Mercator**, areas and perimeters are computed geodetically, taking into consideration the curvature of the planet.
+ *
+ * In **projected coordinate systems** (PCS), apart from Web Mercator, areas and perimeters are computed in a Euclidean manner (in their respective PCS).
  *
  * @since 4.28
  */
-export declare class ArcgisAreaMeasurement2d extends LitElement {
-    /**
-     * The view associated with the component.
-     *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the ArcgisAreaMeasurement2d component will be associated with a map or scene component rather than using the `view` property.
-     */
-    view?: __esri.MapView | nullish;
-    /**
-     * If true, the component will not be destroyed automatically when it is
-     * disconnected from the document. This is useful when you want to move the
-     * component to a different place on the page, or temporarily hide it. If this
-     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/#destroy) method when you are done to
-     * prevent memory leaks.
-     *
-     * @default false
-     */
-    autoDestroyDisabled: boolean;
-    /**
-     * Icon which represents the component.
-     * Typically used when the component is controlled by another component (e.g. by the Expand component).
-     *
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
-     * @default "measure-area"
-     */
-    icon: string;
-    /**
-     * The widget's default label.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#label)
-     */
-    label: string;
-    /** @deprecated since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead. */
-    position?: __esri.UIPosition;
-    /**
-     * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
-     *
-     * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
-     */
-    referenceElement?: ArcgisReferenceElement | string;
-    /**
-     * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#snappingOptions)
-     */
-    snappingOptions: __esri.SnappingOptions;
-    /**
-     * The current state of the component.
-     *
-     * @default "disabled"
-     */
-    readonly state: "ready" | "disabled" | "measuring" | "measured";
-    /**
-     * Unit system (imperial, metric) or specific unit used for displaying the area values.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unit)
-     */
-    unit: __esri.SystemOrAreaUnit;
-    /**
-     * List of available units and unit systems (imperial, metric) for displaying the area values.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unitOptions)
-     */
-    unitOptions: __esri.SystemOrAreaUnit[];
-    /** Clear the current measurement. */
-    clear(): Promise<void>;
-    /** Permanently destroy the component. */
-    destroy(): Promise<void>;
-    /** Starts a new measurement. */
-    start(): Promise<void>;
-    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
-    readonly arcgisPropertyChange: TargetedEvent<this, {
-        name: "state";
-    }>;
-    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
-    readonly arcgisReady: TargetedEvent<this, void>;
-}
-export {};
+export abstract class ArcgisAreaMeasurement2d extends LitElement {
+  /**
+   * The [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/)
+   * created or modified by the component.
+   *
+   * When connecting the Area Measurement 2D component to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)
+   * component, it automatically creates an empty analysis and adds it to the Map's
+   * [arcgis-map.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#analyses) collection.
+   * You can then wait for the [AreaMeasurementAnalysisView2D](https://developers.arcgis.com/javascript/latest/references/core/views/2d/analysis/AreaMeasurementAnalysisView2D/)
+   * to be created before accessing the analysis results.
+   *
+   * ```js
+   * // Get the Map component and the Area Measurement 2D component, and wait until both are ready.
+   * const viewElement = document.querySelector("arcgis-map");
+   * await viewElement.viewOnReady();
+   * const areaMeasurement2dElement = document.querySelector("arcgis-area-measurement-2d");
+   * await areaMeasurement2dElement.componentOnReady();
+   *
+   * // Get the AreaMeasurementAnalysis created by the Area Measurement 2D component.
+   * const analysis = areaMeasurement2dElement.analysis;
+   *
+   * // Get the AreaMeasurementAnalysisView2D and watch for results.
+   * const analysisView = await viewElement.whenAnalysisView(analysis);
+   * const handle = reactiveUtils.watch(
+   *   () => analysisView?.result,
+   *   () => {
+   *     console.log("Analysis results:", analysisView.result);
+   *   },
+   * );
+   * ```
+   * Whenever the component is destroyed, the analysis is automatically removed from the collection.
+   *
+   * Alternatively, a programmatically created [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/)
+   * can be provided to the component.
+   * Then, the application itself needs to add it to and later remove it from the analyses collection of the Map component.
+   *
+   * ```js
+   * // Create the AreaMeasurementAnalysis.
+   * const areaMeasurementAnalysis = new AreaMeasurementAnalysis({
+   *   geometry: new Polygon({
+   *     rings: [
+   *       [
+   *         [-80.208889, 25.775278], // Maimi, Florida
+   *         [-64.782, 32.293],       // Hamilton, Bermuda
+   *         [-66.063889, 18.406389], // San Juan, Puerto Rico
+   *         [-80.208889, 25.775278], // Maimi, Florida
+   *       ],
+   *     ],
+   *  }),
+   * });
+   *
+   * // Get the Map component and the Area Measurement 2D component, and wait until both are ready.
+   * const viewElement = document.querySelector("arcgis-map");
+   * await viewElement.viewOnReady();
+   * const areaMeasurement2dElement = document.querySelector("arcgis-area-measurement-2d");
+   * await areaMeasurement2dElement.componentOnReady();
+   *
+   * // Add the analysis to the analyses collection of the Map component.
+   * viewElement.analyses.add(areaMeasurementAnalysis);
+   *
+   * // Connect the analysis to the measurement component:
+   * areaMeasurement2dElement.analysis = areaMeasurementAnalysis;
+   * ```
+   */
+  accessor analysis: AreaMeasurementAnalysis;
+  /**
+   * If true, the component will not be destroyed automatically when it is
+   * disconnected from the document. This is useful when you want to move the
+   * component to a different place on the page, or temporarily hide it. If this
+   * is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#destroy) method when you are done to
+   * prevent memory leaks.
+   *
+   * @default false
+   */
+  accessor autoDestroyDisabled: boolean;
+  /**
+   * If true, the button that starts a new measurement will be hidden.
+   *
+   * @default false
+   * @since 5.0
+   */
+  accessor hideStartButton: boolean;
+  /**
+   * If true, the unit selection dropdown will be hidden.
+   *
+   * @default false
+   * @since 5.0
+   */
+  accessor hideUnitSelect: boolean;
+  /**
+   * Indicates whether the component's visualization is hidden in the view.
+   *
+   * @default false
+   * @since 5.0
+   */
+  accessor hideVisualization: boolean;
+  /**
+   * Icon which represents the component.
+   * Typically used when the component is controlled by another component (e.g. by the Expand component).
+   *
+   * @default "measure-area"
+   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
+  accessor icon: Icon["icon"] | undefined;
+  /** The component's default label. */
+  accessor label: string | undefined;
+  /** @internal */
+  protected messages: {
+      area: string;
+      componentLabel: string;
+      hint: string;
+      mode: string;
+      modes: {
+          auto: string;
+          planar: string;
+          geodesic: string;
+      };
+      newMeasurement: string;
+      perimeter: string;
+      unit: string;
+      unsupported: string;
+  } & T9nMeta<{
+      area: string;
+      componentLabel: string;
+      hint: string;
+      mode: string;
+      modes: {
+          auto: string;
+          planar: string;
+          geodesic: string;
+      };
+      newMeasurement: string;
+      perimeter: string;
+      unit: string;
+      unsupported: string;
+  }>;
+  /**
+   * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
+   *
+   * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
+   */
+  accessor referenceElement: ArcgisReferenceElement | string | undefined;
+  /**
+   * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/}
+   * for sketching.
+   *
+   * @since 4.28
+   */
+  accessor snappingOptions: SnappingOptions;
+  /**
+   * The component's state. The values mean the following:
+   *
+   * * `disabled` -  not ready yet
+   * * `ready` - ready for measuring
+   * * `measuring` - currently measuring
+   * * `measured` - measuring has finished
+   */
+  get state(): AreaMeasurement2DState;
+  /**
+   * Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in
+   * [unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#unitOptions).
+   */
+  accessor unit: SystemOrAreaUnit;
+  /**
+   * List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.
+   * By default, the following units are included: `metric`, `imperial`, `square-inches`, `square-feet`, `square-us-feet`, `square-yards`, `square-miles`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.
+   * Possible [unit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#unit) values can only be a subset of this list.
+   */
+  accessor unitOptions: Array<SystemOrAreaUnit>;
+  /**
+   * The view associated with the component. 
+   *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-area-measurement-2d component will be associated with a map or scene component rather than using the `view` property.
+   */
+  accessor view: MapView | undefined;
+  /** Clears the current measurement. */
+  clear(): Promise<void>;
+  /** Permanently destroy the component. */
+  destroy(): Promise<void>;
+  /** Starts a new measurement. */
+  start(): Promise<void>;
+  /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
+  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "analysis" | "state"; }>;
+  /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
+  readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
+  readonly "@eventTypes": {
+    arcgisPropertyChange: ArcgisAreaMeasurement2d["arcgisPropertyChange"]["detail"];
+    arcgisReady: ArcgisAreaMeasurement2d["arcgisReady"]["detail"];
+  };
+}