@arcgis/map-components 5.1.0-next.123 → 5.1.0-next.125

package/dist/components/arcgis-paste/PasteViewModel.d.ts

@@ -9,7 +9,7 @@ import type SceneView from "@arcgis/core/views/SceneView.js";
 import type MapView from "@arcgis/core/views/MapView.js";
 import type SubtypeSublayer from "@arcgis/core/layers/support/SubtypeSublayer.js";
 import type BatchAttributeFormViewModel from "@arcgis/core/widgets/BatchAttributeForm/BatchAttributeFormViewModel.js";
-import type TemplateItem from "../arcgis-feature-templates/TemplateItem.js";
+import type TemplateListItem from "@arcgis/core/editing/templates/TemplateListItem.js";
 import type { EsriClipboard, ClipboardItem as EsriClipboardItem } from "@arcgis/core/applications/Components/clipboard.js";
 import type { ApplySet, ApplySetLayerEditResult, ApplySetServiceEditResult } from "@arcgis/core/applications/Components/applySetUtils.js";
 import type { ClipboardMove } from "./ClipboardMove.js";
@@ -127,7 +127,7 @@ export default class PasteViewModel extends Accessor {
       disabled: boolean;
       available: boolean;
   }[];
-  accessor pasteTemplate: TemplateItem | undefined;
+  accessor pasteTemplate: TemplateListItem | undefined;
   get pasteTemplateIsValid(): boolean;
   /** @default true */
   accessor pasteWithAttributes: boolean;

package/dist/components/arcgis-popup/customElement.d.ts

@@ -35,7 +35,7 @@ import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.j
  *
  * The Popup component can also be opened manually at a specific location using the [open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#open) property.
  * To prevent the popup from opening automatically when clicking on features within view components, set the `popup-disabled` attribute to `true` and add the Popup component to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) using the `popup` slot.
- * Before setting the `open` property to `true`, you must set the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) property to specify where the popup should open or call the [fetchFeatures()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#fetchFeatures) method to open the popup template for features at a specific screen location.
+ * Before setting the `open` property to `true`, you must set the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) property to specify where the popup should open.
  *
  * Example of opening the popup at a clicked location with custom content:
  *
@@ -59,7 +59,7 @@ import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.j
  * </script>
  * ```
  *
- * Alternatively, you can call the [fetchFeatures()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#fetchFeatures) method within the view element's click event listener to open the popup with features at the clicked location.
+ * Alternatively, you can call the [arcgis-map.fetchPopupFeatures()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#fetchPopupFeatures) method within the view element's click event listener to open the popup with features at the clicked location.
  * ```html
  * <!-- Set popup-disabled and popup-component-enabled attributes -->
  * <arcgis-map id="06ca49d0ddb447e7817cfc343ca30df9" popup-disabled>
