Layer class final

A base class for classes that represent layers.

A layer, also known as an operational layer, provides access to geographic data that is displayed in a map or scene. Each layer references a file or service data source that contains either vector data (points, lines, polygons and attributes) or raster data (images). The ArcGISMap or ArcGISScene can display these layers inside an ArcGISMapViewController or SceneView, respectively. To enhance the displayed information, you can 'stack' the layers into a collection of GeoModel.operationalLayers or GeoModel.operationalLayers. The first layer in the collection is drawn first (on the bottom) and each subsequent layer is drawn on top of it.

Layer is the base class for these different types of layers:

Layer type 2D/3D Time-aware Online/offline Sources
Annotation layer ([AnnotationLayer]) 2D No Both ArcGIS feature service, portal item, mobile map package (.mmpk)
ArcGIS map image layer ([ArcGISMapImageLayer]) Both Yes Online ArcGIS map service
ArcGIS scene layer ([ArcGISSceneLayer](https://links.esri.com/flutter-parity)) 3D No Both Scene service or scene package
ArcGIS tiled layer ([ArcGISTiledLayer]) Both No Both ArcGIS tile service, tile package (.tpk/.tpkx)
ArcGIS vector tiled layer ([ArcGISVectorTiledLayer]) Both No Both ArcGIS vector tile service, vector tile package (.vtpk)
Bing maps layer ([BingMapsLayer](https://links.esri.com/flutter-parity)) Both No Online Bing maps
Dimension layer ([DimensionLayer]) 2D Yes Offline Mobile map package (.mmpk)
Dynamic entity layer ([DynamicEntityLayer](https://links.esri.com/flutter-parity)) Both No Online ArcGIS stream service
ENC layer ([EncLayer](https://links.esri.com/flutter-parity)) 2D No Offline ENC exchange set, ENC cell
Feature collection layer ([FeatureCollectionLayer]) Both No Both Portal item, web map, feature set / query result
Feature layer ([FeatureLayer]) Both Yes Both ArcGIS feature service, WFS, shapefile, GeoPackage, geodatabase, OGC API Features
Group layer ([GroupLayer]) Both No Both Other layers and group layers
KML layer ([KmlLayer](https://links.esri.com/flutter-parity)) Both Yes Both KML file (.kml, .kmz)
Integrated mesh layer ([IntegratedMeshLayer](https://links.esri.com/flutter-parity)) 3D No Both Scene layer package (.slpk)
Mobile basemap layer ([MobileBasemapLayer]) 2D No Offline Mobile map package (.mmpk)
OGC 3D Tiles layer ([Ogc3DTilesLayer](https://links.esri.com/flutter-parity)) 3D No Both Portal item, tileset, tile package(.3tz)
OpenStreetMap layer ([OpenStreetMapLayer]) Both No Online OpenStreetMap.org
Point cloud layer ([PointCloudLayer](https://links.esri.com/flutter-parity)) 3D No Both Portal item, scene layer package (.slpk)
Raster layer ([RasterLayer](https://links.esri.com/flutter-parity)) Both Yes Both GeoPackage, raster file, ArcGIS Image service
Subtype feature layer ([SubtypeFeatureLayer]) 2D No Both ArcGIS feature service, geodatabase
Web tiled layer ([WebTiledLayer]) Both No Online Web tile service
WMS layer ([WmsLayer]) Both Yes Online WMS service
WMTS layer ([WmtsLayer]) Both No Online WMTS service
Implemented types
Mixed in types
Implementers

Properties

attribution → String
The attribution text for the layer.
no setter
canChangeVisibility → bool
A flag indicating whether the layer content's visibility can be changed.
no setteroverride
description ↔ String
The description for the layer.
getter/setter pair
fullExtent → Envelope?
The full extent of this layer, which is the extent where all layer data is contained.
no setter
hashCode → int
The hash code for this object.
no setteroverride
id ↔ String
The unique identifying string for the layer, as specified in a map or scene.
getter/setter pair
isIdentifyEnabled → bool
True if the layer supports identify, false otherwise.
no setter
isVisible ↔ bool
The layer content's visibility.
getter/setter pairoverride
item → Item?
The item the layer has been created from.
no setter
loadError → ArcGISException?
The load error.
no setterinherited
loadStatus → LoadStatus
The load status.
no setterinherited
maxScale ↔ double
The maximum scale for the layer.
getter/setter pair
minScale ↔ double
The minimum scale for the layer.
getter/setter pair
name ↔ String
The layer content's name.
getter/setter pairoverride-getter
onLoadStatusChanged → Stream<LoadStatus>
A stream that reports changes to the LoadStatus.
no setterinherited
onSubLayerContentChanged → Stream<List<LayerContent>>
Callback invoked when the sublayer content of the layer content have changed.
no setteroverride
onVisibilityChanged → Stream<bool>
Callback invoked when the visibility of the layer changes.
no setter
opacity ↔ double
The opacity for the layer.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showInLegend ↔ bool
A flag indicating whether the layer content participates in the legend.
getter/setter pairoverride
spatialReference → SpatialReference?
The spatial reference of the layer.
no setter
subLayerContents → List<LayerContent>
The sub layer contents of a layer content.
no setteroverride

Methods

cancelLoad() → void
Cancels loading metadata for the object.
inherited
clone() → Layer
Clones this instance of the layer and its members.
fetchLegendInfos() → Future<List<LegendInfo>>
Fetches the list of legend info.
override
isVisibleAtScale(double scale) → bool
Returns the layer content's effective visibility at the specified scale.
override
load() → Future<void>
Loads the metadata for the object asynchronously.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
retryLoad() → Future<void>
Loads or retries loading metadata for the object asynchronously.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
override