ArcGISMapImageLayer class final

A layer that can visualize data from an ArcGIS map service using dynamically generated map images.

An ArcGIS map image layer displays a map from an ArcGIS MapServer REST service endpoint. Each time a request is made to the map server, layers contained in the map are rendered by the server and returned to the client as a single image of the map. While the image itself does not contain information about the features it displays, you can access and control the visual appearance of the layers using the ArcGISMapImageLayer.arcGISMapImageSublayers collection.

Functional characteristics

Map images are created and returned by the server on every request, so they show the latest data at the time of the request. You can specify characteristics of the image, such as ImageAdjustmentLayer.brightness, ImageAdjustmentLayer.contrast, ImageAdjustmentLayer.gamma, and Layer.opacity. If you obtain the associated sublayers of the ArcGISMapImageLayer using the ArcGISMapImageLayer.arcGISMapImageSublayers property, you can control the sublayer's visibility and its ArcGISSublayer.definitionExpression. If you want the background color for the map image to be transparent, you must set the ArcGISMapImageLayer.imageFormat to PNG.

The underlying ServiceFeatureTable, for each map image sublayer or for non-spatial tables used in the service, can be accessed via the ArcGISMapImageLayer.tables property. These tables can be queried using any valid combination of attribute, spatial, and temporal criteria via the numerous query methods. You can also query for FeatureTable.queryStatistics to see summary statistics or to find related features in other tables via the numerous query methods.

This layer supports time-based filtering.

Performance characteristics

The ArcGIS map service creates map images on the fly. This rendering time depends on the amount and complexity of the data in the map. It will typically be slower than fetching the equivalent map as previously rendered and cached tiles via an ArcGISTiledLayer. Because the server renders the map, map image layers require less processing time on the client than similar maps rendered locally.

ArcGIS map image layers are good candidates for showing features that change periodically, or that require filtering by the user. Although rendering occurs on the server, you have access to service feature tables for all sublayers (as well as non-spatial tables and relationships).

Inheritance
Implemented types

Constructors

ArcGISMapImageLayer.withItem(Item item)
Creates an ArcGIS map image layer from a PortalItem representing an ArcGIS map service.
factory
ArcGISMapImageLayer.withUri(Uri uri)
Creates an ArcGIS map image layer from the specified URI.
factory

Properties

arcGISMapImageSublayers → List<ArcGISMapImageSublayer>
The sublayers of an ArcGIS map image layer.
no setter
arcGISMapServiceInfo → ArcGISMapServiceInfo?
The ArcGIS map service information.
no setter
attribution → String
The attribution text for the layer.
no setterinherited
brightness ↔ double
The brightness of the layer.
getter/setter pairinherited
canChangeVisibility → bool
A flag indicating whether the layer content's visibility can be changed.
no setterinherited
contrast ↔ double
The contrast of the layer.
getter/setter pairinherited
description ↔ String
The description for the layer.
getter/setter pairinherited
fullExtent → Envelope?
The full extent of this layer, which is the extent where all layer data is contained.
no setterinherited
fullTimeExtent → TimeExtent?
The full time extent of the layer.
no setteroverride
gamma ↔ double
The gamma of the layer.
getter/setter pairinherited
geodatabaseVersion ↔ String
The geodatabase version of the map image layer.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String
The unique identifying string for the layer, as specified in a map or scene.
getter/setter pairinherited
imageFormat ↔ MapServiceImageFormat
The image format used to generate map images on this layer.
getter/setter pair
isIdentifyEnabled → bool
True if the layer supports identify, false otherwise.
no setterinherited
isTimeFilteringEnabled ↔ bool
True if the layer filters data based on its GeoViewController.timeExtent, false otherwise.
getter/setter pairoverride
isVisible ↔ bool
The layer content's visibility.
getter/setter pairinherited
item → Item?
The item the layer has been created from.
no setterinherited
loadError → ArcGISException?
The load error.
no setterinherited
loadStatus → LoadStatus
The load status.
no setterinherited
maxScale ↔ double
The maximum scale for the layer.
getter/setter pairinherited
minScale ↔ double
The minimum scale for the layer.
getter/setter pairinherited
name ↔ String
The layer content's name.
getter/setter pairinherited
onFullTimeExtentChanged → Stream<TimeExtent?>
Sets the callback invoked when the full time extent of the object has changed.
no setteroverride
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 setterinherited
onVisibilityChanged → Stream<bool>
Callback invoked when the visibility of the layer changes.
no setterinherited
opacity ↔ double
The opacity for the layer.
getter/setter pairinherited
refreshInterval ↔ int
The objects refresh interval.
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 pairinherited
spatialReference → SpatialReference?
The spatial reference of the layer.
no setterinherited
subLayerContents → List<LayerContent>
The sub layer contents of a layer content.
no setterinherited
supportsTimeFiltering → bool
True if the layer supports filtering data based on its time values, false otherwise.
no setteroverride
tables → List<ServiceFeatureTable>
The read-only collection of non-spatial tables in the map image layer.
no setter
timeInterval → TimeValue?
The suggested time slider step size for this time aware layer.
no setteroverride
timeOffset ↔ TimeValue?
The amount of time by which the temporal values of this layer's data points are offset when displaying it in a GeoViewController.
getter/setter pairoverride
uri → Uri?
The URL to the REST endpoint of an ArcGIS map service.
no setter

Methods

cancelLoad() → void
Cancels loading metadata for the object.
inherited
clone() → Layer
Clones this instance of the layer and its members.
inherited
fetchLegendInfos() → Future<List<LegendInfo>>
Fetches the list of legend info.
inherited
fetchLegendInfosCancelable() → CancelableOperation<List<LegendInfo>>
Cancelable version of fetchLegendInfos. See that method for more information.
inherited
isVisibleAtScale(double scale) → bool
Returns the layer content's effective visibility at the specified scale.
inherited
load() → Future<void>
Loads the metadata for the object asynchronously.
inherited
loadTablesAndLayers() → Future<void>
Loads all of the ArcGIS map service's sublayers and non-spatial tables.
loadTablesAndLayersCancelable() → CancelableOperation<void>
Cancelable version of loadTablesAndLayers. See that method for more information.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
resetSublayers() → void
Resets the sublayers of a map image layer to the default values defined by the service.
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.
inherited