Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGISSublayer QML Type

A sublayer of a Layer. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.0
Inherits:

LayerContent

Inherited By:

ArcGISMapImageSublayer and ArcGISTiledSublayer

Properties

Signals

Methods

Detailed Description

Note: You cannot declare or create a component of this type in QML code.

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 Cancelable, LayerContent, Loadable, and PopupSource.

Property Documentation

autoFetchLegendInfos : bool

See also LayerContent.


canChangeVisibility : bool

See also LayerContent.


definitionExpression : string

Returns the sublayer's definition expression (read-only).

This QML property was introduced in Esri.ArcGISRuntime 100.1.


error : Error

Returns the error object (read-only).

This QML property was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable and Error.


labelsEnabled : bool

Returns whether the sublayer's labels are enabled (read-only).

This QML property was introduced in Esri.ArcGISRuntime 100.1.


legendInfos : LegendInfoListModel

Returns a list model containing legend infos for the sublayer and any nested sublayers (read-only).

See also LayerContent.


loadError : Error

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

This QML property was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable.


loadStatus : Enums.LoadStatus

The Enums.LoadStatus of the Layer.

This QML property was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable and Enums.LoadStatus.


mapServiceSublayerInfo : ArcGISMapServiceSublayerInfo

Returns the sublayer metadata after the sublayer is loaded (read-only).

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

This QML property was introduced in Esri.ArcGISRuntime 100.1.


maxScale : double

Returns the maximum scale at which the sublayer displays (read-only).


minScale : double

Returns the minimum scale at which the sublayer displays (read-only).


opacity : real

Returns the sublayer's opacity (read-only).

This QML property was introduced in Esri.ArcGISRuntime 100.1.


popupDefinition : PopupDefinition

See also PopupSource.


popupEnabled : bool

See also PopupSource.


renderer : Renderer

Returns the renderer specifying how the features should be symbolized (read-only).

This QML property was introduced in Esri.ArcGISRuntime 100.1.


scaleSymbols : bool

Returns whether the sublayer renders its symbols based on scale (read-only).

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 QML property was introduced in Esri.ArcGISRuntime 100.1.


showInLegend : bool

See also LayerContent.


subLayerContents : list<LayerContent>

Returns a list of layer contents for any sublayer (read-only).

See also LayerContent.


sublayerId : string

Returns the sublayer ID (read-only).

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This QML property was introduced in Esri.ArcGISRuntime 100.1.

See also sublayerIdAsInt.


sublayerIdAsInt : int

The same as sublayerId but represented as an integer type (read-only).

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This QML property was introduced in Esri.ArcGISRuntime 100.3.


sublayerType : Enums.ArcGISSublayerType

Returns the sublayer's type (read-only).

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

See also Enums.ArcGISSublayerType.


The sublayers represented as a list model of ArcGISSublayer.


visible : bool

See also LayerContent.


Signal Documentation

autoFetchLegendInfosChanged()

emitted when the autoFetchLegendInfos property changes.

See also LayerContent.


definitionExpressionChanged()

Emitted when the definitionExpression property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


labelsEnabledChanged()

Emitted when the labelsEnabled property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


loadErrorChanged()

Emitted when the loadError property of this ArcGISSublayer changes.

Note: load errors are also reported on the error property and emit the errorChanged signal.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable.


mapServiceSublayerInfoChanged()

Emitted when the mapServiceSublayerInfo property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


maxScaleChanged()

Emitted when the maxScale property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


minScaleChanged()

Emitted when the minScale property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


opacityChanged()

Emitted when the opacity property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


popupDefinitionChanged()

Emitted when the popupDefinition property changes.


popupEnabledChanged()

Emitted when the popupEnabled property changes.


rendererChanged()

Emitted when the renderer property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


scaleSymbolsChanged()

Emitted when the scaleSymbols property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


showInLegendChanged()

emitted when the showInLegend property changes.

See also LayerContent.


sublayerIdAsIntChanged()

Emitted when the sublayerIdAsInt property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.3.


sublayerIdChanged()

Emitted when the sublayerId property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


visibleChanged()

Emitted when the visible property changes.

See also LayerContent.


Method Documentation

void cancelLoad()

This QML method was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable.


bool isVisibleAtScale(double scale)

Whether the sublayer is visible at a given scale.


void load()

This QML method was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable.


void retryLoad()

This QML method was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable.



Feedback on this topic?