@arcgis/core 5.0.0-next.51 → 5.0.0-next.53

package/layers/support/MediaElementBase.d.ts

@@ -1,4 +1,182 @@
-import "../../interfaces";
+import type { Loadable, LoadableMixinProperties } from "../../core/Loadable.js";
+import type { MultiOriginJSONMixin, MultiOriginJSONMixinProperties } from "../../core/MultiOriginJSONSupport.js";
+import type { NumericIdentifiableMixin, NumericIdentifiableMixinProperties } from "../../core/NumericIdentifiable.js";
+import type { Georeference } from "./media.js";
+import type { ControlPointsGeoreferenceProperties } from "./ControlPointsGeoreference.js";
+import type { ExtentAndRotationGeoreferenceProperties } from "./ExtentAndRotationGeoreference.js";
+import type { CornersGeoreferenceProperties } from "./CornersGeoreference.js";
 
-import MediaElementBase = __esri.MediaElementBase;
-export default MediaElementBase;
+export interface MediaElementBaseProperties extends LoadableMixinProperties, MultiOriginJSONMixinProperties, NumericIdentifiableMixinProperties, Partial<Pick<MediaElementBase, "opacity">> {
+  /**
+   * The geographic location of the image or video element to be placed on the map. The location can be set by either specifying
+   * extent and rotation of the element, the corner points of the bounding box, or by defining control points.
+   *
+   * @example
+   * // create a new ExtentAndRotationGeoreference
+   * const geoReference = new ExtentAndRotationGeoreference({
+   *   extent: new Extent({
+   *     spatialReference: {
+   *       wkid: 102100
+   *     },
+   *     xmin: -10047456.27662979,
+   *     ymin: 3486722.2723874687,
+   *     xmax: -10006982.870152846,
+   *     ymax: 3514468.91365495
+   *   })
+   * });
+   * const imageElement = new ImageElement({
+   *   image: "https://arcgis.github.io/arcgis-samples-javascript/sample-data/media-layer/new-orleans/neworleans1891.png",
+   *   georeference: geoReference
+   * });
+   * @example
+   * // create a canvas image element by setting its corner points of the bounding box
+   * const canvasElement = new ImageElement({
+   *   image: canvas,
+   *   georeference: new CornersGeoreference({
+   *     bottomRight: new Point({
+   *       x: -121.369,
+   *       y: 45.061
+   *     }),
+   *     bottomLeft: new Point({
+   *       x: -122.363,
+   *       y: 45.061
+   *     }),
+   *     topRight: new Point({
+   *       x: -121.369,
+   *       y: 45.678
+   *     }),
+   *     topLeft: new Point({
+   *       x: -122.363,
+   *       y: 45.678
+   *     })
+   *   })
+   * });
+   * @example
+   * // georeference an ImageElement, using ControlPointsGeoreference in the
+   * // North American Datum 1927 spatial reference
+   * const spatialReference = new SpatialReference({ wkid: 4267 });
+   * const swCorner = {
+   *     sourcePoint: { x: 80, y: 1732 },
+   *     mapPoint: new Point({ x: -107.875, y: 37.875, spatialReference })
+   * };
+   *
+   * const nwCorner = {
+   *     sourcePoint: { x: 75, y: 102 },
+   *     mapPoint: new Point({ x: -107.875, y: 38, spatialReference })
+   * };
+   *
+   * const neCorner = {
+   *    sourcePoint: { x: 1353, y: 99 },
+   *    mapPoint: new Point({ x: -107.75, y: 38, spatialReference })
+   * };
+   *
+   * const seCorner = {
+   *    sourcePoint: { x: 1361, y: 1721 },
+   *    mapPoint: new Point({ x: -107.75, y: 37.875, spatialReference })
+   * };
+   *
+   * const controlPoints = [swCorner, nwCorner, neCorner, seCorner];
+   *
+   * const georeference = new ControlPointsGeoreference({ controlPoints, width: 1991, height: 2500 });
+   *
+   * const imageElement = new ImageElement({
+   *     image: "https://jsapi.maps.arcgis.com/sharing/rest/content/items/1a3df04e7d734535a3a6a09dfec5a6b2/data",
+   *     georeference
+   * });
+   */
+  georeference?: ((CornersGeoreferenceProperties & { type: "corners" }) | (ExtentAndRotationGeoreferenceProperties & { type: "extent-and-rotation" }) | (ControlPointsGeoreferenceProperties & { type: "control-points" })) | null;
+}
+
+/**
+ * Mixin for ImageElement and VideoElement.
+ *
+ * @since 4.24
+ */
+export default abstract class MediaElementBase extends MediaElementBaseSuperclass {
+  /**
+   * The geographic location of the image or video element to be placed on the map. The location can be set by either specifying
+   * extent and rotation of the element, the corner points of the bounding box, or by defining control points.
+   *
+   * @example
+   * // create a new ExtentAndRotationGeoreference
+   * const geoReference = new ExtentAndRotationGeoreference({
+   *   extent: new Extent({
+   *     spatialReference: {
+   *       wkid: 102100
+   *     },
+   *     xmin: -10047456.27662979,
+   *     ymin: 3486722.2723874687,
+   *     xmax: -10006982.870152846,
+   *     ymax: 3514468.91365495
+   *   })
+   * });
+   * const imageElement = new ImageElement({
+   *   image: "https://arcgis.github.io/arcgis-samples-javascript/sample-data/media-layer/new-orleans/neworleans1891.png",
+   *   georeference: geoReference
+   * });
+   * @example
+   * // create a canvas image element by setting its corner points of the bounding box
+   * const canvasElement = new ImageElement({
+   *   image: canvas,
+   *   georeference: new CornersGeoreference({
+   *     bottomRight: new Point({
+   *       x: -121.369,
+   *       y: 45.061
+   *     }),
+   *     bottomLeft: new Point({
+   *       x: -122.363,
+   *       y: 45.061
+   *     }),
+   *     topRight: new Point({
+   *       x: -121.369,
+   *       y: 45.678
+   *     }),
+   *     topLeft: new Point({
+   *       x: -122.363,
+   *       y: 45.678
+   *     })
+   *   })
+   * });
+   * @example
+   * // georeference an ImageElement, using ControlPointsGeoreference in the
+   * // North American Datum 1927 spatial reference
+   * const spatialReference = new SpatialReference({ wkid: 4267 });
+   * const swCorner = {
+   *     sourcePoint: { x: 80, y: 1732 },
+   *     mapPoint: new Point({ x: -107.875, y: 37.875, spatialReference })
+   * };
+   *
+   * const nwCorner = {
+   *     sourcePoint: { x: 75, y: 102 },
+   *     mapPoint: new Point({ x: -107.875, y: 38, spatialReference })
+   * };
+   *
+   * const neCorner = {
+   *    sourcePoint: { x: 1353, y: 99 },
+   *    mapPoint: new Point({ x: -107.75, y: 38, spatialReference })
+   * };
+   *
+   * const seCorner = {
+   *    sourcePoint: { x: 1361, y: 1721 },
+   *    mapPoint: new Point({ x: -107.75, y: 37.875, spatialReference })
+   * };
+   *
+   * const controlPoints = [swCorner, nwCorner, neCorner, seCorner];
+   *
+   * const georeference = new ControlPointsGeoreference({ controlPoints, width: 1991, height: 2500 });
+   *
+   * const imageElement = new ImageElement({
+   *     image: "https://jsapi.maps.arcgis.com/sharing/rest/content/items/1a3df04e7d734535a3a6a09dfec5a6b2/data",
+   *     georeference
+   * });
+   */
+  get georeference(): Georeference | null | undefined;
+  set georeference(value: ((CornersGeoreferenceProperties & { type: "corners" }) | (ExtentAndRotationGeoreferenceProperties & { type: "extent-and-rotation" }) | (ControlPointsGeoreferenceProperties & { type: "control-points" })) | null | undefined);
+  /**
+   * The opacity of the element. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.
+   *
+   * @default 1
+   */
+  accessor opacity: number;
+}
+declare const MediaElementBaseSuperclass: typeof Loadable & typeof MultiOriginJSONMixin & typeof NumericIdentifiableMixin

