IdentifyLayerResult Class

  • IdentifyLayerResult
  • class Esri::ArcGISRuntime::IdentifyLayerResult

    The identified GeoElements of a GeoView::identifyLayersAsync task. More...

    Header: #include <IdentifyLayerResult.h>
    Since: Esri::ArcGISRuntime 100.0
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    virtual ~IdentifyLayerResult() override
    Esri::ArcGISRuntime::Error error() const
    QList<Esri::ArcGISRuntime::GeoElement *> geoElements() const
    bool isTransferLimitExceeded() const
    Esri::ArcGISRuntime::LayerContent *layerContent() const
    QList<Esri::ArcGISRuntime::Popup *> popups() const
    QList<Esri::ArcGISRuntime::IdentifyLayerResult *> sublayerResults() const

    Detailed Description

    Obtain these results through the identifyLayersCompleted signal.

    Relevant samples:

    • Configure clusters: Add client side feature reduction on a point feature layer that is not pre-configured with clustering.
    • Display clusters: Display a web map with a point feature layer that has feature reduction enabled to aggregate points into clusters.
    • Identify KML features: Show a callout with formatted content for a KML feature.
    • Identify layers: Identify features in all layers in a map.
    • Identify raster cell: Get the cell value of a local raster at the tapped location and display the result in a callout.
    • Scene layer selection: Identify features in a scene to select.
    • Show popup: Show predefined popups from a web map.

    See also GeoView, MapQuickView::identifyLayersCompleted, and MapGraphicsView::identifyLayersCompleted.

    Member Function Documentation

    [override virtual] IdentifyLayerResult::~IdentifyLayerResult()

    Destructor.

    Esri::ArcGISRuntime::Error IdentifyLayerResult::error() const

    Returns the error that occurred during the identify operation, if there is one.

    QList<Esri::ArcGISRuntime::GeoElement *> IdentifyLayerResult::geoElements() const

    Returns the identify result's list of identified graphics.

    If there are no geo element results at the layer level (for layers where geo element results are exposed in sublayer results), an empty array is returned. The array type depends on the type of objects contained in the layer and whether AggregationFeatureReduction is enabled on the layer. When AggregationFeatureReduction is enabled on the layer, the array type will be either the AggregateGeoElement or the GeoElement type contained in the layer. The function will always return an array containing objects that implement GeoElement.

    bool IdentifyLayerResult::isTransferLimitExceeded() const

    Returns if the transfer limit was exceeded for the identify results.

    Esri::ArcGISRuntime::LayerContent *IdentifyLayerResult::layerContent() const

    Returns the layer identify result's layer content (a LayerContent).

    The element will contain an object that implements LayerContent. This may be either an ArcGISSublayer or a Layer.

    QList<Esri::ArcGISRuntime::Popup *> IdentifyLayerResult::popups() const

    Gets a list of the identifed popups for the layer represented by layerContent.

    The list of popups may be empty if the layer is composed of sub layers, in which case sublayerResults will be populated with results from sub layers.

    Only valid when the identify was called with the returnPopupsOnly parameter set to true.

    QList<Esri::ArcGISRuntime::IdentifyLayerResult *> IdentifyLayerResult::sublayerResults() const

    Returns the identify layer result's list of sub results.

    For layers that do not contain sublayers, this array will be empty.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.