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

package/widgets/LayerList/LayerListVisibleElements.d.ts

@@ -1,5 +1,6 @@
 import type Accessor from "../../core/Accessor.js";
 
+/** @since 5.0 */
 export interface LayerListVisibleElementsProperties extends Partial<Pick<LayerListVisibleElements, "catalogLayerList" | "closeButton" | "collapseButton" | "errors" | "filter" | "flow" | "heading" | "statusIndicators" | "temporaryLayerIndicators">> {}
 
 /**
@@ -13,54 +14,63 @@ export default abstract class LayerListVisibleElements extends Accessor {
    * **Since 4.30** Indicates whether to display the [LayerList#catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogLayerList).
    *
    * @default true
+   * @since 5.0
    */
   accessor catalogLayerList: boolean;
   /**
    * **Since 4.29** Indicates whether to display a close button in the header.
    *
    * @default false
+   * @since 5.0
    */
   accessor closeButton: boolean;
   /**
    * **Since 4.29** Indicates whether to display a collapse button in the header.
    *
    * @default false
+   * @since 5.0
    */
   accessor collapseButton: boolean;
   /**
    * **Since 4.25** Indicates whether to display layers with load errors.
    *
    * @default false
+   * @since 5.0
    */
   accessor errors: boolean;
   /**
    * **Since 4.29** Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in [LayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minFilterItems), allowing users to filter layers by their title.
    *
    * @default false
+   * @since 5.0
    */
   accessor filter: boolean;
   /**
    * **Since 4.29** Determines whether the widget should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The widget will be displayed within its original flow component if set to `true`. The flow component will be omitted from the widget if set to `false`. To place the widget into an existing Calcite flow component, set this property to `false`.
    *
    * @default true
+   * @since 5.0
    */
   accessor flow: boolean;
   /**
    * **Since 4.29** Indicates whether to display the widget heading. The heading text is "Layer List". The heading level can be set with the [LayerList#headingLevel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#headingLevel).
    *
    * @default false
+   * @since 5.0
    */
   accessor heading: boolean;
   /**
    * Indicates whether the status indicators will be displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor statusIndicators: boolean;
   /**
    * **Since 4.29** Indicates whether temporary layer indicators will be displayed for layers with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#persistenceEnabled) set to `false`. A [temporary icon](https://developers.arcgis.com/calcite-design-system/icons/?icon=temporary&library=Calcite%20UI&query=temporary) will be displayed on the near side of the layer title.
    *
    * @default false
+   * @since 5.0
    */
   accessor temporaryLayerIndicators: boolean;
 }

package/widgets/LayerList/types.d.ts

@@ -2,6 +2,7 @@ import type ActionButton from "../../support/actions/ActionButton.js";
 import type ActionToggle from "../../support/actions/ActionToggle.js";
 import type ListItem from "./ListItem.js";
 
+/** @since 5.0 */
 export type VisibilityAppearance = "default" | "checkbox";
 
 /**
@@ -9,6 +10,7 @@ export type VisibilityAppearance = "default" | "checkbox";
  *
  * @param item - A list item
  *   created by the LayerList.
+ * @since 5.0
  */
 export type FilterPredicate = (item: ListItem) => boolean;
 
@@ -18,19 +20,25 @@ export type FilterPredicate = (item: ListItem) => boolean;
  * See the example snippets in the documentations for those properties for more details.
  *
  * @param event - An object containing a list item created by the LayerList.
+ * @since 5.0
  */
 export type ListItemModifier = (event: ListItemModifierEvent) => void;
 
+/** @since 5.0 */
 export interface ListItemModifierEvent {
   /**
    * A list item
    *   created by the LayerList. You can modify the properties of this item to customize
    *   the text, actions, panel content, and visibility of the list item. See the
    *   documentation for the [LayerList#listItemCreatedFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#listItemCreatedFunction) for more details.
+   *
+   * @since 5.0
    */
   item: ListItem;
 }
 
