@arcgis/core 5.1.0-next.126 → 5.1.0-next.128

package/geometry/support/MeshLocalVertexSpace.d.ts

@@ -4,20 +4,44 @@ import type { JSONSupport } from "../../core/JSONSupport.js";
 export interface MeshLocalVertexSpaceProperties extends Partial<Pick<MeshLocalVertexSpace, "origin">> {}
 
 /**
- * A mesh vertex space that indicates mesh vertices exist in a plain cartesian space as often encountered in 3D
- * modeling and CAD applications. Georeferencing is done by using the coordinates in the
- * [local tangent plane](https://en.wikipedia.org/wiki/Local_tangent_plane_coordinates)
- * reference frame at the fully georeferenced [origin](https://developers.arcgis.com/javascript/latest/references/core/geometry/support/MeshLocalVertexSpace/#origin)
- * of the vertex space.
+ * Represents a [vertex space](https://developers.arcgis.com/javascript/latest/references/core/geometry/Mesh/#vertexSpace) that interprets
+ * [Mesh vertex positions](https://developers.arcgis.com/javascript/latest/references/core/geometry/support/MeshVertexAttributes/#position) as x, y, z values measured in meters
+ * from the source model's own [0,0,0].
  *
- * See [mesh API](https://developers.arcgis.com/javascript/latest/references/core/geometry/Mesh/#mesh-api) for details.
+ * A vertex space is the [Mesh.vertexSpace](https://developers.arcgis.com/javascript/latest/references/core/geometry/Mesh/#vertexSpace) object that tells the SDK how to read the
+ * x, y, z positions stored in [Mesh.vertexAttributes.position](https://developers.arcgis.com/javascript/latest/references/core/geometry/support/MeshVertexAttributes/#position).
+ * Use MeshLocalVertexSpace when those positions describe the shape of a source model relative to the model's own
+ * [0,0,0], and you want to place that model in a global [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).
+ *
+ * The [vertex space's origin](https://developers.arcgis.com/javascript/latest/references/core/geometry/support/MeshLocalVertexSpace/#origin) is the [x, y, z] coordinate where the
+ * source model's [0,0,0] lands. The origin values use the coordinate system identified by
+ * [Mesh.spatialReference](https://developers.arcgis.com/javascript/latest/references/core/geometry/Mesh/#spatialReference). For example, with WGS84 the origin contains longitude,
+ * latitude, and elevation values; with Web Mercator it contains Web Mercator x, y, and z values.
+ *
+ * In a global scene with WGS84, CGCS2000, or Web Mercator, the SDK places the model on a
+ * [local tangent plane](https://en.wikipedia.org/wiki/Local_tangent_plane_coordinates) at the origin. The x-axis points
+ * east, the y-axis points north, and the z-axis points up.
+ *
+ * The word local refers to local coordinates from the source model. It does not mean this vertex space is used for
+ * a [local](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#viewingMode) SceneView. For local scenes, use
+ * [MeshGeoreferencedVertexSpace](https://developers.arcgis.com/javascript/latest/references/core/geometry/support/MeshGeoreferencedVertexSpace/) and a
+ * [Mesh.spatialReference](https://developers.arcgis.com/javascript/latest/references/core/geometry/Mesh/#spatialReference) that matches
+ * [SceneView.spatialReference](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#spatialReference).
  *
  * @since 4.27
- * @see [Mesh](https://developers.arcgis.com/javascript/latest/references/core/geometry/Mesh/)
+ * @see [Mesh.vertexSpace](https://developers.arcgis.com/javascript/latest/references/core/geometry/Mesh/#vertexSpace)
+ * @see [MeshGeoreferencedVertexSpace](https://developers.arcgis.com/javascript/latest/references/core/geometry/support/MeshGeoreferencedVertexSpace/)
  */
 export default class MeshLocalVertexSpace extends MeshLocalVertexSpaceSuperclass {
   constructor(properties?: MeshLocalVertexSpaceProperties);
-  /** Origin of the vertex space. These coordinates are interpreted in the spatial reference of the mesh using the vertex space. */
+  /**
+   * Coordinates of the place where the source model's local [0,0,0] is anchored.
+   *
+   * The array is [x, y, z] in the coordinate system identified by the
+   * [Mesh.spatialReference](https://developers.arcgis.com/javascript/latest/references/core/geometry/Mesh/#spatialReference) property of the Mesh geometry that uses this vertex
+   * space. The vertex position [0,0,0] coincides with the vertex space's origin before any
+   * [Mesh.transform](https://developers.arcgis.com/javascript/latest/references/core/geometry/Mesh/#transform) is applied.
+   */
   accessor origin: readonly [
       number,
       number,

package/geometry/support/MeshVertexAttributes.d.ts

@@ -19,8 +19,12 @@ export default class MeshVertexAttributes extends MeshVertexAttributesSuperclass
    */
   accessor normal: MeshVertexNormal | null | undefined;
   /**
-   * A flat array of vertex positions. Vertex positions have x, y and z coordinates and they should be in the spatial
-   * reference system of the geometry.
+   * A flat array of vertex position values.
+   *
+   * Every three numbers define one x, y, z position. The [Mesh.vertexSpace](https://developers.arcgis.com/javascript/latest/references/core/geometry/Mesh/#vertexSpace) property
+   * of the `Mesh` geometry that owns these attributes defines how the SDK interprets those numbers: as local model
+   * coordinates, as offsets from an origin, or as absolute coordinates in the coordinate system identified by
+   * [Mesh.spatialReference](https://developers.arcgis.com/javascript/latest/references/core/geometry/Mesh/#spatialReference).
    *
    * @since 5.0
    */

package/geometry/support/heightModelInfoUtils.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import e from"../../core/Error.js";import t from"../HeightModelInfo.js";import{parse as n}from"../../layers/support/arcgisLayerUrl.js";function i(n,i){if(!n)return null;if(!o(n))return new e("webscene:unsupported-height-model-info","The vertical coordinate system of the scene is not supported",{heightModelInfo:n});const a=n.heightUnit,r=t.deriveUnitFromSR(n,i).heightUnit;return a!==r?new e("webscene:incompatible-height-unit",`The vertical units of the scene (${a}) must match the horizontal units of the scene (${r})`,{verticalUnit:a,horizontalUnit:r}):null}function a(n,i,a){const o=c(n),l=i,h=r(o,l,a);if(o){const i=t.deriveUnitFromSR(o,n.spatialReference).heightUnit;if(!a&&i!==o.heightUnit){const t=new e("layerview:unmatched-height-unit",`The vertical units of the layer must match the horizontal units (${i})`,{horizontalUnit:i});return new e("layerview:unsupported-height-model-info","The vertical coordinate system of the layer is not supported",{heightModelInfo:o,error:t})}}if(!s(n)||4===h)return new e("layerview:unsupported-height-model-info","The vertical coordinate system of the layer is not supported",{heightModelInfo:o});switch(h){case 1:{const t=o?.heightUnit||"unknown",n=l?.heightUnit||"unknown",i=new e("layerview:incompatible-height-unit",`The vertical units of the layer (${t}) must match the vertical units of the scene (${n})`,{layerUnit:t,sceneUnit:n});return new e("layerview:incompatible-height-model-info","The vertical coordinate system of the layer is incompatible with the scene",{layerHeightModelInfo:o,sceneHeightModelInfo:l,error:i})}case 2:{const t=o?.heightModel||"unknown",n=l?.heightModel||"unknown",i=new e("layerview:incompatible-height-model",`The height model of the layer (${t}) must match the height model of the scene (${n})`,{layerHeightModel:t,sceneHeightModel:n});return new e("layerview:incompatible-height-model-info","The vertical coordinate system of the layer is incompatible with the scene",{layerHeightModelInfo:o,sceneHeightModelInfo:l,error:i})}case 3:{const t=o?.vertCRS||"unknown",n=l?.vertCRS||"unknown",i=new e("layerview:incompatible-vertical-datum",`The vertical datum of the layer (${t}) must match the vertical datum of the scene (${n})`,{layerDatum:t,sceneDatum:n});return new e("layerview:incompatible-height-model-info","The vertical coordinate system of the layer is incompatible with the scene",{layerHeightModelInfo:o,sceneHeightModelInfo:l,error:i})}}return null}function r(e,t,n){if(!o(e)||!o(t))return 4;if(null==e||null==t)return 0;if(!n&&e.heightUnit!==t.heightUnit)return 1;if(e.heightModel!==t.heightModel)return 2;switch(e.heightModel){case"gravity-related-height":return 0;case"ellipsoidal":return e.vertCRS===t.vertCRS?0:3;default:return 4}}function o(e){return null==e||null!=e.heightModel&&null!=e.heightUnit}function s(e){return"heightModelInfo"in e&&null!=e.heightModelInfo||null!=e.spatialReference||!u(e)}function c(e){if("integrated-mesh-3dtiles"===e.type||"gaussian-splat"===e.type)return null;const i=e.url?n(e.url):void 0,a=e.spatialReference?.vcsWkid;return!(null==a&&null!=i&&"ImageServer"===i.serverType)&&l(e)&&e.heightModelInfo?e.heightModelInfo:u(e)?t.deriveUnitFromSR(f,e.spatialReference):null}function l(e){return"heightModelInfo"in e}function h(e){if("unknown"===e.type||!("capabilities"in e))return!1;switch(e.type){case"annotation":case"catalog":case"catalog-footprint":case"csv":case"feature":case"dimension-feature":case"geojson":case"subtype-group":case"ogc-feature":case"oriented-imagery":case"wfs":case"knowledge-graph-sublayer":return!0;default:return!1}}function u(e){return h(e)?!!(e.capabilities&&e.capabilities.data&&e.capabilities.data.supportsZ):d(e)}function g(e){return null!=e.layers||d(e)||h(e)||l(e)}function d(e){switch(e.type){case"annotation":case"building-scene":case"elevation":case"gaussian-splat":case"integrated-mesh":case"integrated-mesh-3dtiles":case"point-cloud":case"scene":case"voxel":return!0;case"base-dynamic":case"base-elevation":case"base-tile":case"bing-maps":case"catalog":case"catalog-footprint":case"catalog-dynamic-group":case"csv":case"dimension":case"dimension-feature":case"geojson":case"feature":case"subtype-group":case"geo-rss":case"graphics":case"group":case"imagery":case"imagery-tile":case"kml":case"knowledge-graph":case"link-chart":case"knowledge-graph-sublayer":case"line-of-sight":case"map-image":case"map-notes":case"media":case"ogc-feature":case"open-street-map":case"oriented-imagery":case"parquet":case"route":case"stream":case"tile":case"unknown":case"unsupported":case"vector-tile":case"video":case"viewshed":case"wcs":case"web-tile":case"wfs":case"wms":case"wmts":case null:return!1}return!1}const f=new t({heightModel:"gravity-related-height"});export{c as deriveHeightModelInfoFromLayer,r as isCompatible,a as rejectLayerError,g as supportsHeightModelInfo,i as validateWebSceneError};
+import e from"../../core/Error.js";import t from"../HeightModelInfo.js";import{parse as n}from"../../layers/support/arcgisLayerUrl.js";function i(n,i){if(!n)return null;if(!o(n))return new e("webscene:unsupported-height-model-info","The vertical coordinate system of the scene is not supported",{heightModelInfo:n});const a=n.heightUnit,r=t.deriveUnitFromSR(n,i).heightUnit;return a!==r?new e("webscene:incompatible-height-unit",`The vertical units of the scene (${a}) must match the horizontal units of the scene (${r})`,{verticalUnit:a,horizontalUnit:r}):null}function a(n,i,a){const o=c(n),l=i,h=r(o,l,a);if(o){const i=t.deriveUnitFromSR(o,n.spatialReference).heightUnit;if(!a&&i!==o.heightUnit){const t=new e("layerview:unmatched-height-unit",`The vertical units of the layer must match the horizontal units (${i})`,{horizontalUnit:i});return new e("layerview:unsupported-height-model-info","The vertical coordinate system of the layer is not supported",{heightModelInfo:o,error:t})}}if(!s(n)||4===h)return new e("layerview:unsupported-height-model-info","The vertical coordinate system of the layer is not supported",{heightModelInfo:o});switch(h){case 1:{const t=o?.heightUnit||"unknown",n=l?.heightUnit||"unknown",i=new e("layerview:incompatible-height-unit",`The vertical units of the layer (${t}) must match the vertical units of the scene (${n})`,{layerUnit:t,sceneUnit:n});return new e("layerview:incompatible-height-model-info","The vertical coordinate system of the layer is incompatible with the scene",{layerHeightModelInfo:o,sceneHeightModelInfo:l,error:i})}case 2:{const t=o?.heightModel||"unknown",n=l?.heightModel||"unknown",i=new e("layerview:incompatible-height-model",`The height model of the layer (${t}) must match the height model of the scene (${n})`,{layerHeightModel:t,sceneHeightModel:n});return new e("layerview:incompatible-height-model-info","The vertical coordinate system of the layer is incompatible with the scene",{layerHeightModelInfo:o,sceneHeightModelInfo:l,error:i})}case 3:{const t=o?.vertCRS||"unknown",n=l?.vertCRS||"unknown",i=new e("layerview:incompatible-vertical-datum",`The vertical datum of the layer (${t}) must match the vertical datum of the scene (${n})`,{layerDatum:t,sceneDatum:n});return new e("layerview:incompatible-height-model-info","The vertical coordinate system of the layer is incompatible with the scene",{layerHeightModelInfo:o,sceneHeightModelInfo:l,error:i})}}return null}function r(e,t,n){if(!o(e)||!o(t))return 4;if(null==e||null==t)return 0;if(!n&&e.heightUnit!==t.heightUnit)return 1;if(e.heightModel!==t.heightModel)return 2;switch(e.heightModel){case"gravity-related-height":return 0;case"ellipsoidal":return e.vertCRS===t.vertCRS?0:3;default:return 4}}function o(e){return null==e||null!=e.heightModel&&null!=e.heightUnit}function s(e){return"heightModelInfo"in e&&null!=e.heightModelInfo||null!=e.spatialReference||!u(e)}function c(e){if("integrated-mesh-3dtiles"===e.type||"gaussian-splat"===e.type)return null;const i=e.url?n(e.url):void 0,a=e.spatialReference?.vcsWkid;return!(null==a&&null!=i&&"ImageServer"===i.serverType)&&l(e)&&e.heightModelInfo?e.heightModelInfo:u(e)?t.deriveUnitFromSR(f,e.spatialReference):null}function l(e){return"heightModelInfo"in e}function h(e){if("unknown"===e.type||!("capabilities"in e))return!1;switch(e.type){case"annotation-feature":case"catalog":case"catalog-footprint":case"csv":case"feature":case"dimension-feature":case"geojson":case"subtype-group":case"ogc-feature":case"oriented-imagery":case"wfs":case"knowledge-graph-sublayer":return!0;default:return!1}}function u(e){return h(e)?!!(e.capabilities&&e.capabilities.data&&e.capabilities.data.supportsZ):d(e)}function g(e){return null!=e.layers||d(e)||h(e)||l(e)}function d(e){switch(e.type){case"annotation-feature":case"building-scene":case"elevation":case"gaussian-splat":case"integrated-mesh":case"integrated-mesh-3dtiles":case"point-cloud":case"scene":case"voxel":return!0;case"base-dynamic":case"base-elevation":case"base-tile":case"bing-maps":case"catalog":case"catalog-footprint":case"catalog-dynamic-group":case"csv":case"dimension":case"dimension-feature":case"geojson":case"feature":case"subtype-group":case"geo-rss":case"graphics":case"group":case"imagery":case"imagery-tile":case"kml":case"knowledge-graph":case"link-chart":case"knowledge-graph-sublayer":case"line-of-sight":case"map-image":case"map-notes":case"media":case"ogc-feature":case"open-street-map":case"oriented-imagery":case"parquet":case"route":case"stream":case"tile":case"unknown":case"unsupported":case"vector-tile":case"video":case"viewshed":case"wcs":case"web-tile":case"wfs":case"wms":case"wmts":case null:return!1}return!1}const f=new t({heightModel:"gravity-related-height"});export{c as deriveHeightModelInfoFromLayer,r as isCompatible,a as rejectLayerError,g as supportsHeightModelInfo,i as validateWebSceneError};

package/geometry/support/zscale.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import{getMetersPerVerticalUnitForSR as o}from"../../core/units.js";import{isSphericalPCPF as n}from"../ellipsoidUtils.js";import{equals as t}from"./spatialReferenceUtils.js";import{getEndpoint as e}from"./curves/curveUtils.js";function r(o,n,t){const e=i(n,t);if(1!==e)switch(o){case"point":case"esriGeometryPoint":return o=>s(o,e);case"polyline":case"esriGeometryPolyline":return o=>c(o,e);case"polygon":case"esriGeometryPolygon":return o=>f(o,e);case"multipoint":case"esriGeometryMultipoint":return o=>l(o,e);case"extent":case"esriGeometryEnvelope":return o=>u(o,e);default:return}}function i(e,r){if(null==e||null==r||r.vcsWkid||t(e,r)||n(e)||n(r))return 1;return o(e)/o(r)}function s(o,n){null!=o?.z&&(o.z*=n)}function f(o,n){if(o){if(o.curveRings)for(const t of o.curveRings)for(const o of t){const t=e(o);t.length>2&&(t[2]*=n)}if(o.rings)for(const t of o.rings)for(const o of t)o.length>2&&(o[2]*=n)}}function c(o,n){if(o){if(o.curvePaths)for(const t of o.curvePaths)for(const o of t){const t=e(o);t.length>2&&(t[2]*=n)}if(o.paths)for(const t of o.paths)for(const o of t)o.length>2&&(o[2]*=n)}}function l(o,n){if(o)for(const t of o.points)t.length>2&&(t[2]*=n)}function u(o,n){o&&null!=o.zmin&&null!=o.zmax&&(o.zmin*=n,o.zmax*=n)}export{r as getGeometryZScaler,i as zScale};
+import{getMetersPerVerticalUnitForSR as o}from"../../core/units.js";import{isSphericalPCPF as n}from"../ellipsoidUtils.js";import{equals as t}from"./spatialReferenceUtils.js";import{getEndpoint as e}from"./curves/curveUtils.js";function r(o,n,t){const e=i(n,t);if(1!==e)switch(o){case"point":case"esriGeometryPoint":return o=>s(o,e);case"polyline":case"esriGeometryPolyline":return o=>c(o,e);case"polygon":case"esriGeometryPolygon":return o=>f(o,e);case"multipoint":case"esriGeometryMultipoint":return o=>l(o,e);case"extent":case"esriGeometryEnvelope":return o=>u(o,e);default:return}}function i(e,r){if(null==e||null==r||t(e,r)||n(e)||n(r))return 1;return o(e)/o(r)}function s(o,n){null!=o?.z&&(o.z*=n)}function f(o,n){if(o){if(o.curveRings)for(const t of o.curveRings)for(const o of t){const t=e(o);t.length>2&&(t[2]*=n)}if(o.rings)for(const t of o.rings)for(const o of t)o.length>2&&(o[2]*=n)}}function c(o,n){if(o){if(o.curvePaths)for(const t of o.curvePaths)for(const o of t){const t=e(o);t.length>2&&(t[2]*=n)}if(o.paths)for(const t of o.paths)for(const o of t)o.length>2&&(o[2]*=n)}}function l(o,n){if(o)for(const t of o.points)t.length>2&&(t[2]*=n)}function u(o,n){o&&null!=o.zmin&&null!=o.zmax&&(o.zmin*=n,o.zmax*=n)}export{r as getGeometryZScaler,i as zScale};

package/graphic/{AnnotationGraphicOrigin.d.ts → AnnotationFeatureGraphicOrigin.d.ts}

@@ -1,15 +1,16 @@
 import type GraphicOrigin from "./GraphicOrigin.js";
-import type AnnotationLayer from "../layers/AnnotationLayer.js";
+import type AnnotationFeatureLayer from "../layers/AnnotationFeatureLayer.js";
+import type AnnotationFeatureSublayer from "../layers/support/AnnotationFeatureSublayer.js";
 
 /**
- * Provides information about the [AnnotationLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationLayer/) from which a graphic originates.
+ * Provides information about the [AnnotationFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationFeatureLayer/) from which a graphic originates.
  * The [origin](https://developers.arcgis.com/javascript/latest/references/core/Graphic/#origin) information may be available when a graphic is returned from methods such as
- * [hitTest()](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#hitTest) or [queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationLayer/#queryFeatures).
+ * [hitTest()](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#hitTest) or [queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationFeatureLayer/#queryFeatures).
  *
  * @since 5.1
  * @see [MapView.hitTest()](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#hitTest)
  * @see [SceneView.hitTest()](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#hitTest)
- * @see [AnnotationLayer.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationLayer/#queryFeatures)
+ * @see [AnnotationFeatureLayer.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationFeatureLayer/#queryFeatures)
  * @example
  * // get a point from view's click event
  *  view.on("click", async (event) => {
@@ -21,14 +22,16 @@ import type AnnotationLayer from "../layers/AnnotationLayer.js";
  *    }
  *  });
  */
-export default class AnnotationGraphicOrigin extends GraphicOrigin {
-  constructor(layer: AnnotationLayer);
+export default class AnnotationFeatureGraphicOrigin extends GraphicOrigin {
+  constructor(sublayer: AnnotationFeatureSublayer);
   /** A layer from which a graphic originates. */
-  readonly layer: AnnotationLayer;
+  get layer(): AnnotationFeatureLayer;
+  /** The [AnnotationFeatureSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/support/AnnotationFeatureSublayer/) from which a graphic originates. */
+  readonly sublayer: AnnotationFeatureSublayer;
   /**
    * Indicates the type of layer the graphic originated from.
    *
-   * @default "annotation"
+   * @default "annotation-feature"
    */
-  readonly type: AnnotationLayer["type"];
+  readonly type: AnnotationFeatureLayer["type"];
 }

package/graphic/AnnotationFeatureGraphicOrigin.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
+import{idFieldsProviderSymbol as r}from"./getIdFieldsProvider.js";import{popupProviderSymbol as t}from"./getPopupProvider.js";import{getSliceableContainerSymbol as e}from"./getSliceableContainer.js";import i from"./GraphicOrigin.js";import{isAnnotationFeatureGraphicOriginSymbol as s}from"./isAnnotationFeatureGraphicOrigin.js";var a;class o extends i{get[(a=s,t)](){return this.layer}get[r](){return this.layer}get[e](){return this.layer}constructor(r){super(),this[a]=!0,this.type="annotation-feature",this.sublayer=r}get layer(){return this.sublayer.parent}get id(){return`${this.layer.id}:__${this.sublayer.subtypeCode}__`}}export{o as default};

package/graphic/DimensionFeatureGraphicOrigin.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import{idFieldsProviderSymbol as r}from"./getIdFieldsProvider.js";import{popupProviderSymbol as e}from"./getPopupProvider.js";import{getSliceableContainerSymbol as t}from"./getSliceableContainer.js";import i from"./GraphicOrigin.js";class s extends i{get[e](){return this.layer}get[r](){return this.layer}get[t](){return this.layer}constructor(r){super(),this.type="dimension-feature",this.layer=r}get id(){return this.layer.id}}export{s as default};
+import{idFieldsProviderSymbol as r}from"./getIdFieldsProvider.js";import{popupProviderSymbol as e}from"./getPopupProvider.js";import{getSliceableContainerSymbol as t}from"./getSliceableContainer.js";import i from"./GraphicOrigin.js";import{isDimensionFeatureGraphicOriginSymbol as s}from"./isDimensionFeatureGraphicOrigin.js";var o;class a extends i{get[(o=s,e)](){return this.layer}get[r](){return this.layer}get[t](){return this.layer}constructor(r){super(),this[o]=!0,this.type="dimension-feature",this.layer=r}get id(){return this.layer.id}}export{a as default};

package/graphic/graphicOrigins.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-export{isBuildingGraphicOrigin}from"./isBuildingGraphicOrigin.js";export{isCatalogGraphicOrigin}from"./isCatalogGraphicOrigin.js";export{isCSVGraphicOrigin}from"./isCSVGraphicOrigin.js";export{isFeatureGraphicOrigin}from"./isFeatureGraphicOrigin.js";export{isGeoJSONGraphicOrigin}from"./isGeoJSONGraphicOrigin.js";export{isGeoRSSGraphicOrigin}from"./isGeoRSSGraphicOrigin.js";export{isKnowledgeGraphGraphicOrigin}from"./isKnowledgeGraphGraphicOrigin.js";export{isMapImageGraphicOrigin}from"./isMapImageGraphicOrigin.js";export{isMapNotesGraphicOrigin}from"./isMapNotesGraphicOrigin.js";export{isOGCFeatureGraphicOrigin}from"./isOGCFeatureGraphicOrigin.js";export{isOrientedImageryGraphicOrigin}from"./isOrientedImageryGraphicOrigin.js";export{isParquetGraphicOrigin}from"./isParquetGraphicOrigin.js";export{isPointCloudGraphicOrigin}from"./isPointCloudGraphicOrigin.js";export{isSceneGraphicOrigin}from"./isSceneGraphicOrigin.js";export{isStreamGraphicOrigin}from"./isStreamGraphicOrigin.js";export{isSubtypeGroupGraphicOrigin}from"./isSubtypeGroupGraphicOrigin.js";export{isTileGraphicOrigin}from"./isTileGraphicOrigin.js";export{isVectorTileGraphicOrigin}from"./isVectorTileGraphicOrigin.js";export{isVoxelGraphicOrigin}from"./isVoxelGraphicOrigin.js";export{isWFSGraphicOrigin}from"./isWFSGraphicOrigin.js";
+export{isAnnotationFeatureGraphicOrigin}from"./isAnnotationFeatureGraphicOrigin.js";export{isBuildingGraphicOrigin}from"./isBuildingGraphicOrigin.js";export{isCatalogGraphicOrigin}from"./isCatalogGraphicOrigin.js";export{isCSVGraphicOrigin}from"./isCSVGraphicOrigin.js";export{isDimensionFeatureGraphicOrigin}from"./isDimensionFeatureGraphicOrigin.js";export{isFeatureGraphicOrigin}from"./isFeatureGraphicOrigin.js";export{isGeoJSONGraphicOrigin}from"./isGeoJSONGraphicOrigin.js";export{isGeoRSSGraphicOrigin}from"./isGeoRSSGraphicOrigin.js";export{isKnowledgeGraphGraphicOrigin}from"./isKnowledgeGraphGraphicOrigin.js";export{isMapImageGraphicOrigin}from"./isMapImageGraphicOrigin.js";export{isMapNotesGraphicOrigin}from"./isMapNotesGraphicOrigin.js";export{isOGCFeatureGraphicOrigin}from"./isOGCFeatureGraphicOrigin.js";export{isOrientedImageryGraphicOrigin}from"./isOrientedImageryGraphicOrigin.js";export{isParquetGraphicOrigin}from"./isParquetGraphicOrigin.js";export{isPointCloudGraphicOrigin}from"./isPointCloudGraphicOrigin.js";export{isSceneGraphicOrigin}from"./isSceneGraphicOrigin.js";export{isStreamGraphicOrigin}from"./isStreamGraphicOrigin.js";export{isSubtypeGroupGraphicOrigin}from"./isSubtypeGroupGraphicOrigin.js";export{isTileGraphicOrigin}from"./isTileGraphicOrigin.js";export{isVectorTileGraphicOrigin}from"./isVectorTileGraphicOrigin.js";export{isVoxelGraphicOrigin}from"./isVoxelGraphicOrigin.js";export{isWFSGraphicOrigin}from"./isWFSGraphicOrigin.js";

package/graphic/isAnnotationFeatureGraphicOrigin.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Provides a utility function to determine whether a graphic's origin is a [AnnotationFeatureGraphicOrigin](https://developers.arcgis.com/javascript/latest/references/core/graphic/AnnotationFeatureGraphicOrigin/).
+ *
+ * @since 5.1
+ * @example
+ * // Use hitTest() to get a graphic, then check whether it originated from a AnnotationFeatureLayer.
+ * view.hitTest(screenPoint).then((response) => {
+ *   const graphic = response.results[0]?.graphic;
+ *   if (!graphic) {
+ *     return;
+ *   }
+ *   if (isAnnotationFeatureGraphicOrigin(graphic.origin)) {
+ *     // hitTest returned a graphic from a AnnotationFeatureLayer.
+ *     // Use this info for your processing logic.
+ *   } else {
+ *     console.log("graphic's origin is NOT a AnnotationFeatureLayer");
+ *   }
+ * });
+ */
+import type AnnotationFeatureGraphicOrigin from "./AnnotationFeatureGraphicOrigin.js";
+import type GraphicOrigin from "./GraphicOrigin.js";
+
+/**
+ * Utility function that determines whether a graphic’s origin is a [AnnotationFeatureGraphicOrigin](https://developers.arcgis.com/javascript/latest/references/core/graphic/AnnotationFeatureGraphicOrigin/).
+ *
+ * @param origin - The graphic origin to check.
+ * @returns Returns `true` if the graphic origin is of type [AnnotationFeatureGraphicOrigin](https://developers.arcgis.com/javascript/latest/references/core/graphic/AnnotationFeatureGraphicOrigin/), `false` otherwise.
+ */
+export function isAnnotationFeatureGraphicOrigin(origin: GraphicOrigin | null | undefined): origin is AnnotationFeatureGraphicOrigin;

package/graphic/isAnnotationFeatureGraphicOrigin.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
+const n=Symbol("isAnnotationFeatureGraphicOrigin");function i(i){return!!i&&n in i}export{i as isAnnotationFeatureGraphicOrigin,n as isAnnotationFeatureGraphicOriginSymbol};

package/graphic/isDimensionFeatureGraphicOrigin.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Provides a utility function to determine whether a graphic's origin is a [DimensionFeatureGraphicOrigin](https://developers.arcgis.com/javascript/latest/references/core/graphic/DimensionFeatureGraphicOrigin/).
+ *
+ * @since 5.1
+ * @example
+ * // Use hitTest() to get a graphic, then check whether it originated from a DimensionFeatureLayer.
+ * view.hitTest(screenPoint).then((response) => {
+ *   const graphic = response.results[0]?.graphic;
+ *   if (!graphic) {
+ *     return;
+ *   }
+ *   if (isDimensionFeatureGraphicOrigin(graphic.origin)) {
+ *     // hitTest returned a graphic from a DimensionFeatureLayer.
+ *     // Use this info for your processing logic.
+ *   } else {
+ *     console.log("graphic's origin is NOT a DimensionFeatureLayer");
+ *   }
+ * });
+ */
+import type DimensionFeatureGraphicOrigin from "./DimensionFeatureGraphicOrigin.js";
+import type GraphicOrigin from "./GraphicOrigin.js";
+
+/**
+ * Utility function that determines whether a graphic’s origin is a [DimensionFeatureGraphicOrigin](https://developers.arcgis.com/javascript/latest/references/core/graphic/DimensionFeatureGraphicOrigin/).
+ *
+ * @param origin - The graphic origin to check.
+ * @returns Returns `true` if the graphic origin is of type [DimensionFeatureGraphicOrigin](https://developers.arcgis.com/javascript/latest/references/core/graphic/DimensionFeatureGraphicOrigin/), `false` otherwise.
+ */
+export function isDimensionFeatureGraphicOrigin(origin: GraphicOrigin | null | undefined): origin is DimensionFeatureGraphicOrigin;

package/graphic/isDimensionFeatureGraphicOrigin.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
+const i=Symbol("isDimensionFeatureGraphicOrigin");function n(n){return!!n&&i in n}export{n as isDimensionFeatureGraphicOrigin,i as isDimensionFeatureGraphicOriginSymbol};

package/interfaces.d.ts

@@ -3375,7 +3375,7 @@ declare namespace __esri {
   export type LocationFunction = import("./intl/t9n.js").LocationFunction;
 
   /** @deprecated since 5.0. Refactor using \@arcgis/codemod */
-  export type AnnotationLayerProperties = import("./layers/AnnotationLayer.js").AnnotationLayerProperties;
+  export type AnnotationLayerProperties = import("./layers/AnnotationFeatureLayer.js").AnnotationFeatureLayerProperties;
 
   /** @deprecated since 5.0. Refactor using \@arcgis/codemod */
   export type BaseDynamicLayerProperties = import("./layers/BaseDynamicLayer.js").BaseDynamicLayerProperties;
@@ -5060,11 +5060,11 @@ declare namespace __esri {
   export const AggregateField: typeof import("./layers/support/AggregateField.js").default;
 
   /** @deprecated since 5.0. Refactor using \@arcgis/codemod */
-  export type AnnotationSublayerProperties = import("./layers/support/AnnotationSublayer.js").AnnotationSublayerProperties;
+  export type AnnotationFeatureSublayerProperties = import("./layers/support/AnnotationFeatureSublayer.js").AnnotationFeatureSublayerProperties;
 
   /** @deprecated since 5.0. Refactor using \@arcgis/codemod */
-  export type AnnotationSublayer = import("./layers/support/AnnotationSublayer.js").default;
-  export const AnnotationSublayer: typeof import("./layers/support/AnnotationSublayer.js").default;
+  export type AnnotationFeatureSublayer = import("./layers/support/AnnotationFeatureSublayer.js").default;
+  export const AnnotationFeatureSublayer: typeof import("./layers/support/AnnotationFeatureSublayer.js").default;
 
   /** @deprecated since 5.0. Refactor using \@arcgis/codemod */
   export type BuildingFieldStatistics = import("./layers/support/BuildingFieldStatistics.js").default;
@@ -12251,8 +12251,8 @@ declare namespace __esri {
   export const SnappingOptions: typeof import("./views/interactive/snapping/SnappingOptions.js").default;
 
   /** @deprecated since 5.0. Refactor using \@arcgis/codemod */
-  export type AnnotationLayerView = import("./views/layers/AnnotationLayerView.js").default;
-  export const AnnotationLayerView: typeof import("./views/layers/AnnotationLayerView.js").default;
+  export type AnnotationFeatureLayerView = import("./views/layers/AnnotationFeatureLayerView.js").default;
+  export const AnnotationFeatureLayerView: typeof import("./views/layers/AnnotationFeatureLayerView.js").default;
 
   /** @deprecated since 5.0. Refactor using \@arcgis/codemod */
   export type BuildingComponentSublayerViewProperties = import("./views/layers/BuildingComponentSublayerView.js").BuildingComponentSublayerViewProperties;

package/kernel.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import has from"./core/has.js";import{addQueryParameter as o}from"./core/urlUtils.js";export{buildDate,commitHash as revision}from"./support/revision.js";Symbol.dispose??=Symbol("Symbol.dispose"),Symbol.asyncDispose??=Symbol("Symbol.asyncDispose");const e="5.1";let s,r=e;function i(o){s=o}function t(e){const r=s?.findCredential(e);return r?.token?o(e,"token",r.token):e}r="5.1.0-next.126",has("host-webworker")||globalThis.$arcgis||Object.defineProperty(globalThis,"$arcgis",{configurable:!1,enumerable:!0,writable:!1,value:{}}),has("host-webworker");export{t as addTokenParameter,r as fullVersion,s as id,i as setId,e as version};
+import has from"./core/has.js";import{addQueryParameter as o}from"./core/urlUtils.js";export{buildDate,commitHash as revision}from"./support/revision.js";Symbol.dispose??=Symbol("Symbol.dispose"),Symbol.asyncDispose??=Symbol("Symbol.asyncDispose");const e="5.1";let s,r=e;function i(o){s=o}function t(e){const r=s?.findCredential(e);return r?.token?o(e,"token",r.token):e}r="5.1.0-next.128",has("host-webworker")||globalThis.$arcgis||Object.defineProperty(globalThis,"$arcgis",{configurable:!1,enumerable:!0,writable:!1,value:{}}),has("host-webworker");export{t as addTokenParameter,r as fullVersion,s as id,i as setId,e as version};

package/layers/{AnnotationLayer.d.ts → AnnotationFeatureLayer.d.ts}

@@ -1,6 +1,9 @@
+import type Graphic from "../Graphic.js";
 import type PopupTemplate from "../PopupTemplate.js";
+import type Collection from "../core/Collection.js";
 import type Extent from "../geometry/Extent.js";
 import type Layer from "./Layer.js";
+import type AnnotationFeatureSublayer from "./support/AnnotationFeatureSublayer.js";
 import type Field from "./support/Field.js";
 import type FeatureSet from "../rest/support/FeatureSet.js";
 import type Query from "../rest/support/Query.js";
@@ -22,78 +25,103 @@ 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";
+import type { AnnotationFeatureSublayerProperties } from "./support/AnnotationFeatureSublayer.js";
+import type { ReadonlyArrayOrCollection } from "../core/Collection.js";
 
-export interface AnnotationLayerProperties extends LayerProperties, APIKeyMixinProperties, CustomParametersMixinProperties, PortalLayerProperties, OperationalLayerProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, BlendLayerProperties, FeatureLayerBaseProperties, Partial<Pick<AnnotationLayer, "outFields" | "popupEnabled">> {
+export interface AnnotationFeatureLayerProperties extends LayerProperties, APIKeyMixinProperties, CustomParametersMixinProperties, PortalLayerProperties, OperationalLayerProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, BlendLayerProperties, FeatureLayerBaseProperties, Partial<Pick<AnnotationFeatureLayer, "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/).
+   * [AnnotationFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationFeatureLayer/).
    *
    * 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 [createPopupTemplate()](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationFeatureLayer/#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;
+  /**
+   * A [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of [AnnotationFeatureSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/support/AnnotationFeatureSublayer/) objects that allow
+   * you to alter the visibility of one or more sublayers of the AnnotationFeatureLayer.
+   * If this property is not specified, all the sublayers from the feature service are displayed as defined in the service.
+   *
+   * All sublayers must be referenced using the [AnnotationFeatureSublayer.subtypeCode](https://developers.arcgis.com/javascript/latest/references/core/layers/support/AnnotationFeatureSublayer/#subtypeCode) to identify the sublayer. The sublayers may be [added](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/#add),
+   * [removed](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/#remove), or
+   * [reordered](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/#reorder) using the
+   * [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) methods. Because [AnnotationFeatureSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/support/AnnotationFeatureSublayer/) extends
+   * [Accessor](https://developers.arcgis.com/javascript/latest/references/core/core/Accessor/), its properties may be
+   * [watched](https://developers.arcgis.com/javascript/latest/watch-for-changes/#watch-for-changes-in-the-api).
+   *
+   * @example
+   * // Only includes the first AnnotationFeatureSublayer from the AnnotationFeatureLayer
+   * let layer = new AnnotationFeatureLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/RiversAnnotation/FeatureServer/0",
+   *   sublayers: [{
+   *     subtypeCode: 0,
+   *     visible: true
+   *   }]
+   * });
+   */
+  sublayers?: ReadonlyArrayOrCollection<AnnotationFeatureSublayerProperties> | null;
 }
 
-export interface AnnotationLayerEvents extends EditBusLayerEvents, RefreshableLayerEvents, LayerEvents {}
+export interface AnnotationFeatureLayerEvents extends EditBusLayerEvents, RefreshableLayerEvents, LayerEvents {}
 
-export default class AnnotationLayer extends AnnotationLayerSuperclass {
+export default class AnnotationFeatureLayer extends AnnotationFeatureLayerSuperclass {
   /**
    * @deprecated
    * Do not directly reference this property.
    * Use EventNames and EventTypes helpers from \@arcgis/core/Evented
    */
-  "@eventTypes": AnnotationLayerEvents;
+  "@eventTypes": AnnotationFeatureLayerEvents;
   /**
    * @example
    * // Create an annotation layer from a feature service layer URL.
    * ```js
-   * const layer = new AnnotationLayer({
+   * const layer = new AnnotationFeatureLayer({
    *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/RiversAnnotation/FeatureServer/0"
    * });
    * ```
    */
-  constructor(properties?: AnnotationLayerProperties);
+  constructor(properties?: AnnotationFeatureLayerProperties);
   /**
    * An array of fields in the layer.
    *
-   * @see [objectIdField](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationLayer/#objectIdField)
+   * @see [objectIdField](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationFeatureLayer/#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)
+   * [queries](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#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 [AnnotationFeatureLayerView.availableFields](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#availableFields)
    * @see [fieldUtils](https://developers.arcgis.com/javascript/latest/references/core/layers/support/fieldUtils/)
    * @example
    * // 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.
+   * // These fields will be added to AnnotationFeatureLayerView.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
+   * 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/AnnotationFeatureLayer/#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`.
    *
    * @default true
-   * @see [createPopupTemplate()](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationLayer/#createPopupTemplate)
+   * @see [createPopupTemplate()](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationFeatureLayer/#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)
    */
@@ -104,20 +132,44 @@ export default class AnnotationLayer extends AnnotationLayerSuperclass {
    * 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/).
+   * [AnnotationFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationFeatureLayer/).
    *
    * 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 [createPopupTemplate()](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationFeatureLayer/#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);
+  /**
+   * A [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of [AnnotationFeatureSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/support/AnnotationFeatureSublayer/) objects that allow
+   * you to alter the visibility of one or more sublayers of the AnnotationFeatureLayer.
+   * If this property is not specified, all the sublayers from the feature service are displayed as defined in the service.
+   *
+   * All sublayers must be referenced using the [AnnotationFeatureSublayer.subtypeCode](https://developers.arcgis.com/javascript/latest/references/core/layers/support/AnnotationFeatureSublayer/#subtypeCode) to identify the sublayer. The sublayers may be [added](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/#add),
+   * [removed](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/#remove), or
+   * [reordered](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/#reorder) using the
+   * [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) methods. Because [AnnotationFeatureSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/support/AnnotationFeatureSublayer/) extends
+   * [Accessor](https://developers.arcgis.com/javascript/latest/references/core/core/Accessor/), its properties may be
+   * [watched](https://developers.arcgis.com/javascript/latest/watch-for-changes/#watch-for-changes-in-the-api).
+   *
+   * @example
+   * // Only includes the first AnnotationFeatureSublayer from the AnnotationFeatureLayer
+   * let layer = new AnnotationFeatureLayer({
+   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/RiversAnnotation/FeatureServer/0",
+   *   sublayers: [{
+   *     subtypeCode: 0,
+   *     visible: true
+   *   }]
+   * });
+   */
+  get sublayers(): Collection<AnnotationFeatureSublayer> | null | undefined;
+  set sublayers(value: ReadonlyArrayOrCollection<AnnotationFeatureSublayerProperties> | 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";
+  get type(): "annotation-feature";
   /**
    * Creates a popup template for the layer, populated with all the fields of the layer.
    *
@@ -132,6 +184,27 @@ export default class AnnotationLayer extends AnnotationLayerSuperclass {
    * @returns A query object initialized from the layer configuration.
    */
   createQuery(): Query;
+  /**
+   * Returns the sublayer to which the given feature belongs.
+   *
+   * @param feature - The feature whose sublayer will be returned.
+   * @returns The sublayer from the `AnnotationFeatureLayer` to which the feature belongs to.
+   */
+  findSublayerForFeature(feature: Graphic): AnnotationFeatureSublayer | null | undefined;
+  /**
+   * Returns the sublayer with the [SubtypeSublayer.subtypeCode](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#subtypeCode) that matches the number passed as an argument.
+   *
+   * @param subtypeCode - The subtype coded value.
+   * @returns The sublayer from the `AnnotationFeatureLayer` to which the feature belongs to.
+   * @example
+   * // Updates the visibility of a sublayer after first finding
+   * // the sublayer from the subtypeCode.
+   * const subtypeCode = 5;
+   * const sublayer = annotationFeatureLayer.findSublayerForSubtypeCode(subtypeCode);
+   *
+   * sublayer.visible = true;
+   */
+  findSublayerForSubtypeCode(subtypeCode: number): AnnotationFeatureSublayer | null | undefined;
   /**
    * 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
@@ -142,7 +215,7 @@ export default class AnnotationLayer extends AnnotationLayerSuperclass {
    * >
    * > 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.
+   * > [AnnotationFeatureLayerView.queryExtent()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#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
@@ -176,7 +249,7 @@ export default class AnnotationLayer extends AnnotationLayerSuperclass {
    * >
    * > 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.
+   * > [AnnotationFeatureLayerView.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#queryFeatureCount) method.
    *
    * @param query - Specifies the attributes and
    * spatial filter of the query. If no parameters are specified, the total number of features
@@ -205,12 +278,12 @@ export default class AnnotationLayer extends AnnotationLayerSuperclass {
    * > **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.
+   * > use the [AnnotationFeatureLayerView.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#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.
+   * > based on `meter` units, then [queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/layers/AnnotationFeatureLayer/#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
@@ -228,7 +301,7 @@ export default class AnnotationLayer extends AnnotationLayerSuperclass {
    *   console.log(results.features);
    * });
    * @example
-   * const layer = new AnnotationLayer({
+   * const layer = new AnnotationFeatureLayer({
    *   url: fsUrl  // points to a Feature Service layer url
    * });
    *
@@ -252,7 +325,7 @@ export default class AnnotationLayer extends AnnotationLayerSuperclass {
    * >
    * > 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.
+   * > [AnnotationFeatureLayerView.queryObjectIds()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#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
@@ -270,4 +343,4 @@ export default class AnnotationLayer extends AnnotationLayerSuperclass {
    */
   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
+declare const AnnotationFeatureLayerSuperclass: 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/AnnotationFeatureLayer.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
+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 y,onAbort as m}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 v}from"../core/accessorSupport/decorators.js";import j from"./Layer.js";import{APIKeyMixin as g}from"./mixins/APIKeyMixin.js";import{ArcGISService as S}from"./mixins/ArcGISService.js";import{BlendLayer as L}from"./mixins/BlendLayer.js";import{CustomParametersMixin as E}from"./mixins/CustomParametersMixin.js";import{FeatureLayerBase as w}from"./mixins/FeatureLayerBase.js";import{OperationalLayer as F}from"./mixins/OperationalLayer.js";import{PortalLayer as I}from"./mixins/PortalLayer.js";import{RefreshableLayer as P}from"./mixins/RefreshableLayer.js";import{ScaleRangeLayer as x}from"./mixins/ScaleRangeLayer.js";import{TemporalLayer as _}from"./mixins/TemporalLayer.js";import T from"./support/AnnotationFeatureSublayer.js";import{barrierWeight as O,popupEnabled as C}from"./support/commonProperties.js";import{ensureLayerCredential as A,createQuery as q,getFieldDomain as U,hasDataChanged as k}from"./support/featureLayerUtils.js";import{defineFieldProperties as D}from"./support/fieldProperties.js";import{fixTimeInfoFields as N}from"./support/fieldUtils.js";import{serviceSupportsSpatialReference as Q}from"./support/versionUtils.js";import G from"../rest/support/Query.js";import{createPopupTemplate as H}from"../support/popupUtils.js";import{reader as J}from"../core/accessorSupport/decorators/reader.js";const M="annotation-feature-layer",R=D(),B=a.ofType(T);let K=class extends(w(L(_(x(P(S(F(I(u(E(g(o(j))))))))))))){constructor(e){super(e),this._sublayerLookup=new Map,this.barrierWeight="high",this.fields=null,this.fieldsIndex=null,this.operationalLayerType="ArcGISAnnotationLayer",this.outFields=null,this.popupEnabled=!0,this.popupTemplate=null,this.source=null,this.supportedSourceTypes=new Set(["Annotation Layer"]),this.type="annotation-feature",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(`${M}:missing-url`,"AnnotationFeatureLayer must be created with a url");return this.initLayerProperties(await this.createGraphicsSource(r))}).then(()=>A(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 B(r.subtypes.map(({code:e})=>new T({subtypeCode:e})).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).sort((e,r)=>e-r)??null)):this._get("visibleLayers")??null}set visibleLayers(e){this._set("visibleLayers",e)}createPopupTemplate(e){return H(this,e)}async createGraphicsSource(t){const s={stack:[],error:void 0,hasError:!1};try{const{default:r}=await y(import("./graphics/sources/FeatureLayerSource.js"),t),i=new r({layer:this,supportedSourceTypes:this.supportedSourceTypes});e(s,l(m(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=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=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}findSublayerForFeature(e){const r=this.fieldsIndex.get(this.subtypeField),t=e.attributes[r.name];return this.findSublayerForSubtypeCode(t)}findSublayerForSubtypeCode(e){return this._sublayerLookup.get(e)}getFieldDomain(e,r){return U(this,e,r,this.getField(e)?.domain??null)}async queryFeatures(e,r){const t=await this.load(),s=await t.source.queryFeatures(G.from(e)??t.createQuery(),r);if(s?.features)for(const i of s.features){const e=this.findSublayerForFeature(i);i.origin=e?.graphicOrigin,i.layer=i.sourceLayer=this}return s}async queryObjectIds(e,r){const t=await this.load();return t.source.queryObjectIds(G.from(e)??t.createQuery(),r)}async queryFeatureCount(e,r){const t=await this.load();return t.source.queryFeatureCount(G.from(e)??t.createQuery(),r)}async queryExtent(e,r){const t=await this.load();return t.source.queryExtent(G.from(e)??t.createQuery(),r)}serviceSupportsSpatialReference(e){return this.loaded&&Q(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})),N(this.timeInfo,this.fieldsIndex)}async hasDataChanged(){return k(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"),this._sublayerLookup.clear()),e&&(e.forEach(e=>{e.parent=this,this._sublayerLookup.set(e.subtypeCode,e)}),this.addHandles([e.on("after-add",({item:e})=>{e.parent=this,this._sublayerLookup.set(e.subtypeCode,e)}),e.on("after-remove",({item:e})=>{e.parent=null,this._sublayerLookup.delete(e.subtypeCode)})],"sublayers-owner"))}};t([b(O)],K.prototype,"barrierWeight",void 0),t([b({json:{write:!0}})],K.prototype,"editingEnabled",null),t([b({readOnly:!0})],K.prototype,"effectiveEditingEnabled",null),t([b({...R.fields,readOnly:!0,json:{read:!1,origins:{service:{read:!0}}}})],K.prototype,"fields",void 0),t([b(R.fieldsIndex)],K.prototype,"fieldsIndex",void 0),t([b({type:["ArcGISAnnotationLayer"]})],K.prototype,"operationalLayerType",void 0),t([b(R.outFields)],K.prototype,"outFields",void 0),t([b(C)],K.prototype,"popupEnabled",void 0),t([b({type:s,json:{name:"popupInfo",write:!0}})],K.prototype,"popupTemplate",void 0),t([b({readOnly:!0})],K.prototype,"defaultPopupTemplate",null),t([b({clonable:!1,readOnly:!0})],K.prototype,"source",void 0),t([b({type:B})],K.prototype,"sublayers",void 0),t([J("service","sublayers",["subtypes"])],K.prototype,"readSublayers",null),t([b({json:{read:!1},value:"annotation-feature",readOnly:!0})],K.prototype,"type",void 0),t([b({type:[Number],json:{write:{ignoreOrigin:!0}}})],K.prototype,"visibleLayers",null),K=t([v("esri.layers.AnnotationFeatureLayer")],K);const V=K;export{V as default};