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

package/layers/AnnotationLayer.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 AnnotationLayerProperties extends FeatureLayerProperties {}
+export interface AnnotationLayerProperties extends LayerProperties, APIKeyMixinProperties, CustomParametersMixinProperties, PortalLayerProperties, OperationalLayerProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, BlendLayerProperties, FeatureLayerBaseProperties, Partial<Pick<AnnotationLayer, "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 an
+   * [AnnotationLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationLayer/).
+   *
+   * 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/AnnotationLayer/#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 AnnotationLayer extends __FeatureLayerSansType {
+export interface AnnotationLayerEvents extends EditBusLayerEvents, RefreshableLayerEvents, LayerEvents {}
+
+export default class AnnotationLayer extends AnnotationLayerSuperclass {
+  /**
+   * @deprecated
+   * Do not directly reference this property.
+   * Use EventNames and EventTypes helpers from \@arcgis/core/Evented
+   */
+  "@eventTypes": AnnotationLayerEvents;
   /**
    * @example
-   * const annotationLayer = new AnnotationLayer({
-   *   url: "..."
+   * // Create an annotation layer from a feature service layer URL.
+   * ```js
+   * const layer = new AnnotationLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/RiversAnnotation/FeatureServer/0"
    * });
-   * @see [Client-side FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#client-side)
+   * ```
+   */
+  constructor(properties?: AnnotationLayerProperties);
+  /**
+   * An array of fields in the layer.
+   *
+   * @see [objectIdField](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationLayer/#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/AnnotationLayerView/#queryFeatures)
+   * if the fields are not part of required fields.
+   *
+   * @see [AnnotationLayerView.availableFields](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationLayerView/#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 AnnotationLayerView.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/AnnotationLayer/#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/AnnotationLayer/#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?: AnnotationLayerProperties);
+  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 an
+   * [AnnotationLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationLayer/).
+   *
+   * 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/AnnotationLayer/#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(): "annotation";
-}
+  /**
+   * 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
+   * > [AnnotationLayerView.queryExtent()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationLayerView/#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
+   * > [AnnotationLayerView.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationLayerView/#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 [AnnotationLayerView.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationLayerView/#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/AnnotationLayer/#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 AnnotationLayer({
+   *   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
+   * > [AnnotationLayerView.queryObjectIds()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationLayerView/#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 AnnotationLayerSuperclass: 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/AnnotationLayer.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{__decorate as e}from"tslib";import t from"../request.js";import r from"../core/Error.js";import{join as o}from"../core/urlUtils.js";import{subclass as a}from"../core/accessorSupport/decorators.js";import{property as s}from"../core/accessorSupport/decorators/property.js";import n from"./FeatureLayer.js";let i=class extends n{constructor(e){super(e),this.supportedSourceTypes=new Set(["Annotation Layer","Annotation SubLayer"]),this.type="annotation",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 a=o(this.url,"queryDataElements"),s={f:"json",layers:this.layerId};return this._dataElementPromise=t(a,{...e,responseType:"json",query:s}).then(e=>{const t=e.data.layerDataElements,o=this.layerId,a=t.find(e=>e.layerId===o);if(!a)throw new r("fetchDataElement:not-available","A data element for this layer could not be retrieved.");return a.dataElement}),this._dataElementPromise}};e([s({json:{read:!1},value:"annotation",readOnly:!0})],i.prototype,"type",void 0),i=e([a("esri.layers.AnnotationLayer")],i);const l=i;export{l as default};
+import{__addDisposableResource as e,__disposeResources as r,__decorate as t}from"tslib";import s from"../PopupTemplate.js";import i from"../request.js";import{ClonableMixin as o}from"../core/Clonable.js";import a from"../core/Collection.js";import n from"../core/Error.js";import{disposable as l,makeHandle as p}from"../core/handleUtils.js";import{MultiOriginJSONSupportMixin as u}from"../core/MultiOriginJSONSupport.js";import{throwIfAbortError as d,whenOrAbort as m,onAbort as y}from"../core/promiseUtils.js";import{watch as h,sync as c}from"../core/reactiveUtils.js";import{join as f}from"../core/urlUtils.js";import{property as b,subclass as g}from"../core/accessorSupport/decorators.js";import v from"../graphic/AnnotationGraphicOrigin.js";import j from"./Layer.js";import{APIKeyMixin as E}from"./mixins/APIKeyMixin.js";import{ArcGISService as S}from"./mixins/ArcGISService.js";import{BlendLayer as L}from"./mixins/BlendLayer.js";import{CustomParametersMixin as w}from"./mixins/CustomParametersMixin.js";import{FeatureLayerBase as I}from"./mixins/FeatureLayerBase.js";import{OperationalLayer as P}from"./mixins/OperationalLayer.js";import{PortalLayer as x}from"./mixins/PortalLayer.js";import{RefreshableLayer as O}from"./mixins/RefreshableLayer.js";import{ScaleRangeLayer as T}from"./mixins/ScaleRangeLayer.js";import{TemporalLayer as F}from"./mixins/TemporalLayer.js";import A from"./support/AnnotationSublayer.js";import{barrierWeight as _,popupEnabled as q}from"./support/commonProperties.js";import{ensureLayerCredential as C,createQuery as U,getFieldDomain as D,hasDataChanged as G}from"./support/featureLayerUtils.js";import{defineFieldProperties as N}from"./support/fieldProperties.js";import{fixTimeInfoFields as Q}from"./support/fieldUtils.js";import{serviceSupportsSpatialReference as H}from"./support/versionUtils.js";import J from"../rest/support/Query.js";import{createPopupTemplate as R}from"../support/popupUtils.js";import{reader as M}from"../core/accessorSupport/decorators/reader.js";const k="annotation-layer",B=N(),K=a.ofType(A);let V=class extends(I(L(F(T(O(S(P(x(u(w(E(o(j))))))))))))){constructor(e){super(e),this.barrierWeight="high",this.fields=null,this.fieldsIndex=null,this.graphicOrigin=new v(this),this.operationalLayerType="ArcGISAnnotationLayer",this.outFields=null,this.popupEnabled=!0,this.popupTemplate=null,this.source=null,this.supportedSourceTypes=new Set(["Annotation Layer"]),this.type="annotation",this._dataElementPromise=null,this.addHandles(h(()=>this.sublayers,(e,r)=>this._handleSublayersChange(e,r),c))}destroy(){this.source?.destroy()}load(e){const r=e?.signal,t=this.loadFromPortal({supportedTypes:["Feature Service"]},e).catch(d).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 n(`${k}:missing-url`,"AnnotationLayer must be created with a url");return this.initLayerProperties(await this.createGraphicsSource(r))}).then(()=>C(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()}readSublayers(e,r){const t=new K(r.subtypes.map(({code:e,name:r})=>new A({subtypeCode:e,title:r})).reverse());if(this.visibleLayers){const e=new Set(this.visibleLayers);t.forEach(r=>{r.visible=e.has(r.subtypeCode)})}return t}get visibleLayers(){return this.sublayers?Array.from(new Set(this.sublayers?.toArray().filter(e=>e.visible).map(e=>e.subtypeCode)??null)):this._get("visibleLayers")??[]}set visibleLayers(e){this._set("visibleLayers",e)}createPopupTemplate(e){return R(this,e)}async createGraphicsSource(t){const s={stack:[],error:void 0,hasError:!1};try{const{default:r}=await m(import("./graphics/sources/FeatureLayerSource.js"),t),i=new r({layer:this,supportedSourceTypes:this.supportedSourceTypes});e(s,l(y(t,()=>i.cancelLoad())??p()),!1);return await i.load({signal:t}),i}catch(i){s.error=i,s.hasError=!0}finally{r(s)}}createQuery(){const e=U(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=f(this.url,"queryDataElements"),t={f:"json",layers:this.layerId};return this._dataElementPromise=i(r,{...e,responseType:"json",query:t}).then(e=>{const r=e.data.layerDataElements,t=this.layerId,s=r.find(e=>e.layerId===t);if(!s)throw new n("fetchDataElement:not-available","A data element for this layer could not be retrieved.");return s.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(),s=await t.source.queryFeatures(J.from(e)??t.createQuery(),r),i=this.graphicOrigin;if(s?.features)for(const o of s.features)o.layer=o.sourceLayer=t,o.origin=i;return s}async queryObjectIds(e,r){const t=await this.load();return t.source.queryObjectIds(J.from(e)??t.createQuery(),r)}async queryFeatureCount(e,r){const t=await this.load();return t.source.queryFeatureCount(J.from(e)??t.createQuery(),r)}async queryExtent(e,r){const t=await this.load();return t.source.queryExtent(J.from(e)??t.createQuery(),r)}serviceSupportsSpatialReference(e){return this.loaded&&H(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})),Q(this.timeInfo,this.fieldsIndex)}async hasDataChanged(){return G(this)}_fetchFirstValidLayerId(e){return i(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})}_handleSublayersChange(e,r){r&&(r.forEach(e=>{e.parent=null}),this.removeHandles("sublayers-owner")),e&&(e.forEach(e=>{e.parent=this}),this.addHandles([e.on("after-add",({item:e})=>{e.parent=this}),e.on("after-remove",({item:e})=>{e.parent=null})],"sublayers-owner"))}};t([b(_)],V.prototype,"barrierWeight",void 0),t([b({json:{write:!0}})],V.prototype,"editingEnabled",null),t([b({readOnly:!0})],V.prototype,"effectiveEditingEnabled",null),t([b({...B.fields,readOnly:!0,json:{read:!1,origins:{service:{read:!0}}}})],V.prototype,"fields",void 0),t([b(B.fieldsIndex)],V.prototype,"fieldsIndex",void 0),t([b({readOnly:!0,clonable:!1})],V.prototype,"graphicOrigin",void 0),t([b({type:["ArcGISAnnotationLayer"]})],V.prototype,"operationalLayerType",void 0),t([b(B.outFields)],V.prototype,"outFields",void 0),t([b(q)],V.prototype,"popupEnabled",void 0),t([b({type:s,json:{name:"popupInfo",write:!0}})],V.prototype,"popupTemplate",void 0),t([b({readOnly:!0})],V.prototype,"defaultPopupTemplate",null),t([b({clonable:!1,readOnly:!0})],V.prototype,"source",void 0),t([b({type:K})],V.prototype,"sublayers",void 0),t([M("service","sublayers",["subtypes"])],V.prototype,"readSublayers",null),t([b({json:{read:!1},value:"annotation",readOnly:!0})],V.prototype,"type",void 0),t([b({type:[Number],json:{write:{ignoreOrigin:!0}}})],V.prototype,"visibleLayers",null),V=t([g("esri.layers.AnnotationLayer")],V);const W=V;export{W as default};

package/layers/BaseDynamicLayer.d.ts

@@ -56,10 +56,10 @@ export interface BaseDynamicLayerProperties extends LayerProperties, Refreshable
  *
  * If data needs to be preprocessed prior to display, then override the [fetchImage()](https://developers.arcgis.com/javascript/latest/references/core/layers/BaseDynamicLayer/#fetchImage)
  * method to generate
- * an [html image element](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement) or
- * [canvas element](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement) by
+ * an [html image element](https://developer.mozilla.org/docs/Web/API/HTMLImageElement) or
+ * [canvas element](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement) by
  * processing the data returned by the server. For example, if you need to apply a
- * [compositing operation](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation)
+ * [compositing operation](https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation)
  * to the image returned from the server before the image is displayed then you would
  * override this method.
  *
@@ -140,8 +140,8 @@ export default abstract class BaseDynamicLayer extends BaseDynamicLayerSuperclas
    * @param height - The height of the view in pixels. This value is provided by the [LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/).
    * @param options - The parameter options is an object with the following properties.
    * @returns Returns a promise that resolves to an
-   * [HTMLImageElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement) or
-   * [HTMLCanvasElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement).
+   * [HTMLImageElement](https://developer.mozilla.org/docs/Web/API/HTMLImageElement) or
+   * [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement).
    * @example
    * // Fetches images for given extent and size
    * fetchImage: function (extent, width, height){

package/layers/BaseTileLayer.d.ts

@@ -23,7 +23,7 @@ export interface BaseTileLayerProperties extends LayerProperties, RefreshableLay
 
 /**
  * This class may be extended to create a custom TileLayer. It is a generic tile layer class designed to work with various tile sources,
- * not just ArcGIS cached [map services](https://enterprise.arcgis.com/en/server/latest/publish-services/windows/what-is-a-map-service.htm),
+ * not just ArcGIS cached [map services](https://doc.esri.com/en/arcgis-enterprise/latest/administer/what-is-a-map-service.html),
  * which are specifically handled by the [TileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/TileLayer/) class. Tile layers are composed of images, such as satellite imagery,
  * that are composed of square tiles mosaicked together in columns and rows, giving the layer the appearance that it is one continuous image.
  * They have several levels of detail (LOD) that permit users to zoom in to any region of the map and load additional tiles that depict features
@@ -116,7 +116,7 @@ export interface BaseTileLayerProperties extends LayerProperties, RefreshableLay
  *
  * If data needs to be preprocessed prior to display, then override the [fetchTile()](https://developers.arcgis.com/javascript/latest/references/core/layers/BaseTileLayer/#fetchTile)
  * method. For example, if you need to apply a
- * [compositing operation](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation)
+ * [compositing operation](https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation)
  * to the image returned from the server before the image is displayed then you would override this method.
  *
  * ```js
@@ -245,8 +245,8 @@ export default abstract class BaseTileLayer extends BaseTileLayerSuperclass {
    * @param col - The column (x) position of the tile to fetch. This value is provided by [LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/).
    * @param options - Optional settings for the tile request. The options have the following properties.
    * @returns Returns a promise that resolves to an
-   * [HTMLImageElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement) or
-   * [HTMLCanvasElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement).
+   * [HTMLImageElement](https://developer.mozilla.org/docs/Web/API/HTMLImageElement) or
+   * [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement).
    * @see [Sample - Custom BlendLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-custom-blendlayer/)
    * @see [Sample - Custom LERC Layer](https://developers.arcgis.com/javascript/latest/sample-code/layers-custom-lerc-2d/)
    * @example

package/layers/BuildingSceneLayer.d.ts

@@ -120,7 +120,7 @@ export interface BuildingSceneLayerProperties extends LayerProperties, APIKeyMix
  *
  * Building data coming from a [Revit](https://pro.arcgis.com/en/pro-app/latest/help/data/revit/what-is-bim-data-.htm) file
  * can be imported and published as a
- * [Scene Service](https://enterprise.arcgis.com/en/server/latest/publish-services/windows/scene-services.htm)
+ * [Scene Service](https://doc.esri.com/en/arcgis-enterprise/latest/plan/base-arcgis-enterprise-deployment.html)
  * using ArcGIS Pro version 2.3.
  *
  * The Scene Service is identified by the [url](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/#url) or [portalItem](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/#portalItem) of the ArcGIS Server REST resource:

package/layers/CSVLayer.d.ts

@@ -363,7 +363,7 @@ export interface CSVLayerEvents extends RefreshableLayerEvents, LayerEvents {}
  *
  * ### Reference in memory csv data by a blob url
  *
- * You can also create a CSVLayer from in memory csv data by passing a [blob url](https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL) to the
+ * You can also create a CSVLayer from in memory csv data by passing a [blob url](https://developer.mozilla.org/docs/Web/API/URL/createObjectURL) to the
  * [url](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/#url) property of the layer.
  * The following snippet shows how to create a new CSVLayer from a blob url.
  *
@@ -938,6 +938,7 @@ export default class CSVLayer extends CSVLayerSuperclass {
    * @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();
@@ -951,7 +952,9 @@ export default class CSVLayer extends CSVLayerSuperclass {
    *   // 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();
@@ -974,12 +977,15 @@ export default class CSVLayer extends CSVLayerSuperclass {
    * 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;
   /**

package/layers/CatalogLayer.d.ts

@@ -435,6 +435,7 @@ export default class CatalogLayer extends CatalogLayerSuperclass {
    * @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();
@@ -448,7 +449,9 @@ export default class CatalogLayer extends CatalogLayerSuperclass {
    *   // 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();
@@ -471,12 +474,15 @@ export default class CatalogLayer extends CatalogLayerSuperclass {
    * 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;
   /**