@arcgis/core
Version:
ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API
38 lines (37 loc) • 2.49 kB
TypeScript
import type GraphicOrigin from "./GraphicOrigin.js";
import type CatalogLayer from "../layers/CatalogLayer.js";
import type CatalogFootprintLayer from "../layers/catalog/CatalogFootprintLayer.js";
/**
* Provides information about the [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/catalog/CatalogFootprintLayer/) 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/catalog/CatalogFootprintLayer/#queryFeatures).
*
* @since 5.0
* @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 [Map component hitTest()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#hitTest)
* @see [Scene component hitTest()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#hitTest)
* @see [CatalogFootprintLayer.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/layers/catalog/CatalogFootprintLayer/#queryFeatures)
* @see [CatalogFootprintLayerView.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/CatalogFootprintLayerView/#queryFeatures)
* @example
* // get a point from view's click event
* view.on("click", async (event) => {
* // Search for all features only on included layer at the clicked location
* const response = await view.hitTest(event, {include: layer});
* // if graphics are returned from layer, get the layer id from graphic origin
* if (response.results.length > 0) {
* const originId = response.results[0].graphic?.origin?.layer?.id;
* }
* });
*/
export default class CatalogGraphicOrigin extends GraphicOrigin {
constructor(layer: CatalogFootprintLayer);
/** A layer from which a graphic originates. */
readonly layer: CatalogFootprintLayer;
/**
* Indicates the type of layer the graphic originated from.
*
* @default "catalog"
*/
readonly type: CatalogLayer["type"];
}