package/layers/support/MosaicRule.d.ts

@@ -1,4 +1,217 @@
-import "../../interfaces";
+import type Point from "../../geometry/Point.js";
+import type DimensionalDefinition from "./DimensionalDefinition.js";
+import type RasterFunction from "./RasterFunction.js";
+import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
+import type { RasterFunctionProperties } from "./RasterFunction.js";
+import type { DimensionalDefinitionProperties } from "./DimensionalDefinition.js";
+import type { PointProperties } from "../../geometry/Point.js";
 
-import MosaicRule = __esri.MosaicRule;
-export default MosaicRule;
+export interface MosaicRuleProperties extends JSONSupportMixinProperties, Partial<Pick<MosaicRule, "ascending" | "lockRasterIds" | "method" | "objectIds" | "operation" | "sortField" | "sortValue" | "where">> {
+  /**
+   * The raster function applied on items before mosaicking.
+   *
+   * @since 4.27
+   */
+  itemRasterFunction?: RasterFunctionProperties | null;
+  /**
+   * The multidimensional definitions associated with the [ImageryLayer#mosaicRule](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#mosaicRule).
+   * Filters the layer by slicing data along defined variables and dimensions such as
+   * time, depth, altitude, etc. For example, you can display a particular variable such as temperature or salinity measured at a fixed dimension
+   * (e.g. time, depth). These data types are commonly used in atmospheric, oceanographic, and earth sciences.
+   * For example, it can be used to display sea temperature at -1000m below sea level for a specific week in the year.
+   *
+   * Multiple definitions are consolidated by server into one single where clause. The consolidation rule is:
+   * * For the same variableName but different dimensionName, it uses the `AND` operator to connect all dimension conditions for the same variable.
+   * * For different variableName, it uses the `OR` operator to connect any variable that meets the dimension conditions.
+   *
+   * @see [ImageryLayer - working with multidimensional raster data](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#multidimensionaldata)
+   * @see [Sample - Work with pixelFilter in an ImageryLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-pixelvalues/)
+   * @example
+   * // Display water salinity at a specific point in time.
+   * // In this case - Nov 30 2009
+   * let mosaicRule = new MosaicRule();
+   * mosaicRule.multidimensionalDefinition = [];
+   * mosaicRule.multidimensionalDefinition.push(new DimensionalDefinition({
+   *   variableName: "Salinity",
+   *   dimensionName: "StdTime",
+   *   values: [1259625600000]
+   * }));
+   *
+   * layer.mosaicRule = mosaicRule;
+   */
+  multidimensionalDefinition?: DimensionalDefinitionProperties[] | null;
+  /**
+   * Defines the viewpoint location on which the ordering is defined based on the
+   * distance from the viewpoint and the nadir of rasters.
+   *
+   * @example
+   * let mosaicRule = new MosaicRule();
+   * mosaicRule.method = "viewpoint";
+   * mosaicRule.viewpoint = inPoint;
+   * layer.mosaicRule = mosaicRule;
+   */
+  viewpoint?: PointProperties | null;
+}
+
+export type OperationType = "first" | "last" | "min" | "max" | "mean" | "blend" | "sum";
+
+export type MethodType = "none" | "center" | "nadir" | "viewpoint" | "attribute" | "lock-raster" | "northwest" | "seamline";
+
+/**
+ * Specifies the mosaic rule when defining how individual images should be mosaicked.
+ * It specifies selection, mosaic method, sort order, overlapping pixel resolution, etc.
+ * Mosaic rules are for mosaicking rasters in the mosaic dataset. A mosaic rule is used to define:
+ *
+ * * The selection of rasters that will participate in the mosaic (using where clause).
+ * * The mosaic method, e.g. how the selected rasters are ordered.
+ * * The mosaic operation, e.g. how overlapping pixels at the same location are resolved.
+ *
+ * @since 4.0
+ * @see [Sample - Work with pixelFilter in an ImageryLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-pixelvalues/)
+ * @see [Sample - ImageryLayer raster function](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-rasterfunction/)
+ * @see [Mosaicking rules for a mosaic dataset](https://pro.arcgis.com/en/pro-app/latest/help/data/imagery/mosaicking-rules-for-a-mosaic-dataset-pro-.htm)
+ * @example
+ * new MosaicRule({
+ *   ascending: true,
+ *   method: "center",
+ *   operation: "last"
+ * });
+ */
+export default class MosaicRule extends JSONSupport {
+  constructor(properties?: MosaicRuleProperties);
+  /**
+   * Indicates whether the sort should be ascending. This property applies to all mosaic
+   * [methods](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) where an ordering is defined except `seamline`.
+   *
+   * @default true
+   */
+  accessor ascending: boolean;
+  /**
+   * The raster function applied on items before mosaicking.
+   *
+   * @since 4.27
+   */
+  get itemRasterFunction(): RasterFunction | null | undefined;
+  set itemRasterFunction(value: RasterFunctionProperties | null | undefined);
+  /**
+   * An array of raster Ids. All the rasters with the given list of raster Ids are
+   * selected to participate in the mosaic. The rasters will be visible at all pixel
+   * sizes regardless of the minimum and maximum pixel size range of the locked rasters.
+   *
+   * @example
+   * let mosaicRule = new MosaicRule();
+   * mosaicRule.method = "lock-raster";
+   * mosaicRule.lockRasterIds = [32,454,14];
+   */
+  accessor lockRasterIds: number[] | null | undefined;
+  /**
+   * The mosaic method determines how the selected rasters are ordered.
+   * The mosaic method defines how the mosaicked image is created from these input rasters.
+   *
+   * Value | Description |
+   * ----- | ----------- |
+   * none | Orders rasters based on the order of [objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#objectIds) in the mosaic dataset attribute table.
+   * center | Enables rasters to be sorted based their ZOrder, then PixelSize, and then by a default order where rasters that have their centers closest to the view center are placed on top.
+   * nadir | Enables rasters to be sorted by the ZOrder, then PixelSize, and then by the distance between the nadir position and view center. This is similar to the Closest to Center method but uses the nadir point to a raster, which may be different than the center, especially for oblique imagery.
+   * viewpoint | Orders rasters based on the ZOrder, then PixelSize, and then by a user-defined location and nadir location for the rasters using the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#viewpoint).
+   * attribute | Enables raster ordering based on ZOrder, then PixelSize, and then by a defined metadata attribute and its difference from a base value.
+   * lock-raster | Enables a user to lock the display of single or multiple rasters based on the [lockRasterIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#lockRasterIds).
+   * northwest | Enables raster ordering by ZOrder, then PixelSize, and then by the shortest distance between the center of a raster to the northwest position.
+   * seamline| Cuts the raster using the predefined seamline shape for each raster, using optional feathering along the seams, and orders images based on the ZOrder and then the SOrder fields in the attribute table.
+   *
+   * @default "none"
+   * @example
+   * let mosaicRule = new MosaicRule();
+   * mosaicRule.method = "lock-raster";
+   */
+  accessor method: MethodType;
+  /**
+   * The multidimensional definitions associated with the [ImageryLayer#mosaicRule](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#mosaicRule).
+   * Filters the layer by slicing data along defined variables and dimensions such as
+   * time, depth, altitude, etc. For example, you can display a particular variable such as temperature or salinity measured at a fixed dimension
+   * (e.g. time, depth). These data types are commonly used in atmospheric, oceanographic, and earth sciences.
+   * For example, it can be used to display sea temperature at -1000m below sea level for a specific week in the year.
+   *
+   * Multiple definitions are consolidated by server into one single where clause. The consolidation rule is:
+   * * For the same variableName but different dimensionName, it uses the `AND` operator to connect all dimension conditions for the same variable.
+   * * For different variableName, it uses the `OR` operator to connect any variable that meets the dimension conditions.
+   *
+   * @see [ImageryLayer - working with multidimensional raster data](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#multidimensionaldata)
+   * @see [Sample - Work with pixelFilter in an ImageryLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-pixelvalues/)
+   * @example
+   * // Display water salinity at a specific point in time.
+   * // In this case - Nov 30 2009
+   * let mosaicRule = new MosaicRule();
+   * mosaicRule.multidimensionalDefinition = [];
+   * mosaicRule.multidimensionalDefinition.push(new DimensionalDefinition({
+   *   variableName: "Salinity",
+   *   dimensionName: "StdTime",
+   *   values: [1259625600000]
+   * }));
+   *
+   * layer.mosaicRule = mosaicRule;
+   */
+  get multidimensionalDefinition(): DimensionalDefinition[] | null | undefined;
+  set multidimensionalDefinition(value: DimensionalDefinitionProperties[] | null | undefined);
+  /** Defines a selection using a set of ObjectIDs. This property applies to all mosaic methods. */
+  accessor objectIds: number[] | null | undefined;
+  /**
+   * Defines the mosaic operation used to resolve overlapping pixels.
+   *
+   * **Possible Values**
+   *
+   * Value | Description |
+   * ----- | ----------- |
+   * first | The overlapping areas will contain the cells from the first raster dataset listed in the source.
+   * last | The overlapping areas will contain the cells from the last raster dataset listed in the source.
+   * min | The overlapping areas will contain the minimum cell values from all the overlapping cells.
+   * max | The overlapping areas will contain the maximum cell values from all the overlapping cells.
+   * mean | The overlapping areas will contain the mean cell values from all the overlapping cells.
+   * blend | The overlapping areas will be a blend of the cell values that overlap. This blend value relies on an algorithm that is weight based and dependent on the distance from the cells to the edge within the overlapping area.
+   * sum | The overlapping areas will contain the total sum of the cell values from all the overlapping cells.
+   *
+   * @default "first"
+   */
+  accessor operation: OperationType;
+  /**
+   * The name of the attribute field that is used with a constant sortValue to define the mosaicking
+   * order when the mosaic [method](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) is set to `attribute`. The ordering is defined
+   * by the absolute value of the difference between the specified sort field value and the sort base
+   * value. For example, if the sort field is `Month` and the sort value is `7 (July)`, then the ordering
+   * is defined by `ABS(Month -7)`.
+   */
+  accessor sortField: string | null | undefined;
+  /**
+   * A constant value defining a reference or base value for the sort field when the mosaic [method](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method)
+   * is set to `attribute`.
+   */
+  accessor sortValue: string | number;
+  /**
+   * Defines the viewpoint location on which the ordering is defined based on the
+   * distance from the viewpoint and the nadir of rasters.
+   *
+   * @example
+   * let mosaicRule = new MosaicRule();
+   * mosaicRule.method = "viewpoint";
+   * mosaicRule.viewpoint = inPoint;
+   * layer.mosaicRule = mosaicRule;
+   */
+  get viewpoint(): Point | null | undefined;
+  set viewpoint(value: PointProperties | null | undefined);
+  /**
+   * The where clause determines which rasters will participate in the mosaic.
+   * This property applies to all mosaic methods. This property will be overridden
+   * by the ImageryLayer's [ImageryLayer#definitionExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#definitionExpression)
+   * property if both properties are set.
+   */
+  accessor where: string | null | undefined;
+  /**
+   * Creates a clone of the MosaicRule object.
+   *
+   * @returns A clone of the object that invoked this method.
+   * @example
+   * // Creates a clone of the mosaic rule
+   * let mosaicRule = layer.mosaicRule.clone();
+   */
+  clone(): MosaicRule;
+}

