;

ArcGISSublayer Class

  • ArcGISSublayer
  • class Esri::ArcGISRuntime::ArcGISSublayer

    A sublayer of a Layer. More...

    This class was introduced in Esri::ArcGISRuntime 100.0.

    Public Functions

    virtual ~ArcGISSublayer() override
    QString definitionExpression() const
    qint64 id() const
    bool isLabelsEnabled() const
    bool isScaleSymbols() const
    Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo mapServiceSublayerInfo() const
    double maxScale() const
    double minScale() const
    float opacity() const
    Esri::ArcGISRuntime::Renderer *renderer() const
    Esri::ArcGISRuntime::ArcGISSublayerType sublayerType() const
    Esri::ArcGISRuntime::ArcGISSublayerListModel *sublayers() const

    Reimplemented Public Functions

    virtual bool canChangeVisibility() const override
    virtual void cancelLoad() override
    virtual bool isAutoFetchLegendInfos() const override
    virtual bool isPopupEnabled() const override
    virtual bool isShowInLegend() const override
    virtual bool isVisible() const override
    virtual bool isVisibleAtScale(double scale) const override
    virtual Esri::ArcGISRuntime::LegendInfoListModel *legendInfos() const override
    virtual void load() override
    virtual Esri::ArcGISRuntime::Error loadError() const override
    virtual Esri::ArcGISRuntime::LoadStatus loadStatus() const override
    virtual QString name() const override
    virtual Esri::ArcGISRuntime::PopupDefinition *popupDefinition() const override
    virtual void retryLoad() override
    virtual void setAutoFetchLegendInfos(bool autoFetchLegendInfos) override
    virtual void setPopupDefinition(Esri::ArcGISRuntime::PopupDefinition *popupDefinition) override
    virtual void setPopupEnabled(bool popupEnabled) override
    virtual void setShowInLegend(bool showInLegend) override
    virtual void setVisible(bool visible) override
    virtual QList<Esri::ArcGISRuntime::LayerContent *> subLayerContents() const override

    Signals

    void doneLoading(Esri::ArcGISRuntime::Error loadError)
    void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

    Detailed Description

    Some layer types contain sublayers. Sublayers contain properties, some of which can be accessed before the layer is loaded. These include:

    • id
    • name
    • maxScale
    • minScale
    • visible

    Other sublayer properties can be accessed only after the Layer is loaded.

    See also PopupSource and Loadable.

    Member Function Documentation

    [signal] void ArcGISSublayer::doneLoading(Esri::ArcGISRuntime::Error loadError)

    Signal emitted when this object is done loading.

    • loadError - Details about any error that may have occurred.

    Note: If there is a load error it will also be emitted on the errorOccurred signal.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    See also Loadable and Object.

    [signal] void ArcGISSublayer::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

    Signal emitted when the loadStatus changes for this object.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    See also Loadable.

    [override virtual] ArcGISSublayer::~ArcGISSublayer()

    Destructor.

    [override virtual] bool ArcGISSublayer::canChangeVisibility() const

    Reimplements: LayerContent::canChangeVisibility() const.

    Returns whether the sublayer's visibility can be changed.

    See LayerContent.

    [override virtual] void ArcGISSublayer::cancelLoad()

    Reimplements: Loadable::cancelLoad().

    See Loadable.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    QString ArcGISSublayer::definitionExpression() const

    Returns the sublayer's definition expression.

    The definition expression string uses the SQL-92 WHERE clause syntax. Be sure to escape special characters in the expression string as required for your platform. The DATE keyword expects the date format yyyy-mm-dd and the TIMESTAMP keyword expects the time stamp format yyyy-mm-dd hh:mm:ss. See the ArcGIS Blog article Querying Feature Services Date-Time Queries for more information.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    qint64 ArcGISSublayer::id() const

    Returns the sublayer's ID.

    [override virtual] bool ArcGISSublayer::isAutoFetchLegendInfos() const

    Reimplements: LayerContent::isAutoFetchLegendInfos() const.

    Returns whether legend infos are automatically fetched by the sublayer's legend info list model.

    See LayerContent.

    bool ArcGISSublayer::isLabelsEnabled() const

    Returns whether the sublayer's labels are displayed.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    [override virtual] bool ArcGISSublayer::isPopupEnabled() const

    Reimplements: PopupSource::isPopupEnabled() const.

    Returns whether the Popup is enabled on the PopupSource.

    bool ArcGISSublayer::isScaleSymbols() const

    Returns whether the sublayer renders its symbols based on scale.

    A value of false means the symbols stay the same size in screen units regardless of the map scale.

    The default value is false.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    [override virtual] bool ArcGISSublayer::isShowInLegend() const

    Reimplements: LayerContent::isShowInLegend() const.

    Returns whether the sublayer will be shown in the legend.

    See LayerContent.

    [override virtual] bool ArcGISSublayer::isVisible() const

    Reimplements: LayerContent::isVisible() const.

    Returns whether the sublayer is enabled to be visible.

    See LayerContent.

    [override virtual] bool ArcGISSublayer::isVisibleAtScale(double scale) const

    Reimplements: LayerContent::isVisibleAtScale(double scale) const.

    Returns whether the sublayer is visible at a given scale.

    See LayerContent.

    [override virtual] Esri::ArcGISRuntime::LegendInfoListModel *ArcGISSublayer::legendInfos() const

    Reimplements: LayerContent::legendInfos() const.

    Returns a list of legend information for the sublayer and any of its sublayers.

    See LayerContent.

    [override virtual] void ArcGISSublayer::load()

    Reimplements: Loadable::load().

    See Loadable.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    [override virtual] Esri::ArcGISRuntime::Error ArcGISSublayer::loadError() const

    Reimplements: Loadable::loadError() const.

    See Loadable.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    [override virtual] Esri::ArcGISRuntime::LoadStatus ArcGISSublayer::loadStatus() const

    Reimplements: Loadable::loadStatus() const.

    See Loadable.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo ArcGISSublayer::mapServiceSublayerInfo() const

    Returns the sublayer metadata after the sublayer is loaded.

    Will return empty object if an error occurs or if the sublayer is not loaded.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    double ArcGISSublayer::maxScale() const

    Returns the maximum scale at which the sublayer displays.

    double ArcGISSublayer::minScale() const

    Returns the minumum scale at which the sublayer displays.

    [override virtual] QString ArcGISSublayer::name() const

    Reimplements: LayerContent::name() const.

    Returns the sublayer's name.

    See LayerContent.

    float ArcGISSublayer::opacity() const

    Returns the sublayer's opacity.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    [override virtual] Esri::ArcGISRuntime::PopupDefinition *ArcGISSublayer::popupDefinition() const

    Reimplements: PopupSource::popupDefinition() const.

    See PopupSource.

    See also setPopupDefinition().

    Esri::ArcGISRuntime::Renderer *ArcGISSublayer::renderer() const

    Returns the renderer specifying how the features should be symbolized.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    [override virtual] void ArcGISSublayer::retryLoad()

    Reimplements: Loadable::retryLoad().

    See Loadable.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    [override virtual] void ArcGISSublayer::setAutoFetchLegendInfos(bool autoFetchLegendInfos)

    Reimplements: LayerContent::setAutoFetchLegendInfos(bool autoFetchLegendInfos).

    Sets whether legend infos are automatically fetched by the sublayer's legend info list model to autoFetchLegendInfos.

    See LayerContent.

    See also isAutoFetchLegendInfos().

    [override virtual] void ArcGISSublayer::setPopupDefinition(Esri::ArcGISRuntime::PopupDefinition *popupDefinition)

    Reimplements: PopupSource::setPopupDefinition(Esri::ArcGISRuntime::PopupDefinition *popupDefinition).

    Sets the popup definition to popupDefinition.

    See also popupDefinition() and PopupSource.

    [override virtual] void ArcGISSublayer::setPopupEnabled(bool popupEnabled)

    Reimplements: PopupSource::setPopupEnabled(bool popupEnabled).

    Sets whether the PopupSource is enabled to popupEnabled.

    See also isPopupEnabled() and PopupSource.

    [override virtual] void ArcGISSublayer::setShowInLegend(bool showInLegend)

    Reimplements: LayerContent::setShowInLegend(bool showInLegend).

    Sets whether the sublayer will be shown in the legend to showInLegend.

    See LayerContent.

    See also isShowInLegend().

    [override virtual] void ArcGISSublayer::setVisible(bool visible)

    Reimplements: LayerContent::setVisible(bool visible).

    Sets whether the sublayer is visible to visible.

    See LayerContent.

    See also isVisible().

    [override virtual] QList<Esri::ArcGISRuntime::LayerContent *> ArcGISSublayer::subLayerContents() const

    Reimplements: LayerContent::subLayerContents() const.

    Gets a list of layer contents for any sublayers.

    See LayerContent.

    Esri::ArcGISRuntime::ArcGISSublayerType ArcGISSublayer::sublayerType() const

    Returns the sublayer's type.

    A sublayer may be an image sublayer or a tiled sublayer, or the type may be unknown.

    Esri::ArcGISRuntime::ArcGISSublayerListModel *ArcGISSublayer::sublayers() const

    Gets a list of sublayers for this sublayer.

    Returns an ArcGISSublayerListModel representing the sublayers.

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