Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGISSublayer Class

(Esri::ArcGISRuntime::ArcGISSublayer)

A sublayer of a Layer. More...

Header: #include <ArcGISSublayer>
Since: Esri::ArcGISRuntime 100.0
Inherits: LayerContent, Loadable, and PopupSource
Inherited By:

Esri::ArcGISRuntime::ArcGISMapImageSublayer and Esri::ArcGISRuntime::ArcGISTiledSublayer

Public Functions

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

Reimplemented Public Functions

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

Signals

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

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

A sublayer of a Layer.

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

ArcGISSublayer::~ArcGISSublayer()

Destructor.

[virtual] bool ArcGISSublayer::canChangeVisibility() const

Reimplemented from LayerContent::canChangeVisibility().

Returns whether the sublayer's visibility can be changed.

See LayerContent.

[virtual] void ArcGISSublayer::cancelLoad()

Reimplemented from Loadable::cancelLoad().

See Loadable.

This function was introduced in Esri::ArcGISRuntime 100.1.

QString ArcGISSublayer::definitionExpression() const

Returns the sublayer's definition expression.

This function was introduced in Esri::ArcGISRuntime 100.1.

[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.

qint64 ArcGISSublayer::id() const

Returns the sublayer's ID.

[virtual] bool ArcGISSublayer::isAutoFetchLegendInfos() const

Reimplemented from LayerContent::isAutoFetchLegendInfos().

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.

[virtual] bool ArcGISSublayer::isPopupEnabled() const

Reimplemented from PopupSource::isPopupEnabled().

See 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.

[virtual] bool ArcGISSublayer::isShowInLegend() const

Reimplemented from LayerContent::isShowInLegend().

Returns whether the sublayer will be shown in the legend.

See LayerContent.

[virtual] bool ArcGISSublayer::isVisible() const

Reimplemented from LayerContent::isVisible().

Returns whether the sublayer is enabled to be visible.

See LayerContent.

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

Reimplemented from LayerContent::isVisibleAtScale().

Returns whether the sublayer is visible at a given scale.

See LayerContent.

[virtual] LegendInfoListModel *ArcGISSublayer::legendInfos() const

Reimplemented from LayerContent::legendInfos().

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

See LayerContent.

[virtual] void ArcGISSublayer::load()

Reimplemented from Loadable::load().

See Loadable.

This function was introduced in Esri::ArcGISRuntime 100.1.

[virtual] Error ArcGISSublayer::loadError() const

Reimplemented from Loadable::loadError().

See Loadable.

This function was introduced in Esri::ArcGISRuntime 100.1.

[virtual] LoadStatus ArcGISSublayer::loadStatus() const

Reimplemented from Loadable::loadStatus().

See Loadable.

This function was introduced in Esri::ArcGISRuntime 100.1.

[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.

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.

[virtual] QString ArcGISSublayer::name() const

Reimplemented from LayerContent::name().

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.

[virtual] PopupDefinition *ArcGISSublayer::popupDefinition() const

Reimplemented from PopupSource::popupDefinition().

See PopupSource.

See also setPopupDefinition().

Renderer *ArcGISSublayer::renderer() const

Returns the renderer specifying how the features should be symbolized.

This function was introduced in Esri::ArcGISRuntime 100.1.

[virtual] void ArcGISSublayer::retryLoad()

Reimplemented from Loadable::retryLoad().

See Loadable.

This function was introduced in Esri::ArcGISRuntime 100.1.

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

Reimplemented from LayerContent::setAutoFetchLegendInfos().

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

See LayerContent.

See also isAutoFetchLegendInfos().

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

Reimplemented from PopupSource::setPopupDefinition().

Sets the popup definition to popupDefinition.

See also popupDefinition() and PopupSource.

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

Reimplemented from PopupSource::setPopupEnabled().

Sets whether the PopupSource is enabled to popupEnabled.

See also isPopupEnabled() and PopupSource.

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

Reimplemented from LayerContent::setShowInLegend().

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

See LayerContent.

See also isShowInLegend().

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

Reimplemented from LayerContent::setVisible().

Sets whether the sublayer is visible to visible.

See LayerContent.

See also isVisible().

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

Reimplemented from LayerContent::subLayerContents().

Gets a list of layer contents for any sublayers.

See LayerContent.

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.

ArcGISSublayerListModel *ArcGISSublayer::sublayers() const

Gets a list of sublayers for this sublayer.

Returns an ArcGISSublayerListModel representing the sublayers.


Feedback on this topic?