@@ -71,7 +71,12 @@ import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.j
  * const popupComponent = document.querySelector("arcgis-popup");
  * // Listen for clicks on the view and populate the popup with features at that location.
  * viewElement.addEventListener("arcgisViewClick", async (event) => {
- *   await popupComponent.fetchFeatures(event.detail);
+ *  const generator = await viewElement.fetchPopupFeatures(event.detail.screenPoint, {
+ *    pointerType: event.detail.pointerType,
+ *  });
+ *
+ *  const features = await Array.fromAsync(generator);
+ *  popupComponent.features = features;
  * });
  * // Open the popup when the features property changes.
  * reactiveUtils.watch(
@@ -426,7 +431,7 @@ export abstract class ArcgisPopup extends LitElement {
   accessor label: string | undefined;
   /**
    * Point used to position the popup. This is automatically set when viewing the
-   * popup by selecting a feature or when calling the [fetchFeatures()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#fetchFeatures) method. If using the Popup to display content not related
+   * popup by selecting a feature. If using the Popup to display content not related
    * to features in the map, such as the results from a task, then you must set this
    * property before [open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#open) the popup.
    *
@@ -505,6 +510,8 @@ export abstract class ArcgisPopup extends LitElement {
    * no pending promises, the value is `null`. When the pending promises are
    * resolved they are removed from this array and the features they return
    * are pushed into the [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) array.
+   *
+   * @deprecated since 5.1.
    */
   accessor promises: Array<Promise<Array<Graphic>>>;
   /**
@@ -570,25 +577,11 @@ export abstract class ArcgisPopup extends LitElement {
   /**
    * Use this method to return feature(s) at a given screen location. These features are fetched from all of the [LayerViews](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/) in the [view](https://developers.arcgis.com/javascript/latest/references/core/views/View/). In order to use this, a layer must already have an associated [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) and have its [popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#popupEnabled). This method allows a developer to control how the input location is handled. For example, you may want to fetch features on a `click` event or on a `pointer-move` event. This method automatically sets the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) based on the input event's screen coordinates.
    *
+   * @deprecated since 5.1. Use the `fetchPopupFeatures` method on the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#fetchPopupFeatures), [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#fetchPopupFeatures), or [Link Chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#fetchPopupFeatures) component to fetch features based on a screen location.
    * @param screenPoint
    * @param options
+   * @deprecated
    * @see [open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#open)
-   * @example
-   * ```js
-   * const viewElement = document.querySelector("arcgis-map");
-   * // Get viewElement's click event
-   * reactiveUtils.on(()=>viewElement, "arcgisViewClick", async (event)=>{
-   *   // Call fetchFeatures on the component and pass in the click event detail
-   *   await component.fetchFeatures(event.detail);
-   * });
-   * // Watch for changes to the features property and open the component when features are available.
-   * reactiveUtils.watch(
-   *   () => component.features,
-   *   () => {
-   *     component.open = component.features ? true : false;
-   *   },
-   * );
-   * ```
    */
   fetchFeatures(screenPoint?: ScreenPoint, options?: FetchFeaturesOptions): Promise<void>;
   /**

package/dist/components/arcgis-scene/customElement.d.ts

@@ -900,6 +900,30 @@ export abstract class ArcgisScene extends LitElement {
    * @param hitTarget
    * @param options
    * @since 5.1
+   * @example
+   * ```js
+   * const viewElement = document.querySelector("arcgis-map");
+   * // Get viewElement's click event
+   * viewElement.addEventListener("arcgisViewClick", async (event) => {
+   *   const generator = await viewElement.fetchPopupFeatures(event.detail.screenPoint, {
+   *     pointerType: event.detail.pointerType
+   *   });
+   *   // Access the features returned from the generator
+   *   for await (const feature of generator) {
+   *     console.log(feature);
+   *   }
+   * });
+   * ```
+   * @example
+   * ```js
+   * // Wait for all the features to be available
+   * view.on("click", async (event) => {
+   *   const generator = view.fetchPopupFeatures(event.screenPoint, {
+   *     pointerType: event.pointerType
+   *   });
+   *
+   *   const features = await Array.fromAsync(generator);
+   * });
    */
   fetchPopupFeatures(hitTarget: ScreenPoint | ScreenRect, options?: FetchPopupFeaturesOptions): Promise<AsyncGenerator<Graphic>>;
   /**

package/dist/components/arcgis-slider-binary-color-size-legacy/customElement.d.ts

@@ -113,10 +113,10 @@ export abstract class ArcgisSliderBinaryColorSizeLegacy extends LitElement {
    *   numBins: 30,
    * });
    *
-   *  slider.histogramConfig = {
-   *    bins: histogramResult.bins
-   *  };
-   *       ```
+   * slider.histogramConfig = {
+   *   bins: histogramResult.bins
+   * };
+   * ```
    * @see [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)
    */
   accessor histogramConfig: HistogramConfig | null | undefined;
@@ -167,7 +167,7 @@ export abstract class ArcgisSliderBinaryColorSizeLegacy extends LitElement {
    *   }
    *   return value.toFixed(0);
    * };
-   *            ```
+   * ```
    */
   accessor inputFormatFunction: LabelFormatFunction | null | undefined;
   /**
@@ -212,7 +212,7 @@ export abstract class ArcgisSliderBinaryColorSizeLegacy extends LitElement {
    * slider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {
    *   return (type === "value") ? value.toFixed(0) : value.toString();
    * };
-   *           ```
+   * ```
    */
   accessor labelFormatFunction: LabelFormatFunction | null | undefined;
   /**
@@ -336,12 +336,12 @@ export abstract class ArcgisSliderBinaryColorSizeLegacy extends LitElement {
    *   min: 10,
    *   max: 25
    * };
-   *           ```
+   * ```
    * @example
    * ```js
    * // disables zooming on the slider
    * slider.zoomOptions = null;
-   *           ```
+   * ```
    * @example
    * ```js
    * // zooms the slider so thumbs can only be moved to positions above
@@ -349,7 +349,7 @@ export abstract class ArcgisSliderBinaryColorSizeLegacy extends LitElement {
    * slider.zoomOptions = {
    *   min: 10
    * };
-   *           ```
+   * ```
    * @example
    * ```js
    * // zooms the slider so thumbs can only be moved to positions below
@@ -357,7 +357,7 @@ export abstract class ArcgisSliderBinaryColorSizeLegacy extends LitElement {
    * slider.zoomOptions = {
    *   max: 25
    * };
-   *           ```
+   * ```
    */
   accessor zoomOptions: ZoomOptions | null | undefined;
   /** Permanently destroy the component. */

package/dist/components/arcgis-slider-classed-color-legacy/customElement.d.ts

@@ -128,10 +128,10 @@ export abstract class ArcgisSliderClassedColorLegacy extends LitElement {
    *   numBins: 30,
    * });
    *
