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

package/layers/GroupLayer.d.ts

@@ -1,4 +1,252 @@
-import "../interfaces";
+import type Layer from "./Layer.js";
+import type LayerBase from "./Layer.js";
+import type PortalItem from "../portal/PortalItem.js";
+import type { ReadonlyCollection } from "../core/Collection.js";
+import type { MultiOriginJSONMixin, MultiOriginJSONMixinProperties } from "../core/MultiOriginJSONSupport.js";
+import type { BlendLayer, BlendLayerProperties } from "./mixins/BlendLayer.js";
+import type { OperationalLayer, OperationalLayerProperties } from "./mixins/OperationalLayer.js";
+import type { PortalLayer, PortalLayerProperties } from "./mixins/PortalLayer.js";
+import type { ScaleRangeLayer, ScaleRangeLayerProperties } from "./mixins/ScaleRangeLayer.js";
+import type { SaveAsOptions, SaveOptions } from "./mixins/properties/ILayerWithSave.js";
+import type { LayersMixin, LayersMixinProperties } from "../support/LayersMixin.js";
+import type { TablesMixin, TablesMixinProperties } from "../support/TablesMixin.js";
+import type { LayerProperties as LayerBaseProperties } from "./Layer.js";
 
-import GroupLayer = __esri.GroupLayer;
-export default GroupLayer;
+export interface GroupLayerProperties extends LayerBaseProperties, MultiOriginJSONMixinProperties, LayersMixinProperties, TablesMixinProperties, PortalLayerProperties, OperationalLayerProperties, ScaleRangeLayerProperties, BlendLayerProperties, Partial<Pick<GroupLayer, "visibilityMode">> {
+  /**
+   * The maximum scale (most zoomed in) at which the layer is visible in the view.
+   * If the map is zoomed in beyond this scale, the layer will not be visible.
+   * A value of `0` means the layer does not have a maximum scale.
+   * The maxScale value should always be smaller than the [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#minScale) value,
+   * and greater than or equal to the service specification.
+   *
+   * @default 0
+   * @since 4.19
+   * @example
+   * // The layer will not be visible when the view is zoomed in beyond a scale of 1:1,000
+   * layer.maxScale = 1000;
+   * @example
+   * // The layer's visibility is not restricted to a maximum scale.
+   * layer.maxScale = 0;
+   * @example
+   * // The layer will not be visible when the view is zoomed in beyond a scale of 1:1,000
+   * layer.maxScale = 1000;
+   * @example
+   * // The layer's visibility is not restricted to a maximum scale.
+   * layer.maxScale = 0;
+   */
+  maxScale?: number;
+  /**
+   * The minimum scale (most zoomed out) at which the layer is visible in the view.
+   * If the map is zoomed out beyond this scale, the layer will not be visible.
+   * A value of `0` means the layer does not have a minimum scale.
+   * The minScale value should always be larger than the [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#maxScale) value,
+   * and lesser than or equal to the service specification.
+   *
+   * @default 0
+   * @since 4.19
+   * @example
+   * // The layer will not be visible when the view is zoomed out beyond a scale of 1:3,000,000
+   * layer.minScale = 3000000;
+   * @example
+   * // The layer's visibility is not restricted to a minimum scale.
+   * layer.minScale = 0;
+   * @example
+   * // The layer will not be visible when the view is zoomed out beyond a scale of 1:3,000,000
+   * layer.minScale = 3000000;
+   * @example
+   * // The layer's visibility is not restricted to a minimum scale.
+   * layer.minScale = 0;
+   */
+  minScale?: number;
+}
+
+/**
+ * GroupLayer provides the ability to organize several sublayers into one common layer. Suppose there are
+ * several [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) that all represent
+ * water features in different dimensions. For example, wells (points), streams (lines), and lakes (polygons).
+ * The GroupLayer provides the functionality to treat them as one layer called "Water Features" even though they
+ * are stored as separate feature layers. To accomplish this, create a new GroupLayer and use the [add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#add)
+ * method to add each of the water layers to the GroupLayer.
+ *
+ * The visibility of each layer is managed in the [listMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#listMode) and [visibilityMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#visibilityMode)
+ * properties.
+ *
+ * @since 4.0
+ * @see [Sample - GroupLayer with LayerList widget](https://developers.arcgis.com/javascript/latest/sample-code/widgets-layerlist-actions/)
+ * @see [GroupLayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-GroupLayerView.html)
+ * @see [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html)
+ * @see [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html)
+ * @see [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html)
+ */
+export default class GroupLayer extends GroupLayerSuperclass {
+  constructor(properties?: GroupLayerProperties);
+  /**
+   * A flattened collection of all [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) in the group layer.
+   * Nested group layers and their children layers are also part of this collection.
+   * Layers should not be added directly to this collection. They must only be added via the
+   * [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#layers) property.
+   *
+   * > [!CAUTION]
+   * >
+   * > To access a flattened collection of tables, use the [allTables](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#allTables) property instead.
+   *
+   * @since 4.24
+   * @example
+   * // Find a layer with title "US Counties"
+   * const foundLayer = groupLayer.allLayers.find((layer) => {
+   *  return layer.title === "US Counties";
+   * });
+   *
+   * // Listen for any layer being added or removed in the GroupLayer
+   * groupLayer.allLayers.on("change", (event) => {
+   *  console.log("Layer added: ", event.added);
+   *  console.log("Layer removed: ", event.removed);
+   *  console.log("Layer moved: ", event.moved);
+   * });
+   */
+  get allLayers(): ReadonlyCollection<Layer>;
+  /**
+   * A flattened collection of tables anywhere in the group layer's hierarchy. This will contain
+   * individual tables within [tables](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#tables), in addition to any children tables of
+   * [nested group layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#layers). In order for the table(s) to be recognized as such, the
+   * [feature layer's isTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#isTable) property must return `true`.
+   *
+   * > [!CAUTION]
+   * >
+   * > Currently, only [feature layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) tables are recognized.
+   * > To access a flattened collection of spatial layers, use the [allLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#allLayers) property instead.
+   *
+   * @since 4.24
+   * @example
+   * // A feature layer where isTable = true.
+   * const foundTable = groupLayer.allTables.find((table) => {
+   *   // Find a table with title "US Counties"
+   *   return table.title === "US Counties";
+   * });
+   */
+  get allTables(): ReadonlyCollection<Layer>;
+  /**
+   * The maximum scale (most zoomed in) at which the layer is visible in the view.
+   * If the map is zoomed in beyond this scale, the layer will not be visible.
+   * A value of `0` means the layer does not have a maximum scale.
+   * The maxScale value should always be smaller than the [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#minScale) value,
+   * and greater than or equal to the service specification.
+   *
+   * @default 0
+   * @since 4.19
+   * @example
+   * // The layer will not be visible when the view is zoomed in beyond a scale of 1:1,000
+   * layer.maxScale = 1000;
+   * @example
+   * // The layer's visibility is not restricted to a maximum scale.
+   * layer.maxScale = 0;
+   * @example
+   * // The layer will not be visible when the view is zoomed in beyond a scale of 1:1,000
+   * layer.maxScale = 1000;
+   * @example
+   * // The layer's visibility is not restricted to a maximum scale.
+   * layer.maxScale = 0;
+   */
+  accessor maxScale: number;
+  /**
+   * The minimum scale (most zoomed out) at which the layer is visible in the view.
+   * If the map is zoomed out beyond this scale, the layer will not be visible.
+   * A value of `0` means the layer does not have a minimum scale.
+   * The minScale value should always be larger than the [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#maxScale) value,
+   * and lesser than or equal to the service specification.
+   *
+   * @default 0
+   * @since 4.19
+   * @example
+   * // The layer will not be visible when the view is zoomed out beyond a scale of 1:3,000,000
+   * layer.minScale = 3000000;
+   * @example
+   * // The layer's visibility is not restricted to a minimum scale.
+   * layer.minScale = 0;
+   * @example
+   * // The layer will not be visible when the view is zoomed out beyond a scale of 1:3,000,000
+   * layer.minScale = 3000000;
+   * @example
+   * // The layer's visibility is not restricted to a minimum scale.
+   * layer.minScale = 0;
+   */
+  accessor minScale: number;
+  /**
+   * The layer type provides a convenient way to check the type of the layer
+   * without the need to import specific layer modules.
+   */
+  get type(): "group";
+  /**
+   * Indicates how to manage the visibility of the children layers. Possible values
+   * are described in the table below.
+   *
+   * Value | Description
+   * ------|------------
+   * independent | Each child layer manages its visibility independent from other layers.
+   * inherited | Each child layer's visibility matches the [GroupLayer's visibility](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#visible).
+   * exclusive | Only one child layer is visible at a time.
+   */
+  accessor visibilityMode: GroupLayerVisibilityMode;
+  /**
+   * Loads all the externally loadable resources associated with the group layer.
+   * For the group layer this will load all the layers.
+   *
+   * @returns Resolves when all the loadable resources have been loaded.
+   *   Rejects if at least one of the loadable resources failed to load.
+   * @since 4.9
+   * @see [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#load)
+   * @example
+   * // Load all resources but ignore if one or more of them failed to load
+   * groupLayer.loadAll()
+   *   .catch((error) => {
+   *     // Ignore any failed resources
+   *   })
+   *   .then(() => {
+   *     console.log("All loaded");
+   *   });
+   */
+  loadAll(): Promise<this>;
+  /**
+   * Saves the layer to its existing portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html)
+   * authenticated within the user's current session. If the layer is not saved to a
+   * [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html), then you should use [saveAs()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#saveAs).
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > Only layers supported by the [web map specification](https://developers.arcgis.com/web-map-specification/) can be saved to a group layer.
+   * > [Media layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html) can only have a single [ImageElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html)
+   * > as the [MediaLayer#source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#source).
+   *
+   * @param options - Various options for saving the layer.
+   * @returns When resolved, returns the portal item to which the layer is saved.
+   * @since 4.28
+   * @example const portalItem = await layer.save();
+   */
+  save(options?: SaveOptions): Promise<PortalItem>;
+  /**
+   * Saves the layer to a new portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > Only layers supported by the [web map specification](https://developers.arcgis.com/web-map-specification/) can be saved to a group layer.
+   * > [Media layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html) can only have a single [ImageElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html)
+   * > as the [MediaLayer#source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#source).
+   *
+   * @param portalItem - The portal item to which the layer will be saved.
+   * @param options - Various options for saving the layer.
+   * @returns When resolved, returns the portal item to which the layer is saved.
+   * @since 4.28
+   * @example
+   * const portalItem = new PortalItem();
+   * await layer.saveAs(portalItem);
+   */
+  saveAs(portalItem: PortalItem, options?: SaveAsOptions): Promise<PortalItem>;
+}
+declare const GroupLayerSuperclass: typeof LayerBase & typeof MultiOriginJSONMixin & typeof LayersMixin & typeof TablesMixin & typeof PortalLayer & typeof OperationalLayer & typeof ScaleRangeLayer & typeof BlendLayer
+
+export type GroupLayerVisibilityMode = "independent" | "exclusive" | "inherited";

