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

package/views/interactive/sketch/SketchTooltipVisibleElements.d.ts

@@ -1,85 +1,103 @@
 import type Accessor from "../../../core/Accessor.js";
 
+/** @since 5.0 */
 export interface SketchTooltipVisibleElementsProperties extends Partial<Pick<SketchTooltipVisibleElements, "area" | "coordinates" | "direction" | "distance" | "elevation" | "header" | "helpMessage" | "orientation" | "radius" | "rotation" | "scale" | "size" | "totalLength">> {}
 
-/** The elements that are displayed within the tooltip while sketching and editing. */
+/**
+ * The elements that are displayed within the tooltip while sketching and editing.
+ *
+ * @since 5.0
+ */
 export default abstract class SketchTooltipVisibleElements extends Accessor {
   /**
    * When set to `false`, the area is not shown in the tooltip.
    *
    * @default true
+   * @since 5.0
    */
   accessor area: boolean;
   /**
    * When set to `false`, the coordinate is not shown in the tooltip.
    *
    * @default true
+   * @since 5.0
    */
   accessor coordinates: boolean;
   /**
    * When set to `false`, the direction (or deflection angle) is not shown in the tooltip.
    *
    * @default true
+   * @since 5.0
    */
   accessor direction: boolean;
   /**
    * When set to `false`, the distance is not shown in the tooltip.
    *
    * @default true
+   * @since 5.0
    */
   accessor distance: boolean;
   /**
    * When set to `false`, the elevation is not shown in the tooltip.
    *
    * @default true
+   * @since 5.0
    */
   accessor elevation: boolean;
   /**
    * When set to `false`, the header at the top of the tooltip is not shown, when in input mode.
    *
    * @default true
+   * @since 5.0
    */
   accessor header: boolean;
   /**
    * When set to `false`, the help message at the bottom of the tooltip is not shown.
    *
    * @default false
+   * @since 5.0
    */
   accessor helpMessage: boolean;
   /**
    * When set to `false`, the orientation is not shown in the tooltip.
    *
    * @default true
+   * @since 5.0
    */
   accessor orientation: boolean;
   /**
    * When set to `false`, the radius is not shown in the tooltip.
    *
    * @default true
+   * @since 5.0
    */
   accessor radius: boolean;
   /**
    * When set to `false`, the rotation is not shown in the tooltip.
    *
    * @default true
+   * @since 5.0
    */
   accessor rotation: boolean;
   /**
    * When set to `false`, the scale is not shown in the tooltip.
    *
    * @default true
+   * @since 5.0
    */
   accessor scale: boolean;
   /**
    * When set to `false`, the size is not shown in the tooltip.
    *
    * @default true
+   * @since 5.0
    */
   accessor size: boolean;
   /**
    * When set to `false`, the total length is not shown in the tooltip.
    *
    * @default true
+   * @since 5.0
    */
   accessor totalLength: boolean;
 }

package/views/interactive/sketch/Units.d.ts

@@ -1,11 +1,13 @@
 import type Accessor from "../../../core/Accessor.js";
 import type { SystemOrAreaUnit, SystemOrLengthUnit } from "../../../core/units.js";
 
