Layer QML Type

  • Esri.ArcGISRuntime
  • Layer
  • 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.

    Layer is the base class for all layer types. A layer is a representation of geographic data portrayed using symbols and text labels. Multiple layers can be 'stacked' to enhance the information displayed. Layers are displayed in a Map inside a MapView control. Layers are drawn bottom-to-top, so the first layer in a map's layer collection is drawn first (on the bottom) and each subsequent layer is drawn on top of it.

    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.

    Layer is the base type for the following layer types.

    Layer type2D/3DTime-awareOnline/offlineSources
    AnnotationLayer2DNoBothArcGIS feature service, portal item, mobile map package (.mmpk)
    ArcGISMapImageLayerBothYesOnlineArcGIS map service
    ArcGISSceneLayer3DNoBothScene service or scene package
    ArcGISTiledLayerBothNoArcGIS tile service, tile package (.tpk/.tpkx)
    ArcGISVectorTiledLayer2DNoBothArcGIS vector tile service, vector tile package (.vtpk)
    BingMapsLayerBothNoOnlineBing maps
    DimensionLayer2DYesOfflineMobile map package (.mmpk)
    DynamicEntityLayerBothNoOnlineArcGIS stream service
    EncLayer2DNoOfflineENC exchange set, ENC cell
    FeatureCollectionLayerBothNoBothPortal item, web map, feature set / query result
    FeatureLayerBothYesBothArcGIS feature service, WFS, shapefile, GeoPackage, geodatabase, OGC API Features
    GroupLayerBothNoBothOther layers and group layers
    KmlLayerBothYesBothKML file (.kml, .kmz)
    IntegratedMeshLayer3DNoBothScene later package (.slpk)
    MobileBasemapLayer2DNoOfflineMobile map package (.mmpk)
    OpenStreetMapLayerBothNoOnlineOpenStreetMap.org
    PointCloudLayer3DNoBothPortal item, scene layer package (.slpk)
    RasterLayerBothYesBothGeoPackage, raster file, ArcGIS Image service
    SubtypeFeatureLayer2DNoBothArcGIS feature service, geodatabase
    WebTiledLayerBothNoOnlineWeb tile service
    WmsLayerBothYesOnlineWMS service
    WmtsLayerBothNoOnlineWMTS service

    See also Cancelable, LayerContent, and Loadable.

    Property Documentation

    [read-only] 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.


    [read-only] error : Error

    Returns the error object (read-only).

    See also Loadable and Error.


    [read-only] fullExtent : Envelope

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


    [read-only] identifyEnabled : bool

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


    [read-only] item : ArcGISItem

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


    layerId : string

    The unique identifying string for the layer, for example specified in a map or scene.

    The id is used by other parts of this API to refer to a specific Layer, such as in a set of FeatureFenceParameters or a FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.

    It is not recommended to change this property when the layer is obtained from a map or scene. If changed, ensure that the string is unique, for example based on a generated GUID.

    See also Layer::item.


    [read-only] layerType : Enums.LayerType

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

    See also Enums.LayerType.


    [read-only] legendInfos : LegendInfoListModel

    See also LayerContent.


    [read-only] 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.


    [read-only] 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.


    [read-only] spatialReference : SpatialReference

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


    [read-only] subLayerContents : list<LayerContent>

    See also LayerContent.


    Signal Documentation

    attributionChanged()

    Emitted when the attribution property changes.

    Note: The corresponding handler is onAttributionChanged.


    descriptionChanged()

    Emitted when the description property changes.

    Note: The corresponding handler is onDescriptionChanged.


    fullExtentChanged()

    Emitted when the fullExtent property changes.

    Note: The corresponding handler is onFullExtentChanged.


    identifyEnabledChanged()

    Emitted when the identifyEnabled property changes.

    Note: The corresponding handler is onIdentifyEnabledChanged.


    itemChanged()

    Emitted when the item property changes.

    Note: The corresponding handler is onItemChanged.


    layerIdChanged()

    Emitted when the layerId property changes.

    Note: The corresponding handler is onLayerIdChanged.


    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.

    Note: The corresponding handler is onLoadErrorChanged.

    See also Loadable and Object.


    loadStatusChanged()

    Emitted when the loadStatus property changes.

    Note: The corresponding handler is onLoadStatusChanged.

    See also Loadable.


    maxScaleChanged()

    Emitted when the maxScale property changes.

    Note: The corresponding handler is onMaxScaleChanged.


    minScaleChanged()

    Emitted when the minScale property changes.

    Note: The corresponding handler is onMinScaleChanged.


    opacityChanged()

    Emitted when the opacity property changes.

    Note: The corresponding handler is onOpacityChanged.


    spatialReferenceChanged()

    Emitted when the spatialReference property changes.

    Note: The corresponding handler is onSpatialReferenceChanged.


    Method Documentation

    void cancelLoad()

    See also Loadable.


    [since Esri.ArcGISRuntime 200.1] Layer clone()

    Creates a deep copy of this object.

    This method was introduced in Esri.ArcGISRuntime 200.1.


    [since Esri.ArcGISRuntime 200.1] bool equals(Layer other)

    Compares two Layers for equality.

    Returns whether this instance and other are equivalent.

    This method was introduced in Esri.ArcGISRuntime 200.1.


    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.


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