@arcgis/core
Version:
ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API
33 lines (32 loc) • 1.62 kB
TypeScript
import type GraphicOrigin from "./GraphicOrigin.js";
import type ParquetLayer from "../layers/ParquetLayer.js";
/**
* Provides information about the [ParquetLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ParquetLayer/) 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).
*
* @since 5.0
* @see [MapView.hitTest()](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#hitTest)
* @see [Map component hitTest()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#hitTest)
* @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 ParquetGraphicOrigin extends GraphicOrigin {
constructor(layer: ParquetLayer);
/** A layer from which a graphic originates. */
readonly layer: ParquetLayer;
/**
* Indicates the type of layer the graphic originated from.
*
* @default "parquet"
*/
readonly type: ParquetLayer["type"];
}