package/layers/ImageryLayer.d.ts

@@ -1,4 +1,372 @@
-import "../interfaces";
+import type PopupTemplate from "../PopupTemplate.js";
+import type Layer from "./Layer.js";
+import type PortalItem from "../portal/PortalItem.js";
+import type ElevationInfo from "../symbols/support/ElevationInfo.js";
+import type { ClonableMixin, ClonableMixinProperties } from "../core/Clonable.js";
+import type { MultiOriginJSONMixin, MultiOriginJSONMixinProperties } from "../core/MultiOriginJSONSupport.js";
+import type { LayerEvents, LayerProperties } from "./Layer.js";
+import type { ArcGISImageService, ArcGISImageServiceProperties } from "./mixins/ArcGISImageService.js";
+import type { ArcGISService, ArcGISServiceProperties } from "./mixins/ArcGISService.js";
+import type { BlendLayer, BlendLayerProperties } from "./mixins/BlendLayer.js";
+import type { CustomParametersMixin, CustomParametersMixinProperties } from "./mixins/CustomParametersMixin.js";
+import type { OperationalLayer, OperationalLayerProperties } from "./mixins/OperationalLayer.js";
+import type { PortalLayer, PortalLayerProperties } from "./mixins/PortalLayer.js";
+import type { RasterJobHandlerMixin, RasterJobHandlerMixinProperties } from "./mixins/RasterJobHandlerMixin.js";
+import type { RasterPresetRendererMixin, RasterPresetRendererMixinProperties } from "./mixins/RasterPresetRendererMixin.js";
+import type { RefreshableLayerEvents, RefreshableLayer, RefreshableLayerProperties } from "./mixins/RefreshableLayer.js";
+import type { ScaleRangeLayer, ScaleRangeLayerProperties } from "./mixins/ScaleRangeLayer.js";
+import type { TemporalLayer, TemporalLayerProperties } from "./mixins/TemporalLayer.js";
+import type { SaveAsOptions, SaveOptions } from "./mixins/properties/ILayerWithSave.js";
+import type { PortalItemProperties } from "../portal/PortalItem.js";
+import type { CreatePopupTemplateOptions } from "../support/popupUtils.js";
+import type { ElevationInfoProperties } from "../symbols/support/ElevationInfo.js";
+import type { PopupTemplateProperties } from "../PopupTemplate.js";
 
