@arcgis/core/graphic/GraphicOrigin.d.ts

ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API

/**
 * The base class for graphic origins. This class has no constructor.
 * Provides contextual information about where a graphic originates from, when available.
 * Origin details may be returned by methods such as [MapView.hitTest()](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#hitTest) or by calling `queryFeatures()` on a layer or layer view.
 * Depending on the origin type, this information may include the source layer or other origin-related metadata.
 *
 * @since 4.34
 * @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 [FeatureLayer.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#queryFeatures)
 * @see [FeatureLayerView.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/FeatureLayerView/#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 abstract class GraphicOrigin {}