Class ArcGISMapImageLayer
This class allows you to display data from an ArcGIS Map service by using dynamically generated map images.
Namespace: Esri.ArcGISRuntime.Mapping
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class ArcGISMapImageLayer : ImageAdjustmentLayer, INotifyPropertyChanged, ILoadable, ILayerContent, ICoreInstanceOwner, ICoreCallback_Layer_VisibilityChanged, ITimeAwareRemarks
ArcGIS map image layer displays maps from an ArcGIS map server (version 9.3 and higher) using REST. A map service can contain multiple layers, rendered by the server each time a request is made and returned to the client as a single image. While the image itself does not contain information about the features it displays, you can get the underlying data (service feature table) for each sub-layer. This layer supports time-based filtering.
Functional characteristics
Map images are created and returned by the server on every request, so they always show the latest data at the time of the request. Characteristics of the image, such as Brightness, Contrast, Gamma, and Opacity can be specified. By obtaining the associated sub-layers of the ArcGISMapImageLayer using the Sublayers property, you can control each sub-layer IsVisible and filter the data via the DefinitionExpression. Also, the SpatialReference can be changed from the service's default and the service will re-project each image on the fly.
The underlying ServiceFeatureTable, for each map
image sub-layer or for non-spatial tables used in the service, can be accessed via the
Tables property. These tables can be queried using any
valid combination of attribute, spatial, and temporal criteria via the numerous
QueryFeaturesAsync methods. You can also query for
QueryStatisticsAsync(StatisticsQueryParameters)
or to find related features in other tables via the numerous QueryRelatedFeasturesAsync
methods.
If you want the background color for the map image to be transparent, make sure the ImageFormat is set to PNG.
Performance characteristic
The map service creates map images on the fly. Rendering time depends on the amount and complexity of the data in the map. This will typically be slower than fetching the equivalent map as pre-rendered (or 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 over time, or that require some sort of filtering by the user. Although rendering occurs on the server, the client has access to service feature tables for all sub-layers (as well as non-spatial tables and relationships).
Sample Code:
Constructors
| Name | Description |
|---|---|
| ArcGISMapImageLayer(Item) | Initializes a new instance of the ArcGISMapImageLayer class from the specified PortalItem. |
| ArcGISMapImageLayer(Uri) | Initializes a new instance of the ArcGISMapImageLayer class with the specified URI. |
Properties
| Name | Description |
|---|---|
| Credential | Gets or sets the Credential used to access a remote service. |
| FullTimeExtent | Gets the temporal window that encapsulates the instance's complete set of data |
| GeodatabaseVersion | Gets or sets the geodatabase version of the map image layer. |
| ImageFormat | Gets or sets the MapServiceImageFormat of the map image layer. |
| IsTimeFilteringEnabled | Gets or sets a value indicating whether the instance respects any temporal filters that are applied to it. |
| RefreshInterval | Gets or sets the refresh interval on an ArcGISMapImageLayer. |
| ServiceInfo | Gets the map service information. |
| Source | Gets or sets the URI of the map service. |
| Sublayers | Gets a list of sublayers of this map image layer. |
| SupportsTimeFiltering | Gets a value indicating whether the instance supports filtering its data based on time. |
| Tables | Gets a read-only list of non-spatial tables in the map image layer. |
| TimeInterval | Gets a temporal value that represents the suggested temporal interval to use when sequentially stepping through the instance's data by time |
| TimeOffset | Gets or sets the amount of time by which to offset the temporal values of data points in this instance when displaying the data in a GeoView |
Methods
| Name | Description |
|---|---|
| LoadTablesAndLayersAsync() | Asynchronously initiates loading of the layer's sublayers. |
| ResetSublayers() | Resets the sub-layers of this ArcGISMapImageLayer to the default values defined by the ArcGIS Server service. |
Events
| Name | Description |
|---|---|
| FullTimeExtentChanged | Raised when the FullTimeExtent of the instance's data changes |
See Also
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0 |
| .NET Framework | 100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |
| .NET 5 | 100.12.0, 100.11.0, 100.10.0 |
| .NET Core | 100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0 |
| Xamarin.Android | 100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |
| Xamarin.iOS | 100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |
| UWP | 100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |