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

package/layers/support/Sublayer.d.ts

@@ -1,4 +1,1123 @@
-import "../../interfaces";
+import type Graphic from "../../Graphic.js";
+import type PopupTemplate from "../../PopupTemplate.js";
+import type Collection from "../../core/Collection.js";
+import type Extent from "../../geometry/Extent.js";
+import type SpatialReference from "../../geometry/SpatialReference.js";
+import type FeatureLayer from "../FeatureLayer.js";
+import type MapImageLayer from "../MapImageLayer.js";
+import type TileLayer from "../TileLayer.js";
+import type Domain from "./Domain.js";
+import type FeatureType from "./FeatureType.js";
+import type Field from "./Field.js";
+import type FieldsIndex from "./FieldsIndex.js";
+import type LabelClass from "./LabelClass.js";
+import type LayerFloorInfo from "./LayerFloorInfo.js";
+import type OrderByInfo from "./OrderByInfo.js";
+import type Relationship from "./Relationship.js";
+import type AttachmentInfo from "../../rest/query/support/AttachmentInfo.js";
+import type FeatureSet from "../../rest/support/FeatureSet.js";
+import type Query from "../../rest/support/Query.js";
+import type AttributeTableTemplate from "../../tables/AttributeTableTemplate.js";
+import type { ReadonlyArrayOrCollection } from "../../core/Collection.js";
+import type { IdentifiableMixin, IdentifiableMixinProperties } from "../../core/Identifiable.js";
+import type { Loadable, LoadableMixinProperties } from "../../core/Loadable.js";
+import type { MultiOriginJSONMixin, MultiOriginJSONMixinProperties } from "../../core/MultiOriginJSONSupport.js";
+import type { AbortOptions } from "../../core/promiseUtils.js";
+import type { FieldDomainOptions } from "../mixins/properties/ILayerWithGetField.js";
+import type { SublayerCapabilities } from "./interfaces.js";
+import type { LayerSource } from "./source/types.js";
+import type { RendererUnion } from "../../renderers/support/typeUtils.js";
+import type { AttachmentQueryProperties } from "../../rest/support/AttachmentQuery.js";
+import type { QueryProperties } from "../../rest/support/Query.js";
+import type { RelationshipQueryProperties } from "../../rest/support/RelationshipQuery.js";
+import type { CreatePopupTemplateOptions } from "../../support/popupUtils.js";
+import type { ObjectId } from "../../views/IObjectId.js";
+import type { AttributeTableTemplateProperties } from "../../tables/AttributeTableTemplate.js";
+import type { LayerFloorInfoProperties } from "./LayerFloorInfo.js";
+import type { LabelClassProperties } from "./LabelClass.js";
+import type { OrderByInfoProperties } from "./OrderByInfo.js";
+import type { PopupTemplateProperties } from "../../PopupTemplate.js";
+import type { HeatmapRendererProperties } from "../../renderers/HeatmapRenderer.js";
+import type { PieChartRendererProperties } from "../../renderers/PieChartRenderer.js";
+import type { DictionaryRendererProperties } from "../../renderers/DictionaryRenderer.js";
+import type { DotDensityRendererProperties } from "../../renderers/DotDensityRenderer.js";
+import type { UniqueValueRendererProperties } from "../../renderers/UniqueValueRenderer.js";
+import type { ClassBreaksRendererProperties } from "../../renderers/ClassBreaksRenderer.js";
+import type { SimpleRendererProperties } from "../../renderers/SimpleRenderer.js";
+import type { MapLayerSourceProperties } from "./source/MapLayerSource.js";
+import type { DataLayerSourceProperties } from "./source/DataLayerSource.js";
 
