Skip To Content ArcGIS for Developers Sign In Dashboard

Layer QML Type

Base type for layer types. More...

Properties

Signals

Methods

Detailed Description

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

This base type contains methods to call on derived layer types to change extent, draw, and so on.

Layer is the base types for many types of layers. Each layer type is designed for a certain type of data source, display characteristics or behavior.

See also Cancelable, LayerContent, Loadable, and Loadable.

Property Documentation

attribution : string

Returns the attribution of the Layer (read-only).


description : string

The description of the Layer.

For service layers, the description is defined by the service when the layer initializes.


error : Error

Returns the error object (read-only).

See also Loadable and Error.


fullExtent : Envelope

Returns the full extent of the layer if available (read-only).


identifyEnabled : bool

Specifies whether the layer supports identify (read-only).


item : ArcGISItem

The item used to initialize the layer (read-only).


layerId : string

The layer's ID specified in the web map JSON.


layerType : Enums.LayerType

Returns the Enums.LayerType of the Layer (read-only).

See also Enums.LayerType.


legendInfos : LegendInfoListModel

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.

See also Loadable.


loadStatus : Enums.LoadStatus

The Enums.LoadStatus of the Layer.

See also Loadable and Enums.LoadStatus.


maxScale : double

Gets the maximum scale at which the layer displays.

For service layers, this is defined by the service.


minScale : double

Gets the minimum scale at which the layer displays.

For service layers, this is defined by the service.


name : string

The name of the layer.

See also LayerContent.


opacity : real

The opacity of the layer between 0.0 and 1.0.

0.0 is transparent and 1.0 is solid or opaque.


spatialReference : SpatialReference

Returns the spatial reference of the Layer (read-only).


subLayerContents : list<LayerContent>

See also LayerContent.


Signal Documentation

attributionChanged()

Emitted when the attribution property changes.


descriptionChanged()

Emitted when the description property changes.


fullExtentChanged()

Emitted when the fullExtent property changes.


identifyEnabledChanged()

Emitted when the identifyEnabled property changes.


itemChanged()

Emitted when the item property changes.


layerIdChanged()

Emitted when the layerId property changes.


loadErrorChanged()

Emitted when the loadError property of this Layer changes.

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

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property changes.

See also Loadable.


maxScaleChanged()

Emitted when the maxScale property changes.


minScaleChanged()

Emitted when the minScale property changes.


opacityChanged()

Emitted when the opacity property changes.


spatialReferenceChanged()

Emitted when the spatialReference property changes.


Method Documentation

void cancelLoad()

See also Loadable.


bool isVisibleAtScale(double scale)

Returns whether this layer would normally be visible when zoomed to the specified scale.


void load()

See also Loadable.


void retryLoad()

See also Loadable.



Feedback on this topic?