package/layers/support/MultidimensionalSubset.d.ts

@@ -1,4 +1,89 @@
-import "../../interfaces";
+import type Extent from "../../geometry/Extent.js";
+import type Polygon from "../../geometry/Polygon.js";
+import type DimensionalDefinition from "./DimensionalDefinition.js";
+import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
+import type { PolygonProperties } from "../../geometry/Polygon.js";
+import type { ExtentProperties } from "../../geometry/Extent.js";
+import type { DimensionalDefinitionProperties } from "./DimensionalDefinition.js";
 
-import MultidimensionalSubset = __esri.MultidimensionalSubset;
-export default MultidimensionalSubset;
+export interface MultidimensionalSubsetProperties extends JSONSupportMixinProperties {
+  /**
+   * The spatial area of interest. The area of interest can only be set on an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html).
+   * Only the imagery within the area of interest will be available when set.
+   *
+   * > [!WARNING]
+   * >
+   * > **Note:**
+   * >
+   * > This property will not be honored on an [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html).
+   */
+  areaOfInterest?: (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }) | null;
+  /**
+   * The variable and dimension subset definitions to set the layer.
+   * Only the dimensional definitions defined here will be available on the layer.
+   */
+  subsetDefinitions?: DimensionalDefinitionProperties[] | null;
+}
+
+/**
+ * A subset of multidimensional raster data created by slicing the data along defined variables and dimensions.
+ * Only dimensional slices that meet the multidimensionalSubset requirements will be available on a multidimensional [ImageryLayer#multidimensionalSubset](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#multidimensionalSubset)
+ * or [ImageryTileLayer#multidimensionalSubset](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#multidimensionalSubset) when the `multiDimensionalSubset` property is set on the layer.
+ * For example, if you have an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) that contains 30 years of monthly precipitation data,
+ * and you only want to expose data for each January to see how precipitation has changed for that month, you can set the `multiDimensionalSubset` on the imagery layer.
+ *
+ * When the `multiDimensionalSubset` is defined on a layer, the [ImageryTileLayer#multidimensionalDefinition](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#multidimensionalDefinition)
+ * property of the [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#multidimensionaldata) or the [mosaicRule.multidimensionalDefinition](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#mosaicRule)
+ * of the [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#multidimensionaldata) must be within the defined `multidimensionalSubset`, otherwise nothing will be displayed on the map or available for analysis.
+ *
+ * @since 4.25
+ * @see [ImageryLayer - working with multidimensional raster data](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#multidimensionaldata)
+ * @see [ImageryTileLayer - working with multidimensional raster data](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#multidimensionaldata)
+ * @see [Sample - Multidimensional ImageryTileLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-multidimensional/)
+ */
+export default class MultidimensionalSubset extends JSONSupport {
+  constructor(properties?: MultidimensionalSubsetProperties);
+  /**
+   * The spatial area of interest. The area of interest can only be set on an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html).
+   * Only the imagery within the area of interest will be available when set.
+   *
+   * > [!WARNING]
+   * >
+   * > **Note:**
+   * >
+   * > This property will not be honored on an [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html).
+   */
+  get areaOfInterest(): Extent | Polygon | null | undefined;
+  set areaOfInterest(value: (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }) | null | undefined);
+  /** The aggregated dimension names and their extents or ranges computed from the [subsetDefinitions](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#subsetDefinitions). */
+  get dimensions(): SubsetDimension[];
+  /**
+   * The variable and dimension subset definitions to set the layer.
+   * Only the dimensional definitions defined here will be available on the layer.
+   */
+  get subsetDefinitions(): DimensionalDefinition[] | null | undefined;
+  set subsetDefinitions(value: DimensionalDefinitionProperties[] | null | undefined);
+  /** The aggregated variables list computed from the [subsetDefinitions](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#subsetDefinitions). */
+  get variables(): string[];
+  /**
+   * Creates a deep clone of the MultidimensionalSubset object.
+   *
+   * @returns A clone of the object that invoked this method.
+   */
+  clone(): MultidimensionalSubset;
+}
+
+/**
+ * Dimension name and its extent or range computed from the [subsetDefinitions](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#subsetDefinitions) and it is added to [dimensions](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#dimensions).
+ *
+ * @since 4.25
+ */
+export interface SubsetDimension {
+  /** The computed extent or ranges for the given dimension. */
+  extent: [
+      number,
+      number
+  ];
+  /** The dimension name. */
+  name: string;
+}