+/** @since 5.0 */
 export type Action = ActionButton | ActionToggle;
 
+/** @since 5.0 */
 export type State = "ready" | "loading" | "disabled";

package/widgets/Legend/styles/card/CardView.d.ts

@@ -1,11 +1,17 @@
 import type Widget from "../../../Widget.js";
 import type { WidgetProperties } from "../../../Widget.js";
 
+/** @since 5.0 */
 export interface CardViewProperties extends WidgetProperties, Partial<Pick<CardView, "layout">> {}
 
+/** @since 5.0 */
 export type CardLayout = "auto" | "stack" | "side-by-side";
 
-/** In wide views, the legend has a landscape orientation that allows users to scroll horizontally to view all legend elements. This style can be responsive, making it ideal for mobile web apps. In smaller views, the legend collapses to occupy less space. One element is shown at a time in a card-style layout, which the user can navigate horizontally. */
+/**
+ * In wide views, the legend has a landscape orientation that allows users to scroll horizontally to view all legend elements. This style can be responsive, making it ideal for mobile web apps. In smaller views, the legend collapses to occupy less space. One element is shown at a time in a card-style layout, which the user can navigate horizontally.
+ *
+ * @since 5.0
+ */
 export default abstract class CardView extends Widget {
   /**
    * You can specify one of the following layout options.
@@ -17,8 +23,13 @@ export default abstract class CardView extends Widget {
    * stack | The legend cards are stacked, which conserves space, but restricts the user to seeing only one card at a time.
    *
    * @default "stack"
+   * @since 5.0
    */
   accessor layout: CardLayout;
-  /** The type of style. For Card this value is always `card`. */
+  /**
+   * The type of style. For Card this value is always `card`.
+   *
+   * @since 5.0
+   */
   get type(): "card";
 }

package/widgets/Legend/styles/classic/ClassicView.d.ts

@@ -1,10 +1,19 @@
 import type Widget from "../../../Widget.js";
 import type { WidgetProperties } from "../../../Widget.js";
 
+/** @since 5.0 */
 export interface ClassicViewProperties extends WidgetProperties {}
 
-/** The legend has a portrait orientation. The user can scroll vertically when many elements are included in the legend's content. */
+/**
+ * The legend has a portrait orientation. The user can scroll vertically when many elements are included in the legend's content.
+ *
+ * @since 5.0
+ */
 export default abstract class ClassicView extends Widget {
-  /** The type of style. For Classic this value is always `classic`. */
+  /**
+   * The type of style. For Classic this value is always `classic`.
+   *
+   * @since 5.0
+   */
   get type(): "classic";
 }

package/widgets/Measurement/types.d.ts

@@ -1,6 +1,9 @@
 
+/** @since 5.0 */
 export type MeasurementComponentType2D = "area" | "distance";
 
+/** @since 5.0 */
 export type MeasurementComponentType3D = "area" | "direct-line";
 
+/** @since 5.0 */
 export type MeasurementComponentType = MeasurementComponentType2D | MeasurementComponentType3D;

package/widgets/OrientedImageryViewer/types.d.ts

@@ -1,8 +1,20 @@
 
-/** Represents the pixel location in image space, where (0, 0) corresponds to the center of the upper left pixel. */
+/**
+ * Represents the pixel location in image space, where (0, 0) corresponds to the center of the upper left pixel.
+ *
+ * @since 5.0
+ */
 export interface LocationInImageSpace {
-  /** The row the pixel location. */
+  /**
+   * The row the pixel location.
+   *
+   * @since 5.0
+   */
   x: number;
-  /** The column the pixel location. */
+  /**
+   * The column the pixel location.
+   *
+   * @since 5.0
+   */
   y: number;
 }

package/widgets/Popup/PopupVisibleElements.d.ts

@@ -1,5 +1,6 @@
 import type Accessor from "../../core/Accessor.js";
 
