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

package/layers/CatalogLayer.d.ts

@@ -1,4 +1,662 @@
-import "../interfaces";
+import type Graphic from "../Graphic.js";
+import type Collection from "../core/Collection.js";
+import type Extent from "../geometry/Extent.js";
+import type Layer from "./Layer.js";
+import type CatalogDynamicGroupLayer from "./catalog/CatalogDynamicGroupLayer.js";
+import type CatalogFootprintLayer from "./catalog/CatalogFootprintLayer.js";
+import type Field from "./support/Field.js";
+import type AttributeBinsFeatureSet from "../rest/support/AttributeBinsFeatureSet.js";
+import type FeatureSet from "../rest/support/FeatureSet.js";
+import type Query from "../rest/support/Query.js";
+import type { MultiOriginJSONMixin, MultiOriginJSONMixinProperties } from "../core/MultiOriginJSONSupport.js";
+import type { APIKeyMixin, APIKeyMixinProperties } from "./mixins/APIKeyMixin.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 { DisplayFilteredLayer, DisplayFilteredLayerProperties } from "./mixins/DisplayFilteredLayer.js";
+import type { EditBusLayer, EditBusLayerProperties } from "./mixins/EditBusLayer.js";
+import type { FeatureLayerBase, FeatureLayerBaseProperties } from "./mixins/FeatureLayerBase.js";
+import type { OperationalLayer, OperationalLayerProperties } from "./mixins/OperationalLayer.js";
+import type { OrderedLayer, OrderedLayerProperties } from "./mixins/OrderedLayer.js";
+import type { PortalLayer, PortalLayerProperties } from "./mixins/PortalLayer.js";
+import type { RefreshableLayer, RefreshableLayerProperties } from "./mixins/RefreshableLayer.js";
+import type { ScaleRangeLayer, ScaleRangeLayerProperties } from "./mixins/ScaleRangeLayer.js";
+import type { TemporalLayer, TemporalLayerProperties } from "./mixins/TemporalLayer.js";
+import type { RequestOptions } from "../request/interfaces.js";
+import type { AttributeBinsQueryProperties } from "../rest/support/AttributeBinsQuery.js";
+import type { QueryProperties } from "../rest/support/Query.js";
+import type { ObjectId } from "../views/IObjectId.js";
+import type { LayerProperties } from "./Layer.js";
 
