@arcgis/map-components 5.2.0-next.7 → 5.2.0-next.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/components/arcgis-map/customElement.d.ts +21 -35
  2. package/dist/docs/api.json +1 -1
  3. package/dist/docs/docs.json +1 -1
  4. package/dist/docs/vscode.html-custom-data.json +1 -1
  5. package/dist/docs/web-types.json +1 -1
  6. package/package.json +4 -4
package/dist/components/arcgis-map/customElement.d.ts CHANGED
@@ -994,42 +994,28 @@ export abstract class ArcgisMap extends LitElement {
994
994
  */
995
995
  goTo(target: GoToTarget2D, options?: GoToOptions2D): Promise<unknown>;
996
996
  /**
997
- * Returns [hit test results](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#HitTestResult)
998
- * from each layer that intersects the specified screen coordinates. The results are
999
- * organized as an array of objects containing different [result types](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#HitTestResult).
1000
- *
1001
- * The following layer types will return all [features](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#GraphicHit) if a hit is
1002
- * made on intersecting features: [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/),
1003
- * [CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/),
1004
- * [CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/),
1005
- * [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/),
1006
- * [GeoRSSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoRSSLayer/),
1007
- * [GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/),
1008
- * [KMLLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KMLLayer/),
1009
- * [MapNotesLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MapNotesLayer/),
1010
- * [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OGCFeatureLayer/),
1011
- * [StreamLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/StreamLayer/),
1012
- * [SubtypeSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/),
1013
- * [VectorTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VectorTileLayer/), and
1014
- * [WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer/).
1015
- *
1016
- * The [ParquetLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ParquetLayer/) hit result returns only the topmost feature
1017
- * when the hit occurs on overlapping features in a ParquetLayer.
1018
- *
1019
- * The [VectorTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VectorTileLayer/) hit test result contains an array of objects containing
1020
- * a [graphic](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#GraphicHit).
1021
- * The graphic returns attributes of a style layer. In addition, the graphic's [origin](https://developers.arcgis.com/javascript/latest/references/core/Graphic/#origin)
1022
- * contains the style layer's [id](https://maplibre.org/maplibre-style-spec/layers/#id) and layer index within the [vector tile style](https://doc.arcgis.com/en/arcgis-online/reference/tile-layers.htm#ESRI_SECTION1_8F68399EB47B48FF9EF46719FCC96978).
1023
- * Spatial information about the actual feature represented in the style layer is returned only if the style layer is a [symbol layer](https://maplibre.org/maplibre-style-spec/layers/#symbol).
1024
- * Otherwise, the graphic's geometry is `null`.
1025
- *
1026
- * The [MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer/) hit test result contains all media elements if the hit is made on intersecting elements.
1027
- * The [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/) hit test result contains all route elements if the hit is made on intersecting elements.
1028
- *
1029
- * If the [polygon](https://developers.arcgis.com/javascript/latest/references/core/geometry/Polygon/) feature's symbol
1030
- * [style](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleFillSymbol/#style) is set to `none`, the hitTest method will not
997
+ * Returns [hit test results](https://developers.arcgis.com/javascript/latest/references/core/views/types/#ViewHitTestResult) from each layer that intersects the specified screen point or screen rectangle.
998
+ * The results are organized as an array of objects containing different [ViewHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#ViewHit) result types such as graphics, raster pixels, media elements, or routes.
999
+ *
1000
+ * **2D hitTest() behavior by layer type**
1001
+ * | Layer type | Hit test behavior |
1002
+ * | :--- | :--- |
1003
+ * | [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer), [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/catalog/CatalogFootprintLayer), [CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer), [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OGCFeatureLayer), [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OrientedImageryLayer), [StreamLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/StreamLayer), [SubtypeGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SubtypeGroupLayer), [WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer) | Returns all intersecting [GraphicHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) features at the hit location. |
1004
+ * | [ParquetLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ParquetLayer) | Returns only the topmost [GraphicHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) feature when the hit occurs on overlapping features. (as of version 4.34). |
1005
+ * | [GeoRSSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoRSSLayer), [GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer), [KMLLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KMLLayer), [MapNotesLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MapNotesLayer) | Returns all intersecting [GraphicHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) features at the hit location. |
1006
+ * | [ImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer), [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryTileLayer)| Returns [RasterHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#RasterHit) result containing raster pixel value used in rendering and bandId info on intersecting pixels. The `screenRect` hitTarget is not supported for these layers. |
1007
+ * | [VectorTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VectorTileLayer) | Returns a result for all intersecting [GraphicHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) features containing attributes of style layers (as of version 4.29; in prior releases, only the topmost style layer result was returned). In addition, the graphic's [origin](https://developers.arcgis.com/javascript/latest/references/core/Graphic#origin) contains the style layer's [id](https://maplibre.org/maplibre-style-spec/layers/#id) and layer index within the [vector tile style](https://doc.arcgis.com/en/arcgis-online/reference/tile-layers.htm#ESRI_SECTION1_8F68399EB47B48FF9EF46719FCC96978). Spatial information about the actual feature represented in the style layer is returned only if the style layer is a [symbol layer](https://maplibre.org/maplibre-style-spec/layers/#symbol). Otherwise, the graphic's geometry is `null`. |
1008
+ * | [MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer) | Returns [MediaHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#MediaHit) result containing all media elements if the hit is made on intersecting elements. |
1009
+ * | [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer) | Returns [RouteHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#RouteHit) result containing all intersecting route elements if the hit is made on intersecting elements. |
1010
+ *
1011
+ * **Note:** If the [Polygon](https://developers.arcgis.com/javascript/latest/references/core/geometry/Polygon) feature's symbol [SimpleFillSymbol.style](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleFillSymbol#style) is set to "none", the hitTest method will not
1031
1012
  * return results when the fill is clicked. However, it will return results when the outline is clicked. To get results when clicking the fill, set the
1032
- * [color](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleFillSymbol/#color) to a transparent color instead.
1013
+ * [SimpleFillSymbol.color](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleFillSymbol#color) to a transparent color instead.
1014
+ *
1015
+ * Release-specific changes:
1016
+ * * At version 5.1, the [ScreenRect](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenRect) option was added to perform hit tests on rectangular areas.
1017
+ * * At version 4.24, [ViewHitTestResult](https://developers.arcgis.com/javascript/latest/references/core/views/types/#ViewHitTestResult) returns an array of objects containing [GraphicHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) graphic, [MediaHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#MediaHit) media element, and [RouteHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#RouteHit) route.
1018
+ * * At version 4.23, all hit test features from feature layers are returned in the result. In prior releases, only the top most feature was returned.
1033
1019
  *
1034
1020
  * @param hitTarget
1035
1021
  * @param options