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

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

import type GraphicOrigin from "./GraphicOrigin.js";
import type FeatureLayer from "../layers/FeatureLayer.js";

/**
 * Provides information about the [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/) 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/FeatureLayer/#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 [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 class FeatureGraphicOrigin extends GraphicOrigin {
  constructor(layer: FeatureLayer);
  /** A layer from which a graphic originates. */
  readonly layer: FeatureLayer;
  /**
   * Indicates the type of layer the graphic originated from.
   *
   * @default "feature"
   */
  readonly type: FeatureLayer["type"];
}