@arcgis/core 5.0.0-next.70 → 5.0.0-next.71

package/widgets/Print/types.d.ts

@@ -1,58 +1,122 @@
 import type { PrintLayoutTemplate, PrintFileFormat } from "../../rest/support/types.js";
 
+/** @since 5.0 */
 export interface TemplateInfo<ValueType> {
-  /** A list of supported layouts. */
+  /**
+   * A list of supported layouts.
+   *
+   * @since 5.0
+   */
   choiceList: ValueType[];
-  /** The default layout selected by the print service. */
+  /**
+   * The default layout selected by the print service.
+   *
+   * @since 5.0
+   */
   defaultValue: ValueType;
 }
 
+/** @since 5.0 */
 export interface TemplatesInfo {
-  /** Metadata about the available output formats. */
+  /**
+   * Metadata about the available output formats.
+   *
+   * @since 5.0
+   */
   format: TemplateInfo<PrintFileFormat>;
-  /** Metadata about the available page layouts. */
+  /**
+   * Metadata about the available page layouts.
+   *
+   * @since 5.0
+   */
   layout: TemplateInfo<PrintLayoutTemplate>;
 }
 
+/** @since 5.0 */
 export type Layout = string;
 
+/** @since 5.0 */
 export type Layouts = "all" | Layout[];
 
+/** @since 5.0 */
 export type Format = string;
 
+/** @since 5.0 */
 export type Formats = "all" | Format[];
 
+/** @since 5.0 */
 export type State = "ready" | "initializing" | "disabled" | "error";
 
+/** @since 5.0 */
 export type CustomTextElement = Record<string, string>;
 
+/** @since 5.0 */
 export type TemplateCustomTextElements = Record<string, CustomTextElement[]>;
 
+/** @since 5.0 */
 export interface MapSurroundInfo {}
 
+/** @since 5.0 */
 export interface LayoutTemplateInfo {
-  /** Defines the layout elements. */
+  /**
+   * Defines the layout elements.
+   *
+   * @since 5.0
+   */
   layoutOptions: LayoutTemplateInfoLayoutOptions;
-  /** The default page size(s) to be used. */
+  /**
+   * The default page size(s) to be used.
+   *
+   * @since 5.0
+   */
   pageSize: [
       number,
       number
   ];
-  /** The unit type of the page size(s) to be used. */
+  /**
+   * The unit type of the page size(s) to be used.
+   *
+   * @since 5.0
+   */
   pageUnits: string;
 }
 
+/** @since 5.0 */
 export interface LayoutTemplateInfoLayoutOptions {
-  /** The CustomTextElements in layoutOptions. */
+  /**
+   * The CustomTextElements in layoutOptions.
+   *
+   * @since 5.0
+   */
   customTextElements: CustomTextElement[];
-  /** Author text in layoutOptions. */
+  /**
+   * Author text in layoutOptions.
+   *
+   * @since 5.0
+   */
   hasAuthorText: boolean;
-  /** Copyright text in layoutOptions. */
+  /**
+   * Copyright text in layoutOptions.
+   *
+   * @since 5.0
+   */
   hasCopyrightText: boolean;
-  /** Legend in layoutOptions. */
+  /**
+   * Legend in layoutOptions.
+   *
+   * @since 5.0
+   */
   hasLegend: boolean;
-  /** Title text in layoutOptions. */
+  /**
+   * Title text in layoutOptions.
+   *
+   * @since 5.0
+   */
   hasTitleText: boolean;
-  /** The MapSurroundInfos in layoutOptions. */
+  /**
+   * The MapSurroundInfos in layoutOptions.
+   *
+   * @since 5.0
+   */
   mapSurroundInfos: MapSurroundInfo[];
 }

package/widgets/ScaleRangeSlider/types.d.ts

@@ -77,9 +77,13 @@
  * | `VE` | Venezuela|
  * | `VI` | U.S. Virgin Islands|
  * | `ZA` | South Africa|
+ *
+ * @since 5.0
  */
 export type SupportedRegion = LowerCaseRegion | UpperCaseRegion;
 
