Base type for layer types. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: | |
| Inherited By: | AnnotationLayer, ArcGISSceneLayer, ArcGISVectorTiledLayer, DimensionLayer, EncLayer, FeatureCollectionLayer, FeatureLayer, GroupLayer, ImageAdjustmentLayer, IntegratedMeshLayer, KmlLayer, MobileBasemapLayer, PointCloudLayer, UnknownLayer, and UnsupportedLayer |
Properties
- attribution : string
- description : string
- error : Error
- fullExtent : Envelope
- identifyEnabled : bool
- item : ArcGISItem
- layerId : string
- layerType : Enums.LayerType
- legendInfos : LegendInfoListModel
- loadError : Error
- loadStatus : Enums.LoadStatus
- maxScale : double
- minScale : double
- name : string
- opacity : real
- spatialReference : SpatialReference
- subLayerContents : list<LayerContent>
Signals
- attributionChanged()
- descriptionChanged()
- fullExtentChanged()
- identifyEnabledChanged()
- itemChanged()
- layerIdChanged()
- loadErrorChanged()
- loadStatusChanged()
- maxScaleChanged()
- minScaleChanged()
- opacityChanged()
- spatialReferenceChanged()
Methods
- void cancelLoad()
- bool isVisibleAtScale(double scale)
- void load()
- void retryLoad()
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 type | 2D/3D | Time-aware | Online/offline | Sources |
|---|---|---|---|---|
| AnnotationLayer | 2D | No | Both | ArcGIS feature service, portal item, mobile map package (.mmpk) |
| ArcGISMapImageLayer | Both | Yes | Online | ArcGIS map service |
| ArcGISSceneLayer | 3D | No | Both | Scene service or scene package |
| ArcGISTiledLayer | Both | No | ArcGIS tile service, tile package (.tpk/.tpkx) | |
| ArcGISVectorTiledLayer | 2D | No | Both | ArcGIS vector tile service, vector tile package (.vtpk) |
| BingMapsLayer | Both | No | Online | Bing maps |
| EncLayer | 2D | No | Offline | ENC exchange set, ENC cell |
| FeatureCollectionLayer | Both | No | Both | Portal item, web map, feature set / query result |
| FeatureLayer | Both | Yes | Both | ArcGIS feature service, WFS, shapefile, GeoPackage, geodatabase, OGC API Features |
| GroupLayer | Both | No | Both | Other layers and group layers |
| KmlLayer | Both | Yes | Both | KML file (.kml, .kmz) |
| IntegratedMeshLayer | 3D | No | Both | Scene later package (.slpk) |
| MobileBasemapLayer | 2D | No | Offline | Mobile map package (.mmpk) |
| OpenStreetMapLayer | Both | No | Online | OpenStreetMap.org |
| PointCloudLayer | 3D | No | Both | Portal item, scene layer package (.slpk) |
| RasterLayer | Both | Yes | Both | GeoPackage, raster file, ArcGIS Image service |
| SubtypeFeatureLayer | 2D | No | Both | ArcGIS feature service, geodatabase |
| WebTiledLayer | Both | No | Online | Web tile service |
| WmsLayer | Both | Yes | Online | WMS service |
| WmtsLayer | Both | No | Online | WMTS service |
See also Cancelable, LayerContent, and Loadable.
Property Documentation
The description of the Layer.
For service layers, the description is defined by the service when the layer initializes.
fullExtent : Envelope |
Returns the full extent of the layer if available (read-only).
item : ArcGISItem |
The item used to initialize the layer (read-only).
The layer's ID specified in the web map JSON.
See also Layer::item.
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.
The Enums.LoadStatus of the Layer.
See also Loadable and Enums.LoadStatus.
Gets the maximum scale at which the layer displays.
For service layers, this is defined by the service.
Gets the minimum scale at which the layer displays.
For service layers, this is defined by the service.
The name of the layer.
See also LayerContent.
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
Emitted when the attribution property changes.
Note: The corresponding handler is onAttributionChanged.
Emitted when the description property changes.
Note: The corresponding handler is onDescriptionChanged.
Emitted when the fullExtent property changes.
Note: The corresponding handler is onFullExtentChanged.
Emitted when the identifyEnabled property changes.
Note: The corresponding handler is onIdentifyEnabledChanged.
Emitted when the item property changes.
Note: The corresponding handler is onItemChanged.
Emitted when the layerId property changes.
Note: The corresponding handler is onLayerIdChanged.
Emitted when the loadStatus property changes.
Note: The corresponding handler is onLoadStatusChanged.
See also Loadable.
Emitted when the maxScale property changes.
Note: The corresponding handler is onMaxScaleChanged.
Emitted when the minScale property changes.
Note: The corresponding handler is onMinScaleChanged.
Emitted when the opacity property changes.
Note: The corresponding handler is onOpacityChanged.
Emitted when the spatialReference property changes.
Note: The corresponding handler is onSpatialReferenceChanged.
Method Documentation
See also Loadable.
Returns whether this layer would normally be visible when zoomed to the specified scale.
See also Loadable.
See also Loadable.