identifyGraphicsOverlays

suspend fun identifyGraphicsOverlays(screenCoordinate: ScreenCoordinate, tolerance: Double, returnPopupsOnly: Boolean): Result<List<IdentifyGraphicsOverlayResult>>

Initiate an Identify operation on all graphics overlays.

Results are returned in top-to-bottom order.

The tolerance parameter determines the extent of the region used during the identify operation. This overload will return the single visible topmost graphic per overlay only. A tolerance of 0 tests just the physical pixel at screenCoordinate. Tolerance values above 0 are in DIPs and specify a circular region centered on screenCoordinate, with radius equal to tolerance. The maximum allowed tolerance value is 100 DIPs, resulting in an identify circle of diameter 200 DIPs.

The returnPopupsOnly parameter controls what properties are populated in the IdentifyGraphicsOverlayResult instances that are returned by the identify operation:

Return

A Result containing a List of IdentifyGraphicsOverlayResult containing one entry for each overlay in the view, or failure. Each entry holds a GraphicsOverlay, a List of GeoElement, and a List of Graphics

Since

200.0.0

Parameters

screenCoordinate

location on which to run identify in screen coordinates

tolerance

extent of the region used during the identify operation

returnPopupsOnly

whether the graphics property of the results are populated


suspend fun identifyGraphicsOverlays(screenCoordinate: ScreenCoordinate, tolerance: Double, returnPopupsOnly: Boolean, maximumResults: Int): Result<List<IdentifyGraphicsOverlayResult>>

Initiate an Identify operation on all graphics overlays.

Results are returned in top-to-bottom order.

The tolerance parameter determines the extent of the region used during the identify operation. Any graphics that intersect this test region when rendered are returned, up to the maximumResults limit. A tolerance of 0 tests just the physical pixel at screenCoordinate. Tolerance values above 0 are in DIPs and specify a circular region centered on screenCoordinate, with radius equal to tolerance. The maximum allowed tolerance value is 100 DIPs, resulting in an identify circle of diameter 200 DIPs.

The returnPopupsOnly parameter controls what properties are populated in the IdentifyGraphicsOverlayResult instances that are returned by the identify operation:

Return

A Result containing a List of IdentifyGraphicsOverlayResult containing one entry for each overlay in the view, or failure. Each entry holds a GraphicsOverlay, a List of GeoElement, and a List of Graphics

Since

200.0.0

Parameters

screenCoordinate

location on which to run identify in screen coordinates

tolerance

extent of the region used during the identify operation

returnPopupsOnly

whether the graphics property of the results are populated