+/** @since 5.0 */
 export interface PopupVisibleElementsProperties extends Partial<Pick<PopupVisibleElements, "actionBar" | "closeButton" | "collapseButton" | "featureListLayerTitle" | "featureMenuHeading" | "featureNavigation" | "heading" | "spinner">> {}
 
 /**
@@ -7,24 +8,29 @@ export interface PopupVisibleElementsProperties extends Partial<Pick<PopupVisibl
  * This provides the ability to turn individual elements of the widget's display on/off.
  *
  * ![popup-visibleElements](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/popup/popup-visible-elements.png)
+ *
+ * @since 5.0
  */
 export default abstract class PopupVisibleElements extends Accessor {
   /**
    * **Since 4.29.** Indicates whether to display the action bar that holds the feature's [Popup#actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions).
    *
    * @default true
+   * @since 5.0
    */
   accessor actionBar: boolean;
   /**
    * Indicates whether to display a close button on the widget dialog.
    *
    * @default true
+   * @since 5.0
    */
   accessor closeButton: boolean;
   /**
    * **Since 4.29.** Indicates whether to display the collapse button on the widget dialog.
    *
    * @default true
+   * @since 5.0
    */
   accessor collapseButton: boolean;
   /**
@@ -33,30 +39,35 @@ export default abstract class PopupVisibleElements extends Accessor {
    * ![popup-visibleElements-featureListLayerTitle](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/popup/popup-listlayertitle-true2.png)
    *
    * @default true
+   * @since 5.0
    */
   accessor featureListLayerTitle: boolean;
   /**
    * **Since 4.32.** Indicates whether to display a heading and description on the widget feature menu list.
    *
    * @default true
+   * @since 5.0
    */
   accessor featureMenuHeading: boolean;
   /**
    * Indicates whether pagination for feature navigation will be displayed. This allows the user to scroll through various [selected features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features) using pagination arrows.
    *
    * @default true
+   * @since 5.0
    */
   accessor featureNavigation: boolean;
   /**
    * **Since 4.29.** Indicates whether to display the widget heading.
    *
    * @default true
+   * @since 5.0
    */
   accessor heading: boolean;
   /**
    * **Since 4.29.** Indicates whether to display the widget's loading spinner.
    *
    * @default true
+   * @since 5.0
    */
   accessor spinner: boolean;
 }

package/widgets/Popup/types.d.ts

@@ -6,33 +6,44 @@ import type ActionToggle from "../../support/actions/ActionToggle.js";
 import type { AbortOptions } from "../../core/promiseUtils.js";
 import type { ClickEvent } from "../../views/input/types.js";
 
+/** @since 5.0 */
 export type PopupAction = ActionButton | ActionToggle;
 
+/** @since 5.0 */
 export type PopupPositionResult = "top-left" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right";
 
+/** @since 5.0 */
 export type PopupPositionVariable = "auto" | "top-leading" | "top-trailing" | "bottom-leading" | "bottom-trailing";
 
+/** @since 5.0 */
 export type PopupPositionValue = PopupPositionVariable | PopupPositionResult;
 
+/** @since 5.0 */
 export type Alignment = PopupPositionValue | (() => PopupPositionValue);
 
+/** @since 5.0 */
 export type PopupDockPosition = PopupPositionValue | (() => PopupPositionValue);
 
+/** @since 5.0 */
 export interface ActionEvent {
   /**
    * The action clicked by the user. For a description
    * of this object and a specification of its properties, see the [Popup#actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions) property of this
    * class.
+   *
+   * @since 5.0
    */
   action: PopupAction;
 }
 
+/** @since 5.0 */
 export interface DockOptionsBreakpoint {
   /**
    * The maximum height of the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html)
    *                        at which the popup will be set to dockEnabled automatically.
    *
    * @default 544
+   * @since 5.0
    */
   height?: number;
   /**
@@ -40,21 +51,26 @@ export interface DockOptionsBreakpoint {
    *                        at which the popup will be set to dockEnabled automatically.
    *
    * @default 544
+   * @since 5.0
    */
   width?: number;
 }
 
