Skip to content

IdentifyLayerResult Class

  • IdentifyLayerResult
  • class Esri::ArcGISRuntime::IdentifyLayerResult

    The identify layer result contains the identified geoelements of a layer. 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

    Operations that identify the geoelements in a layer, such as GeoView::identifyLayerAsync(Esri::ArcGISRuntime::Layer*, const QPointF&, double, bool, QObject*) or GeoView::identifyLayersAsync(const QPointF&, double, bool, QObject*), return the resulting geoelements in a geoElements collection for each layer.

    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 noexcept] 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 collection of identified geoelements.

    If there are no geoelement results at the layer level (for layers where geoelement results are exposed in sublayer results), an empty QList is returned. The function will always return an QList containing objects that implement GeoElement. The specific type of geoelement in the collection 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, geoelements in the QList will be either AggregateGeoElement or the GeoElement type contained in the layer.

    bool IdentifyLayerResult::isTransferLimitExceeded() const

    Returns true if the transfer limit was exceeded for the identify results, false otherwise.

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

    Returns the layer that contains the identified geoelements.

    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

    Returns a QList of identified popups.

    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 QList of sub results.

    For layers that do not contain sublayers, the QList 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.