-import ImageryLayer = __esri.ImageryLayer;
-export default ImageryLayer;
+export interface ImageryLayerProperties extends LayerProperties, ClonableMixinProperties, MultiOriginJSONMixinProperties, ArcGISServiceProperties, CustomParametersMixinProperties, RefreshableLayerProperties, RasterJobHandlerMixinProperties, ArcGISImageServiceProperties, RasterPresetRendererMixinProperties, PortalLayerProperties, OperationalLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, BlendLayerProperties, Partial<Pick<ImageryLayer, "legendEnabled" | "popupEnabled" | "screenSizePerspectiveEnabled">> {
+  /**
+   * Specifies how the imagery is placed on the vertical axis (z). This property may only be used
+   * in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [ElevationInfo sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-elevationinfo/)
+   * for an example of how this property may be used.
+   *
+   * > [!WARNING]
+   * >
+   * > The elevation info only affects [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) if the `renderer` is set to [FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html) and applies `on-the-ground` mode if it is null.
+   * > The `relative-to-scene` mode does not affect [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html).
+   * > [ElevationInfo#featureExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-ElevationInfo.html#featureExpressionInfo) is not supported when the elevation info is specified for this class.
+   * > If the elevation info is not specified, the effective elevation depends on the context and could vary per point.
+   *
+   * @since 4.34
+   */
+  elevationInfo?: ElevationInfoProperties | null;
+  /**
+   * The popup template for the layer. When set on the layer, the popupTemplate
+   * allows users to access attributes and display their values using text and/or charts
+   * in the view's popup when a pixel is clicked.
+   * See [this sample](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-popup/)
+   * for an example of how [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) interacts with an
+   * [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html).
+   *
+   * A default popup template is automatically used if no `popupTemplate` has been defined when
+   * [Popup#defaultPopupTemplateEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#defaultPopupTemplateEnabled)
+   * is set to `true`.
+   *
+   * @see [createPopupTemplate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#createPopupTemplate)
+   * @see [SceneView#popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#popup)
+   * @see [View2D#popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#popup)
+   * @example
+   * // displays the temperature stored in the clicked pixel
+   * layer.popupTemplate = {
+   *   title: "Sea Surface Temperature",
+   *   content: "{Raster.ServicePixelValue}° Celsius"
+   * }
+   */
+  popupTemplate?: PopupTemplateProperties | null;
+}
+
+export interface ImageryLayerEvents extends RefreshableLayerEvents, LayerEvents {}
+
+/**
+ * Represents a dynamic [image service resource](https://developers.arcgis.com/rest/services-reference/image-service.htm)
+ * as a layer. An ImageryLayer retrieves and displays data from dynamic image services.
+ * An image service supports accessing the mosaicked image, its catalog, and the individual
+ * rasters in the catalog. An image service supports dynamic access and tiled access. Dynamic access provides more functionalities,
+ * and tiled access provides faster and more scalable access to precooked tiles.
+ *
+ * [![layers-imagery](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/imagery/layers-imagery.png)](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-pixelvalues/)
+ *
+ * If the image service is requested from a different domain, a [CORS enabled server](https://developers.arcgis.com/javascript/latest/cors/) or a
+ * [proxy](https://developers.arcgis.com/javascript/latest/proxies/) is required.
+ *
+ * > [!WARNING]
+ * >
+ * > Esri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content.
+ * > For detailed guidelines on working with attribution, please visit the official [attribution in your app](https://developers.arcgis.com/terms/attribution/) documentation.
+ * > For information on terms of use, see the [Terms of Use FAQ](https://developers.arcgis.com/terms/faq/).
+ *
+ * <span id="rendering"></span>
+ * ### ImageryLayer rendering
+ *
+ * ImageryLayer can be rendered on the server or on the client. This section talks about different approaches you can take when rendering
+ * an ImageryLayer in your application.
+ *
+ * <details>
+ * <summary>Read More</summary>
+ *
+ * #### Applying rasterFunction
+ *
+ * Image service supports dynamic processing which can be applied through the layer's [rasterFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#rasterFunction) property.
+ * A raster function defines how the requested image should be processed or rendered. You can process images using raster functions
+ * published with the image service. You can also use well-known raster functions, such as the
+ * [hillshade function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm) for elevation data,
+ * the [stretch function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm) for multispectral
+ * data, and the [colormap function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm)
+ * for thematic data. When rasterFunction is applied to the layer, the network request is made to the server for the image to be processed.
+ *
+ * #### Applying renderer
+ *
+ * ImageryLayer supports various [renderers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#renderer). By default, an ImageryLayer uses server side rendering. ImageryLayer
+ * parses a renderer specified by a user and leverages a [rasterFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#rasterFunction) specified by the server or the user to achieve the
+ * expected rendering for the images. The server processes and renders the ImageryLayer and returns a ready-to-draw `jpg` or `png` image
+ * to the client.
+ *
+ * When an ImageryLayer is created with `lerc` [format](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#format), the client gets access to the raw data which
+ * can be used for client-side analysis and rendering. A default renderer that leverages available imagery information
+ * is applied to an ImageryLayer with `lerc` format if the [pixelFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter) function is not specified.
+ * The user can change this default renderer on the client-side by applying a [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#renderer) or [pixelFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter).
+ * The [pixelFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter) is a good alternative if the existing renderers do not meet your requirements. If both
+ * `renderer` and `pixelFilter` are applied to the layer then the `pixelFilter` will take priority and its logic will be applied.
+ *
+ * #### Applying pixelFilter
+ *
+ * The [pixelFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter) can be used to colorize raw image pixels when ImageryLayer's [format](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#format) is set to `lerc`.
+ * It is a function that processes the [ImageryLayerViewMixin#pixelData](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerViewMixin.html#pixelData).
+ * The `pixelData` object contains a [PixelBlock](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html) property that gives
+ * you access to all of the pixels in the raster on the client. Inside the `pixelFilter` you may loop through all the pixels
+ * and process them. This function is a useful alternative if the existing renderers do not meet your requirements, because it gives you
+ * control over how to color image pixels. If both a [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#renderer) and `pixelFilter` are applied to the layer then the
+ * `pixelFilter` will take priority and its logic will be applied.
+ *
+ * </details>
+ *
+ * <span id="multidimensionaldata"></span>
+ * ### Working with multidimensional raster data
+ * Multidimensional data is commonly used in the scientific community to store atmospheric, oceanographic, and earth science data. Temperature, humidity, wind speed, and direction
+ * are all examples of the data that can be stored as variables in a multidimensional array.
+ * As illustrated in the graphic below, multidimensional data can show sea temperature (variable) for a specific area at multiple time and depth dimensions.
+ * This information is stored as slices, where the service has a slice for each unique combination of dimension values and variable names.
+ *
+ * [![layers-imagery](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/imagery/multidimensional-data.png)](https://developers.arcgis.com/javascript/latest/sample-code/layers-hosted-imagerytilelayer/)
+ *
+ * <details>
+ * <summary>Read More</summary>
+ *
+ * ImageryLayer's multidimensional data information can be accessed through the layer's [multidimensionalInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#multidimensionalInfo) property. This
+ * information can then be used for analysis and visualization. For example, in the following snippet, the time dimension values associated with
+ * the `wind_magdir` variable are read from the layer's `multidimensionalInfo` property once the layer is loaded. Then time values are used to configure
+ * the [TimeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html) widget to animate the wind speed and direction data over time.
+ *
+ * ```js
+ * view.whenLayerView(layer).then(() => {
+ *   // get all time dimension values from the service, create an array of dates
+ *   const windEpochDates = layer.multidimensionalInfo.variables[0].dimensions[0].values;
+ *   const windDates = windEpochDates.map((item) => new Date(item));
+ *
+ *   // time slider widget initialization
+ *   // users can visualize daily wind information for all the time dimension available
+ *   const timeSlider = new TimeSlider({
+ *     mode: "instant",
+ *     view: view,
+ *     fullTimeExtent: {
+ *       start: new Date(windDates[0]), // Jan 1, 2011,
+ *       end: new Date(windDates[windDates.length - 1]) // Dec 31, 2011
+ *     },
+ *     // set the stops to match the dates coming from time dimension
+ *     stops: {
+ *       dates: windDates
+ *     }
+ *   });
+ * });
+ * ```
+ *
+ * To display the data based on a specified slice of a variable and dimensions, set the layer's [mosaicRule.multidimensionalDefinition](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#mosaicRule)
+ * property to an array of desired [dimensional definitions](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html). For example, the following snippet
+ * shows how to update the layer's `mosaicRule.multidimensionalDefinition` to display the data based on a given `StdZ` (depth) value in response to a slider thumb change event.
+ *
+ * ```js
+ * depthSlider.on(["thumb-change", "thumb-drag"], (delta) => updateRenderer("StdZ", value));
+ * const updateRenderer = promiseUtils.debounce(function (dimensionName, sliderData) {
+ *   // set the depth or StdZ dimension of the layer corresponding to the slider's thumb location
+ *   const multidimensionalDefinition = layer.mosaicRule.multidimensionalDefinition;
+ *   const depthDef = multidimensionalDefinition.find((def) => def.dimensionName === "StdZ");
+ *   if (dimensionName === "StdZ") {
+ *     if (depthDef.values[0] === sliderData.value) {
+ *       return;
+ *     }
+ *     depthDef.values[0] = sliderData.value;
+ *   }
+ *   layer.mosaicRule.multidimensionalDefinition = multidimensionalDefinition;
+ * });
+ * ```
+ *
+ * The [multidimensionalSubset](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#multidimensionalSubset) can be set on a layer to expose only a subset of multidimensional data that satisfies the requirements.
+ * For example, if you have one year of wind speed and direction data collected daily, but only want to expose a subset of the data for every day of October, then
+ * you can set the `multidimensionalSubset` property on the layer as shown in the code snippet below.
+ *
+ * ```js
+ * // Wind speed and direction info for every day of Oct will be available on the layer.
+ * // Users will not be able to access data that falls outside of Oct.
+ * // Only the data intersects the extent will be available to users.
+ * const multidimensionalSubset = new MultidimensionalSubset({
+ *   // extent covering california
+ *   areaOfInterest: new Extent({
+ *     xmax: -12195369.680716056,
+ *     xmin: -14166833.514246799,
+ *     ymax: 5336486.804891889,
+ *     ymin: 3047044.933694898,
+ *     spatialReference: {
+ *       wkid: 102100
+ *     }
+ *   }),
+ *   subsetDefinitions: [
+ *     {
+ *       variableName: "Vector-MagDir",
+ *       dimensionName: "StdTime",
+ *       values: [1412121600000, 1414713600000], // 10/1/14 - 10/31/14
+ *       isSlice: false
+ *     }
+ *   ]
+ * });
+ * layer.multidimensionalSubset = multidimensionalSubset;
+ * ```
+ *
+ * The following image illustrates when the `multidimensionalDefinition` and `multidimensionalSubset` properties are both set on the layer. Slices with the
+ * purple borders are slices included in the layer's `multidimensionalSubset`. The slice with the red border is the `multidimensionalDefinition` of the layer and
+ * what is visible on the map. The layer's `multidimensionalDefinition` must fall within the `multidimensionalSubset`, otherwise nothing will be displayed in the map.
+ *
+ * [![layers-imagery](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/imagery/multidimensionalsubset.png)](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-multidimensional/)
+ *
+ * </details>
+ *
+ * @since 4.0
+ * @see [ImageryLayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html)
+ * @see [Sample - Add an ImageryLayer to a map](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagerylayer/)
+ * @see [Sample - Work with pixelFilter in an ImageryLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-pixelvalues/)
+ * @see [Sample - Set a server side raster function](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-popup/)
+ * @see [Sample - ImageryLayer raster function](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-rasterfunction/)
+ * @see [Sample - Raster attribute table](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-attribute-table/)
+ * @see [Sample - Image coordinate system](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-coordinatesystem/)
+ */
+export default class ImageryLayer extends ImageryLayerSuperclass {
+  /**
+   * @deprecated
+   * Do not directly reference this property.
+   * Use EventNames and EventTypes helpers from \@arcgis/core/Evented
+   */
+  "@eventTypes": ImageryLayerEvents;
+  /**
+   * @example
+   * // Typical usage
+   * let layer = new ImageryLayer({
+   *   // URL to the imagery service
+   *   url: "https://landsat2.arcgis.com/arcgis/rest/services/Landsat8_Views/ImageServer"
+   * });
+   */
+  constructor(properties?: ImageryLayerProperties);
+  /**
+   * Specifies how the imagery is placed on the vertical axis (z). This property may only be used
+   * in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [ElevationInfo sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-elevationinfo/)
+   * for an example of how this property may be used.
+   *
+   * > [!WARNING]
+   * >
+   * > The elevation info only affects [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) if the `renderer` is set to [FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html) and applies `on-the-ground` mode if it is null.
+   * > The `relative-to-scene` mode does not affect [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html).
+   * > [ElevationInfo#featureExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-ElevationInfo.html#featureExpressionInfo) is not supported when the elevation info is specified for this class.
+   * > If the elevation info is not specified, the effective elevation depends on the context and could vary per point.
+   *
+   * @since 4.34
+   */
+  get elevationInfo(): ElevationInfo | null | undefined;
+  set elevationInfo(value: ElevationInfoProperties | null | undefined);
+  /**
+   * Indicates whether the layer will be included in the legend.
+   *
+   * @default true
+   * @since 4.12
+   */
+  accessor legendEnabled: boolean;
+  /**
+   * Indicates whether to display popups when features in the layer are clicked.
+   *
+   * @default true
+   */
+  accessor popupEnabled: boolean;
+  /**
+   * The popup template for the layer. When set on the layer, the popupTemplate
+   * allows users to access attributes and display their values using text and/or charts
+   * in the view's popup when a pixel is clicked.
+   * See [this sample](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-popup/)
+   * for an example of how [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) interacts with an
+   * [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html).
+   *
+   * A default popup template is automatically used if no `popupTemplate` has been defined when
+   * [Popup#defaultPopupTemplateEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#defaultPopupTemplateEnabled)
+   * is set to `true`.
+   *
+   * @see [createPopupTemplate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#createPopupTemplate)
+   * @see [SceneView#popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#popup)
+   * @see [View2D#popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#popup)
+   * @example
+   * // displays the temperature stored in the clicked pixel
+   * layer.popupTemplate = {
+   *   title: "Sea Surface Temperature",
+   *   content: "{Raster.ServicePixelValue}° Celsius"
+   * }
+   */
+  get popupTemplate(): PopupTemplate | null | undefined;
+  set popupTemplate(value: PopupTemplateProperties | null | undefined);
+  /**
+   * Apply perspective scaling to screen-size symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   * When `true`, screen sized objects such as streamlines from a [FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html)
+   * integrate better in the 3D scene by applying a certain perspective projection to the size.
+   * This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > Screen size perspective is currently not optimized for situations where the camera is very near the ground, or for
+   * > scenes with visual elements located far from the ground surface. In these cases it may be better to turn off
+   * > screen size perspective.
+   *
+   * @default true
+   * @since 4.34
+   */
+  accessor screenSizePerspectiveEnabled: boolean;
+  /**
+   * The layer type provides a convenient way to check the type of the layer
+   * without the need to import specific layer modules.
+   */
+  get type(): "imagery";
+  /**
+   * Creates a default popup template for the layer, populated with all the fields of the layer.
+   *
+   * @param options - Options for creating the popup template.
+   * @returns The popup template, or `null` if the layer does not
+   * have any fields.
+   * @since 4.11
+   */
+  createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | null | undefined;
+  /**
+   * Executes the [pixelFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter) function and redraws the layer.
+   *
+   * @example
+   * // function defined in layer.pixelFilter is re-executed
+   * layer.redraw();
+   */
+  redraw(): void;
+  /**
+   * Saves the layer to its existing portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html)
+   * authenticated within the user's current session. If the layer is not saved to a
+   * [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html), then you should use [saveAs()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#saveAs).
+   *
+   * @param options - Various options for saving the layer.
+   * @returns When resolved, returns the portal item to which the layer is saved.
+   * @since 4.28
+   * @example const portalItem = await layer.save();
+   */
+  save(options?: SaveOptions): Promise<PortalItem>;
+  /**
+   * Saves the layer to a new portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session.
+   *
+   * @param portalItem - The portal item to which the layer will be saved.
+   * @param options - Various options for saving the layer.
+   * @returns When resolved, returns the portal item to which the layer is saved.
+   * @since 4.28
+   * @example
+   * const portalItem = new PortalItem();
+   * await layer.saveAs(portalItem);
+   */
+  saveAs(portalItem: PortalItemProperties, options?: SaveAsOptions): Promise<PortalItem>;
+}
+declare const ImageryLayerSuperclass: typeof Layer & typeof ClonableMixin & typeof MultiOriginJSONMixin & typeof ArcGISService & typeof CustomParametersMixin & typeof RefreshableLayer & typeof RasterJobHandlerMixin & typeof ArcGISImageService & typeof RasterPresetRendererMixin & typeof PortalLayer & typeof OperationalLayer & typeof ScaleRangeLayer & typeof TemporalLayer & typeof BlendLayer