-   *  slider.histogramConfig = {
-   *    bins: histogramResult.bins
-   *  };
-   *       ```
+   * slider.histogramConfig = {
+   *   bins: histogramResult.bins
+   * };
+   * ```
    * @see [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)
    */
   accessor histogramConfig: HistogramConfig | null | undefined;
@@ -182,7 +182,7 @@ export abstract class ArcgisSliderClassedColorLegacy extends LitElement {
    *   }
    *   return value.toFixed(0);
    * };
-   *            ```
+   * ```
    */
   accessor inputFormatFunction: LabelFormatFunction | null | undefined;
   /**
@@ -227,7 +227,7 @@ export abstract class ArcgisSliderClassedColorLegacy extends LitElement {
    * slider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {
    *   return (type === "value") ? value.toFixed(0) : value.toString();
    * };
-   *           ```
+   * ```
    */
   accessor labelFormatFunction: LabelFormatFunction | null | undefined;
   /**

package/dist/components/arcgis-slider-classed-size-legacy/customElement.d.ts

@@ -121,10 +121,10 @@ export abstract class ArcgisSliderClassedSizeLegacy extends LitElement {
    *   numBins: 30,
    * });
    *
-   *  slider.histogramConfig = {
-   *    bins: histogramResult.bins
-   *  };
-   *       ```
+   * slider.histogramConfig = {
+   *   bins: histogramResult.bins
+   * };
+   * ```
    * @see [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)
    */
   accessor histogramConfig: HistogramConfig | null | undefined;
@@ -175,7 +175,7 @@ export abstract class ArcgisSliderClassedSizeLegacy extends LitElement {
    *   }
    *   return value.toFixed(0);
    * };
-   *            ```
+   * ```
    */
   accessor inputFormatFunction: LabelFormatFunction | null | undefined;
   /**
@@ -220,7 +220,7 @@ export abstract class ArcgisSliderClassedSizeLegacy extends LitElement {
    * slider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {
    *   return (type === "value") ? value.toFixed(0) : value.toString();
    * };
-   *           ```
+   * ```
    */
   accessor labelFormatFunction: LabelFormatFunction | null | undefined;
   /**

package/dist/components/arcgis-slider-color-legacy/customElement.d.ts

@@ -127,10 +127,10 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    *   numBins: 30,
    * });
    *
-   *  slider.histogramConfig = {
-   *    bins: histogramResult.bins
-   *  };
-   *       ```
+   * slider.histogramConfig = {
+   *   bins: histogramResult.bins
+   * };
+   * ```
    * @see [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)
    */
   accessor histogramConfig: HistogramConfig | null | undefined;
@@ -181,7 +181,7 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    *   }
    *   return value.toFixed(0);
    * };
-   *            ```
+   * ```
    */
   accessor inputFormatFunction: LabelFormatFunction | null | undefined;
   /**
@@ -226,7 +226,7 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    * slider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {
    *   return (type === "value") ? value.toFixed(0) : value.toString();
    * };
-   *           ```
+   * ```
    */
   accessor labelFormatFunction: LabelFormatFunction | null | undefined;
   /**
@@ -332,12 +332,12 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    *   min: 10,
    *   max: 25
    * };
-   *           ```
+   * ```
    * @example
    * ```js
    * // disables zooming on the slider
    * slider.zoomOptions = null;
-   *           ```
+   * ```
    * @example
    * ```js
    * // zooms the slider so thumbs can only be moved to positions above
@@ -345,7 +345,7 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    * slider.zoomOptions = {
    *   min: 10
    * };
-   *           ```
+   * ```
    * @example
    * ```js
    * // zooms the slider so thumbs can only be moved to positions below
@@ -353,7 +353,7 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    * slider.zoomOptions = {
    *   max: 25
    * };
-   *           ```
+   * ```
    */
   accessor zoomOptions: ZoomOptions | null | undefined;
   /** Permanently destroy the component. */

package/dist/components/arcgis-slider-color-size-legacy/customElement.d.ts

@@ -135,10 +135,10 @@ export abstract class ArcgisSliderColorSizeLegacy extends LitElement {
    *   numBins: 30,
    * });
    *