+/** @since 5.0 */
 export interface UnitsProperties extends Partial<Pick<Units, "area" | "length" | "verticalLength">> {}
 
 /**
  * Units used for displaying or interpreting values in the UI.
  *
+ * @since 5.0
  * @beta
  */
 export default abstract class Units extends Accessor {
@@ -13,6 +15,7 @@ export default abstract class Units extends Accessor {
    * Area units.
    *
    * @default null
+   * @since 5.0
    * @beta
    */
   accessor area: SystemOrAreaUnit | null | undefined;
@@ -20,6 +23,7 @@ export default abstract class Units extends Accessor {
    * Length units.
    *
    * @default null
+   * @since 5.0
    * @beta
    */
   accessor length: SystemOrLengthUnit | null | undefined;
@@ -27,6 +31,7 @@ export default abstract class Units extends Accessor {
    * Vertical length units.
    *
    * @default null
+   * @since 5.0
    * @beta
    */
   accessor verticalLength: SystemOrLengthUnit | null | undefined;

package/views/interactive/tooltip/types.d.ts

@@ -1,4 +1,6 @@
 
+/** @since 5.0 */
 export type TooltipMode = "feedback" | "input";
 
+/** @since 5.0 */
 export type TooltipDirectionMode = "relative" | "absolute";

package/views/layers/HighlightLayerViewMixin.d.ts

@@ -1,7 +1,37 @@
 import type Graphic from "../../Graphic.js";
+import type HighlightOptions from "../support/HighlightOptions.js";
 import type { ResourceHandle } from "../../core/Handles.js";
+import type { HighlightOptionsProperties } from "../support/HighlightOptions.js";
 
-export interface HighlightLayerViewMixinProperties {}
+export interface HighlightLayerViewMixinProperties {
+  /**
+   * Options for configuring the highlight. Use the [highlight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-HighlightLayerViewMixin.html#highlight) method on the layer view
+   * to highlight a feature.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > The `highlightOptions` on layer views are only supported in [2D MapViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). To
+   * > configure highlights for a [3D SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), use
+   * > [SceneView#highlights](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlights) instead.
+   *
+   * @deprecated since version 4.34. Use the [View#highlights](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#highlights) property instead.
+   * @since 4.26
+   * @see [highlight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-HighlightLayerViewMixin.html#highlight)
+   * @see [Sample: Highlight SceneLayer](https://developers.arcgis.com/javascript/latest/sample-code/highlight-scenelayer/)
+   * @example
+   * // Features in the layerview will be highlighted with bright
+   * // yellow colors in the map.
+   * const layerView = await view.whenLayerView(layer);
+   * layerView.highlightOptions = {
+   *   color: [255, 255, 0, 1],
+   *   haloOpacity: 0.9,
+   *   fillOpacity: 0.2
+   * };
+   */
+  highlightOptions?: HighlightOptionsProperties | null;
+}
 
 /**
  * Mixin for highlight method on layer views.
@@ -10,6 +40,34 @@ export interface HighlightLayerViewMixinProperties {}
  */
 export abstract class HighlightLayerViewMixin {
   constructor(...args: any[]);
+  /**
+   * Options for configuring the highlight. Use the [highlight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-HighlightLayerViewMixin.html#highlight) method on the layer view
+   * to highlight a feature.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > The `highlightOptions` on layer views are only supported in [2D MapViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). To
+   * > configure highlights for a [3D SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), use
+   * > [SceneView#highlights](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlights) instead.
+   *
+   * @deprecated since version 4.34. Use the [View#highlights](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#highlights) property instead.
+   * @since 4.26
+   * @see [highlight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-HighlightLayerViewMixin.html#highlight)
+   * @see [Sample: Highlight SceneLayer](https://developers.arcgis.com/javascript/latest/sample-code/highlight-scenelayer/)
+   * @example
+   * // Features in the layerview will be highlighted with bright
+   * // yellow colors in the map.
+   * const layerView = await view.whenLayerView(layer);
+   * layerView.highlightOptions = {
+   *   color: [255, 255, 0, 1],
+   *   haloOpacity: 0.9,
+   *   fillOpacity: 0.2
+   * };
+   */
+  get highlightOptions(): HighlightOptions | null | undefined;
+  set highlightOptions(value: HighlightOptionsProperties | null | undefined);
   /**
    * Highlights the given feature(s) in a layer view using the named [HighlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html)
    * from the view's [View#highlights](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#highlights) collection. If no `name` is provided, the

package/views/layers/HighlightLayerViewMixin.js

@@ -2,4 +2,4 @@
 All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
 */
-import{__decorate as r}from"tslib";import{subclass as e}from"../../core/accessorSupport/decorators.js";const s=s=>{const o=s;let t=class extends o{};return t=r([e("esri.views.layers.HighlightLayerViewMixin")],t),t};export{s as HighlightLayerViewMixin};
+import{__decorate as t}from"tslib";import{subclass as i}from"../../core/accessorSupport/decorators.js";const s=s=>{const e=s;let r=class extends e{get highlightOptions(){}set highlightOptions(t){}};return r=t([i("esri.views.layers.HighlightLayerViewMixin")],r),r};export{s as HighlightLayerViewMixin};

package/views/layers/ImageryLayerViewMixin.d.ts

@@ -1,12 +1,68 @@
+import type HighlightOptions from "../support/HighlightOptions.js";
 import type { ResourceHandle } from "../../core/Handles.js";
-import type { PixelData } from "../../layers/support/types.js";
+import type { PixelData } from "../../layers/raster/types.js";
 import type { PixelHighlightTarget, HighlightTarget } from "../types.js";
 import type { LayerViewHighlightOptions } from "./types.js";
+import type { HighlightOptionsProperties } from "../support/HighlightOptions.js";
 
-export interface ImageryLayerViewMixinProperties {}
+/** @since 5.0 */
+export interface ImageryLayerViewMixinProperties {
+  /**
+   * Options for configuring the highlight. Use the [ImageryLayerView#highlight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#highlight) method on the layer view
+   * to highlight a feature.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > The `highlightOptions` on layer views are only supported in [2D MapViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+   *
+   * @deprecated since version 4.34. Use the [View#highlights](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#highlights) property instead.
+   * @since 4.26
+   * @see [ImageryLayerView#highlight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#highlight)
+   * @see [Sample: Highlight SceneLayer](https://developers.arcgis.com/javascript/latest/sample-code/highlight-scenelayer/)
+   * @example
+   * // Features in the layerview will be highlighted with bright
+   * // yellow colors in the map.
+   * const layerView = await view.whenLayerView(layer);
+   * layerView.highlightOptions = {
+   *   color: [255, 255, 0, 1],
+   *   haloOpacity: 0.9,
+   *   fillOpacity: 0.2
+   * };
+   */
+  highlightOptions?: HighlightOptionsProperties | null;
+}
 
+/** @since 5.0 */
 export abstract class ImageryLayerViewMixin {
   constructor(...args: any[]);
+  /**
+   * Options for configuring the highlight. Use the [ImageryLayerView#highlight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#highlight) method on the layer view
+   * to highlight a feature.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > The `highlightOptions` on layer views are only supported in [2D MapViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+   *
+   * @deprecated since version 4.34. Use the [View#highlights](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#highlights) property instead.
+   * @since 4.26
+   * @see [ImageryLayerView#highlight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#highlight)
+   * @see [Sample: Highlight SceneLayer](https://developers.arcgis.com/javascript/latest/sample-code/highlight-scenelayer/)
+   * @example
+   * // Features in the layerview will be highlighted with bright
+   * // yellow colors in the map.
+   * const layerView = await view.whenLayerView(layer);
+   * layerView.highlightOptions = {
+   *   color: [255, 255, 0, 1],
+   *   haloOpacity: 0.9,
+   *   fillOpacity: 0.2
+   * };
+   */
+  get highlightOptions(): HighlightOptions | null | undefined;
+  set highlightOptions(value: HighlightOptionsProperties | null | undefined);
   /**
    * An object that provides the user access to
    * [PixelBlock#pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) and their values in the layer.
@@ -20,6 +76,7 @@ export abstract class ImageryLayerViewMixin {
    * >
    * > The `pixelData` is only supported in 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
    *
+   * @since 5.0
    * @see [Sample - Access pixel values in an ImageryLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-pixelvalues/)
    */
   get pixelData(): PixelData | null | undefined;
@@ -38,6 +95,7 @@ export abstract class ImageryLayerViewMixin {
    * @param options - An object with the following properties.
    * @returns Returns a highlight handler with a `remove()` method that
    * can be called to remove the highlight.
+   * @since 5.0
    * @see [View#highlights](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#highlights)
    * @see [Sample: Highlight SceneLayer](https://developers.arcgis.com/javascript/latest/sample-code/highlight-scenelayer/)
    * @example

package/views/layers/ImageryTileLayerViewMixin.d.ts

@@ -1,6 +1,8 @@
 
+/** @since 5.0 */
 export interface ImageryTileLayerViewMixinProperties {}
 
+/** @since 5.0 */
 export abstract class ImageryTileLayerViewMixin {
   constructor(...args: any[]);
   /**

package/views/layers/LayerView.d.ts

@@ -30,6 +30,12 @@ export default abstract class LayerView extends LayerViewSuperclass {
    * Indicates if the  [View2D#spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#spatialReference) of the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is supported by the layer view.
    * When `false` layer view will be [suspended](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#suspended).
    *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > This property is not supported for layer views of a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   *
    * @since 4.23
    * @see [suspended](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#suspended)
    */

package/views/layers/MediaLayerViewMixin.d.ts

@@ -5,6 +5,7 @@ import type { MediaElement } from "../../layers/media/types.js";
 import type { LayerViewHighlightOptions } from "./types.js";
 import type { MediaLayerInteractionOptionsProperties } from "../3d/layers/support/MediaLayerInteractionOptions.js";
 
+/** @since 5.0 */
 export interface MediaLayerViewMixinProperties extends Partial<Pick<MediaLayerViewMixin, "interactive" | "selectedElement">> {
   /**
    * Options for when the layer view is interactive.
@@ -19,6 +20,7 @@ export interface MediaLayerViewMixinProperties extends Partial<Pick<MediaLayerVi
   interactionOptions?: MediaLayerInteractionOptionsProperties;
 }
 
+/** @since 5.0 */
 export abstract class MediaLayerViewMixin {
   constructor(...args: any[]);
   /**
@@ -54,7 +56,11 @@ export abstract class MediaLayerViewMixin {
    * });
    */
   accessor interactive: boolean;
-  /** The layer being viewed. */
+  /**
+   * The layer being viewed.
+   *
+   * @since 5.0
+   */
   get layer(): MediaLayer;
   /**
    * The selected element. If [interactive](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-MediaLayerViewMixin.html#interactive) is `true`, any element in the
@@ -85,6 +91,7 @@ export abstract class MediaLayerViewMixin {
    * @param options - An object with the following properties.
    * @returns Returns a highlight handler with a `remove()` method that
    * can be called to remove the highlight.
+   * @since 5.0
    * @see [SceneView#highlights](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlights)
    * @see [Sample: Highlight SceneLayer](https://developers.arcgis.com/javascript/latest/sample-code/highlight-scenelayer/)
    * @example

package/views/layers/types.d.ts

@@ -1,8 +1,11 @@
 
+/** @since 5.0 */
 export interface LayerViewHighlightOptions {
   /**
    * The [HighlightOptions#name](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html#name) of the highlight options from the view's [View#highlights](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#highlights) collection.
    * If a `name` is provided, the corresponding highlight options will be applied to the feature(s). Otherwise, the `default` highlight options will be used.
+   *
+   * @since 5.0
    */
   readonly name?: string;
 }

package/views/navigation/types.d.ts

@@ -1,5 +1,10 @@
 
-/** Type of action to be performed when a drag gesture is performed. */
+/**
+ * Type of action to be performed when a drag gesture is performed.
+ *
+ * @since 5.0
+ */
 export type DragAction = "pan" | "rotate" | "zoom" | "none";
 
+/** @since 5.0 */
 export type MouseWheelAction = "zoom" | "none";

package/views/support/AttributionItem.d.ts

@@ -6,8 +6,16 @@
  * @see [View#attributionItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#attributionItems)
  */
 export default abstract class AttributionItem {
-  /** The score for this attribution item, which are displayed in descending order. */
+  /**
+   * The score for this attribution item, which are displayed in descending order.
+   *
+   * @since 5.0
+   */
   readonly score: number;
-  /** The text to display for this attribution item. */
+  /**
+   * The text to display for this attribution item.
+   *
+   * @since 5.0
+   */
   readonly text: string;
 }