Method IdentifyGraphicsOverlaysAsync
| Edit this page View SourceIdentifyGraphicsOverlaysAsync(Point, double, bool, long)
Identifies a limited number of graphics in all graphics overlays, at the given screen point.
Declaration
public virtual Task<IReadOnlyList<IdentifyGraphicsOverlayResult>> IdentifyGraphicsOverlaysAsync(Point screenPoint, double tolerance, bool returnPopupsOnly = false, long maximumResultsPerOverlay = 1)
Parameters
| Type | Name | Description |
|---|---|---|
| Point | screenPoint | The screen coordinates to identify the graphics. |
| double | tolerance | A radius in device-independent pixels (DIP) that specifies how precise the identify operation should be. |
| bool | returnPopupsOnly |
|
| long | maximumResultsPerOverlay | The maximum number of graphics and/or popups returned in the IdentifyGraphicsOverlayResult per graphics overlay. A value of -1 indicates unlimited results. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<IdentifyGraphicsOverlayResult>> | A read-only collection of IdentifyGraphicsOverlayResult instances where each result is for one overlay in the view. |
Remarks
As locations from user gestures are not always accurate to the exact pixel, you can define a tolerance for the identify operation. The tolerance parameter sets the radius of a circle, centered at the specified coordinates, in device-independent pixels (DIP). If the tolerance value is 0, identify performs the test at the specified coordinates. If it is greater than 0, identify tests inside the circle. For touch displays a value of 22 is recommended to cover an average finger tap. The maximum allowed value is 100 DIPs.
The returnPopupsOnly parameter controls which properties are populated in the IdentifyGraphicsOverlayResult
instance. If true, only Popups is populated. If false, both Graphics and
Popups are populated, if the overlay has popups.
Results are returned in a top-to-bottom order.
This method is not supported on LocalSceneView.
IdentifyGraphicsOverlaysAsync(Point, double, bool, long)
Identifies a limited number of graphics in all graphics overlays, at the given screen point.
Declaration
public virtual Task<IReadOnlyList<IdentifyGraphicsOverlayResult>> IdentifyGraphicsOverlaysAsync(Point screenPoint, double tolerance, bool returnPopupsOnly = false, long maximumResultsPerOverlay = 1)
Parameters
| Type | Name | Description |
|---|---|---|
| Point | screenPoint | The screen coordinates to identify the graphics. |
| double | tolerance | A radius in device-independent pixels (DIP) that specifies how precise the identify operation should be. |
| bool | returnPopupsOnly |
|
| long | maximumResultsPerOverlay | The maximum number of graphics and/or popups returned in the IdentifyGraphicsOverlayResult per graphics overlay. A value of -1 indicates unlimited results. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<IdentifyGraphicsOverlayResult>> | A read-only collection of IdentifyGraphicsOverlayResult instances where each result is for one overlay in the view. |
Remarks
As locations from user gestures are not always accurate to the exact pixel, you can define a tolerance for the identify operation. The tolerance parameter sets the radius of a circle, centered at the specified coordinates, in device-independent pixels (DIP). If the tolerance value is 0, identify performs the test at the specified coordinates. If it is greater than 0, identify tests inside the circle. For touch displays a value of 22 is recommended to cover an average finger tap. The maximum allowed value is 100 DIPs.
The returnPopupsOnly parameter controls which properties are populated in the IdentifyGraphicsOverlayResult
instance. If true, only Popups is populated. If false, both Graphics and
Popups are populated, if the overlay has popups.
Results are returned in a top-to-bottom order.
This method is not supported on LocalSceneView.