-import CatalogLayer = __esri.CatalogLayer;
-export default CatalogLayer;
+export interface CatalogLayerProperties extends LayerProperties, APIKeyMixinProperties, CustomParametersMixinProperties, MultiOriginJSONMixinProperties, PortalLayerProperties, OperationalLayerProperties, ArcGISServiceProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, OrderedLayerProperties, BlendLayerProperties, EditBusLayerProperties, FeatureLayerBaseProperties, DisplayFilteredLayerProperties, Partial<Pick<CatalogLayer, "legendEnabled" | "outFields">> {
+  /**
+   * The absolute URL of the REST endpoint of a catalog service.
+   *
+   * @example
+   * // Create a catalog layer from a service
+   * const layer = new CatalogLayer({
+   *   url: "https://services3.arcgis.com/TVDq0jswpjtt1Xia/arcgis/rest/services/PNW_Forest_Fuels_Inventory_Status/FeatureServer"
+   * });
+   * @example
+   * // Hosted Feature Service on ArcGIS Online
+   * layer.url = "http://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/origins/FeatureServer/0";
+   * @example
+   * // Layer from Map Service on ArcGIS Server
+   * layer.url = "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/2";
+   * @example
+   * // Can also be used if URL points to service and not layer
+   * const layer = new FeatureLayer({
+   *   // Notice that the url doesn't end with /2
+   *   url: "http://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/MonterreyBayCanyon_WFL/FeatureServer",
+   *   layerId: 2
+   * });
+   * @example
+   * // Non-spatial table in San Francisco incidents service.
+   * const table = new FeatureLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/SF311/FeatureServer/1"
+   * });
+   * // table must be loaded so it can be used in the app.
+   * table.load().then(function() {
+   *   // table is loaded. ready to be queried.
+   * });
+   */
+  url?: string | null;
+}
+
+/**
+ * * [Overview](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#overview)
+ * * [Creating a CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#creating-a-cataloglayer)
+ * * [Sublayers of CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#layer-types)
+ * * [CatalogLayer attributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#attributes)
+ *
+ * <span id="overview"></span>
+ * ### Overview
+ *
+ * CatalogLayer points to different portal items and services, helping you to better organize and manage your data. It also makes it simpler for users to find information.
+ * Instead of manually gathering and adding each dataset separately in your map, you can create a CatalogLayer, which serves as a centralized reference point for all
+ * the data you need. CatalogLayer enhances collaboration by enabling users to share and access data more efficiently. For instance, if you're collaborating with
+ * colleagues on a GIS project, you can share your CatalogLayer with them. They can then access the same datasets and services referenced in the CatalogLayer,
+ * streamlining the collaboration process.
+ *
+ * <span id="creating-a-cataloglayer"></span>
+ * ### Creating a CatalogLayer
+ *
+ * CatalogLayers may be created in one of two ways: from a [service URL](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#url) or from an ArcGIS portal [item ID](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#portalItem).
+ *
+ * <details>
+ * <summary>Read More</summary>
+ *
+ * #### Reference a service URL
+ *
+ * To create a CatalogLayer instance from a service, you must set the [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#url) property to the REST endpoint of a layer in either a Feature Service or a Map Service.
+ * For a layer to be visible in a view, it must be added to the [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) referenced by the view. See [Map#add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#add) for information
+ * about adding layers to a map.
+ *
+ * ```js
+ * const CatalogLayer = await $arcgis.import("@arcgis/core/layers/CatalogLayer.js");
+ * // points to pacific northwest forest fuels inventory status
+ * const layer = new CatalogLayer({
+ *   url: "https://services3.arcgis.com/TVDq0jswpjtt1Xia/arcgis/rest/services/PNW_Forest_Fuels_Inventory_Status/FeatureServer"
+ * });
+ * map.add(layer);  // adds the layer to the map
+ * ```
+ *
+ * #### Reference an ArcGIS portal item ID
+ *
+ * You can also create a CatalogLayer from its portal item ID if it exists as an item in ArcGIS Online or ArcGIS Enterprise.
+ * For example, the following snippet shows how to add a new CatalogLayer instance to a map using the [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#portalItem) property.
+ *
+ * ```js
+ * // points to a hosted Feature Layer in ArcGIS Online
+ * const layer = new CatalogLayer({
+ *   portalItem: {  // autocasts as esri/portal/PortalItem
+ *     id: "3a9938eab3a3483f88d20b9269f0c098" // portal item id
+ *   }
+ * });
+ * map.add(layer);  // adds the layer to the map
+ * ```
+ *
+ * </details>
+ *
+ * <span id="layer-types"></span>
+ * ### Sublayers of CatalogLayer
+ *
+ * The catalog layer has two main sublayers which can be accessed via the [footprintLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#footprintLayer) and the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#dynamicGroupLayer) properties.
+ * These parts are grouped together under the catalog layer, which manages their settings.
+ *
+ * <details>
+ * <summary>Read More</summary>
+ *
+ * #### Footprint layer
+ * Every catalog item (layer) in the CatalogLayer has a footprint stored in the [footprintLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#footprintLayer).
+ * A footprint is a polygon feature that envelopes all of the item's features, rasters, and so forth.
+ * Each footprint feature has attributes that provide details about the item, such as its name, layer type, source, minScale, and maxScale.
+ * You can add, update, and maintain your own fields and values in the footprint layer. You cannot remove the `footprintLayer` from the CatalogLayer.
+ *
+ * <figure>
+ *   <img src="https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/cataloglayer/catalog-layer.png" alt="footprint"/>
+ *   <figcaption> This image shows CatalogLayer and its footprint layer legend in the CatalogLayerList.</figcaption>
+ * </figure>
+ *
+ * This layer has the same properties as a polygon feature layer, with some exceptions. You can update its [visibility](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogFootprintLayer.html#visible) and
+ * change how the layer is visualized by adding [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogFootprintLayer.html#labelingInfo), updating the [CatalogFootprintLayer#renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogFootprintLayer.html#renderer),
+ * and [extruding](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogFootprintLayer.html#elevationInfo) the features (in 3D). You can also [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogFootprintLayer.html#queryFeatures) the layer to get the footprints of the items in the CatalogLayer.
+ *
+ * #### Dynamic group layer
+ * The [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#dynamicGroupLayer) dynamically updates to display catalog items (layers) in the current view. By default, it draws up to 10 layers at a time.
+ * This default setting can be changed by adjusting [CatalogDynamicGroupLayer#maximumVisibleSublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogDynamicGroupLayer.html#maximumVisibleSublayers)
+ * property on the `CatalogDynamicGroupLayer`. Additionally, the layer can be filtered to show catalog items in a defined scale range, time, or other property.
+ * Because the layer is dynamic, its list of layers in the [LayerList#catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogLayerList) changes as you pan, zoom, or change the view's extent.
+ *
+ * The layers in the dynamicGroupLayer are read-only and not editable. All layers in the dynamicGroupLayer draw with their default symbology. To edit, change, or save a layer,
+ * you must add the layer to the map by calling [createLayerFromFootprint()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#createLayerFromFootprint) method on the parent [CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html).
+ *
+ * <figure>
+ *   <img src="https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/cataloglayer/dynamic-group-layer.png" alt="dynamic"/>
+ *   <figcaption> This image shows the sublayers of the CatalogDynamicGroupLayer visible on the map.</figcaption>
+ * </figure>
+ *
+ * </details>
+ *
+ * <span id="attributes"></span>
+ * ### CatalogLayer attributes
+ *
+ * The catalog layer's attribute table can be opened to view all catalog items included in the layer. Each item is a record in the attribute table.
+ * A catalog layer's attribute table typically includes the following fields that are required to be present in the catalog layer:
+ * | Field name | Description |
+ * | ----------- | ----------- |
+ * | [cd_itemname](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#itemNameField) | The name of the catalog item. |
+ * | [cd_itemsource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#itemSourceField) | The source path of the catalog item. |
+ * | [cd_itemtype](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#itemTypeField) | The type of the catalog item, such as `Feature Class` or `Image Service`. |
+ * | [cd_maxscale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#maxScaleField) | The maximum scale at which the catalog item can be displayed. |
+ * | [cd_minscale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#minScaleField) | The minimum scale at which the catalog item can be displayed. |
+ * | [cd_draworder](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#drawOrderField) | The draw order field holds the value to sort catalog items. By default, items with the highest values draw first (on the bottom), and the lowest values draw last (on top). |
+ *
+ *
+ * > [!WARNING]
+ * >
+ * > <span id="limits"></span>
+ * > **Notes**
+ * >
+ * > The CatalogLayer's [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#dynamicGroupLayer) frequently adds and removes layers from the map which puts more pressure on mobile devices. To improve performance on mobile devices, we recommend
+ * > the following settings on your CatalogLayer:
+ * >   * Turn off the visibility of the [CatalogDynamicGroupLayer#visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogDynamicGroupLayer.html#visible) by default.
+ * >   * Set the CatalogDynamicGroupLayer's [CatalogDynamicGroupLayer#maximumVisibleSublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogDynamicGroupLayer.html#maximumVisibleSublayers) to a small number.
+ * >   * Set appropriate scale ranges on catalog items with many features in the service via [minScaleField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#minScaleField) and [maxScaleField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#maxScaleField) properties.
+ * >   * Set scale ranges on the CatalogDynamicGroupLayer via its [minsScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogDynamicGroupLayer.html#minScale) and [CatalogDynamicGroupLayer#maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogDynamicGroupLayer.html#maxScale)
+ * > properties to visualize `Layers in view` at appropriate scales.
+ *
+ * > [!WARNING]
+ * >
+ * > <span id="limits"></span>
+ * > **Known Limitations**
+ * >
+ * > In 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), the [CatalogDynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogDynamicGroupLayer.html) may load layers outside of the view's visible area. This will be improved in a future release.
+ *
+ * @since 4.30
+ * @see [CatalogDynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogDynamicGroupLayer.html)
+ * @see [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogFootprintLayer.html)
+ * @see [Sample - Intro to CatalogLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-cataloglayer/)
+ * @see [Sample - Explore data in CatalogLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-cataloglayer-2d/)
+ */
+export default class CatalogLayer extends CatalogLayerSuperclass {
+  /**
+   * @example
+   * // Typical usage
+   * // Create catalog layer from a service
+   * const layer = new CatalogLayer({
+   *   // URL to the service
+   *   url: "https://services3.arcgis.com/TVDq0jswpjtt1Xia/arcgis/rest/services/PNW_Forest_Fuels_Inventory_Status/FeatureServer"
+   * });
+   */
+  constructor(properties?: CatalogLayerProperties);
+  /**
+   * The draw order field holds the value to sort catalog items (layers). By default, layers with the highest values draw first (on the bottom), and the lowest values draw last (on top). This can be changed by specifying the
+   * [orderBy](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#orderBy) property.
+   *
+   * @default "cd_draworder"
+   */
+  get drawOrderField(): "cd_draworder";
+  /**
+   * The dynamicGroupLayer includes the catalog items (layers) that are currently visible in your view. Since it's dynamic, its list of
+   * layers in the [LayerList#catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogLayerList) changes as you interact with the map. By default, CatalogLayer draws up to 10 layers at a time.
+   * This default setting can be changed by adjusting the [CatalogDynamicGroupLayer#maximumVisibleSublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogDynamicGroupLayer.html#maximumVisibleSublayers) property.
+   *
+   * @example
+   * // Change the maximumVisibleSublayers of the dynamicGroupLayer after the catalog layer is loaded
+   * const layerView = await view.whenLayerView(layer);
+   * await reactiveUtils.whenOnce(() => !layerView.updating);
+   * layer.dynamicGroupLayer.maximumVisibleSublayers = 20;
+   */
+  get dynamicGroupLayer(): CatalogDynamicGroupLayer;
+  /**
+   * An array of fields in the layer. Each field represents an attribute that may contain a value for each feature in the layer.
+   * For example, a field named `cd_itemtype`, stores information about the type of the catalog item, such as `Feature Service` or `Map Service`.
+   *
+   * @example
+   * // Create popup template for the footprint layer after the catalog layer is loaded
+   * const layerView = await view.whenLayerView(layer);
+   *
+   * layer.footprintLayer.fields.forEach((field) => {
+   *   let fieldInfo = {
+   *     fieldName: field.name
+   *   };
+   *   fieldInfosArray.push(fieldInfo);
+   * });
+   *
+   * layer.footprintLayer.popupTemplate = new PopupTemplate({
+   *   title: layer.title,
+   *   fieldInfos: fieldInfosArray,
+   *   content: [
+   *     {
+   *       type: "fields"
+   *     }
+   *   ]
+   * });
+   */
+  get fields(): Field[];
+  /**
+   * The footprint layer is a layer that displays footprints of items referenced in a CatalogLayer. In the CatalogLayer, each service or item has a footprint, which is a visual
+   * representation covering all features, rasters, etc., within it. The attributes of each footprint feature provide details about the item's name, type, source, min and max scales.
+   *
+   * @example
+   * layer.footprintLayer.fields.forEach((field) => {
+   *   let fieldInfo = {
+   *     fieldName: field.name
+   *   };
+   *   fieldInfosArray.push(fieldInfo);
+   * });
+   *
+   * // Create popup template for the footprint layer and add a button in the popup template
+   * // When button is clicked, create a new layer for the catalog item associated with the clicked
+   * // footprint feature and add it to the map
+   * layer.footprintLayer.popupTemplate = new PopupTemplate({
+   *   title: layer.title,
+   *   fieldInfos: fieldInfosArray,
+   *   content: [
+   *     {
+   *       type: "fields"
+   *     }
+   *   ],
+   *   actions: [
+   *     {
+   *       type: "button",
+   *       id: "add-layer",
+   *       icon: "add-layer",
+   *       title: "Add layer"
+   *     }
+   *   ]
+   * });
+   *
+   * // Create a new layer for the catalog item associated from the clicked the footprint
+   * // feature and add it to the map when the button is clicked
+   * reactiveUtils.on(() => view.popup, "trigger-action", async (event) => {
+   *   if (event.action.id === "add-layer") {
+   *     const sublayer = await layer.createLayerFromFootprint(view.popup.selectedFeature);
+   *     map.layers.push(sublayer);
+   *  }
+   * });
+   */
+  get footprintLayer(): CatalogFootprintLayer;
+  /**
+   * The geometry type of features in the layer.
+   *
+   * @see [Add an array of client-side features](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#client-side)
+   */
+  get geometryType(): "polygon";
+  /**
+   * The item name field stores the name of the catalog item referenced in the CatalogLayer.
+   *
+   * @default "cd_itemname"
+   */
+  get itemNameField(): "cd_itemname";
+  /**
+   * The item source field stores the original source path of the catalog item.
+   *
+   * @default "cd_itemsource"
+   */
+  get itemSourceField(): "cd_itemsource";
+  /**
+   * The item type field stores the type of the catalog item, such as `Feature Service` or `Map Service`.
+   *
+   * @default "cd_itemtype"
+   */
+  get itemTypeField(): "cd_itemtype";
+  /** A collection of [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogFootprintLayer.html) and [CatalogDynamicGroupLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogDynamicGroupLayer.html). */
+  get layers(): Collection<CatalogDynamicGroupLayer | CatalogFootprintLayer>;
+  /**
+   * 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;
+  /**
+   * The max scale field holds the maximum scale at which the catalog item is visible in the view. If the map is zoomed in beyond this scale,
+   * the item will not be visible. A value of 0 or `null` means the catalog item does not have a maximum scale. The maxScale value should always be smaller
+   * than the minScale value, and greater than or equal to the service specification.
+   *
+   * @default "cd_maxscale"
+   */
+  get maxScaleField(): "cd_maxscale";
+  /**
+   * The min scale field holds the minimum scale at which the catalog item is visible in the view. If the map is zoomed in beyond this scale,
+   * the item will not be visible. A value of 0 or `null` means the catalog item does not have a minimum scale. The minScale value should always
+   * be larger than the maxScale value, and lesser than or equal to the service specification.
+   *
+   * @default "cd_minscale"
+   */
+  get minScaleField(): "cd_minscale";
+  /**
+   * An array of field names from the service to include with each feature. To fetch the values from all fields in the layer, use `["*"]`.
+   * Fields specified in `outFields` will be requested alongside with required fields for {@link layers/CatalogLayer#renderer rendering},
+   * {@link layers/CatalogLayer#labelingInfo labeling} and setting the [elevation info](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#elevationInfo) for the layer.
+   *
+   * @see [fieldUtils](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-fieldUtils.html)
+   * @example
+   * // Includes all fields from the service in the layer
+   * catalogLayer.outFields = ["*"];
+   * @example
+   * // Get the specified fields from the service in the layer. These fields will be added to
+   * // catalogFootprintLayerView.availableFields along with rendering and labeling fields.
+   * // Use these fields for client-side filtering and querying.
+   * catalogLayer.outFields = ["NAME", "POP_2010", "FIPS", "AREA"];
+   * @example
+   * // set the outFields for the layer coming from webmap
+   * webmap.when(function () {
+   *   const catalogLayer = webmap.layers.at(1);
+   *   catalogLayer.outFields = ["*"];
+   * });
+   */
+  accessor outFields: string[] | null | undefined;
+  /**
+   * The layer type provides a convenient way to check the type of the layer
+   * without the need to import specific layer modules.
+   */
+  get type(): "catalog";
+  /**
+   * The absolute URL of the REST endpoint of a catalog service.
+   *
+   * @example
+   * // Create a catalog layer from a service
+   * const layer = new CatalogLayer({
+   *   url: "https://services3.arcgis.com/TVDq0jswpjtt1Xia/arcgis/rest/services/PNW_Forest_Fuels_Inventory_Status/FeatureServer"
+   * });
+   * @example
+   * // Hosted Feature Service on ArcGIS Online
+   * layer.url = "http://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/origins/FeatureServer/0";
+   * @example
+   * // Layer from Map Service on ArcGIS Server
+   * layer.url = "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/2";
+   * @example
+   * // Can also be used if URL points to service and not layer
+   * const layer = new FeatureLayer({
+   *   // Notice that the url doesn't end with /2
+   *   url: "http://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/MonterreyBayCanyon_WFL/FeatureServer",
+   *   layerId: 2
+   * });
+   * @example
+   * // Non-spatial table in San Francisco incidents service.
+   * const table = new FeatureLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/SF311/FeatureServer/1"
+   * });
+   * // table must be loaded so it can be used in the app.
+   * table.load().then(function() {
+   *   // table is loaded. ready to be queried.
+   * });
+   */
+  accessor url: string | null | undefined;
+  /**
+   * Returns a footprint [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) that represents a layer in the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#dynamicGroupLayer).
+   * The layer can be created by calling [createLayerFromFootprint()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#createLayerFromFootprint),
+   * or found in the [CatalogDynamicGroupLayer#layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogDynamicGroupLayer.html#layers) collection.
+   *
+   * @param layer - A layer in a [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#dynamicGroupLayer) for which to obtain its footprint from.
+   * @returns The graphic representing the layer's footprint.
+   */
+  createFootprintFromLayer(layer: Layer): Graphic | null | undefined;
+  /**
+   * Creates a new instance of a layer for the given layer in the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#dynamicGroupLayer) based on its footprint feature.
+   * The instance of the footprint feature associated with the layer can be obtained by calling the [createFootprintFromLayer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#createFootprintFromLayer) method.
+   *
+   * @param footprint - The footprint feature used to instantiate a layer within its bounds.
+   * @returns When resolved, a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) instance is returned.
+   * @example
+   * // This example demonstrates how to create a new layer for the catalog item from its footprint feature.
+   * // Create popup template for a footprint layer, add a button to create a new layer from the footprint feature
+   * layer.footprintLayer.popupTemplate = new PopupTemplate({
+   *   title: "{cd_itemname}",
+   *   fieldInfos: fieldInfosArray,
+   *   actions: [
+   *     {
+   *       type: "button",
+   *       id: "add-layer",
+   *       icon: "add-layer",
+   *       title: "Add layer"
+   *    }
+   *   ]
+   * });
+   *
+   * // Create a new layer for a catalog item from the given footprint feature
+   * reactiveUtils.on(() => view.popup, "trigger-action", async (event) => {
+   *   if (event.action.id === "add-layer") {
+   *     const sublayer = await layer.createLayerFromFootprint(view.popup.selectedFeature);
+   *     map.layers.push(sublayer);
+   *   }
+   * });
+   */
+  createLayerFromFootprint(footprint: Graphic): Promise<Layer>;
+  /**
+   * Creates query parameter object that can be used to fetch features that satisfy the layer's configurations such as [definitionExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#definitionExpression).
+   * It will return `Z` and `M` values based on the layer's [data capabilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#capabilities).
+   * It sets the query parameter's [Query#outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outFields) property to `["*"]`.
+   * The results will include geometries of features and values for all {@link views/layers/CatalogFootprintLayerView#availableFields available fields} for
+   * {@link views/layers/CatalogFootprintLayerView#queryFeatures client-side queries} or all fields in the layer for [server side queries](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#queryFeatures).
+   *
+   * @returns The query object representing the layer's definition expression and other configurations.
+   * @see [Sample - Explore data in CatalogLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-cataloglayer-2d/)
+   * @example
+   * // Get a query object for the layer's current configuration and set
+   * // additional parameters to filter features by a region of interest and type
+   * const queryParams = footprintLayer.createQuery();
+   * // set a geometry for filtering features by a region of interest
+   * queryParams.geometry = extentForRegionOfInterest;
+   * // Add to the layer's current definitionExpression
+   * queryParams.where = queryParams.where + " AND TYPE = 'Extreme'";
+   *
+   * // query the layer with the modified params object
+   * footprintLayer.queryFeatures(queryParams).then((results) =>{
+   *   // prints the array of result graphics to the console
+   *   console.log(results.features);
+   * });
+   */
+  createQuery(): Query;
+  /**
+   * Executes an [AttributeBinsQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttributeBinsQuery.html) against a CatalogLayer, which groups features into bins based on ranges in numeric or date fields, and returns an
+   * [AttributeBinsFeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttributeBinsFeatureSet.html) containing the series of bins. Please refer to the [AttributeBinsQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttributeBinsQuery.html) document for more detailed information
+   * on how to configure the bin parameters.
+   *
+   * Binned data can condense complex information into meaningful insight. This query allows you to classify data into meaningful categories and summarize the data within each bin with summary statistics.
+   * Binned data can be effectively visualized in histograms (or bar charts), providing clearer insights into data distributions and trends.
+   * It can reveal underlying patterns that might be obscured in raw data. For example, bins can show concentrations of values in common ranges.
+   *
+   * > [!WARNING]
+   * >
+   * > **Notes**
+   * > The `queryAttributeBins()` method is unrelated to querying bins in [FeatureReductionBinning](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html).
+   *
+   * @param binsQuery - Specifies the parameters of the `queryAttributeBins()` operation. The [AttributeBinsQuery#binParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttributeBinsQuery.html#binParameters) property must be set.
+   * @param options - An object with the following properties.
+   * @returns When resolved, returns an [AttributeBinsFeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttributeBinsFeatureSet.html) containing
+   * a series of bins. Each feature in the AttributeBinsFeatureSet represents a bin. The attributes of each feature contains statistics summarizing the data in the bin, including count, average, standard deviation, etc.
+   * @since 4.33
+   * @see [AttributeBinsQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttributeBinsQuery.html)
+   * @see [Sample - Attribute Bins Query](https://developers.arcgis.com/javascript/latest/sample-code/query-attribute-bins/)
+   * @example
+   * // Query the temperature field in the feature layer and create a histogram
+   * // Analyze temperature data over a year, create 100 bins for different temperature ranges
+   * // to assess frequency and identify patterns.
+   * const binQuery = new AttributeBinsQuery({
+   *   where: "UnitTop = 0",
+   *   binParameters: new AutoIntervalBinParameters({
+   *     bins: 100,
+   *     field: "temp",
+   *     start: 0, // lowest temp value to be included in the bin query
+   *     end: 30 // highest temp value to be included
+   *   })
+   * });
+   *
+   * layer.queryAttributeBins(query).then((results) => {
+   *   const bins = results.features.map((bin) => {
+   *     return {
+   *       minValue: bin.attributes.lowerBoundary,
+   *       maxValue: bin.attributes.upperBoundary,
+   *       count: bin.attributes.temperature_count,
+   *     };
+   *   });
+   *
+   *   // get the lower boundary of the first bin
+   *   const min = results.features[0].attributes.lowerBoundary;
+   *   // get the upper boundary of the last bin
+   *   const max = results.features[results.features.length - 1].attributes.upperBoundary;
+   *   // calculate the average for the bins
+   *   const average = results.features[0].attributes.lowerBoundary + results.features[results.features.length - 1].attributes.upperBoundary) / 2;
+   *
+   *   const histogram = new Histogram({
+   *     container: "histogramDiv",
+   *     bins: bins,
+   *     min: min,
+   *     max: max,
+   *     average: average,
+   *     barCreatedFunction:(index, element) => {
+   *       element.setAttribute("fill", "#FFA500");
+   *       element.setAttribute("opacity", 0.5);
+   *     },
+   *     labelFormatFunction: (value, type) => {
+   *       return (Math.round(value)).toLocaleString();
+   *     },
+   *     dataLines: [{
+   *       value: histogram.min,
+   *       label: histogram.min.toLocaleString()
+   *     }, {
+   *       value: histogram.average,
+   *       label: histogram.average.toLocaleString()
+   *     }, {
+   *       value: histogram.max,
+   *       label: histogram.max.toLocaleString()
+   *     }]
+   *   });
+   * });
+   */
+  queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: RequestOptions): Promise<AttributeBinsFeatureSet>;
+  /**
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the feature service and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. If no
+   * parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned.
+   *
+   * > [!WARNING]
+   * >
+   * > To query for the extent of features/graphics available to or visible in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) on the client rather than making a server-side query, you must
+   * > use the {@link views/layers/CatalogFootprintLayerView#queryExtent} method.
+   *
+   * @param query - Specifies the attributes and spatial filter of the query. If no parameters are specified, then the extent and count of all features
+   * satisfying the layer's configuration/filters are returned.
+   * @param options - An object with the following properties.
+   * @returns When resolved, returns the extent and count of the features that satisfy the input query. See the object specification table below for details.
+   * Property | Type | Description
+   * ---------|------|-------------
+   * count | Number | The number of features that satisfy the input query.
+   * extent | [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) \| null | The extent of the features that satisfy the query.
+   * @example
+   * // Queries for the extent of all features matching the layer's configurations
+   * // e.g. definitionExpression
+   * layer.queryExtent().then(function(results){
+   *   // go to the extent of the results satisfying the query
+   *   view.goTo(results.extent);
+   * });
+   * @example
+   * const query = new Query();
+   * query.where = "region = 'Southern California'";
+   *
+   * layer.queryExtent(query).then((results) =>{
+   *   view.goTo(results.extent);  // go to the extent of the results satisfying the query
+   * });
+   */
+  queryExtent(query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<{
+      count: number;
+      extent: Extent | null;
+  }>;
+  /**
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the service and returns the number of features that satisfy the query. If no parameters are specified,
+   * then the total number of features satisfying the layer's configuration/filters is returned.
+   *
+   * @param query - Specifies the attributes and spatial filter of the query.
+   * When no parameters are passed to this method, all features in the client are returned. To only return features
+   * visible in the view, set the `geometry` parameter in the query object to the view's extent.
+   * @param options - An object with the following properties.
+   * @returns When resolved, returns an the number of features satisfying the query.
+   * @example
+   * // returns a count of all features in the layer
+   * const count = await layer.queryFeatureCount();
+   * console.log("Feature count: ", count);
+   */
+  queryFeatureCount(query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<number>;
+  /**
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) once the promise resolves.
+   * A [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, which can be added to the [view's graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics). This array will not be populated if zero results are found.
+   *
+   * @param query - Specifies the attributes and spatial filter of the query. When no parameters are passed to this method,
+   * all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent.
+   * @param options - An object with the following properties.
+   * @returns When resolved, a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) containing
+   * an array of graphic features is returned.
+   * @see [Sample - Explore data in CatalogLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-cataloglayer-2d/)
+   * @see [Query and filter guide](https://developers.arcgis.com/javascript/latest/query-filter/)
+   * @example
+   * // Queries for all the features in the service
+   * catalogLayer.queryFeatures().then((results) => {
+   *   // prints the array of result graphics to the console
+   *   console.log(results.features);
+   * });
+   * @example
+   * // query all feature service types from the catalog layer
+   * let query = new Query({
+   *   where: "cd_itemtype = 'Feature Service'",
+   *   returnGeometry: true
+   * });
+   *
+   * catalogLayer.queryFeatures(query).then((results) => {
+   *   processResults(results);
+   * })
+   * .catch(function (error) {
+   *   console.log(error)
+   * });
+   */
+  queryFeatures(query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<FeatureSet>;
+  /**
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the service 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.
+   * When no parameters are passed to this method, all features in the client are returned. To only return features
+   * visible in the view, set the `geometry` parameter in the query object to the view's extent.
+   * @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.
+   * @example
+   * // Queries for all the Object IDs of features
+   * const result = await catalogLayer.queryObjectIds();
+   * // prints the array of Object IDs to the console
+   * console.log(result);
+   * @example
+   * const query = new Query({
+   *   where: "state = California"
+   * });
+   *
+   * //query objectIds of features belonging to California
+   * catalogLayer.queryObjectIds(query).then((ids) => {
+   *   console.log(ids);  // an array of object IDs
+   * });
+   */
+  queryObjectIds(query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<ObjectId[]>;
+}
+declare const CatalogLayerSuperclass: typeof Layer & typeof APIKeyMixin & typeof CustomParametersMixin & typeof MultiOriginJSONMixin & typeof PortalLayer & typeof OperationalLayer & typeof ArcGISService & typeof RefreshableLayer & typeof ScaleRangeLayer & typeof TemporalLayer & typeof OrderedLayer & typeof BlendLayer & typeof EditBusLayer & typeof FeatureLayerBase & typeof DisplayFilteredLayer