-import Sublayer = __esri.Sublayer;
-export default Sublayer;
+export interface SublayerProperties extends LoadableMixinProperties, IdentifiableMixinProperties, MultiOriginJSONMixinProperties, Partial<Pick<Sublayer, "definitionExpression" | "id" | "labelsVisible" | "layer" | "legendEnabled" | "listMode" | "maxScale" | "minScale" | "opacity" | "parent" | "popupEnabled" | "sourceJSON" | "title" | "url" | "visible">> {
+  /**
+   * This property is used to configure the associated layer's [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html). It is meant to configure how the columns display within the table in regard to visibility, column order, and sorting.
+   *
+   * > [!WARNING]
+   * >
+   * > This property differs from a [FeatureTable's tableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) property. The `TableTemplate` provides more fine-grained control over how the table is rendered within the application by offering more advanced configurations such as custom cell rendering, column formatting, and more. `TableTemplate` is useful for application-level development that remains within an application. Use the `attributeTableTemplate` property to access the table's settings across different applications. By using this property, the settings can be saved within a webmap or layer. Please refer to the [AttributeTableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-tables-AttributeTableTemplate.html) and [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) documentation for more information.
+   *
+   * @since 4.33
+   */
+  attributeTableTemplate?: AttributeTableTemplateProperties | null;
+  /**
+   * If a map image layer contains a sublayer which is meant to be floor-aware, then that sublayer
+   * must have a floorInfo property, containing a [LayerFloorInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LayerFloorInfo.html) object
+   * which has a string property to represent the floorField.
+   *
+   * @since 4.21
+   */
+  floorInfo?: LayerFloorInfoProperties | null;
+  /**
+   * The label definition for this layer,
+   * specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) objects.
+   * Use this property to specify labeling properties for the layer such as label expression, placement, and size.
+   *
+   * @see [Sample - MapImageLayer: label sublayer features](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-dynamic-labels/)
+   * @example
+   * let layer = new MapImageLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+   *   sublayers: [{
+   *     id: 3,
+   *     labelsVisible: true,
+   *     // labelingInfo autocasts to an array of LabelClass objects
+   *     labelingInfo: [{
+   *       labelExpression: "[name]",
+   *       labelPlacement: "always-horizontal",
+   *       symbol: {
+   *         type: "text",  // autocasts as new TextSymbol()
+   *         color: [255, 255, 255, 0.7],
+   *         haloColor: [0, 0, 0, 0.85],
+   *         haloSize: 1,
+   *         font: {
+   *           size: 11
+   *         }
+   *       },
+   *       minScale: 2400000,
+   *       maxScale: 73000
+   *     }]
+   *   }]
+   * });
+   */
+  labelingInfo?: LabelClassProperties[] | null;
+  /**
+   * Determines the order in which features are drawn in the view. You
+   * can sort features by a field value or the value returned from an
+   * [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression in ascending or descending order.
+   *
+   * When `null` (default), features are drawn in the order they are returned from
+   * the service or client.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > - Feature drawing order configurations defined with Arcade expressions cannot be [saved](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#save) to web maps.
+   * > - Currently, you can only sort features by one field or expression.
+   * > - This property cannot be [saved](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#save) to a web scene.
+   *
+   * @since 4.32
+   * @see [Arcade Feature Z Profile](https://developers.arcgis.com/javascript/latest/arcade/#feature-sorting)
+   * @example
+   * // Features with larger population values will
+   * // be rendered on top of smaller features.
+   * sublayer.orderBy = [
+   *   {
+   *     field: "POP2024",
+   *     order: "descending"
+   *   }
+   * ];
+   */
+  orderBy?: OrderByInfoProperties[] | null;
+  /**
+   * The popup template for the sublayer. When set, the `popupTemplate`
+   * allows users to access attributes and display their values in the
+   * view's Popup when the user clicks
+   * the image.
+   *
+   * Sublayers with a [RasterDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-source-RasterDataSource.html) cannot be queried and
+   * therefore do not support [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).
+   *
+   * Alternatively, a default popup template may be automatically used if
+   * [Popup#defaultPopupTemplateEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#defaultPopupTemplateEnabled) is set to `true`.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions
+   * > are not supported in PopupTemplates set on MapImageLayer sublayers or TileLayer sublayers
+   * > unless they reference ArcGIS Enterprise 10.6 map services (or later) created from ArcGIS Pro.
+   *
+   * @see [Sample - MapImageLayer: dynamic data layer with table join](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicdatalayer-table-join/)
+   * @example
+   * let layer = new MapImageLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+   *   sublayers: [{
+   *     id: 0,
+   *     popupTemplate: {
+   *       title: "{COUNTY}",
+   *       content: "{POP2007} people lived in this county in 2007"
+   *     }
+   *   }]
+   * });
+   */
+  popupTemplate?: PopupTemplateProperties | null;
+  /**
+   * The renderer to apply to the sublayer.
+   * This value overrides the renderer read from the map service.
+   * To see if you can use this property, check the
+   * `supportsDynamicLayers` property of
+   * [MapImageLayer#capabilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#capabilities).
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > [3D symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html) are not currently supported in
+   * > renderers set on sublayers.
+   * > [Visual variables](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#visualVariables) and
+   * > [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions
+   * > are not supported in renderers set on MapImageLayer sublayers
+   * > unless they reference ArcGIS Enterprise 10.6 map services (or later) created from ArcGIS Pro.
+   *
+   * @see [Sample - MapImageLayer: set renderers on sublayers](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-renderers/)
+   * @example
+   * let layer = new MapImageLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+   *   sublayers: [{
+   *     id: 0,
+   *     renderer: {
+   *       type: "simple",  // autocasts as new SimpleRenderer()
+   *       symbol: {
+   *         type: "simple-marker",  // autocasts as new SimpleMarkerSymbol()
+   *         color: "black",
+   *         size: 8
+   *       }
+   *     }
+   *   }]
+   * });
+   */
+  renderer?: (((SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" })) | (HeatmapRendererProperties & { type: "heatmap" })) | null;
+  /**
+   * An object that allows you to create a dynamic layer with data
+   * either from the map service sublayers or data from a registered workspace.
+   * See [MapLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-source-MapLayerSource.html)
+   * for creating dynamic layers from map service layers for on the fly
+   * rendering, labeling, and filtering (definition expressions). To create
+   * dynamic layers from other sources in registered workspaces such as tables and table joins,
+   * see [DataLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-source-DataLayerSource.html).
+   *
+   * @example
+   * // Creates two sublayers that point to the same map service layer.
+   * // Each layer presents different features in the data using
+   * // definition expressions and renderers.
+   * let mapImageLayer = new MapImageLayer({
+   *   sublayers: [{
+   *     id: 10,
+   *     definitionExpression: "POP < 100000",
+   *     renderer: {
+   *       type: "simple",  // autocasts as new SimpleRenderer()
+   *       symbol: smallMarker
+   *     },
+   *     source: {
+   *       type: "map-layer",
+   *       mapLayerId: 0
+   *     }
+   *   }, {
+   *     id: 11,
+   *     definitionExpression: "POP > 100001",
+   *     renderer: {
+   *       type: "simple",  // autocasts as new SimpleRenderer()
+   *       symbol: largeMarker
+   *     },
+   *     source: {
+   *       type: "map-layer",
+   *       mapLayerId: 0
+   *     }
+   *   }]
+   * });
+   */
+  source?: ((DataLayerSourceProperties & { type: "data-layer" }) | (MapLayerSourceProperties & { type: "map-layer" }));
+  /**
+   * If a sublayer contains sublayers, this
+   * property is a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html)
+   * objects belonging to the given sublayer with sublayers.
+   *
+   * @example
+   * // test function for determining if a MapImageLayer's sublayers
+   * // contain at least one dynamic data layer
+   * function hasDynamicDataLayer (layer){
+   *   if (layer.sublayers && layer.sublayers.sublayers){
+   *     return layer.sublayers.sublayers.some(function(sublayer){
+   *       return sublayer.source.type === "data-layer";
+   *     });
+   *   } else {
+   *     console.log("layer does not have sublayers or nested sublayers");
+   *     return false;
+   *   }
+   * }
+   */
+  sublayers?: ReadonlyArrayOrCollection<SublayerProperties>;
+}
+
+/**
+ * Represents a sublayer in a [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) or a [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html).
+ * MapImageLayer allows you to display, query, and analyze layers from data defined in a [map service](https://enterprise.arcgis.com/en/server/latest/publish-services/windows/what-is-a-map-service.htm).
+ * Map services contain sublayers with properties such as [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#renderer),
+ * [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#labelingInfo), and [definitionExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#definitionExpression), and others that are
+ * defined on the server. The properties of each MapImageLayer sublayer on the map service may be dynamically
+ * changed by the user or developer. The properties of each TileLayer sublayer are read-only, and cannot be modified.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > All properties of a [TileLayer's sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#sublayers) are read-only, except the following:
+ * >   - [legendEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#legendEnabled)
+ * >   - [popupEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupEnabled)
+ * >   - [popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupTemplate)
+ * >   - [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#title)
+ * >
+ * > The following limitations apply to sublayers from all map services published with ArcMap, or published to ArcGIS Server 10.5.1 or earlier:
+ * > [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions are not supported in the [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#renderer)
+ * >   and [popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupTemplate).
+ * > [Visual variables](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#visualVariables) are not supported in the [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#renderer).
+ *
+ * ## Dynamic layers
+ *
+ * Sublayers may be rendered on the fly as dynamic layers. Dynamic layers are created using
+ * the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#source) property of the sublayer. There are two types of dynamic layers:
+ * [dynamic map layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-source-MapLayerSource.html) and [dynamic data layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-source-DataLayerSource.html).
+ *
+ * [Dynamic map layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-source-MapLayerSource.html) allow you to override sublayers in the map service with new renderers,
+ * definition expressions, opacity, scale visibility, etc. Multiple dynamic map layers may exist
+ * for a single map service layer.
+ *
+ * [Dynamic data layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-source-DataLayerSource.html) provide the ability to create sublayers on the fly
+ * from data inside registered workspaces.
+ * The data may be tables with or without geometries, feature classes, or
+ * rasters. These data sources are not directly visible to the services directory, but may be
+ * published and configured with the ArcGIS Server Manager. Data from tables may be joined to other
+ * tables or dynamic map layers.
+ *
+ * @since 4.1
+ * @see [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html)
+ * @see [Sample - MapImageLayer: toggle sublayer visibility](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-sublayers/)
+ * @see [Sample - MapImageLayer: set definition expression](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-definitionexpression/)
+ * @see [Sample - MapImageLayer: set renderers on sublayers](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-renderers/)
+ * @see [Sample - MapImageLayer: label sublayer features](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-dynamic-labels/)
+ * @see [Sample - MapImageLayer: create dynamic map layers](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicmaplayer/)
+ * @see [Sample - MapImageLayer: dynamic data layer with table join](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicdatalayer-table-join/)
+ * @see [Sample - MapImageLayer: dynamic data layer with query table](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicdatalayer-query-table/)
+ * @see [Sample - MapImageLayer: dynamic data layer with raster](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicdatalayer-raster/)
+ * @example
+ * // defines the properties of various sublayers in a map service
+ * let layer = new MapImageLayer({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+ *   sublayers: [
+ *     {  // sets a definition expression on sublayer 3
+ *       id: 3,
+ *       definitionExpression: "pop2000 > 40000000"
+ *     },
+ *     {  // sublayer 2 will be rendered as defined in the map service
+ *       id: 2
+ *     },
+ *     {  // sublayer 1 will be included in the layer, with visibility off
+ *       id: 1,
+ *       visible: false
+ *     },
+ *     {  // sublayer 0 will have new renderer and label
+ *        // expressions applied in the view on the fly
+ *       id: 0,
+ *        renderer: {
+ *          type: "class-breaks"  // autocasts as new ClassBreaksRenderer()
+ *          // set renderer properties here
+ *        },
+ *        labelingInfo: [ new LabelClass ( ... ) ]
+ *      }
+ *    ]
+ * });
+ */
+export default class Sublayer extends SublayerSuperclass {
+  /**
+   * @example
+   * // typical usage
+   * let layer = new MapImageLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+   *   sublayers: [  // autocasts as a Collection of Sublayers
+   *     { // sets a definition expression on sublayer 0
+   *       id: 0,
+   *       definitionExpression: "pop2000 > 40000000"
+   *     },
+   *     {  // creates a dynamic data layer
+   *       source: {
+   *         type: dynamic-layer,
+   *         dataSource: {
+   *           type: "table",
+   *           workspaceId: "MyDatabaseWorkspaceIDSSR2",
+   *           dataSourceName: "ss6.gdb.Railroads"
+   *         }
+   *       }
+   *     }
+   *   ]
+   * });
+   */
+  constructor(properties?: SublayerProperties);
+  /**
+   * This property is used to configure the associated layer's [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html). It is meant to configure how the columns display within the table in regard to visibility, column order, and sorting.
+   *
+   * > [!WARNING]
+   * >
+   * > This property differs from a [FeatureTable's tableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) property. The `TableTemplate` provides more fine-grained control over how the table is rendered within the application by offering more advanced configurations such as custom cell rendering, column formatting, and more. `TableTemplate` is useful for application-level development that remains within an application. Use the `attributeTableTemplate` property to access the table's settings across different applications. By using this property, the settings can be saved within a webmap or layer. Please refer to the [AttributeTableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-tables-AttributeTableTemplate.html) and [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) documentation for more information.
+   *
+   * @since 4.33
+   */
+  get attributeTableTemplate(): AttributeTableTemplate | null | undefined;
+  set attributeTableTemplate(value: AttributeTableTemplateProperties | null | undefined);
+  /**
+   * Describes the layer's supported capabilities.
+   *
+   * @since 4.27
+   * @example
+   * // Once the layer loads, check if `supportsAttachment`
+   * // operation is enabled on the layer
+   *
+   * layer.when(function(){
+   *   if (layer.capabilities.data.supportsAttachment) {
+   *     // if attachments are enabled on the layer
+   *     setupAttachments();
+   *   }
+   * });
+   */
+  get capabilities(): SublayerCapabilities;
+  /**
+   * A SQL where clause used to filter features in the image.
+   * Only the features that satisfy the definition expression are displayed in the
+   * [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). Definition expressions
+   * may be set when a sublayer is constructed prior to it loading in the view or after it has
+   * been added to the MapImageLayer. To see if you can use this property, check the
+   * `supportsSublayerDefinitionExpression` property of
+   * [MapImageLayer#capabilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#capabilities).
+   *
+   * @see [Sample - MapImageLayer: set definition expression](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-definitionexpression/)
+   * @example
+   * let countiesLyr = layer.sublayers.find(function(sublayer){
+   *   return sublayer.title === "States";
+   * });
+   * countiesLyr.definitionExpression = "STATE = 'Nebraska'"
+   * @example
+   * // add a definition expression to sublayer when
+   * // it is created in MapImageLayer constructor
+   * let layer = new MapImageLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+   *   sublayers: [{
+   *     id: 0,
+   *     definitionExpression: "STATE = 'Nebraska'"
+   *   }]
+   * });
+   * @example
+   * // Set a definition expression on the sublayer with ID of 0
+   * layer.findSublayerById(0).definitionExpression = "STATE = 'Nebraska'";
+   */
+  accessor definitionExpression: string | null | undefined;
+  /**
+   * An array of fields in the Sublayer. Each field represents an attribute
+   * that may contain a value for each feature in the Sublayer. This property
+   * is only available after the Sublayer has been [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#loadStatus).
+   *
+   * @since 4.15
+   * @see [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#load)
+   * @see [loadStatus](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#loadStatus)
+   * @example
+   * // print the first Sublayer's first field to the console
+   * console.log(mapImageLayer.sublayers.items[0].fields[0]);
+   *
+   * // OUTPUT:
+   * alias: "OBJECTID"
+   * defaultValue: undefined
+   * description: "the objectid"
+   * domain: null
+   * editable: false
+   * name: "objectid"
+   * nullable: false
+   * type: "oid"
+   * valueType: null
+   */
+  get fields(): Field[];
+  /**
+   * A convenient property that can be used to make case-insensitive lookups for a {@link layers/support/Sublayer#field} by name.
+   * It can also provide a list of the [date fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FieldsIndex.html#dateFields)
+   * in a Sublayer. This property is only available after the Sublayer has been [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#loadStatus).
+   *
+   * @since 4.15
+   * @see [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#load)
+   * @see [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#fields)
+   * @example
+   * // lookup a field by name, name is case-insensitive
+   * const fieldsIndex = mapImageLayer.sublayers.items[0].fieldsIndex.get("OBjecTID");
+   *
+   * // if there's a field by that name, print it to the console
+   * if (fieldsIndex) {
+   *   console.log("fieldsIndex: ", fieldsIndex);
+   * }
+   */
+  get fieldsIndex(): FieldsIndex<Field>;
+  /**
+   * If a map image layer contains a sublayer which is meant to be floor-aware, then that sublayer
+   * must have a floorInfo property, containing a [LayerFloorInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LayerFloorInfo.html) object
+   * which has a string property to represent the floorField.
+   *
+   * @since 4.21
+   */
+  get floorInfo(): LayerFloorInfo | null | undefined;
+  set floorInfo(value: LayerFloorInfoProperties | null | undefined);
+  /**
+   * The full extent of the Sublayer.
+   * This property is only available after the Sublayer has been [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#loadStatus).
+   *
+   * @since 4.15
+   * @see [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#load)
+   * @see [loadStatus](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#loadStatus)
+   */
+  get fullExtent(): Extent | null | undefined;
+  /**
+   * The sublayer's layer ID. When a [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#source) is not defined on the
+   * layer, this value represents the id of the sublayer defined by the map service.
+   * If creating a [DataLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-source-DataLayerSource.html) or a {@link layers/support/Sublayer#MapDataLayer}
+   * and adding it to the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#source) property of the sublayer, the value of this
+   * property can be anything set by the developer.
+   *
+   * @see [Sample - MapImageLayer: toggle sublayer visibility](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-sublayers/)
+   * @example
+   * // Creates a MapImageLayer instance containing only the sublayers defined below.
+   * let layer = new MapImageLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+   *   // this service has four sublayers, but we're only going to include three.
+   *   sublayers: [ { id: 2 }, { id: 1 }, { id: 0 } ]
+   * });
+   * @example
+   * // Creates a MapImageLayer instance containing only the sublayers defined below.
+   * let layer = new MapImageLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+   *   sublayers: [{ // sets a new renderer on this sublayer
+   *     id: 2,
+   *     renderer: {
+   *       type: "class-breaks"  // autocasts as new ClassBreaksRenderer()
+   *       // set renderer properties here
+   *     }
+   *   }, { // sets new labelingInfo on the sublayer
+   *     id: 1,
+   *     labelingInfo: [ new LabelClass( ... ) ]
+   *   }, { // retains properties defined by the service, but makes sublayer not visible
+   *     id: 0,
+   *     visible: false
+   *   }]
+   * });
+   */
+  accessor id: number;
+  /**
+   * Returns `true` if the sublayer is a non-spatial table in a map service.
+   *
+   * @default false
+   * @since 4.30
+   * @see [MapImageLayer#subtables](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#subtables)
+   * @see [TileLayer#subtables](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#subtables)
+   */
+  get isTable(): boolean;
+  /**
+   * The label definition for this layer,
+   * specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) objects.
+   * Use this property to specify labeling properties for the layer such as label expression, placement, and size.
+   *
+   * @see [Sample - MapImageLayer: label sublayer features](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-dynamic-labels/)
+   * @example
+   * let layer = new MapImageLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+   *   sublayers: [{
+   *     id: 3,
+   *     labelsVisible: true,
+   *     // labelingInfo autocasts to an array of LabelClass objects
+   *     labelingInfo: [{
+   *       labelExpression: "[name]",
+   *       labelPlacement: "always-horizontal",
+   *       symbol: {
+   *         type: "text",  // autocasts as new TextSymbol()
+   *         color: [255, 255, 255, 0.7],
+   *         haloColor: [0, 0, 0, 0.85],
+   *         haloSize: 1,
+   *         font: {
+   *           size: 11
+   *         }
+   *       },
+   *       minScale: 2400000,
+   *       maxScale: 73000
+   *     }]
+   *   }]
+   * });
+   */
+  get labelingInfo(): LabelClass[] | null | undefined;
+  set labelingInfo(value: LabelClassProperties[] | null | undefined);
+  /**
+   * Indicates if labels for the sublayer will be visible in the view.
+   *
+   * @default true
+   * @see [Sample - MapImageLayer: label sublayer features](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-dynamic-labels/)
+   * @example
+   * // turns on labels defined for sublayer 0
+   * layer.findSublayerById(0).labelsVisible = true;
+   */
+  accessor labelsVisible: boolean;
+  /** The [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) or [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html) to which the sublayer belongs. */
+  accessor layer: MapImageLayer | TileLayer | null | undefined;
+  /**
+   * Indicates whether the layer will be included in the legend. When `false`, the layer will be excluded from the legend.
+   *
+   * @default true
+   */
+  accessor legendEnabled: boolean;
+  /**
+   * Indicates how the layer should display in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget.
+   * The possible values are listed below.
+   *
+   * Value | Description
+   * ------|------------
+   *  show | The layer is visible in the table of contents.
+   *  hide | The layer is hidden in the table of contents.
+   *  hide-children | Hide the children layers from the table of contents.
+   *
+   * @default "show"
+   * @since 4.11
+   */
+  accessor listMode: "hide" | "show" | "hide-children";
+  /**
+   * 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-support-Sublayer.html#minScale) value,
+   * and greater than or equal to the service specification.
+   *
+   * @see [Sample - MapImageLayer - label sublayer features](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-dynamic-labels/)
+   * @example
+   * let layer = new MapImageLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+   *   sublayers: [
+   *     {
+   *       id: 0,
+   *       minScale: 5000000,
+   *       maxScale: 24000
+   *     },
+   *     {
+   *       id: 1
+   *       minScale: 24000,
+   *       maxScale: 100
+   *     }
+   *   ]
+   * });
+   */
+  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-support-Sublayer.html#maxScale) value,
+   * and lesser than or equal to the service specification.
+   *
+   * @see [Sample - MapImageLayer - label sublayer features](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-dynamic-labels/)
+   * @example
+   * let layer = new MapImageLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+   *   sublayers: [
+   *     {
+   *       id: 0,
+   *       minScale: 5000000,
+   *       maxScale: 24000
+   *     },
+   *     {
+   *       id: 1,
+   *       minScale: 24000,
+   *       maxScale: 100
+   *     }
+   *   ]
+   * });
+   */
+  accessor minScale: number;
+  /**
+   * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#fields) containing a unique value or identifier for each
+   * feature in the Sublayer.
+   *
+   * @since 4.15
+   * @see [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#fields)
+   * @see [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#load)
+   */
+  get objectIdField(): string | null | undefined;
+  /**
+   * The level of opacity to set on the sublayer on a scale
+   * from 0.0 - 1.0 where `0` is fully transparent and `1.0` is fully opaque.
+   * If the [MapImageLayer#opacity](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#opacity)
+   * is set, the actual opacity value of the sublayer will be the value of
+   * [MapImageLayer#opacity](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#opacity) multiplied
+   * by the sublayer's opacity.
+   *
+   * @see [Sample - MapImageLayer: dynamic data layer with table join](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicdatalayer-table-join/)
+   * @example
+   * // Set the opacity of the layer to 0.5
+   * layer.findSublayerById(0).opacity = 0.5;
+   */
+  accessor opacity: number;
+  /**
+   * Determines the order in which features are drawn in the view. You
+   * can sort features by a field value or the value returned from an
+   * [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression in ascending or descending order.
+   *
+   * When `null` (default), features are drawn in the order they are returned from
+   * the service or client.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > - Feature drawing order configurations defined with Arcade expressions cannot be [saved](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#save) to web maps.
+   * > - Currently, you can only sort features by one field or expression.
+   * > - This property cannot be [saved](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#save) to a web scene.
+   *
+   * @since 4.32
+   * @see [Arcade Feature Z Profile](https://developers.arcgis.com/javascript/latest/arcade/#feature-sorting)
+   * @example
+   * // Features with larger population values will
+   * // be rendered on top of smaller features.
+   * sublayer.orderBy = [
+   *   {
+   *     field: "POP2024",
+   *     order: "descending"
+   *   }
+   * ];
+   */
+  get orderBy(): OrderByInfo[] | null | undefined;
+  set orderBy(value: OrderByInfoProperties[] | null | undefined);
+  /**
+   * The parent layer to which the sublayer belongs.
+   *
+   * @since 4.27
+   */
+  accessor parent: Sublayer | MapImageLayer | TileLayer | null | undefined;
+  /**
+   * Indicates whether to display popups when features in the layer are clicked. The layer needs to have a
+   * [popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupTemplate) to define what information should be displayed in the popup. Alternatively,
+   * a default popup template may be automatically used if
+   * [Popup#defaultPopupTemplateEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#defaultPopupTemplateEnabled) is set to `true`.
+   *
+   * @default true
+   * @since 4.7
+   */
+  accessor popupEnabled: boolean;
+  /**
+   * The popup template for the sublayer. When set, the `popupTemplate`
+   * allows users to access attributes and display their values in the
+   * view's Popup when the user clicks
+   * the image.
+   *
+   * Sublayers with a [RasterDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-source-RasterDataSource.html) cannot be queried and
+   * therefore do not support [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).
+   *
+   * Alternatively, a default popup template may be automatically used if
+   * [Popup#defaultPopupTemplateEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#defaultPopupTemplateEnabled) is set to `true`.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions
+   * > are not supported in PopupTemplates set on MapImageLayer sublayers or TileLayer sublayers
+   * > unless they reference ArcGIS Enterprise 10.6 map services (or later) created from ArcGIS Pro.
+   *
+   * @see [Sample - MapImageLayer: dynamic data layer with table join](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicdatalayer-table-join/)
+   * @example
+   * let layer = new MapImageLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+   *   sublayers: [{
+   *     id: 0,
+   *     popupTemplate: {
+   *       title: "{COUNTY}",
+   *       content: "{POP2007} people lived in this county in 2007"
+   *     }
+   *   }]
+   * });
+   */
+  get popupTemplate(): PopupTemplate | null | undefined;
+  set popupTemplate(value: PopupTemplateProperties | null | undefined);
+  /**
+   * An array of [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html) associated with the sublayer.
+   * Each [Relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html) defines a _relationship_ between this sublayer and another layer or table.
+   *
+   * @since 4.30
+   */
+  get relationships(): Relationship[] | null | undefined;
+  /**
+   * The renderer to apply to the sublayer.
+   * This value overrides the renderer read from the map service.
+   * To see if you can use this property, check the
+   * `supportsDynamicLayers` property of
+   * [MapImageLayer#capabilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#capabilities).
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > [3D symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html) are not currently supported in
+   * > renderers set on sublayers.
+   * > [Visual variables](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#visualVariables) and
+   * > [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions
+   * > are not supported in renderers set on MapImageLayer sublayers
+   * > unless they reference ArcGIS Enterprise 10.6 map services (or later) created from ArcGIS Pro.
+   *
+   * @see [Sample - MapImageLayer: set renderers on sublayers](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-renderers/)
+   * @example
+   * let layer = new MapImageLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+   *   sublayers: [{
+   *     id: 0,
+   *     renderer: {
+   *       type: "simple",  // autocasts as new SimpleRenderer()
+   *       symbol: {
+   *         type: "simple-marker",  // autocasts as new SimpleMarkerSymbol()
+   *         color: "black",
+   *         size: 8
+   *       }
+   *     }
+   *   }]
+   * });
+   */
+  get renderer(): RendererUnion | null | undefined;
+  set renderer(value: (((SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" })) | (HeatmapRendererProperties & { type: "heatmap" })) | null | undefined);
+  /**
+   * An object that allows you to create a dynamic layer with data
+   * either from the map service sublayers or data from a registered workspace.
+   * See [MapLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-source-MapLayerSource.html)
+   * for creating dynamic layers from map service layers for on the fly
+   * rendering, labeling, and filtering (definition expressions). To create
+   * dynamic layers from other sources in registered workspaces such as tables and table joins,
+   * see [DataLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-source-DataLayerSource.html).
+   *
+   * @example
+   * // Creates two sublayers that point to the same map service layer.
+   * // Each layer presents different features in the data using
+   * // definition expressions and renderers.
+   * let mapImageLayer = new MapImageLayer({
+   *   sublayers: [{
+   *     id: 10,
+   *     definitionExpression: "POP < 100000",
+   *     renderer: {
+   *       type: "simple",  // autocasts as new SimpleRenderer()
+   *       symbol: smallMarker
+   *     },
+   *     source: {
+   *       type: "map-layer",
+   *       mapLayerId: 0
+   *     }
+   *   }, {
+   *     id: 11,
+   *     definitionExpression: "POP > 100001",
+   *     renderer: {
+   *       type: "simple",  // autocasts as new SimpleRenderer()
+   *       symbol: largeMarker
+   *     },
+   *     source: {
+   *       type: "map-layer",
+   *       mapLayerId: 0
+   *     }
+   *   }]
+   * });
+   */
+  get source(): LayerSource;
+  set source(value: ((DataLayerSourceProperties & { type: "data-layer" }) | (MapLayerSourceProperties & { type: "map-layer" })));
+  /**
+   * The [map service's metadata JSON](https://developers.arcgis.com/rest/services-reference/map-service.htm)
+   * exposed by the ArcGIS REST API. While most commonly used properties
+   * are exposed on the Sublayer class directly, this property gives access to all information returned
+   * by the map service. This property is useful if working in an application built using an older version of the API
+   * which requires access to map service properties from a more recent version.
+   *
+   * @since 4.15
+   */
+  accessor sourceJSON: any | null | undefined;
+  /**
+   * The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) of the sublayer as defined by the service.
+   *
+   * @since 4.30
+   */
+  get spatialReference(): SpatialReference | null | undefined;
+  /**
+   * If a sublayer contains sublayers, this
+   * property is a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html)
+   * objects belonging to the given sublayer with sublayers.
+   *
+   * @example
+   * // test function for determining if a MapImageLayer's sublayers
+   * // contain at least one dynamic data layer
+   * function hasDynamicDataLayer (layer){
+   *   if (layer.sublayers && layer.sublayers.sublayers){
+   *     return layer.sublayers.sublayers.some(function(sublayer){
+   *       return sublayer.source.type === "data-layer";
+   *     });
+   *   } else {
+   *     console.log("layer does not have sublayers or nested sublayers");
+   *     return false;
+   *   }
+   * }
+   */
+  get sublayers(): Collection<Sublayer>;
+  set sublayers(value: ReadonlyArrayOrCollection<SublayerProperties>);
+  /**
+   * The title of the sublayer used to identify it in places such as the
+   * [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/).
+   * This value can be defined in the map service or programmatically
+   * by the developer. It can also be useful for finding a specific
+   * sublayer.
+   *
+   * @example
+   * let radarSublayer = layer.sublayers.find(function(sublayer){
+   *   return sublayer.title === "radar";
+   * });
+   */
+  accessor title: string | null | undefined;
+  get type(): "sublayer";
+  /**
+   * The name of the field holding the type ID or subtypes for the features.
+   * See [ArcGIS Pro subtypes document](https://pro.arcgis.com/en/pro-app/latest/help/data/geodatabases/overview/an-overview-of-subtypes.htm).
+   * This property is only available after the Sublayer has been [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#loadStatus).
+   *
+   * @since 4.15
+   * @see [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#load)
+   */
+  get typeIdField(): string | null | undefined;
+  /**
+   * An array of [types](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html) defined in the feature service exposed by ArcGIS REST API.
+   * Each item includes information about the type, such as the type ID, name, and definition expression.
+   * This property is only available after the Sublayer has been [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#loadStatus).
+   *
+   * @since 4.15
+   * @see [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#load)
+   */
+  get types(): FeatureType[] | null | undefined;
+  /**
+   * The URL to the REST endpoint of the sublayer. This allows
+   * you to view the schema of fields and query tables located
+   * in registered workspaces.
+   */
+  accessor url: string | null | undefined;
+  /**
+   * Indicates if the layer is visible in the view.
+   * To see if you can use this property, check the
+   * `supportsSublayerVisibility` property of
+   * [MapImageLayer#capabilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#capabilities).
+   *
+   * @see [Sample - MapImageLayer: toggle sublayer visibility](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-sublayers/)
+   * @example
+   * let layer = new MapImageLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
+   *   sublayers: [{
+   *     // this sublayer is visible by default
+   *     id: 0
+   *   }, {
+   *     // this sublayer will be added to the layer but not visible
+   *     id: 1,
+   *     visible: false
+   *   }]
+   *     // all other sublayers in the service are excluded from the layer
+   * });
+   */
+  accessor visible: boolean;
+  /**
+   * Creates a deep clone of the sublayer.
+   *
+   * @returns A deep clone of the sublayer
+   * instance that invoked this method.
+   */
+  clone(): Sublayer;
+  /**
+   * A convenient method for creating a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) instance
+   * based on the Sublayer's configuration, including
+   * [dynamic sources](https://enterprise.arcgis.com/en/server/latest/publish-services/linux/about-dynamic-layers.htm).
+   * This allows you to take advantage of FeatureLayer
+   * capabilities not supported in Sublayer, such as the
+   * [Smart Mapping creator functions](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html).
+   *
+   * @returns A promise resolving to a FeatureLayer matching the
+   *                                                    configuration of the Sublayer instance that called this method.
+   * @since 4.7
+   * @see [FeatureLayer#dynamicDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#dynamicDataSource)
+   * @example
+   * let sublayer = mapImageLayer.findSublayerById(0);
+   *
+   * // when the createFeatureLayer() promise resolves, load the FeatureLayer
+   * // and pass it to the createParameters function
+   * sublayer.createFeatureLayer()
+   *   .then(function(featureLayer){
+   *     return featureLayer.load();
+   *   })
+   *   .then(createParameters);
+   *
+   * function createParameters (featureLayer) {
+   *   let colorParams = {
+   *     layer: featureLayer,
+   *     basemap: map.basemap,
+   *     field: "POPULATION",
+   *     normalizationField: "SQ_MILES",
+   *     legendOptions: {
+   *       title: "Population density (sq. miles)"
+   *     }
+   *   };
+   * }
+   *
+   * // when the promise resolves, apply the renderer to the sublayer
+   * colorRendererCreator.createContinuousRenderer(colorParams)
+   *   .then(function(response){
+   *     sublayer.renderer = response.renderer;
+   *   });
+   */
+  createFeatureLayer(): Promise<FeatureLayer | null | undefined>;
+  /**
+   * Creates a popup template for the sublayer, populated with all the fields of the sublayer.
+   *
+   * @param options - Options for creating the popup template.
+   * @returns The popup template, or `null` if the layer does not
+   * have any fields.
+   * @since 4.15
+   */
+  createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | null | undefined;
+  /**
+   * Creates a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) object with
+   * default values representing the layer's state, including filters (definition
+   * expression) on the layer's features.
+   *
+   * @returns The default query object
+   * including the definitionExpression for the sublayer.
+   */
+  createQuery(): Query;
+  /**
+   * Returns a [FeatureType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html) describing the feature's type.
+   * This is applicable if the layer containing the feature has a [typeIdField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#typeIdField).
+   *
+   * @param feature - A feature from this Sublayer.
+   * @returns The [FeatureType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html) describing the feature's type.
+   * @since 4.15
+   */
+  getFeatureType(feature: Graphic | null | undefined): FeatureType | null | undefined;
+  /**
+   * Returns the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the given field name. The domain can be either a
+   * [CodedValueDomain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html) or [RangeDomain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html).
+   *
+   * @param fieldName - Name of the field.
+   * @param options - An object specifying additional options. See the
+   *                      object specification table below for the required properties of this object.
+   * @returns The Domain object associated with the given field name for the given feature.
+   * @since 4.15
+   * @example
+   * // Get a range domain associated with the first feature
+   * // returned from queryFeatures().
+   * sublayer.queryFeatures(query).then(function(results){
+   *   const domain = sublayer.getFieldDomain("Height", {feature: results.features[0]});
+   *   console.log("domain", domain)
+   * });
+   */
+  getFieldDomain(fieldName: string, options?: FieldDomainOptions): Domain | null | undefined;
+  /**
+   * Query information about attachments associated with features. It will return an error if the layer's
+   * [capabilities.data.supportsAttachment](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#capabilities) property is `false`.
+   * Attachments for multiple features can be queried if the layer's
+   * [capabilities.operations.supportsQueryAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#capabilities) is `true`.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > When the layer's [capabilities.operations.supportsQueryAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#capabilities) property is
+   * > `false`, [AttachmentQuery#objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#objectIds) property only accepts a single
+   * > `objectId`.
+   *
+   * @param attachmentQuery - Specifies the attachment parameters for query.
+   * @param options - An object with the following properties.
+   * @since 4.26
+   */
+  queryAttachments(attachmentQuery: AttachmentQueryProperties, options?: AbortOptions): Promise<Record<string, AttachmentInfo[]>>;
+  /**
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the sublayer and returns the number of features that
+   * satisfy the query. If no parameters are specified, the total number of features satisfying the layer's
+   * configuration/filters is returned.
+   *
+   * @param query - Specifies the attributes and spatial filter of the query. If no
+   *                                                   parameters are specified, the total number of features satisfying
+   *                                                   the layer's configuration/filters is returned.
+   * @param options - An object with the following properties.
+   * @returns When resolved, returns the number of features that satisfy the query.
+   * @since 4.30
+   */
+  queryFeatureCount(query?: QueryProperties, options?: AbortOptions): Promise<number>;
+  /**
+   * Executes a [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html) against features in the sublayer.
+   * To see if you can use this property, check the
+   * `supportsQuery` property of
+   * [MapImageLayer#capabilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#capabilities).
+   *
+   * @param query - Specifies the attributes and spatial
+   * filter of the query. If no parameters are specified, then all features satisfying the
+   * layer's configuration/filters are returned.
+   * @param options - An object with the following properties.
+   * @returns Returns a promise that resolves to a
+   * [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) containing the features
+   * that satisfy the query.
+   */
+  queryFeatures(query?: QueryProperties, options?: AbortOptions): Promise<FeatureSet>;
+  /**
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the sublayer and returns an array of Object IDs for
+   * features that satisfy the input query. If no parameters are specified, then the Object IDs of all features
+   * satisfying the layer's configuration/filters are returned.
+   *
+   * @param query - Specifies the attributes and spatial filter of the query. If no
+   *                                                   parameters are specified, then the Object IDs of all features
+   *                                                   satisfying the layer's configuration/filters are returned.
+   * @param options - An object with the following properties.
+   * @returns When resolved, returns an array of numbers representing the object IDs of the features
+   *                             satisfying the query.
+   * @since 4.30
+   */
+  queryObjectIds(query?: QueryProperties, options?: AbortOptions): Promise<ObjectId[]>;
+  /**
+   * Executes a [RelationshipQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html) against the sublayer and returns
+   * [FeatureSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) grouped by source layer or table objectIds.
+   *
+   * @param relationshipQuery - Specifies relationship parameters for
+   *                                                                         querying related features or records from
+   *                                                                         a layer or a table.
+   * @param options - An object with the following properties.
+   * @returns When resolved, returns [FeatureSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) grouped
+   *                           by source layer/table objectIds. Each [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html)
+   *                           contains an array of [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) features including the values of the
+   *                           fields requested by the user.
+   * @since 4.30
+   */
+  queryRelatedFeatures(relationshipQuery: RelationshipQueryProperties, options?: AbortOptions): Promise<Record<string, FeatureSet>>;
+  /**
+   * Executes a [RelationshipQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html) against the sublayer and when resolved, it returns
+   * an `object` containing key value pairs. Key in this case is the `objectId` of the feature and value is the number
+   * of related features associated with the feature.
+   *
+   * @param relationshipQuery - Specifies relationship parameters for
+   *                                                                         querying related features or records from
+   *                                                                         a layer or a table.
+   * @param options - An object with the following properties.
+   * @returns When resolved, returns a hashmap containing key value pairs. Key in this case is the
+   *                           `objectId` of the feature and value is the number of related features.
+   * @since 4.30
+   */
+  queryRelatedFeaturesCount(relationshipQuery: RelationshipQueryProperties, options?: AbortOptions): Promise<Record<string, number>>;
+  /**
+   * Reloads the properties for the sublayer.
+   * Use this function after modifying the sublayer's [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#url) after it was loaded.
+   *
+   * @param options - An object with the following properties.
+   * @returns A promise that resolves when the sublayer is reloaded.
+   * @since 4.34
+   */
+  reload(options?: AbortOptions | null | undefined): Promise<void>;
+}
+declare const SublayerSuperclass: typeof Loadable & typeof IdentifiableMixin & typeof MultiOriginJSONMixin