package/layers/support/NumberFieldFormat.d.ts

@@ -1,4 +1,106 @@
-import "../../interfaces";
+import type FieldFormat from "./FieldFormat.js";
 
-import NumberFieldFormat = __esri.NumberFieldFormat;
-export default NumberFieldFormat;
+export interface NumberFieldFormatProperties extends Partial<Pick<NumberFieldFormat, "maximumFractionDigits" | "minimumFractionDigits" | "useGrouping">> {}
+
+export type Style = "decimal";
+
+export type Grouping = "always" | "auto" | "never";
+
+/**
+ * The `NumberFieldFormat` class defines the formatting options for numeric field [types](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type). It is used in the [FieldConfiguration](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FieldConfiguration.html) class to define the display format of fields in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). It is also used in the [FieldInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html) class to define the display format of fields content in a [PopupTemplate#content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content).
+ *
+ * It applies to both the map's popup and any components/widgets that display the field.
+ *
+ * > [!WARNING]
+ * >
+ * > **Breaking change**
+ * > Numeric fields with decimal values are now automatically formatted with a limit on decimal places. For example, a value such as `1.234566788` would display with all available decimal places in the FeatureTable. Now, if no field configurations are defined, components automatically limit the display to two decimal places (`1.23`). To customize this behavior, define field configurations on your layer.
+ *
+ * ### Numeric Format Mappings
+ *
+ * The following tables show equivalencies between the legacy [FieldInfoFormat#places](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#places) and [FieldInfoFormat#digitSeparator](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#digitSeparator)  values and `NumberFieldFormat` properties. The examples shown are for the `en-US` locale. Note that the actual display will vary based on the locale of the user.
+ *
+ * ---
+ *
+ * #### Integer Field Types
+ *
+ * | **Legacy** | **NumberFieldFormat equivalency** | **Example (en-US)** |
+ * |---|---|---|
+ * | `digitSeparator = true` | `useGrouping = "always"` | 1,234,567  |
+ * | `digitSeparator = false` | `useGrouping = "never"` | 1234567 |
+ *
+ * ### Floating-point field types
+ * | **Legacy** | **NumberFieldFormat equivalency** | **Example: (en-US) Input** | **`NumberFieldFormat` output** |
+ * |---|---|---| --- |
+ * | `digitSeparator = true`, `places = 4` | `useGrouping = "always"`, `minimumFractionDigits = 4`, `maximumFractionDigits = 4` | 1,234.5678 | 1,234.5678 |
+ * | `digitSeparator = false`, `places = 4` | `useGrouping = "never"`, `minimumFractionDigits = 4`, `maximumFractionDigits = 4` | 1234.5678 | 1234.5678 |
+ * | `digitSeparator = false`, `places = 3` | `useGrouping = "never"`, `minimumFractionDigits = 2`, `maximumFractionDigits = 3` | 1234.323443 | 1234.323 |
+ * | `digitSeparator = true`, `places = 2` | `useGrouping = "auto"`, `minimumFractionDigits = 3`, `maximumFractionDigits = 3` | 1,234.323443 | 1,234.323 |
+ *
+ * ---
+ *
+ * @since 4.34
+ * @see [FieldConfiguration](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FieldConfiguration.html)
+ * @see [MDN documentation - DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat)
+ * @see [CLDR](https://cldr.unicode.org/)
+ * @example
+ * // Create a number field format
+ * const numberFieldFormat = new NumberFieldFormat ({
+ *   minimumFractionDigits: 1,
+ *   maximumFractionDigits: 3,
+ *   useGrouping: "never"
+ * });
+ *
+ * // Create a field configuration object containing the number format
+ * const numberFieldConfiguration = new FieldConfiguration ({
+ *   name: "voterCount", // name of the field in the service
+ *   fieldFormat: numberFieldFormat,
+ *   alias: "Voter Count"
+ * });
+ *
+ * // Create a feature layer and pass in the field configurations
+ * const featureLayer = new FeatureLayer ({
+ *   url: "url to feature layer",
+ *   outFields: ["*"],
+ *   fieldConfigurations: [numberFieldConfiguration] // add as many field configurations as needed
+ * });
+ */
+export default class NumberFieldFormat extends FieldFormat {
+  constructor(properties?: NumberFieldFormatProperties);
+  /**
+   * The maximum number of decimal places to display. If the number has more decimal places, it will be rounded to the nearest value with the specified number of decimal places. For example, if `maximumFractionDigits` is set to `2`, the number `3.456` will be displayed as `3.46`.
+   *
+   * @see [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat)
+   */
+  accessor maximumFractionDigits: number;
+  /**
+   * The minimum number of decimal places to display.
+   * If the number has fewer decimal places, it will be padded with trailing zeros.
+   * If the number has more decimal places, it will be rounded to the nearest value
+   * with the specified number of decimal places.
+   * For example, if `minimumFractionDigits` is set to `2`, the number `3.1` will be displayed as `3.10` and the number `3.456` will be displayed as `3.46`.
+   *
+   * @see [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat)
+   */
+  accessor minimumFractionDigits: number;
+  /**
+   * The formatting style to use. Support is currently limited to `decimal` style.
+   *
+   * @default decimal
+   * @see [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat)
+   */
+  get style(): Style;
+  /**
+   * The type of field format.
+   *
+   * @default "number"
+   */
+  get type(): "number";
+  /**
+   * Indicates whether to use grouping separators, such as thousands separators. For example, if `useGrouping` is set to `always`, the number `1234567` will be displayed as `1,234,567`. If set to `never`, the number will be displayed as `1234567`. `auto` is the default value and uses grouping separators based on the locale and the number of digits.
+   *
+   * @default auto
+   * @see [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat)
+   */
+  accessor useGrouping: Grouping;
+}