identify
Initiate an Identify operation on the specified graphicsOverlay.
The tolerance parameter determines the extent of the region used during the identify operation. This overload will return the visible topmost graphic. 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 instance that is returned by the identify operation:
true: only the IdentifyGraphicsOverlayResult.popups property will be populated with results. If the overlay does not have popups an error will be returned.
false: the IdentifyGraphicsOverlayResult.geoElements, IdentifyGraphicsOverlayResult.graphics, and IdentifyGraphicsOverlayResult.popups are populated, if the overlay has popups.
Return
A Result containing an IdentifyGraphicsOverlayResult, or failure
Since
200.0.0
Parameters
overlay on which to run the identify
location at which to run identify in screen coordinates
extent of the region used during the identify operation
whether the graphics property of the result is populated
Initiate an Identify operation on the specified graphicsOverlay.
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 instance that is returned by the identify operation:
true: only the IdentifyGraphicsOverlayResult.popups property will be populated with results. If the overlay does not have popups an error will be returned.
false: IdentifyGraphicsOverlayResult.geoElements, IdentifyGraphicsOverlayResult.graphics, and IdentifyGraphicsOverlayResult.popups are populated, if the overlay has popups.
Return
A Result containing an IdentifyGraphicsOverlayResult, or failure
Since
200.0.0
Parameters
overlay on which to run the identify
location at which to run identify in screen coordinates
extent of the region used during the identify operation
whether the graphics property of the result is populated
maximum size of the result set of ref@Graphic to return. -1 indicates unlimited results