+/** @since 5.0 */
 export type LowerCaseRegion = "ae" | "ar" | "at" | "au" | "be" | "bg" | "bo" | "br" | "ca" | "ch" | "ci" | "cl" | "cn" | "co" | "cr" | "cz" | "de" | "dk" | "ee" | "eg" | "es" | "fi" | "fr" | "gb" | "gl" | "gr" | "gt" | "hk" | "id" | "ie" | "il" | "in" | "iq" | "is" | "it" | "jp" | "ke" | "kr" | "kw" | "li" | "lt" | "lu" | "lv" | "ma" | "mg" | "ml" | "mo" | "mx" | "my" | "ni" | "nl" | "no" | "nz" | "pe" | "pl" | "pr" | "pt" | "ro" | "ru" | "rw" | "se" | "sg" | "sk" | "sr" | "sv" | "th" | "tn" | "tw" | "us" | "ve" | "vi" | "za";
 
+/** @since 5.0 */
 export type UpperCaseRegion = Uppercase<LowerCaseRegion>;

package/widgets/ScaleRangeSlider.d.ts

@@ -43,7 +43,11 @@ export interface VisibleElements {
    * Default value is `true`.
    */
   preview?: boolean;
-  /** _Since 4.24_ Indicates whether the scale dropdown menus are visible. */
+  /**
+   * Indicates whether the scale dropdown menus are visible.
+   *
+   * @since 4.24
+   */
   scaleMenus?: boolean | VisibleElementsScaleMenus;
 }
 

package/widgets/ShadowCast/ShadowCastVisibleElements.d.ts

@@ -1,6 +1,9 @@
 import type Accessor from "../../core/Accessor.js";
 