+/** @since 5.0 */
 export interface DockOptions {
   /**
    * Defines the dimensions of the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html)
    *                        at which to dock the popup. Set to `false` to disable docking at a breakpoint.
    *
    * @default true
+   * @since 5.0
    */
   breakpoint?: DockOptionsBreakpoint | boolean;
   /**
    * If `true`, displays the dock button. If `false`, hides the dock
    *                         button from the popup.
+   *
+   * @since 5.0
    */
   buttonEnabled?: boolean;
   /**
@@ -77,25 +93,35 @@ export interface DockOptions {
    * > If viewing the popup in a mobile  UI, the default dock position is bottom 100%.
    *
    * @default auto
+   * @since 5.0
    */
   position?: PopupDockPosition;
 }
 
+/** @since 5.0 */
 export type InitialDisplayOptions = "list" | "feature";
 
+/** @since 5.0 */
 export interface PopupOpenOptions {
   /**
    * This property allows you to specify a collection of [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html)
    * to the action bar when the Features widget opens.
+   *
+   * @since 5.0
    */
   actions?: Collection<PopupAction>;
   /**
    * Indicates whether the widget displays its content. If `true`, only the header displays.
    *
    * @default false
+   * @since 5.0
    */
   collapsed?: boolean;
-  /** Sets the [Popup#content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) of the popup. */
+  /**
+   * Sets the [Popup#content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) of the popup.
+   *
+   * @since 5.0
+   */
   content?: any;
   /**
    * This property enables multiple features in a popup to display in a list rather than displaying the first selected feature. Setting this to `true`
@@ -103,46 +129,77 @@ export interface PopupOpenOptions {
    * This value will only be honored if [PopupViewModel#initialDisplayMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#initialDisplayMode) is set to `feature`.
    *
    * @default false
+   * @since 5.0
    */
   featureMenuOpen?: boolean;
-  /** Sets the title to display on the widget while viewing the feature menu. */
+  /**
+   * Sets the title to display on the widget while viewing the feature menu.
+   *
+   * @since 5.0
+   */
   featureMenuTitle?: string;
-  /** Sets the popup's [Popup#features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features), which populate the title and content of the popup based on each graphic's [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). */
+  /**
+   * Sets the popup's [Popup#features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features), which populate the title and content of the popup based on each graphic's [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).
+   *
+   * @since 5.0
+   */
   features?: Graphic[];
   /**
    * When `true`, indicates the the content of this feature should be fetched and displayed. If no [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) exists, a default template is created for the layer if
    * [Popup#defaultPopupTemplateEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#defaultPopupTemplateEnabled) = `true`. In order for this option to work, there must be a valid `view` and `location` set.
    *
    * @default false
+   * @since 5.0
    */
   fetchFeatures?: boolean;
-  /** Sets the popup's [Popup#location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location), which is the geometry used to position the popup. */
+  /**
+   * Sets the popup's [Popup#location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location), which is the geometry used to position the popup.
+   *
+   * @since 5.0
+   */
   location?: Point;
-  /** Sets pending [Popup#promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#promises) on the popup. The popup will display once the promises resolve. Each promise must resolve to an array of [Graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). */
+  /**
+   * Sets pending [Popup#promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#promises) on the popup. The popup will display once the promises resolve. Each promise must resolve to an array of [Graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html).
+   *
+   * @since 5.0
+   */
   promises?: Promise<any>[];
   /**
    * **Since:** 4.23 <br> When `true`, indicates that the focus should be on the popup after it has been opened.
    *
    * @default false
+   * @since 5.0
    */
   shouldFocus?: boolean;
-  /** Sets the [Popup#title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) of the popup. */
+  /**
+   * Sets the [Popup#title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) of the popup.
+   *
+   * @since 5.0
+   */
   title?: string;
   /**
    * When `true`, indicates the popup should update its [Popup#location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) for each paginated feature based on the [selectedFeature's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature) geometry.
    *
    * @default false
+   * @since 5.0
    */
   updateLocationEnabled?: boolean;
 }
 
