isStreamGraphicOrigin

import { isStreamGraphicOrigin } from "@arcgis/core/graphic/isStreamGraphicOrigin.js";

Since: ArcGIS Maps SDK for JavaScript 5.0

Provides a utility function to determine whether a graphic's origin is a StreamGraphicOrigin.

Example

// Use hitTest() to get a graphic, then check whether it originated from a StreamLayer.
view.hitTest(screenPoint).then((response) => {
  const graphic = response.results[0]?.graphic;
  if (!graphic) {
    return;
  }
  if (isStreamGraphicOrigin(graphic.origin)) {
    // hitTest returned a graphic from a StreamLayer.
    // Use this info for your processing logic.
  } else {
    console.log("graphic's origin is NOT a StreamLayer");
  }
});

Functions

Name	Return Type	Object
`isStreamGraphicOrigin`	`origin is StreamGraphicOrigin`

Function

Utility function that determines whether a graphic’s origin is a StreamGraphicOrigin.

Signature: isStreamGraphicOrigin (origin: GraphicOrigin | null | undefined): origin is StreamGraphicOrigin

Parameters

Parameter	Type	Description	Required
origin	`GraphicOrigin \| null \| undefined`	The graphic origin to check.

Returns: origin is StreamGraphicOrigin
Returns true if the graphic origin is of type StreamGraphicOrigin, false otherwise.