-/** @deprecated since version 5.0. Use the [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html) or [Shadow Cast component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/) instead. For information on widget deprecation, read about [Esri's move to web components](https://developers.arcgis.com/javascript/latest/components-transition-plan/). */
+/**
+ * @deprecated since version 5.0. Use the [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html) or [Shadow Cast component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/) instead. For information on widget deprecation, read about [Esri's move to web components](https://developers.arcgis.com/javascript/latest/components-transition-plan/).
+ * @since 5.0
+ */
 export interface ShadowCastVisibleElementsProperties extends Partial<Pick<ShadowCastVisibleElements, "colorPicker" | "datePicker" | "thresholdContext" | "thresholdContextColor" | "thresholdContextTimeInterval" | "thresholdContextToggle" | "timeRangeSlider" | "timezone" | "tooltip" | "visualizationOptions">> {}
 
 /**
@@ -8,6 +11,7 @@ export interface ShadowCastVisibleElementsProperties extends Partial<Pick<Shadow
  * This provides the ability to turn individual elements of the widget's display on/off.
  *
  * @deprecated since version 5.0. Use the [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html) or [Shadow Cast component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/) instead. For information on widget deprecation, read about [Esri's move to web components](https://developers.arcgis.com/javascript/latest/components-transition-plan/).
+ * @since 5.0
  */
 export default abstract class ShadowCastVisibleElements extends Accessor {
   /**
@@ -15,12 +19,14 @@ export default abstract class ShadowCastVisibleElements extends Accessor {
    *   of the visualization modes.
    *
    * @default true
+   * @since 5.0
    */
   accessor colorPicker: boolean;
   /**
    * When set to `false`, the date picker is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor datePicker: boolean;
   /**
@@ -28,6 +34,7 @@ export default abstract class ShadowCastVisibleElements extends Accessor {
    *   visualization mode is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor thresholdContext: boolean;
   /**
@@ -35,6 +42,7 @@ export default abstract class ShadowCastVisibleElements extends Accessor {
    *   threshold visualization mode is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor thresholdContextColor: boolean;
   /**
@@ -42,6 +50,7 @@ export default abstract class ShadowCastVisibleElements extends Accessor {
    *   the threshold visualization mode is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor thresholdContextTimeInterval: boolean;
   /**
@@ -50,6 +59,7 @@ export default abstract class ShadowCastVisibleElements extends Accessor {
    *   set to `false` and the discrete shadows visualization is turned off.
    *
    * @default true
+   * @since 5.0
    */
   accessor thresholdContextToggle: boolean;
   /**
@@ -57,6 +67,7 @@ export default abstract class ShadowCastVisibleElements extends Accessor {
    *   analysis is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor timeRangeSlider: boolean;
   /**
@@ -64,6 +75,7 @@ export default abstract class ShadowCastVisibleElements extends Accessor {
    *   is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor timezone: boolean;
   /**
@@ -71,6 +83,7 @@ export default abstract class ShadowCastVisibleElements extends Accessor {
    *   displayed when hovering the view.
    *
    * @default true
+   * @since 5.0
    */
   accessor tooltip: boolean;
   /**
@@ -78,6 +91,7 @@ export default abstract class ShadowCastVisibleElements extends Accessor {
    *   are not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor visualizationOptions: boolean;
 }

package/widgets/ShadowCast/types.d.ts

@@ -1,6 +1,12 @@
 
-/** @deprecated since version 5.0. Use the [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html) or [Shadow Cast component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/) instead. For information on widget deprecation, read about [Esri's move to web components](https://developers.arcgis.com/javascript/latest/components-transition-plan/). */
+/**
+ * @deprecated since version 5.0. Use the [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html) or [Shadow Cast component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/) instead. For information on widget deprecation, read about [Esri's move to web components](https://developers.arcgis.com/javascript/latest/components-transition-plan/).
+ * @since 5.0
+ */
 export type ShadowVisualizationType = "threshold" | "duration" | "discrete";
 
-/** @deprecated since version 5.0. Use the [Shadow Cast component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/) or [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html) instead. For information on widget deprecation, read about [Esri's move to web components](https://developers.arcgis.com/javascript/latest/components-transition-plan/). */
+/**
+ * @deprecated since version 5.0. Use the [Shadow Cast component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/) or [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html) instead. For information on widget deprecation, read about [Esri's move to web components](https://developers.arcgis.com/javascript/latest/components-transition-plan/).
+ * @since 5.0
+ */
 export type DurationMode = "continuous" | "hourly";

package/widgets/Sketch/CreateToolVisibilityMap.d.ts

@@ -1,60 +1,75 @@
 import type Accessor from "../../core/Accessor.js";
 
+/** @since 5.0 */
 export interface CreateToolVisibilityMapProperties extends Partial<Pick<CreateToolVisibilityMap, "circle" | "freehandPolygon" | "freehandPolyline" | "multipoint" | "point" | "polygon" | "polyline" | "rectangle" | "text">> {}
 
+/** @since 5.0 */
 export default abstract class CreateToolVisibilityMap extends Accessor {
   /**
    * Indicates whether to display the circle sketch tool. Default is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor circle: boolean;
   /**
-   * _since 4.32_ Indicates whether to display the freehandPolygon tool. Default is `false`.
+   * Indicates whether to display the freehandPolygon tool. Default is `false`.
    *
    * @default false
+   * @since 4.32
+   * @since 5.0
    */
   accessor freehandPolygon: boolean;
   /**
-   * _since 4.32_ Indicates whether to display the freehandPolyline tool. Default is `false`.
+   * Indicates whether to display the freehandPolyline tool. Default is `false`.
    *
    * @default false
+   * @since 4.32
+   * @since 5.0
    */
   accessor freehandPolyline: boolean;
   /**
-   * _since 4.32_ Indicates whether to display the multipoint tool. Regardless of setting, multipoint is not available when working with a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Default is `false`.
+   * Indicates whether to display the multipoint tool. Regardless of setting, multipoint is not available when working with a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Default is `false`.
    *
    * @default true
+   * @since 4.32
+   * @since 5.0
    */
   accessor multipoint: boolean;
   /**
    * Indicates whether to display the point sketch tool. Default is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor point: boolean;
   /**
    * Indicates whether to display the polygon sketch tool. Default is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor polygon: boolean;
   /**
    * Indicates whether to display the polyline sketch tool. Default is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor polyline: boolean;
   /**
    * Indicates whether to display the rectangle sketch tool. Default is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor rectangle: boolean;
   /**
-   * _since 4.34_ Indicates whether to display the text sketch tool. Default is `false`.
+   * Indicates whether to display the text sketch tool. Default is `false`.
    *
    * @default false
+   * @since 4.34
+   * @since 5.0
    */
   accessor text: boolean;
 }

package/widgets/Sketch/SelectionToolVisibilityMap.d.ts

@@ -1,18 +1,22 @@
 import type Accessor from "../../core/Accessor.js";
 
+/** @since 5.0 */
 export interface SelectionToolVisibilityMapProperties extends Partial<Pick<SelectionToolVisibilityMap, "lasso-selection" | "rectangle-selection">> {}
 
+/** @since 5.0 */
 export default abstract class SelectionToolVisibilityMap extends Accessor {
   /**
    * Indicates whether to display the `"lasso-selection"` tool. Default is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor "lasso-selection": boolean;
   /**
    * Indicates whether to display the `"rectangle-selection"` tool. Default is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor "rectangle-selection": boolean;
 }

package/widgets/Sketch/VisibleElements.d.ts

@@ -6,8 +6,13 @@ import type { CreateToolVisibilityMapProperties } from "./CreateToolVisibilityMa
 import type { SelectionToolVisibilityMapProperties } from "./SelectionToolVisibilityMap.js";
 import type { SnappingControlsVisibleElementsProperties } from "../support/SnappingControls/VisibleElements.js";
 
+/** @since 5.0 */
 export interface VisibleElementsProperties extends Partial<Pick<VisibleElements, "deleteButton" | "duplicateButton" | "labelsToggle" | "selectionCountLabel" | "settingsMenu" | "snappingControls" | "tooltipsToggle" | "undoRedoMenu">> {
-  /** The available sketch tools within the widget. */
+  /**
+   * The available sketch tools within the widget.
+   *
+   * @since 5.0
+   */
   createTools?: CreateToolVisibilityMapProperties;
   /**
    * The available selection tools within the widget.
@@ -16,9 +21,15 @@ export interface VisibleElementsProperties extends Partial<Pick<VisibleElements,
    * > **Known Limitation**
    * >
    * > Rectangle and lasso selection is only supported when working with a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+   *
+   * @since 5.0
    */
   selectionTools?: SelectionToolVisibilityMapProperties;
-  /** The available [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) elements within the widget. */
+  /**
+   * The available [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) elements within the widget.
+   *
+   * @since 5.0
+   */
   snappingControlsElements?: SnappingControlsVisibleElementsProperties;
 }
 
@@ -26,6 +37,7 @@ export interface VisibleElementsProperties extends Partial<Pick<VisibleElements,
  * The visible elements that are displayed within the widget.
  * This provides the ability to turn individual elements of the widget's display on/off.
  *
+ * @since 5.0
  * @example
  * // This hides the lasso selection tools
  * sketch.visibleElements = {
@@ -48,31 +60,40 @@ export interface VisibleElementsProperties extends Partial<Pick<VisibleElements,
  * }
  */
 export default abstract class VisibleElements extends Accessor {
-  /** The available sketch tools within the widget. */
+  /**
+   * The available sketch tools within the widget.
+   *
+   * @since 5.0
+   */
   get createTools(): CreateToolVisibilityMap;
   set createTools(value: CreateToolVisibilityMapProperties);
   /**
    * Indicates whether to display the 'delete' button while a graphic is selected. Default is `true`. Do not hide this button without giving users on touch devices another way to delete selected geometries.
    *
    * @default true
+   * @since 5.0
    */
   accessor deleteButton: boolean;
   /**
    * Indicates whether to display the 'duplicate' button while a graphic is selected. Default is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor duplicateButton: boolean;
   /**
-   * _Since 4.29_. Indicates whether to display the sketch labels toggle. Default value is `true`.
+   * Indicates whether to display the sketch labels toggle. Default value is `true`.
    *
    * @default true
+   * @since 4.29
+   * @since 5.0
    */
   accessor labelsToggle: boolean;
   /**
    * Indicates whether to display a label indicating the length of the currently selected feature set.
    *
    * @default true
+   * @since 5.0
    */
   accessor selectionCountLabel: boolean;
   /**
@@ -82,6 +103,8 @@ export default abstract class VisibleElements extends Accessor {
    * > **Known Limitation**
    * >
    * > Rectangle and lasso selection is only supported when working with a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+   *
+   * @since 5.0
    */
   get selectionTools(): SelectionToolVisibilityMap;
   set selectionTools(value: SelectionToolVisibilityMapProperties);
@@ -89,27 +112,36 @@ export default abstract class VisibleElements extends Accessor {
    * Indicates whether to display the settings menu. Currently this menu contains snapping options. Default value is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor settingsMenu: boolean;
   /**
    * Indicates whether to display the `SnappingControls` widget. Default is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor snappingControls: boolean;
-  /** The available [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) elements within the widget. */
+  /**
+   * The available [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) elements within the widget.
+   *
+   * @since 5.0
+   */
   get snappingControlsElements(): SnappingControlsVisibleElements;
   set snappingControlsElements(value: SnappingControlsVisibleElementsProperties);
   /**
-   * _Since 4.29_. Indicates whether to display the tooltips toggle. Default value is `true`.
+   * Indicates whether to display the tooltips toggle. Default value is `true`.
    *
    * @default true
+   * @since 4.29
+   * @since 5.0
    */
   accessor tooltipsToggle: boolean;
   /**
    * Indicates whether to display the undo/redo menu within the widget. Default is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor undoRedoMenu: boolean;
 }