+/** @since 5.0 */
 export type State = "disabled" | "ready";
 
-/** Optional properties to use with the [Features#fetchFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#fetchFeatures) and [Popup#fetchFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#fetchFeatures) methods. */
+/**
+ * Optional properties to use with the [Features#fetchFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#fetchFeatures) and [Popup#fetchFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#fetchFeatures) methods.
+ *
+ * @since 5.0
+ */
 export interface FetchFeaturesOptions extends AbortOptions {
   /**
    * The `click` event for either the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
    * The event can be supplied in order to adjust the query radius depending on the pointer type. For example, touch events query a larger radius.
+   *
+   * @since 5.0
    */
   event?: ClickEvent;
 }

package/widgets/Print/FileLink.d.ts

@@ -3,8 +3,13 @@ import type EsriError from "../../core/Error.js";
 import type IPortalItem from "../../portal/PortalItem.js";
 import type { PortalItemProperties } from "../../portal/PortalItem.js";
 
+/** @since 5.0 */
 export interface FileLinkProperties extends Partial<Pick<FileLink, "count" | "error" | "extension" | "formattedName" | "name" | "state" | "url">> {
-  /** The [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) of the template. */
+  /**
+   * The [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) of the template.
+   *
+   * @since 5.0
+   */
   portalItem?: PortalItemProperties | null;
 }
 
@@ -12,6 +17,7 @@ export interface FileLinkProperties extends Partial<Pick<FileLink, "count" | "er
  * Represents an exported map request from the result of the Print widget.
  * Successful exports will have a URL that links to the printout. Failed ones will have information on what went wrong.
  *
+ * @since 5.0
  * @example
  * const [Print, esriConfig] = await $arcgis.import([
  *   "@arcgis/core/widgets/Print.js",
@@ -44,32 +50,56 @@ export interface FileLinkProperties extends Partial<Pick<FileLink, "count" | "er
  * });
  */
 export default abstract class FileLink extends Accessor {
-  /** The location of the FileLink element in the array. */
+  /**
+   * The location of the FileLink element in the array.
+   *
+   * @since 5.0
+   */
   accessor count: number | null | undefined;
-  /** The [Error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html) from the Print widget, if any. */
+  /**
+   * The [Error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html) from the Print widget, if any.
+   *
+   * @since 5.0
+   */
   accessor error: EsriError | null | undefined;
-  /** The [file type](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#format) of the print-out. */
+  /**
+   * The [file type](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#format) of the print-out.
+   *
+   * @since 5.0
+   */
   accessor extension: string | null | undefined;
-  /** The name of the FileLink, formatted with name, extension and count. */
+  /**
+   * The name of the FileLink, formatted with name, extension and count.
+   *
+   * @since 5.0
+   */
   accessor formattedName: string | null | undefined;
   /**
    * The [TemplateOptions#fileName](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#fileName)
    * or [TemplateOptions#title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#title) of the print-out.
+   *
+   * @since 5.0
    */
   accessor name: string | null | undefined;
-  /** The [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) of the template. */
+  /**
+   * The [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) of the template.
+   *
+   * @since 5.0
+   */
   get portalItem(): IPortalItem | null | undefined;
   set portalItem(value: PortalItemProperties | null | undefined);
   /**
    * The state of the print-out. Either `"ready"` or `"pending"` or `"error"`.
    *
    * @default "pending"
+   * @since 5.0
    */
   accessor state: "ready" | "error" | "pending";
   /**
    * The [Print#printServiceUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#printServiceUrl) of the print-out.
    *
    * @default ""
+   * @since 5.0
    */
   accessor url: string;
 }