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

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

/**
 * Provides a utility function to determine whether a graphic's origin is a [SceneGraphicOrigin](https://developers.arcgis.com/javascript/latest/references/core/graphic/SceneGraphicOrigin/).
 *
 * @since 5.0
 * @example
 * // Use hitTest() to get a graphic, then check whether it originated from a SceneLayer.
 * view.hitTest(screenPoint).then((response) => {
 *   const graphic = response.results[0]?.graphic;
 *   if (!graphic) {
 *     return;
 *   }
 *   if (isSceneGraphicOrigin(graphic.origin)) {
 *     // hitTest returned a graphic from a SceneLayer.
 *     // Use this info for your processing logic.
 *   } else {
 *     console.log("graphic's origin is NOT a SceneLayer");
 *   }
 * });
 */
import type GraphicOrigin from "./GraphicOrigin.js";
import type SceneGraphicOrigin from "./SceneGraphicOrigin.js";

/**
 * Utility function that determines whether a graphic’s origin is a [SceneGraphicOrigin](https://developers.arcgis.com/javascript/latest/references/core/graphic/SceneGraphicOrigin/).
 *
 * @param origin - The graphic origin to check.
 * @returns Returns `true` if the graphic origin is of type [SceneGraphicOrigin](https://developers.arcgis.com/javascript/latest/references/core/graphic/SceneGraphicOrigin/), `false` otherwise.
 */
export function isSceneGraphicOrigin(origin: GraphicOrigin | null | undefined): origin is SceneGraphicOrigin;