Arc
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.mapImageSublayers 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.mapImageSublayers 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(StatisticsQueryParameters) 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).
Since
200.1.0
See also
Constructors
Creates an ArcGIS map image layer from a PortalItem representing an ArcGIS map service. The item's type should be PortalItemType.MapService.
Creates an ArcGIS map image layer from the specified URI. If the specified URI is a map service URL, the MapServer must have "Single Fused Map Cache" set to false in its ArcGIS REST Services Directory. If the specified URI is a portal item URL, the underlying PortalItem is created and can be accessed through Layer.item. See PortalItem.PortalItem(String) for the supported URL formats.
Properties
The geodatabase version of the map image layer.
The image format used to generate map images on this layer. If imageFormat value is MapServiceImageFormat.Default, the default image format is defined by the service.
The sublayers of an ArcGIS map image layer. The collection is specific to a layer so you can't reuse a sublayer collection coming from another ArcGISMapImageLayer or ArcGISSublayer. You have to create a new layer collection.
The ArcGIS map service information. This information is available after the layer has successfully loaded.
The read-only collection of non-spatial tables in the map image layer. The collection is specific to this map image layer. Tables are not loaded by default. You can load a table by calling FeatureTable.load() or ArcGISMapImageLayer.loadTablesAndLayers(). Alternatively, tables are loaded internally when asynchronous operations like query are performed.
Inherited properties
The attribution text for the layer.
The brightness of the layer.
A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.
The description for the layer.
The full extent of this layer, which is the extent where all layer data is contained. You can use this to zoom to all of the data contained in this layer. For feature layers, the extent is retrieved from its FeatureTable.extent.
The full time extent of the layer. If the layer, such as an ArcGISMapImageLayer, has sublayers with different time extents, fullTimeExtent is a union of its sublayer's time extents.
The unique identifying string for the layer, as 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.
True if the layer supports identify, false otherwise. The value of this property may not be correct until the layer is in a fully loaded state.
True if the layer filters data based on its GeoView.timeExtent, false otherwise. This is only applicable if the layer's TimeAware.supportsTimeFiltering value is true. If the GeoView.timeExtent value is null, no time filtering is applied and all content is rendered.
The load status.
The maximum scale for the layer. The maximum scale at which this layer is visible. If the map or scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means there is no maximum scale threshold and the layer will be visible at the smallest scale available for the map or scene. If the value is nil, there is no maximum scale. All of the connected map and scene views will be updated.
The minimum scale for the layer. The minimum scale at which this layer is visible. If the map or scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means there is no minimum scale threshold and the layer will be visible at the largest scale available for the map or scene. If the value is nil, there is no minimum scale. All of the connected map and scene views will be updated.
The objects refresh interval. The refresh interval, in milliseconds. A refresh interval of null means never refresh.
A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.
The spatial reference of the layer.
The sub layer contents of a layer content.
True if the layer supports filtering data based on its time values, false otherwise.
The suggested time slider step size for this time aware layer. You can use this information to set the step size for a time slider control. The value is null if no time interval is suggested. The author of the layer's data typically configures this property if the data has been collected on a regular basis. For example, the daily position of a hurricane.
The amount of time by which the temporal values of this layer's data points are offset when displaying it in a GeoView. The time offset is subtracted from the time extent set on the layer's GeoView. This is useful if you want to overlay data in multiple layers that lies within different temporal extents. For example, if you want to compare data in one layer for a certain year with data in the same layer from the subsequent year, you can create two layers that reference the same data's service endpoint but set the TimeValue in one of the layers to be one year.
Callback invoked when the visibility of the layer changes.
Functions
Clones the ArcGISMapImageLayer.
Loads all of the ArcGIS map service's sublayers and non-spatial tables.
Resets the sublayers of a map image layer to the default values defined by the service. After this call, any changes to the sublayers (either by using an ArcGISMapImageSublayer setter or by changing the sublayer collections) are lost. The sublayer hierarchy returns to its initial state (defined by the service) and image requests to display the layer will no longer use the dynamic layer capabilities of the service. All ArcGISMapImageSublayer objects will be recreated.
Inherited functions
Cancels loading metadata for the Loadable object.
Fetches the list of legend info.
Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.