@arcgis/core 5.2.0-next.6 → 5.2.0-next.8

package/layers/DimensionFeatureLayer.d.ts

@@ -1,42 +1,273 @@
-import type { __FeatureLayerSansType } from "./FeatureLayer.js";
-import type FeatureLayer from "./FeatureLayer.js";
-import type { FeatureLayerProperties } from "./FeatureLayer.js";
+import type PopupTemplate from "../PopupTemplate.js";
+import type Extent from "../geometry/Extent.js";
+import type Layer from "./Layer.js";
+import type Field from "./support/Field.js";
+import type FeatureSet from "../rest/support/FeatureSet.js";
+import type Query from "../rest/support/Query.js";
+import type { ClonableMixin } from "../core/Clonable.js";
+import type { MultiOriginJSONSupportMixin } from "../core/MultiOriginJSONSupport.js";
+import type { LayerEvents, LayerProperties } from "./Layer.js";
+import type { APIKeyMixin, APIKeyMixinProperties } from "./mixins/APIKeyMixin.js";
+import type { BlendLayer, BlendLayerProperties } from "./mixins/BlendLayer.js";
+import type { CustomParametersMixin, CustomParametersMixinProperties } from "./mixins/CustomParametersMixin.js";
+import type { EditBusLayerEvents } from "./mixins/EditBusLayer.js";
+import type { FeatureLayerBase, FeatureLayerBaseProperties } from "./mixins/FeatureLayerBase.js";
+import type { OperationalLayer, OperationalLayerProperties } from "./mixins/OperationalLayer.js";
+import type { PortalLayer, PortalLayerProperties } from "./mixins/PortalLayer.js";
+import type { RefreshableLayer, RefreshableLayerEvents, 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/types.js";
+import type { QueryProperties } from "../rest/support/Query.js";
+import type { CreatePopupTemplateOptions } from "../support/popupUtils.js";
+import type { ObjectId } from "../views/types.js";
+import type { PopupTemplateProperties } from "../PopupTemplate.js";
 
-export interface DimensionFeatureLayerProperties extends FeatureLayerProperties {}
+export interface DimensionFeatureLayerProperties extends LayerProperties, APIKeyMixinProperties, CustomParametersMixinProperties, PortalLayerProperties, OperationalLayerProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, BlendLayerProperties, FeatureLayerBaseProperties, Partial<Pick<DimensionFeatureLayer, "outFields" | "popupEnabled">> {
+  /**
+   * The popup template for the layer. When set on the layer, the `popupTemplate`
+   * allows users to access attributes and display their values in the
+   * view's Popup when a feature is selected
+   * using text and/or charts. See the [PopupTemplate sample](https://developers.arcgis.com/javascript/latest/sample-code/intro-popuptemplate/)
+   * for an example of how [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) interacts with a
+   * [DimensionFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/DimensionFeatureLayer/).
+   *
+   * A default popup template is automatically used if no `popupTemplate` has been defined when
+   * [Popup.defaultPopupTemplateEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/#defaultPopupTemplateEnabled)
+   * is set to `true`.
+   *
+   * @see [createPopupTemplate()](https://developers.arcgis.com/javascript/latest/references/core/layers/DimensionFeatureLayer/#createPopupTemplate)
+   * @see [SceneView.popup](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#popup)
+   * @see [View2D.popup](https://developers.arcgis.com/javascript/latest/references/core/views/View2D/#popup)
+   */
+  popupTemplate?: PopupTemplateProperties | null;
+}
 
-export default class DimensionFeatureLayer extends __FeatureLayerSansType {
+export interface DimensionFeatureLayerEvents extends EditBusLayerEvents, RefreshableLayerEvents, LayerEvents {}
+
+export default class DimensionFeatureLayer extends DimensionFeatureLayerSuperclass {
+  /**
+   * @deprecated
+   * Do not directly reference this property.
+   * Use EventNames and EventTypes helpers from \@arcgis/core/Evented
+   */
+  "@eventTypes": DimensionFeatureLayerEvents;
   /**
    * @example
-   * const dimensionFeatureLayer = new DimensionFeatureLayer({
-   *   url: "..."
+   * // Create a dimension feature layer from a feature service layer URL.
+   * ```js
+   * const layer = new DimensionFeatureLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Dimensions/FeatureServer/0"
    * });
-   * @see [Client-side FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#client-side)
+   * ```
+   */
+  constructor(properties?: DimensionFeatureLayerProperties);
+  /**
+   * An array of fields in the layer.
+   *
+   * @see [objectIdField](https://developers.arcgis.com/javascript/latest/references/core/layers/DimensionFeatureLayer/#objectIdField)
+   */
+  get fields(): Field[];
+  /**
+   * An array of field names from the service to include with each feature.
+   * To fetch the values from all fields in the layer, use `["*"]`.
+   * Set this property to include the fields that will be used for client-side
+   * [queries](https://developers.arcgis.com/javascript/latest/references/core/views/layers/DimensionFeatureLayerView/#queryFeatures)
+   * if the fields are not part of required fields.
+   *
+   * @see [DimensionFeatureLayerView.availableFields](https://developers.arcgis.com/javascript/latest/references/core/views/layers/DimensionFeatureLayerView/#availableFields)
+   * @see [fieldUtils](https://developers.arcgis.com/javascript/latest/references/core/layers/support/fieldUtils/)
    * @example
-   * // Typical usage
-   * // Create featurelayer from feature service
-   * const layer = new FeatureLayer({
-   *   // URL to the service
-   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer/0"
-   * });
+   * // Includes all fields from the service in the layer
+   * layer.outFields = ["*"];
+   * @example
+   * // Get the specified fields from the service in the layer.
+   * // These fields will be added to DimensionFeatureLayerView.availableFields.
+   * // Use these fields for client-side filtering and querying.
+   * layer.outFields = ["NAME", "POP_2010", "FIPS", "AREA"];
+   */
+  accessor outFields: string[] | 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/references/core/layers/DimensionFeatureLayer/#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/references/core/widgets/Popup/#defaultPopupTemplateEnabled) is set to `true`.
    *
-   * // Typical usage
-   * // Create featurelayer from client-side graphics
-   * const layer = new FeatureLayer({
-   *   source: graphics,
-   *   fields: [{
-   *     name: "ObjectID",
-   *     alias: "ObjectID",
-   *     type: "oid"
-   *   }, {
-   *     name: "place",
-   *     alias: "Place",
-   *     type: "string"
-   *   }],
-   *   objectIdField: "ObjectID",
-   *   geometryType: "point"
-   * });
+   * @default true
+   * @see [createPopupTemplate()](https://developers.arcgis.com/javascript/latest/references/core/layers/DimensionFeatureLayer/#createPopupTemplate)
+   * @see [SceneView.popup](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#popup)
+   * @see [View2D.popup](https://developers.arcgis.com/javascript/latest/references/core/views/View2D/#popup)
    */
-  constructor(properties?: DimensionFeatureLayerProperties);
+  accessor popupEnabled: boolean;
+  /**
+   * The popup template for the layer. When set on the layer, the `popupTemplate`
+   * allows users to access attributes and display their values in the
+   * view's Popup when a feature is selected
+   * using text and/or charts. See the [PopupTemplate sample](https://developers.arcgis.com/javascript/latest/sample-code/intro-popuptemplate/)
+   * for an example of how [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) interacts with a
+   * [DimensionFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/DimensionFeatureLayer/).
+   *
+   * A default popup template is automatically used if no `popupTemplate` has been defined when
+   * [Popup.defaultPopupTemplateEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/#defaultPopupTemplateEnabled)
+   * is set to `true`.
+   *
+   * @see [createPopupTemplate()](https://developers.arcgis.com/javascript/latest/references/core/layers/DimensionFeatureLayer/#createPopupTemplate)
+   * @see [SceneView.popup](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#popup)
+   * @see [View2D.popup](https://developers.arcgis.com/javascript/latest/references/core/views/View2D/#popup)
+   */
+  get popupTemplate(): PopupTemplate | null | undefined;
+  set popupTemplate(value: PopupTemplateProperties | 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(): "dimension-feature";
-}
+  /**
+   * Creates a popup template for the layer, populated with all the fields of the layer.
+   *
+   * @param options - Options for creating the popup template.
+   * @returns The popup template, or `null` if the layer does not
+   * have any fields.
+   */
+  createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | null | undefined;
+  /**
+   * Creates a query object that respects the layer's current filters.
+   *
+   * @returns A query object initialized from the layer configuration.
+   */
+  createQuery(): Query;
+  /**
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/) against the feature service and
+   * returns the [Extent](https://developers.arcgis.com/javascript/latest/references/core/geometry/Extent/) 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/references/core/views/View/) on the client rather than making a server-side query, you must use the
+   * > [DimensionFeatureLayerView.queryExtent()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/DimensionFeatureLayerView/#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/references/core/geometry/Extent/) \| null | The extent of the features that satisfy the query.
+   * @see [Sample - Zoom to extent of all features](https://developers.arcgis.com/javascript/latest/sample-code/featurelayer-queryextent/)
+   * @example
+   * // Queries for the extent of all features matching the layer's configurations
+   * // e.g. definitionExpression
+   * layer.queryExtent().then((results) => {
+   *   // go to the extent of the results satisfying the query
+   *   view.goTo(results.extent);
+   * });
+   */
+  queryExtent(query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<{
+      count: number;
+      extent: Extent | null;
+  }>;
+  /**
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/) against the feature service 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.
+   *
+   * > [!WARNING]
+   * >
+   * > To query for the count of features/graphics available to or visible in the [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/)
+   * > on the client rather than making a server-side query, you must use the
+   * > [DimensionFeatureLayerView.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/DimensionFeatureLayerView/#queryFeatureCount) method.
+   *
+   * @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.
+   * @see [Sample - Query features from a FeatureLayer](https://developers.arcgis.com/javascript/latest/sample-code/featurelayer-query/)
+   * @example
+   * // Queries for the count of all features matching the layer's configurations
+   * // e.g. definitionExpression
+   * layer.queryFeatureCount().then((numFeatures) => {
+   *   // prints the total count to the console
+   *   console.log(numFeatures);
+   * });
+   */
+  queryFeatureCount(query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<number>;
+  /**
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/) against the feature service and returns a
+   * [FeatureSet](https://developers.arcgis.com/javascript/latest/references/core/rest/support/FeatureSet/) once the promise resolves.
+   * A [FeatureSet](https://developers.arcgis.com/javascript/latest/references/core/rest/support/FeatureSet/) contains an array of [features](https://developers.arcgis.com/javascript/latest/references/core/Graphic/).
+   * See the [querying](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#querying)
+   * section for more information on how to query features from a layer.
+   *
+   * > [!WARNING]
+   * >
+   * > **Notes**
+   * >
+   * > To query features available to or visible in the [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) on the client rather than making a server-side query, you must
+   * > use the [DimensionFeatureLayerView.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/DimensionFeatureLayerView/#queryFeatures) method.
+   * >
+   * > When querying a service with z-values and no [vertical coordinate system](https://doc.esri.com/en/arcgis-pro/latest/help/mapping/properties/vertical-coordinate-systems.html) information,
+   * > the z-values will automatically be converted to match the [Query.outSpatialReference](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/#outSpatialReference) units.
+   * > Example: The service has a horizontal spatial reference using `feet` units and the query is made with `outSpatialReference`
+   * > based on `meter` units, then [queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/layers/DimensionFeatureLayer/#queryFeatures) automatically converts the values from `feet` to `meter` units.
+   *
+   * @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 When resolved, a [FeatureSet](https://developers.arcgis.com/javascript/latest/references/core/rest/support/FeatureSet/) containing
+   * an array of graphic features is returned.
+   * @see [Sample - Query features from a FeatureLayer](https://developers.arcgis.com/javascript/latest/sample-code/featurelayer-query/)
+   * @see [Query and filter guide](https://developers.arcgis.com/javascript/latest/query-filter/)
+   * @example
+   * // Queries for all the features matching the layer's configurations
+   * // e.g. definitionExpression
+   * layer.queryFeatures().then((results) => {
+   *   // prints the array of result graphics to the console
+   *   console.log(results.features);
+   * });
+   * @example
+   * const layer = new DimensionFeatureLayer({
+   *   url: fsUrl  // points to a Feature Service layer url
+   * });
+   *
+   * const query = new Query();
+   * query.where = "STATE_NAME = 'Washington'";
+   * query.outSpatialReference = { wkid: 102100 };
+   * query.returnGeometry = true;
+   * query.outFields = [ "CITY_NAME" ];
+   *
+   * layer.queryFeatures(query).then((results) => {
+   *   console.log(results.features);  // prints the array of features to the console
+   * });
+   */
+  queryFeatures(query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<FeatureSet>;
+  /**
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/) against the feature 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.
+   *
+   * > [!WARNING]
+   * >
+   * > To query for ObjectIDs of features available to or visible in the [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) on the client rather
+   * > than making a server-side query, you must use the
+   * > [DimensionFeatureLayerView.queryObjectIds()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/DimensionFeatureLayerView/#queryObjectIds) method.
+   *
+   * @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.
+   * @see [Sample - Query Related Features](https://developers.arcgis.com/javascript/latest/sample-code/query-related-features/)
+   * @example
+   * // Queries for all the Object IDs of features matching the layer's configurations
+   * // e.g. definitionExpression
+   * layer.queryObjectIds().then((results) => {
+   *   // prints the array of Object IDs to the console
+   *   console.log(results);
+   * });
+   */
+  queryObjectIds(query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<ObjectId[]>;
+}
+declare const DimensionFeatureLayerSuperclass: typeof Layer & typeof ClonableMixin & typeof APIKeyMixin & typeof CustomParametersMixin & typeof MultiOriginJSONSupportMixin & typeof PortalLayer & typeof OperationalLayer & typeof RefreshableLayer & typeof ScaleRangeLayer & typeof TemporalLayer & typeof BlendLayer & typeof FeatureLayerBase

package/layers/DimensionFeatureLayer.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{__decorate as e}from"tslib";import r from"../request.js";import t from"../core/Error.js";import{join as o}from"../core/urlUtils.js";import{subclass as s}from"../core/accessorSupport/decorators.js";import{property as a}from"../core/accessorSupport/decorators/property.js";import i from"./FeatureLayer.js";let n=class extends i{constructor(e){super(e),this.supportedSourceTypes=new Set(["Dimension Layer","Dimension SubLayer"]),this.type="dimension-feature",this._dataElementPromise=null}async fetchDataElement(e){if(this._dataElementPromise)return this._dataElementPromise;if(!this.url)throw new Error("InternalError: A URL is required to retrieve the data element for this layer.");const s=o(this.url,"queryDataElements"),a={f:"json",layers:this.layerId};return this._dataElementPromise=r(s,{...e,responseType:"json",query:a}).then(e=>{const r=e.data.layerDataElements,o=this.layerId,s=r.find(e=>e.layerId===o);if(!s)throw new t("fetchDataElement:not-available","A data element for this layer could not be retrieved.");return s.dataElement}),this._dataElementPromise}};e([a({json:{read:!1},value:"dimension-feature",readOnly:!0})],n.prototype,"type",void 0),n=e([s("esri.layers.DimensionFeatureLayer")],n);const l=n;export{l as default};
+import{__addDisposableResource as e,__disposeResources as r,__decorate as t}from"tslib";import i from"../PopupTemplate.js";import s from"../request.js";import{ClonableMixin as o}from"../core/Clonable.js";import a from"../core/Error.js";import{disposable as n,makeHandle as p}from"../core/handleUtils.js";import{MultiOriginJSONSupportMixin as l}from"../core/MultiOriginJSONSupport.js";import{throwIfAbortError as u,whenOrAbort as d,onAbort as m}from"../core/promiseUtils.js";import{join as c}from"../core/urlUtils.js";import{property as h,subclass as y}from"../core/accessorSupport/decorators.js";import f from"../graphic/DimensionFeatureGraphicOrigin.js";import g from"./Layer.js";import{APIKeyMixin as j}from"./mixins/APIKeyMixin.js";import{ArcGISService as E}from"./mixins/ArcGISService.js";import{BlendLayer as v}from"./mixins/BlendLayer.js";import{CustomParametersMixin as S}from"./mixins/CustomParametersMixin.js";import{FeatureLayerBase as b}from"./mixins/FeatureLayerBase.js";import{OperationalLayer as I}from"./mixins/OperationalLayer.js";import{PortalLayer as L}from"./mixins/PortalLayer.js";import{RefreshableLayer as P}from"./mixins/RefreshableLayer.js";import{ScaleRangeLayer as w}from"./mixins/ScaleRangeLayer.js";import{TemporalLayer as x}from"./mixins/TemporalLayer.js";import{barrierWeight as O,popupEnabled as F}from"./support/commonProperties.js";import{ensureLayerCredential as T,createQuery as q,getFieldDomain as D,hasDataChanged as _}from"./support/featureLayerUtils.js";import{defineFieldProperties as U}from"./support/fieldProperties.js";import{fixTimeInfoFields as A}from"./support/fieldUtils.js";import{serviceSupportsSpatialReference as G}from"./support/versionUtils.js";import Q from"../rest/support/Query.js";import{createPopupTemplate as C}from"../support/popupUtils.js";const J="dimension-feature-layer",N=U();let R=class extends(b(v(x(w(P(E(I(L(l(S(j(o(g))))))))))))){constructor(e){super(e),this.barrierWeight="high",this.fields=null,this.fieldsIndex=null,this.graphicOrigin=new f(this),this.operationalLayerType="ArcGISDimensionLayer",this.outFields=null,this.popupEnabled=!0,this.popupTemplate=null,this.source=null,this.supportedSourceTypes=new Set(["Dimension Layer"]),this.type="dimension-feature",this._dataElementPromise=null}destroy(){this.source?.destroy()}load(e){const r=e?.signal,t=this.loadFromPortal({supportedTypes:["Feature Service"]},e).catch(u).then(async()=>{if(this.url&&null==this.layerId&&/FeatureServer|MapServer\/*$/i.test(this.url)){const e=await this._fetchFirstValidLayerId(r);null!=e&&(this.layerId=e)}if(!this.url)throw new a(`${J}:missing-url`,"DimensionFeatureLayer must be created with a url");return this.initLayerProperties(await this.createGraphicsSource(r))}).then(()=>T(this,"load",e));return this.addResolvingPromise(t),Promise.resolve(this)}get editingEnabled(){return this._isOverridden("editingEnabled")?this._get("editingEnabled"):this.loaded&&null!=this.capabilities&&this.capabilities.operations.supportsEditing&&this.userHasEditingPrivileges}set editingEnabled(e){this._overrideIfSome("editingEnabled",e)}get effectiveEditingEnabled(){return!1}get defaultPopupTemplate(){return this.createPopupTemplate()}createPopupTemplate(e){return C(this,e)}async createGraphicsSource(t){const i={stack:[],error:void 0,hasError:!1};try{const{default:r}=await d(import("./graphics/sources/FeatureLayerSource.js"),t),s=new r({layer:this,supportedSourceTypes:this.supportedSourceTypes});e(i,n(m(t,()=>s.cancelLoad())??p()),!1);return await s.load({signal:t}),s}catch(s){i.error=s,i.hasError=!0}finally{r(i)}}createQuery(){const e=q(this);return e.where=this.definitionExpression||"1=1",e}async fetchDataElement(e){if(this._dataElementPromise)return this._dataElementPromise;if(!this.url)throw new Error("InternalError: A URL is required to retrieve the data element for this layer.");const r=c(this.url,"queryDataElements"),t={f:"json",layers:this.layerId};return this._dataElementPromise=s(r,{...e,responseType:"json",query:t}).then(e=>{const r=e.data.layerDataElements,t=this.layerId,i=r.find(e=>e.layerId===t);if(!i)throw new a("fetchDataElement:not-available","A data element for this layer could not be retrieved.");return i.dataElement}),this._dataElementPromise}getFieldDomain(e,r){return D(this,e,r,this.getField(e)?.domain??null)}async queryFeatures(e,r){const t=await this.load(),i=await t.source.queryFeatures(Q.from(e)??t.createQuery(),r),s=this.graphicOrigin;if(i?.features)for(const o of i.features)o.layer=o.sourceLayer=t,o.origin=s;return i}async queryObjectIds(e,r){const t=await this.load();return t.source.queryObjectIds(Q.from(e)??t.createQuery(),r)}async queryFeatureCount(e,r){const t=await this.load();return t.source.queryFeatureCount(Q.from(e)??t.createQuery(),r)}async queryExtent(e,r){const t=await this.load();return t.source.queryExtent(Q.from(e)??t.createQuery(),r)}serviceSupportsSpatialReference(e){return this.loaded&&G(this,e)}async initLayerProperties(e){this._set("source",e),e.sourceJSON&&(this.sourceJSON=e.sourceJSON,this.read(e.sourceJSON,{origin:"service",portalItem:this.portalItem,portal:this.portalItem?.portal,url:this.parsedUrl})),A(this.timeInfo,this.fieldsIndex)}async hasDataChanged(){return _(this)}_fetchFirstValidLayerId(e){return s(this.url??"",{query:{f:"json",...this.customParameters,token:this.apiKey},responseType:"json",signal:e}).then(e=>{const r=e.data;if(!r)return;this.applyPreferredHost(r);const t=[...r.layers||[],...r.tables||[]];return t.find(({type:e})=>!e||this.supportedSourceTypes.has(e))?.id})}};t([h(O)],R.prototype,"barrierWeight",void 0),t([h({json:{write:!0}})],R.prototype,"editingEnabled",null),t([h({readOnly:!0})],R.prototype,"effectiveEditingEnabled",null),t([h({...N.fields,readOnly:!0,json:{read:!1,origins:{service:{read:!0}}}})],R.prototype,"fields",void 0),t([h(N.fieldsIndex)],R.prototype,"fieldsIndex",void 0),t([h({readOnly:!0,clonable:!1})],R.prototype,"graphicOrigin",void 0),t([h({type:["ArcGISDimensionLayer"]})],R.prototype,"operationalLayerType",void 0),t([h(N.outFields)],R.prototype,"outFields",void 0),t([h(F)],R.prototype,"popupEnabled",void 0),t([h({type:i,json:{name:"popupInfo",write:!0}})],R.prototype,"popupTemplate",void 0),t([h({readOnly:!0})],R.prototype,"defaultPopupTemplate",null),t([h({clonable:!1,readOnly:!0})],R.prototype,"source",void 0),t([h({json:{read:!1},value:"dimension-feature",readOnly:!0})],R.prototype,"type",void 0),R=t([y("esri.layers.DimensionFeatureLayer")],R);const M=R;export{M as default};

package/layers/FeatureLayer.d.ts

@@ -9,6 +9,7 @@ import type FeatureType from "./support/FeatureType.js";
 import type Field from "./support/Field.js";
 import type FieldConfiguration from "./support/FieldConfiguration.js";
 import type LabelClass from "./support/LabelClass.js";
+import type Subtype from "./support/Subtype.js";
 import type SymbolLayerDrawing from "./support/SymbolLayerDrawing.js";
 import type PortalItem from "../portal/PortalItem.js";
 import type DynamicDataLayer from "../rest/layerSources/DynamicDataLayer.js";
@@ -26,6 +27,7 @@ import type { LayerSaveAsOptions, LayerSaveOptions, FeatureTitleOptions } from "
 import type { APIKeyMixin, APIKeyMixinProperties } from "./mixins/APIKeyMixin.js";
 import type { BlendLayer, BlendLayerProperties } from "./mixins/BlendLayer.js";
 import type { CustomParametersMixin, CustomParametersMixinProperties } from "./mixins/CustomParametersMixin.js";
+import type { DataSeriesLayer, DataSeriesLayerProperties } from "./mixins/DataSeriesLayer.js";
 import type { DisplayFilteredLayer, DisplayFilteredLayerProperties } from "./mixins/DisplayFilteredLayer.js";
 import type { EditBusLayer, EditBusLayerEvents } from "./mixins/EditBusLayer.js";
 import type { FeatureEffectLayer, FeatureEffectLayerProperties } from "./mixins/FeatureEffectLayer.js";
@@ -67,7 +69,7 @@ import type { SimpleRendererProperties } from "../renderers/SimpleRenderer.js";
 import type { FeatureTemplateProperties } from "./support/FeatureTemplate.js";
 import type { FeatureTypeProperties } from "./support/FeatureType.js";
 
-export interface FeatureLayerProperties extends LayerProperties, APIKeyMixinProperties, CustomParametersMixinProperties, PortalLayerProperties, OperationalLayerProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, TrackableLayerProperties, TemporalLayerProperties, OrderedLayerProperties, BlendLayerProperties, DisplayFilteredLayerProperties, PublishableLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, FeatureLayerBaseProperties, Partial<Pick<FeatureLayer, "charts" | "editingEnabled" | "labelsVisible" | "legendEnabled" | "outFields" | "popupEnabled" | "screenSizePerspectiveEnabled" | "typeIdField" | "uniqueIdFields">> {
+export interface FeatureLayerProperties extends LayerProperties, APIKeyMixinProperties, CustomParametersMixinProperties, PortalLayerProperties, OperationalLayerProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, TrackableLayerProperties, DataSeriesLayerProperties, TemporalLayerProperties, OrderedLayerProperties, BlendLayerProperties, DisplayFilteredLayerProperties, PublishableLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, FeatureLayerBaseProperties, Partial<Pick<FeatureLayer, "charts" | "editingEnabled" | "labelsVisible" | "legendEnabled" | "outFields" | "popupEnabled" | "screenSizePerspectiveEnabled" | "typeIdField" | "uniqueIdFields">> {
   /**
    * This property is used to configure the associated layer's [Feature Table](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/). It is meant to configure how the columns display within the table in regard to visibility, column order, and sorting.
    *
@@ -93,7 +95,7 @@ export interface FeatureLayerProperties extends LayerProperties, APIKeyMixinProp
    * method on the Sublayer to construct the layer for you.
    *
    * This only applies to map services with
-   * [dynamic layers](https://enterprise.arcgis.com/en/server/latest/publish-services/linux/about-dynamic-layers.htm) enabled.
+   * [dynamic layers](https://doc.esri.com/en/arcgis-enterprise/latest/administer/about-dynamic-layers.html) enabled.
    *
    * > [!WARNING]
    * >
@@ -162,6 +164,7 @@ export interface FeatureLayerProperties extends LayerProperties, APIKeyMixinProp
    * @see [FeatureLayer.getFieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#getFieldConfiguration)
    * @see [FeatureLayer.getFieldAlias](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#getFieldAlias)
    * @example
+   * ```js
    * // Adding a new field configuration
    * const addNewConfig = (layer, fieldName, alias, fieldFormat) => {
    *   // Check if there is already an existing configuration for fieldName
@@ -173,7 +176,9 @@ export interface FeatureLayerProperties extends LayerProperties, APIKeyMixinProp
    *     layer.fieldConfigurations = newConfigs;
    *   }
    * };
+   * ```
    * @example
+   * ```js
    * // Updating an existing field configuration
    * const updateConfig = (layer, fieldName, alias, fieldFormat) => {
    *   const existingConfig = layer.getFieldConfiguration(fieldName);
@@ -188,7 +193,9 @@ export interface FeatureLayerProperties extends LayerProperties, APIKeyMixinProp
    *     layer.fieldConfigurations = newConfigs;
    *   }
    * };
+   * ```
    * @example
+   * ```js
    * // Deleting an existing field configuration
    * const deleteConfig = (layer, fieldName) => {
    *   const existingConfig = layer.getFieldConfiguration(fieldName);
@@ -199,6 +206,7 @@ export interface FeatureLayerProperties extends LayerProperties, APIKeyMixinProp
    *     layer.fieldConfigurations = newConfigs;
    *   }
    * };
+   * ```
    */
   fieldConfigurations?: FieldConfigurationProperties[] | null;
   /**
@@ -437,6 +445,14 @@ export interface FeatureLayerProperties extends LayerProperties, APIKeyMixinProp
    * layer.load().then(() => console.log(layer.isTable))
    */
   source?: ReadonlyArrayOrCollection<Graphic>;
+  /** The name of the field which holds the id of the [FeatureLayerBase.subtypes](https://developers.arcgis.com/javascript/latest/references/core/layers/mixins/FeatureLayerBase/#subtypes). */
+  subtypeField?: string;
+  /**
+   * An array of [subtypes](https://developers.arcgis.com/javascript/latest/references/core/layers/support/Subtype/) defined in the layer.
+   *
+   * @see [Introduction to subtypes](https://pro.arcgis.com/en/pro-app/latest/help/data/geodatabases/overview/an-overview-of-subtypes.htm)
+   */
+  subtypes?: Subtype[] | null;
   /**
    * Defines symbol layer drawing options. Use symbol layer drawing to override the default drawing order of [CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/)s on maps.
    * When symbols have more than one symbol layer (such as a cased road symbol), symbol layer drawing can also control how those individual symbol layers are ordered across symbol classes.
@@ -481,8 +497,8 @@ export interface FeatureLayerEvents extends EditBusLayerEvents, RefreshableLayer
  * ## Overview
  *
  * A FeatureLayer is a single layer that can be created from a
- * [Map Service](https://enterprise.arcgis.com/en/server/latest/publish-services/windows/what-is-a-map-service.htm)
- * or [Feature Service](https://enterprise.arcgis.com/en/server/latest/publish-services/windows/what-is-a-feature-service-.htm);
+ * [Map Service](https://doc.esri.com/en/arcgis-enterprise/latest/administer/what-is-a-map-service.html)
+ * or [Feature Service](https://doc.esri.com/en/arcgis-enterprise/latest/administer/what-is-a-feature-service-.html);
  * ArcGIS Online or ArcGIS Enterprise portal items; or from an array of client-side features. The layer can be either a
  * spatial (has geographic features) or non-spatial (table).
  *
@@ -842,7 +858,7 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    * method on the Sublayer to construct the layer for you.
    *
    * This only applies to map services with
-   * [dynamic layers](https://enterprise.arcgis.com/en/server/latest/publish-services/linux/about-dynamic-layers.htm) enabled.
+   * [dynamic layers](https://doc.esri.com/en/arcgis-enterprise/latest/administer/about-dynamic-layers.html) enabled.
    *
    * > [!WARNING]
    * >
@@ -920,6 +936,7 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    * @see [FeatureLayer.getFieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#getFieldConfiguration)
    * @see [FeatureLayer.getFieldAlias](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#getFieldAlias)
    * @example
+   * ```js
    * // Adding a new field configuration
    * const addNewConfig = (layer, fieldName, alias, fieldFormat) => {
    *   // Check if there is already an existing configuration for fieldName
@@ -931,7 +948,9 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    *     layer.fieldConfigurations = newConfigs;
    *   }
    * };
+   * ```
    * @example
+   * ```js
    * // Updating an existing field configuration
    * const updateConfig = (layer, fieldName, alias, fieldFormat) => {
    *   const existingConfig = layer.getFieldConfiguration(fieldName);
@@ -946,7 +965,9 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    *     layer.fieldConfigurations = newConfigs;
    *   }
    * };
+   * ```
    * @example
+   * ```js
    * // Deleting an existing field configuration
    * const deleteConfig = (layer, fieldName) => {
    *   const existingConfig = layer.getFieldConfiguration(fieldName);
@@ -957,6 +978,7 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    *     layer.fieldConfigurations = newConfigs;
    *   }
    * };
+   * ```
    */
   get fieldConfigurations(): FieldConfiguration[] | null | undefined;
   set fieldConfigurations(value: FieldConfigurationProperties[] | null | undefined);
@@ -1307,6 +1329,14 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    */
   get source(): Collection<Graphic>;
   set source(value: ReadonlyArrayOrCollection<Graphic>);
+  /** The name of the field which holds the id of the [FeatureLayerBase.subtypes](https://developers.arcgis.com/javascript/latest/references/core/layers/mixins/FeatureLayerBase/#subtypes). */
+  accessor subtypeField: string;
+  /**
+   * An array of [subtypes](https://developers.arcgis.com/javascript/latest/references/core/layers/support/Subtype/) defined in the layer.
+   *
+   * @see [Introduction to subtypes](https://pro.arcgis.com/en/pro-app/latest/help/data/geodatabases/overview/an-overview-of-subtypes.htm)
+   */
+  accessor subtypes: Subtype[] | null | undefined;
   /**
    * Defines symbol layer drawing options. Use symbol layer drawing to override the default drawing order of [CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/)s on maps.
    * When symbols have more than one symbol layer (such as a cased road symbol), symbol layer drawing can also control how those individual symbol layers are ordered across symbol classes.
@@ -1463,10 +1493,11 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    * @returns An array of field configuration objects, or `null` if the layer does not have any fields that require formatting.
    * @since 4.34
    * @see [FeatureLayer.fieldConfigurations](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#fieldConfigurations)
-   * @returns An array of field configuration objects, or `null` if the layer does not have any fields that require formatting.
    * @example
+   * ```js
    * const fieldConfigs = layer.createFieldConfigurations();
    * layer.fieldConfigurations = fieldConfigs;
+   * ```
    */
   createFieldConfigurations(): FieldConfiguration[] | null | undefined;
   /**
@@ -1490,6 +1521,7 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    * @returns The query object representing the layer's definition expression and other configurations.
    * @see [Sample - Query features from a FeatureLayer](https://developers.arcgis.com/javascript/latest/sample-code/featurelayer-query/)
    * @example
+   * ```js
    * // Get a query object for the layer's current configuration
    * queryParams.outFields will be set to ["*"] to get values for all available fields.
    * const queryParams = layer.createQuery();
@@ -1503,7 +1535,9 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    *   // prints the array of result graphics to the console
    *   console.log(results.features);
    * });
+   * ```
    * @example
+   * ```js
    * // this snippet shows the query parameter object that is returned
    * // from FeatureLayer.createQuery().
    * const queryParams = new Query();
@@ -1526,12 +1560,15 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    * queryParams.outFields = ["*"];
    * queryParams.where = layer.definitionExpression || "1=1";
    * queryParams.multipatchOption = layer.geometryType === "multipatch" ? "xyFootprint" : null;
+   * ```
    * @example
+   * ```js
    * // this snippet shows query image footprints from imagery layer
    * // that honors the layer's definitionExpression and other configurations.
    * if (imageryLayer.capabilities.operations.supportsQuery) {
    * const query = imageryLayer.createQuery();
    * const rasters = await imageryLayer.queryRasters(query);
+   * ```
    */
   createQuery(): Query;
   /**
@@ -2177,7 +2214,7 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    */
   refresh(): void;
   /**
-   * Reloads the schema of the layer and the properties from the [portalItem](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#portalItem) and feature service.
+   * Reloads the layer's schema and properties from its [portalItem](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#portalItem), provided the layer was created from an ArcGIS portal item.
    *
    * Returns `true` when the layer is successfully updated with data from the portal item or service.
    * Returns `false` when the layer is not updated, not loaded, or composed of client-side features.
@@ -2240,4 +2277,4 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    */
   updateAttachment(feature: Graphic, attachmentId: number, attachment: HTMLFormElement | FormData): Promise<FeatureEditResult>;
 }
-declare const FeatureLayerSuperclass: typeof Layer & typeof ClonableMixin & typeof APIKeyMixin & typeof CustomParametersMixin & typeof MultiOriginJSONSupportMixin & typeof PortalLayer & typeof OperationalLayer & typeof RefreshableLayer & typeof ScaleRangeLayer & typeof TrackableLayer & typeof TemporalLayer & typeof OrderedLayer & typeof BlendLayer & typeof DisplayFilteredLayer & typeof EditBusLayer & typeof PublishableLayer & typeof FeatureEffectLayer & typeof FeatureReductionLayer & typeof FeatureLayerBase
+declare const FeatureLayerSuperclass: typeof Layer & typeof ClonableMixin & typeof APIKeyMixin & typeof CustomParametersMixin & typeof MultiOriginJSONSupportMixin & typeof PortalLayer & typeof OperationalLayer & typeof RefreshableLayer & typeof ScaleRangeLayer & typeof TrackableLayer & typeof DataSeriesLayer & typeof TemporalLayer & typeof OrderedLayer & typeof BlendLayer & typeof DisplayFilteredLayer & typeof EditBusLayer & typeof PublishableLayer & typeof FeatureEffectLayer & typeof FeatureReductionLayer & typeof FeatureLayerBase