-   *  slider.histogramConfig = {
-   *    bins: histogramResult.bins
-   *  };
-   *       ```
+   * slider.histogramConfig = {
+   *   bins: histogramResult.bins
+   * };
+   * ```
    * @see [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)
    */
   accessor histogramConfig: HistogramConfig | null | undefined;
@@ -189,7 +189,7 @@ export abstract class ArcgisSliderColorSizeLegacy extends LitElement {
    *   }
    *   return value.toFixed(0);
    * };
-   *            ```
+   * ```
    */
   accessor inputFormatFunction: LabelFormatFunction | null | undefined;
   /**
@@ -234,7 +234,7 @@ export abstract class ArcgisSliderColorSizeLegacy extends LitElement {
    * slider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {
    *   return (type === "value") ? value.toFixed(0) : value.toString();
    * };
-   *           ```
+   * ```
    */
   accessor labelFormatFunction: LabelFormatFunction | null | undefined;
   /**
@@ -375,12 +375,12 @@ export abstract class ArcgisSliderColorSizeLegacy extends LitElement {
    *   min: 10,
    *   max: 25
    * };
-   *           ```
+   * ```
    * @example
    * ```js
    * // disables zooming on the slider
    * slider.zoomOptions = null;
-   *           ```
+   * ```
    * @example
    * ```js
    * // zooms the slider so thumbs can only be moved to positions above
@@ -388,7 +388,7 @@ export abstract class ArcgisSliderColorSizeLegacy extends LitElement {
    * slider.zoomOptions = {
    *   min: 10
    * };
-   *           ```
+   * ```
    * @example
    * ```js
    * // zooms the slider so thumbs can only be moved to positions below
@@ -396,7 +396,7 @@ export abstract class ArcgisSliderColorSizeLegacy extends LitElement {
    * slider.zoomOptions = {
    *   max: 25
    * };
-   *           ```
+   * ```
    */
   accessor zoomOptions: ZoomOptions | null | undefined;
   /** Permanently destroy the component. */

package/dist/components/arcgis-slider-opacity-legacy/customElement.d.ts

@@ -115,10 +115,10 @@ export abstract class ArcgisSliderOpacityLegacy extends LitElement {
    *   numBins: 30,
    * });
    *
-   *  slider.histogramConfig = {
-   *    bins: histogramResult.bins
-   *  };
-   *       ```
+   * slider.histogramConfig = {
+   *   bins: histogramResult.bins
+   * };
+   * ```
    * @see [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)
    */
   accessor histogramConfig: HistogramConfig | null | undefined;
@@ -169,7 +169,7 @@ export abstract class ArcgisSliderOpacityLegacy extends LitElement {
    *   }
    *   return value.toFixed(0);
    * };
-   *            ```
+   * ```
    */
   accessor inputFormatFunction: LabelFormatFunction | null | undefined;
   /**
@@ -214,7 +214,7 @@ export abstract class ArcgisSliderOpacityLegacy extends LitElement {
    * slider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {
    *   return (type === "value") ? value.toFixed(0) : value.toString();
    * };
-   *           ```
+   * ```
    */
   accessor labelFormatFunction: LabelFormatFunction | null | undefined;
   /**
@@ -322,12 +322,12 @@ export abstract class ArcgisSliderOpacityLegacy extends LitElement {
    *   min: 10,
    *   max: 25
    * };
-   *           ```
+   * ```
    * @example
    * ```js
    * // disables zooming on the slider
    * slider.zoomOptions = null;
-   *           ```
+   * ```
    * @example
    * ```js
    * // zooms the slider so thumbs can only be moved to positions above
@@ -335,7 +335,7 @@ export abstract class ArcgisSliderOpacityLegacy extends LitElement {
    * slider.zoomOptions = {
    *   min: 10
    * };
-   *           ```
+   * ```
    * @example
    * ```js
    * // zooms the slider so thumbs can only be moved to positions below
@@ -343,7 +343,7 @@ export abstract class ArcgisSliderOpacityLegacy extends LitElement {
    * slider.zoomOptions = {
    *   max: 25
    * };
-   *           ```
+   * ```
    */
   accessor zoomOptions: ZoomOptions | null | undefined;
   /** Permanently destroy the component. */

package/dist/components/arcgis-slider-scale-range/customElement.d.ts

@@ -234,7 +234,7 @@ export abstract class ArcgisSliderScaleRange extends LitElement {
    * Each region comes from the [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
    * See [SupportedRegion](https://developers.arcgis.com/javascript/latest/references/core/widgets/ScaleRangeSlider/types/#SupportedRegion) for the list of regions that are currently supported.
    */
-  accessor region: SupportedRegion | string | undefined;
+  accessor region: SupportedRegion | undefined;
   /**
    * Indicates whether the world scale value is shown in the scale menu.
    *