Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/layers/MapImageLayer"], function(MapImageLayer) { /* code goes here */ });
Class: esri/layers/MapImageLayer
Inheritance: MapImageLayer Layer Accessor
Since: ArcGIS API for JavaScript 4.0

Overview

MapImageLayer allows you to display and analyze data from sublayers defined in a map service, exporting images instead of features. Map service images are dynamically generated on the server based on a request, which includes an LOD (level of detail), a bounding box, dpi, spatial reference and other options. The exported image is of the entire map extent specified.

Unlike FeatureLayer, MapImageLayer processing is handled by the server, not the client. Offloading the processing to the server allows MapImageLayer to render more features with a higher level of performance in some cases.

MapImageLayer does not display tiled images. To display tiled map service layers, see TileLayer.

Creating a MapImageLayer

MapImageLayer may be created in one of two ways: from a service URL or from an ArcGIS Portal item ID.

Reference a service URL

To create a MapImageLayer instance from a service, you must set the url property to the REST endpoint of a layer in a Map Service. The URL will typically look like the following.

https://<hostname>/arcgis/rest/services/<service-name>/MapServer

For a layer to be visible in a view, it must be added to the Map referenced by the view. See Map.add() for information about adding layers to a map.

require(["esri/layers/MapImageLayer"], function(MapImageLayer){
  // points to the states layer in a service storing U.S. census data
  var layer = new MapImageLayer({
    url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer"
  });
  map.add(layer);  // adds the layer to the map
});

If the map service is requested from a different domain, a CORS enabled server or a proxy is required.

Reference an ArcGIS portal Item ID

You can also create a MapImageLayer from its ID if it exists as an item in ArcGIS Online or ArcGIS Enterprise. For example, the following snippet shows how to add a new MapImageLayer instance to a map using the portalItem property.

// references an ArcGIS Online item pointing to a Map Service Layer
var layer = new MapImageLayer({
  portalItem: {  // autocasts as esri/portal/PortalItem
    id: "8444e275037549c1acab02d2626daaee"
  }
});
map.add(layer);  // adds the layer to the map

Sublayers

Map services contain one or more sublayers. Sublayers may even contain nested sublayers. When the sublayers property of the MapImageLayer is not specified, then an image of all sublayers in the service is exported to the client. If a subset of sublayers from the service are specified, then only the subset of sublayers are rendered on the client. Sublayers have default rendering, scale visibility, labels, and other properties saved to the server. However, these properties may be dynamically changed so a new map image is exported to the view. Sublayers of a MapImageLayer can only be styled with 2D symbology even if they are rendered in a WebScene. To learn more about working with sublayers, see the Sublayer API documentation.

mapimagelayer-renderer

Dynamic layers

Sublayers may be rendered on the fly as dynamic layers. There are two types of dynamic layers: DynamicMapLayer and DynamicDataLayer.

Dynamic map layers allow you to override sublayers in the map service with new renderers, definition expressions, opacity, scale visibility, etc. Multiple dynamic map layers may exist for a single map service layer.

Dynamic data layers provide the ability to create layers on the fly from data referenced in registered workspaces. The data may be tables with or without geometries, feature classes, and rasters. These data sources are not directly visible to the services directory, but may be published and configured with the ArcGIS Server Manager. Data from tables may be joined to other tables or dynamic map layers.

Esri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content. For detailed guidelines on working with attribution, please visit the official attribution in your app documentation. For information on terms of use, see the Terms of Use FAQ.

See also:
Example:
var layer = new MapImageLayer({
url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
  sublayers: [
   {
     id: 3,
     visible: false
   }, {
     id: 2,
     visible: true
   }, {
     id: 1,
     visible: true
   }, {
     id: 0,
     visible: true,
     definitionExpression: "pop2000 > 100000"
   }
 ]
});

Constructors

new MapImageLayer(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Example:
// Typical usage
var layer = new MapImageLayer({
  // URL to the map service
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
  // dynamic sublayers. See sublayers documentation for more info
  sublayers: [ {}, {}, {} ]
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Collection<Sublayer>

A flat Collection of all the sublayers in the MapImageLayer including the sublayers of its sublayers.

more details
more detailsMapImageLayer
String

Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.

more details
more detailsLayer
Object

Indicates the layer's supported capabilities.

more details
more detailsMapImageLayer
String

The copyright text as defined by the service.

more details
more detailsMapImageLayer
String

The name of the class.

more details
more detailsAccessor
Number

The output dots per inch (DPI) of the MapImageLayer.

more details
more detailsMapImageLayer
Extent

The full extent of the layer as defined by the map service.

more details
more detailsMapImageLayer
String

The version of the geodatabase of the map service data.

more details
more detailsMapImageLayer
String

The unique ID assigned to the layer.

more details
more detailsLayer
String

The output image type.

more details
more detailsMapImageLayer
Number

Indicates the maximum height of the image exported by the service.

more details
more detailsMapImageLayer
Number

Indicates the maximum width of the image exported by the service.

more details
more detailsMapImageLayer
Boolean

Indicates whether the background of the image exported by the service is transparent.

more details
more detailsMapImageLayer
Boolean

Indicates whether the layer will be included in the legend.

more details
more detailsMapImageLayer
String

Indicates how the layer should display in the LayerList widget.

more details
more detailsLayer
Boolean

Indicates whether the layer's resources have loaded.

more details
more detailsMapImageLayer
Error

The Error object returned if an error occurred while loading.

more details
more detailsLayer
String

Represents the status of a load operation.

more details
more detailsLayer
Object[]

A list of warnings which occurred while loading.

more details
more detailsLayer
Number

The maximum scale (most zoomed in) at which the layer is visible in the view.

more details
more detailsMapImageLayer
Number

The minimum scale (most zoomed out) at which the layer is visible in the view.

more details
more detailsMapImageLayer
Number

The opacity of the layer.

more details
more detailsLayer
PortalItem

The portal item from which the layer is loaded.

more details
more detailsMapImageLayer
Number

Refresh interval of the layer in minutes.

more details
more detailsMapImageLayer
Object

The map service's metadata JSON exposed by the ArcGIS REST API.

more details
more detailsMapImageLayer
SpatialReference

The spatial reference of the layer as defined by the service.

more details
more detailsMapImageLayer
Collection<Sublayer>

A Collection of Sublayer objects that allow you to alter the properties of one or more sublayers of the MapImageLayer.

more details
more detailsMapImageLayer
TimeExtent

The layer's time extent.

more details
more detailsMapImageLayer
TimeInfo

TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer.

more details
more detailsMapImageLayer
TimeInterval

A temporary offset of the time data based on a certain TimeInterval.

more details
more detailsMapImageLayer
String

The title of the layer used to identify it in places such as the Legend and LayerList widgets.

more details
more detailsMapImageLayer
StringFor MapImageLayer the type is always "map-image". more detailsmore detailsMapImageLayer
String

The URL to the REST endpoint of the map service.

more details
more detailsMapImageLayer
Boolean

Determines if the layer will update its temporal data based on the view's timeExtent.

more details
more detailsMapImageLayer
Number

The version of ArcGIS Server in which the map service is published.

more details
more detailsMapImageLayer
Boolean

Indicates if the layer is visible in the View.

more details
more detailsLayer

Property Details

allSublayers Collection<Sublayer>readonly

A flat Collection of all the sublayers in the MapImageLayer including the sublayers of its sublayers. All sublayers are referenced in the order in which they are drawn in the view (bottom to top).

Example:
// finds the census tracts sublayer from a parent sublayer of the
// MapImageLayer containing various census sublayers
var tractsId = 5;
var tracksSublayer = layer.allSublayers.find(function(sublayer){
  return sublayer.id === tracksId;
});
blendMode String inherited
Since: ArcGIS API for JavaScript 4.16

Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer. Unlike the method of using transparency which can result in a washed-out top layer, blend modes can create a variety of very vibrant and intriguing results by blending a layer with the layer(s) below it.

When blending layers, a top layer is a layer that has a blend mode applied. All layers underneath the top layer are background layers. The default blending mode is normal where the top layer is simply displayed over the background layer. While this default behavior is perfectly acceptable, the use of blend modes on layers open up a world of endless possibilities to generate creative maps.

The layers in a GroupLayer are blended together in isolation from the rest of the map.

In the following screenshots, the vintage shaded relief layer is displayed over a firefly world imagery layer. The color blend mode is applied to the vintage shaded relief and the result looks a new layer.

color-blend

Known Limitations

The following factors will affect the blend result:

  • Order of all layers
  • Layer opacity
  • Opacity of features in layers
  • Visibility of layers
  • By default, the very bottom layer in a map is drawn on a transparent background. You can change the MapView's background color.
Blend modeDescription
normalThe top layer is displayed over the background layer. The data of the top layer block the data of background layer where they overlap.
averageTakes the mathematical average of top and background layers. Result of average blend mode is often similar to the effect of setting the layer's opacity to 50%.

Lighten blend modes:

The following blend modes create lighter results than all layers. In lighten blend modes, pure black colors in the top layer become transparent allowing the background layer to show through. White in the top layer will stay unchanged. Any color that is lighter than pure black is going lighten colors in the top layer to varying degrees all way to pure white.

Lighten blend modes can be useful when lightening dark colors of the top layer or removing black colors from the result. The add, lighten and screen modes can be used to brighten layers that have faded or dark colors on a dark background.

Blend modeDescription
lightenCompares top and background layers and retains the lighter color in the top layer. Colors in the top layer become transparent if they are darker than the overlapping colors in the background layer allowing the background layer to show through completely. Can be thought of as the opposite of darken blend mode.
lighterColors in top and background layers are multiplied by their alphas (layer opacity and layer's data opacity. Then the resulting colors are added together. All overlapping midrange colors are lightened in the top layer. The opacity of layer and layer's data will affect the blend result.
plusColors in top and background layers are added together. All overlapping midrange colors are lightened in the top layer. This mode is also known as add or linear-dodge.
screenInverts colors of the background layer and multiplies with colors of the top layer. The resulting colors will be lighter than the original color with less contrast. Screen can produce many different levels of brightening depending on the luminosity values of the top layer. Can be thought of as the opposite of the multiply mode.
color-dodgeCreates a brighter effect by decreasing the contrast between the top and background layers, resulting in saturated mid-tones and bright highlights.

Darken blend modes:

The following blend modes create darker results than all layers. In darken blend modes, pure white in the top layer will become transparent allowing the background layer to show through. Black in the top layer will stay unchanged. Any color that is darker than pure white is going to darken a top layer to varying degrees all the way to pure black.

The multiply blend mode is often used to highlight shadows, show contrast, or accentuate an aspect of a map. For example, you can use multiply blend mode on a topographic map displayed over hillshade when you want to have your elevation show through the topographic layer. See the intro to layer blending sample.

The multiply and darken modes can be used to have dark labels of the basemap to show through top layers. See the darken blending sample.

The color-burn mode works well with colorful top and background layers since increases saturation in mid-tones. It increases the contrast by tinting pixels in overlapping areas in top and bottom layers more towards the top layer color. Use this blend mode, when you want an effect with more contrast than multiply or darken.

The following screenshots show how the multiply blend mode used for creating a physical map of the world that shows both boundaries and elevation. multiply-blend

Blend modeDescription
darkenEmphasizes the darkest parts of overlapping layers. Colors in the top layer become transparent if they are lighter than the overlapping colors in the background layer, allowing the background layer to show through completely.
multiplyEmphasizes the darkest parts of overlapping layers by multiplying colors of the top layer and the background layer. Midrange colors from top and background layers are mixed together more evenly.
color-burnIntensifies the dark areas in all layers. It increases the contrast between top and background layers, by tinting colors in overlapping area towards the top color. To do this it inverts colors of the background layer, divides the result by colors of the top layer, then inverts the results.

Contrast blend modes:

The following blend modes create contrast by both lightening the lighter areas and darkening the darker areas in the top layer by using lightening or darkening blend modes to create the blend. The contrast blend modes will lighten the colors lighter than 50% gray ([128,128,128]), and darken the colors darker than 50% gray. 50% gray will be transparent in the top layer. Each mode can create a variety of results depending on the colors of top and background layers being blended together. The overlay blend mode makes its calculations based on the brightness of the colors in the background layer while all of the other contrast blend modes make their calculations based on the brightness of the top layer. Some of these modes are designed to simulate the effect of shining a light through the top layer, effectively projecting upon the layers beneath it.

Contrast blend modes can be used to increase the contrast and saturation to have more vibrant colors and give a punch to your layers. For example, you can duplicate a layer and set overlay blend mode on the top layer to increase the contrast and tones of your layer. You can also add a polygon layer with a white fill symbol over a dark imagery layer and apply soft-light blend mode to increase the brightness in the imagery layer.

The following screenshots show an effect of the overlay blend mode on a GraphicsLayer. The left image shows when the buffer graphics layer has the normal blend mode. As you can see, the gray color for the buffer polygon is blocking the intersecting census tracts. The right image shows when the overlay blend mode is applied to the buffer graphics layer. The overlay blend mode darkens or lightens the gray buffer polygon depending on the colors of the background layer while the census tracts layer is shining through. See this in action.

Normal blend modeOverlay blend mode
no-blendmodeoverlay-blend
Blend modeDescription
overlayUses a combination of multiply and screen modes to darken and lighten colors in the top layer with the background layer always shining through. The result is darker color values in the background layer intensify the top layer, while lighter colors in the background layer wash out overlapping areas in the top layer.
soft-lightApplies a half strength screen mode to lighter areas and and half strength multiply mode to darken areas of the top layer. You can think of the soft-light as a softer version of the overlay mode.
hard-lightMultiplies or screens the colors, depending on colors of the top layer. The effect is similar to shining a harsh spotlight on the top layer.
vivid-lightUses a combination of color-burn or color-dodge by increasing or decreasing the contrast, depending on colors in the top layer.

Component blend modes:

The following blend modes use primary color components, which are hue, saturation and luminosity to blend top and background layers. You can add a feature layer with a simple renderer over any layer and set hue, saturation, color or luminosity blend mode on this layer. With this technique, you create a brand new looking map.

The following screenshots show where the topo layer is blended with world hillshade layer with luminosity blend mode. The result is a drastically different looking map which preserves the brightness of the topo layer while adapting the hue and saturation of the hillshade layer.

color-blend

Blend modeDescription
hueCreates an effect with the hue of the top layer and the luminosity and saturation of the background layer.
saturationCreates an effect with the saturation of the top layer and the hue and luminosity of the background layer. 50% gray with no saturation in the background layer will not produce any change.
luminosityCreates effect with the luminosity of the top layer and the hue and saturation of the background layer. Can be thought of as the opposite of color blend mode.
colorCreates an effect with the hue and saturation of the top layer and the luminosity of the background layer. Can be thought of as the opposite of luminosity blend mode.

Composite blend modes:

The following blend modes can be used to mask the contents of top, background or both layers.

  • Destination modes are used to mask the data of the top layer with the data of the background layer.
  • Source modes are used to mask the data of the background layer with the data of the top layer.

The destination-in blend mode can be used to show areas of focus such as earthquakes, animal migration, or point-source pollution by revealing the underlying map, providing a bird’s eye view of the phenomenon. Check out multiple blending and groupLayer blending samples to see composite blend modes in action.

The following screenshots show feature and imagery layers on the left side on their own in the order they are drawn in the view. The imagery layer that contains land cover classification rasters. The feature layer contains 2007 county crops data. The right image shows the result of layer blending where destination-in blendMode is set on the imagery layer. As you can see, the effect is very different from the original layers. The blended result shows areas of cultivated crops only (where both imagery and feature layers overlap).

destination-in

Blend modeDescription
destination-overDestination/background layer covers the top layer. The top layer is drawn underneath the destination layer. You'll see the top layer peek through wherever the background layer is transparent or has no data.
destination-atopDestination/background layer is drawn only where it overlaps the top layer. The top layer is drawn underneath the background layer. You'll see the top layer peek through wherever the background layer is transparent or has no data.
destination-inDestination/background layer is drawn only where it overlaps with the top layer. Everything else is made transparent.
destination-outDestination/background layer is drawn where it doesn't overlap the top layer. Everything else is made transparent.
source-atopSource/top layer is drawn only where it overlaps the background layer. You will see the background layer peek through where the source layer is transparent or has no data.
source-inSource/top layer is drawn only where it overlaps with the background layer. Everything else is made transparent.
source-outSource/top layer is drawn where it doesn't overlap the background layer. Everything else is made transparent.
xorTop and background layers are made transparent where they overlap. Both layers are drawn normal everywhere else.

Invert blend modes:

The following blend modes either invert or cancel out colors depending on colors of the background layer. These blend modes look for variations between top and background layers. For example, you can use difference or exclusion blend modes on two imagery layers of forest covers to visualize how forest covers changed from one year to another.

The invert blend mode can be used to turn any light basemap into a dark basemap to accommodate those who work in low-light conditions. The following screenshots show how setting the invert blend mode set on a feature layer with a simple renderer turns the world terrain basemap into a dark themed basemap in no time.

color-blend

Blend modeDescription
differenceSubtracts the darker of the overlapping colors from the lighter color. When two pixels with the same value are subtracted, the result is black. Blending with black produces no change. Blending with white inverts the colors. This blending mode is useful for aligning layers with similar content.
exclusionSimilar to the difference blend mode, except that the resulting image is lighter overall. Overlapping areas with lighter color values are lightened, while darker overlapping color values become transparent.
minusSubtracts colors of the top layer from colors of the background layer making the blend result darker. In the case of negative values, black is displayed.
invertInverts the background colors wherever the top and background layers overlap. The invert blend mode inverts the layer similar to a photographic negative.
reflectThis blend mode creates effects as if you added shiny objects or areas of light in the layer. Black pixels in the background layer are ignored as if they were transparent.

Possible Values:"average"|"color-burn"|"color-dodge"|"color"|"darken"|"destination-atop"|"destination-in"|"destination-out"|"destination-over"|"difference"|"exclusion"|"hard-light"|"hue"|"invert"|"lighten"|"lighter"|"luminosity"|"minus"|"multiply"|"normal"|"overlay"|"plus"|"reflect"|"saturation"|"screen"|"soft-light"|"source-atop"|"source-in"|"source-out"|"vivid-light"|"xor"

Default Value:normal
See also:
capabilities Objectreadonly
Since: ArcGIS API for JavaScript 4.8

Indicates the layer's supported capabilities.

Properties:
exportMap Object

Indicates options supported by the exportMap operation. Will be null if the supportsExportMap is false.

Specification:
supportsDynamicLayers Boolean

Indicates if sublayers rendering can be modified or added using dynamic layers.

supportsModification Boolean

Indicates if a sublayer supports modifying its renderer and/or data source.

supportsSublayersChanges Boolean

Indicates if sublayers can be added, removed, or reordered.

supportsSublayerDefinitionExpression Boolean

Indicates if sublayers definition expression can be set.

supportsSublayerVisibility Boolean

Indicates if sublayers visibility can be changed.

exportTiles Object

Indicates options supported by the exportTiles operation. Will be null if the supportsExportTiles is false.

Specification:
maxExportTilesCount Number

Specifies the maximum number of tiles that can be exported to a cache dataset or a tile package.

operations Object

Indicates operations that can be performed on the service.

Specification:
supportsQuery Boolean

Indicates if features in the sublayers can be queried.

supportsExportMap Boolean

Indicates if the service can generate images.

supportsExportTiles Boolean

Indicates if the tiles from the service can be exported.

supportsTileMap Boolean

Indicates if the service exposes a tile map that describes the presence of tiles.

The copyright text as defined by the service.

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

dpi Number

The output dots per inch (DPI) of the MapImageLayer.

Default Value:96
fullExtent Extent

The full extent of the layer as defined by the map service.

Example:
// zooms the view to the full extent of the layer
layer.when(function(){
  view.goTo(layer.fullExtent);
});
gdbVersion String

The version of the geodatabase of the map service data. Read the Overview of versioning topic for more details about this capability.

The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.

imageFormat String

The output image type.

Possible Values:"png"|"png8"|"png24"|"png32"|"jpg"|"pdf"|"bmp"|"gif"|"svg"|"pngjpg"

Default Value:png24
imageMaxHeight Number
Since: ArcGIS API for JavaScript 4.3

Indicates the maximum height of the image exported by the service.

Default Value:2048
imageMaxWidth Number
Since: ArcGIS API for JavaScript 4.3

Indicates the maximum width of the image exported by the service.

Default Value:2048
imageTransparency Boolean

Indicates whether the background of the image exported by the service is transparent.

Default Value:true
legendEnabled Boolean

Indicates whether the layer will be included in the legend.

Default Value:true
listMode String inherited

Indicates how the layer should display in the LayerList widget. The possible values are listed below.

ValueDescription
showThe layer is visible in the table of contents.
hideThe layer is hidden in the table of contents.
hide-childrenIf the layer is a GroupLayer, BuildingSceneLayer, KMLLayer, MapImageLayer, TileLayer or WMSLayer, hide the children layers from the table of contents.

Possible Values:"show"|"hide"|"hide-children"

Default Value:show
loaded Booleanreadonly

Indicates whether the layer's resources have loaded. When true, all the properties of the object can be accessed.

Default Value:false
loadError Errorreadonly inherited

The Error object returned if an error occurred while loading.

Default Value:null
loadStatus Stringreadonly inherited

Represents the status of a load operation.

ValueDescription
not-loadedThe object's resources have not loaded.
loadingThe object's resources are currently loading.
loadedThe object's resources have loaded without errors.
failedThe object's resources failed to load. See loadError for more details.

Possible Values:"not-loaded"|"loading"|"failed"|"loaded"

Default Value:not-loaded
loadWarnings Object[]readonly inherited

A list of warnings which occurred while loading.

maxScale Number

The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.

Default Value:0
Examples:
// The layer will not be visible when the view is zoomed in beyond a scale of 1:1,000
layer.maxScale = 1000;
// The layer's visibility is not restricted to a maximum scale.
layer.maxScale = 0;
minScale Number

The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale. The minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.

Default Value:0
Examples:
// The layer will not be visible when the view is zoomed out beyond a scale of 1:3,000,000
layer.minScale = 3000000;
// The layer's visibility is not restricted to a minimum scale.
layer.minScale = 0;

The opacity of the layer. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.

Default Value:1
Example:
// Makes the layer 50% transparent
layer.opacity = 0.5;
portalItem PortalItem

The portal item from which the layer is loaded. This will load the layer along with any overridden properties (e.g. renderers, definition expressions, etc.) saved to the portal item, not the map service.

Example:
var layer = new MapImageLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "caa9bd9da1f4487cb4989824053bb847"
  }
});
refreshInterval Number
Since: ArcGIS API for JavaScript 4.6

Refresh interval of the layer in minutes. Value of 0 indicates no refresh.

Default Value:0
Example:
// the layer will be refreshed every 6 seconds.
layer.refreshInterval = 0.1;
sourceJSON Object
Since: ArcGIS API for JavaScript 4.13

The map service's metadata JSON exposed by the ArcGIS REST API. While most commonly used properties are exposed on the MapImageLayer class directly, this property gives access to all information returned by the map service. This property is useful if working in an application built using an older version of the API which requires access to map service properties from a more recent version.

spatialReference SpatialReferencereadonly

The spatial reference of the layer as defined by the service.

Autocasts from Object[]

A Collection of Sublayer objects that allow you to alter the properties of one or more sublayers of the MapImageLayer. If this property is not specified, all the sublayers from the service are displayed as defined in the service. If an empty array is passed to this property then none of the sublayers from the service are displayed in the layer.

All sublayers are referenced in the order in which they are drawn in the view (bottom to top). They may be added, removed, or reordered using the Collection methods. Because Sublayer extends Accessor, its properties may be watched.

Examples:
// Only includes the first sublayer from the map service
var layer = new MapImageLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
  sublayers: [{
    id: 0
  }]
});
// toggles the visibility of the first sublayer to false
layer.findSublayerById(0).visible = false;
// sublayers from the service are excluded from the layer
layer = new MapImageLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer",
  sublayers: []
});
// Moves the cities sublayer from index 3 to index 0.
var citiesLayer = layer.sublayers.getItemAt(3);
layer.sublayers.reorder(citiesLayer, 0);
// Overrides the drawing info on the layer with a custom renderer
var citiesLayer = layer.sublayers.getItemAt(3);
citiesLayer.renderer = {
  type: "simple",  // autocasts as new SimpleRenderer()
  symbol: {
    type: "simple-marker",  // autocasts as new SimpleMarkerSymbol()
    color: "blue",
    size: 3
  }
};
Since: ArcGIS API for JavaScript 4.14

The layer's time extent. When the layer's useViewTime is false, the layer instructs the view to show data from the layer based on this time extent. If the useViewTime is true, and both layer and view time extents are set, then features that fall within the intersection of the view and layer time extents will be displayed. For example, if the layer's time extent is set to display features between 1970 and 1975 and the view has a time extent set to 1972-1980, the effective time on the feature layer will be 1972-1975.

Default Value:null
Examples:
if (!layer.useViewTime) {
  if (layer.timeExtent) {
    console.log("Current timeExtent:", layer.timeExtent.start, " - ", layer.timeExtent.end}
  } else {
    console.log("The layer will display data within the view's timeExtent.");
    console.log("Current view.timeExtent:", view.timeExtent.start, " - ", view.timeExtent.end}
  }
}
// set the timeExtent on the layer and useViewTime false
// In this case, the layer will honor its timeExtent and ignore
// the view's timeExtent
const layer = new ImageryLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ScientificData/SeaTemperature/ImageServer",
  timeExtent: {
    start: new Date(2014, 4, 18),
    end: new Date(2014, 4, 19)
  },
  useViewTime: false
});
// timeExtent is set on the layer and the view
// In this case, the layer will display features that fall
// within the intersection of view and layer time extents
// features within Jan 1, 1976 - Jan 1, 1981 will be displayed
const view = new MapView({
  timeExtent: {
    start: new Date(1976, 0, 1),
    end: new Date(2002, 0, 1)
  }
});
const layer = new FeatureLayer({
  url: myUrl,
  timeExtent: {
    start: new Date(1974, 0, 1),
    end: new Date(1981, 0, 1)
  }
});
Since: ArcGIS API for JavaScript 4.11

TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer. The timeInfo property, along with its startField and endField properties, must be set at the time of layer initialization if it is being set for a FeatureLayer, CSVLayer or GeoJSONLayer initialized from client-side features. The fullTimeExtent for timeInfo is automatically calculated based on its startField and endField properties. The timeInfo parameters cannot be changed after the layer is loaded.

Default Value:null
Example:
// create geojson layer from usgs earthquakes geojson feed
const geojsonLayer = new GeoJSONLayer({
  url: "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_month.geojson",
  copyright: "USGS Earthquakes",
  fields: [
    { "name": "mag", "type": "double" },
    { "name": "place", "type": "string" },
    { "name": "time", "type": "date" }, // date field
    { "name": "depth", "type": "double" }
  ],
  // timeInfo can be used to do temporal queries
  // set the startField and endField.
  // timeExtent is automatically calculated from the
  // the start and end date fields
  timeInfo: {
    startField: "time"
  }
});
Since: ArcGIS API for JavaScript 4.14

A temporary offset of the time data based on a certain TimeInterval. This allows users to overlay features from two or more time-aware layers with different time extents. For example, if a layer has data recorded for the year 1970, an offset value of 2 years would temporarily shift the data to 1972. You can then overlay this data with data recorded in 1972. A time offset can be used for display purposes only. The query and selection are not affected by the offset.

Default Value:null
Example:
// Offset a CSV Layer containing hurricanes from 2015 so that they appear in 2019 (+4 years).
var layer = new CSVLayer({
  url: `hurricanes-and-storms-2015.csv`,
  timeOffset: {
    value: 4,
    unit: "years"
  },
  timeInfo: {
    startField: "ISO_time"
  },
  renderer: {
    type: "simple",
    symbol: {
      type: "simple-marker",
      size: 6,
      color: "red",
      outline: {
        width: 0.5,
        color: "black"
      }
    }
  }
});
title String

The title of the layer used to identify it in places such as the Legend and LayerList widgets.

When loading a layer by service url, the title is derived from the service name. The titles for the sublayers will be the same as the names of the sublayers in the service. When the layer is loaded from a portal item, the title of the portal item will be used instead. Finally, if a layer is loaded as part of a webmap or a webscene, then the title of the layer as stored in the webmap/webscene will be used.

type Stringreadonly

For MapImageLayer the type is always "map-image".

url String

The URL to the REST endpoint of the map service.

Example:
// Layer from Map Service on ArcGIS Server
layer.url = "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer";
useViewTime Boolean
Since: ArcGIS API for JavaScript 4.14

Determines if the layer will update its temporal data based on the view's timeExtent. When false, the layer will display its temporal data based on the layer's timeExtent, regardless of changes to the view. If both view and layer time extents are set while this property is true, then the features that fall within the intersection of the view and layer time extents will be displayed. For example, if a layer's time extent is set to display features between 1970 and 1975 and the view has a time extent set to 1972-1980, the effective time on the feature layer will be 1972-1975.

Default Value:true
Example:
if (featureLayer.useViewTime) {
  console.log("Displaying data between:", view.timeExtent.start, " - ", view.timeExtent.end);
}
version Numberreadonly

The version of ArcGIS Server in which the map service is published.

Example:
// Prints the version number to the console, e.g. 10.2, 10.3, 10.41.
console.log(layer.version);

Indicates if the layer is visible in the View. When false, the layer may still be added to a Map instance that is referenced in a view, but its features will not be visible in the view.

Default Value:true
Example:
// The layer is no longer visible in the view
layer.visible = false;

Method Overview

NameReturn TypeSummaryClass

Cancels a load() operation if it is already in progress.

more details
more detailsLayer
Object

Gets the parameters of the exported image to use when calling the export REST operation.

more details
more detailsMapImageLayer
Promise<LayerView>

Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it.

more details
more detailsLayer
Collection<Sublayer>

Returns a deep clone of a map service's sublayers as defined by the service.

more details
more detailsMapImageLayer
Boolean

Emits an event on the instance.

more details
more detailsLayer
Promise<Object>

Fetches custom attribution data for the layer when it becomes available.

more details
more detailsLayer
Promise<HTMLImageElement>

This method fetches the image for the specified extent and size.

more details
more detailsMapImageLayer
Sublayer

Returns the sublayer with the given layerId.

more details
more detailsMapImageLayer
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
more detailsLayer
Boolean

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more details
more detailsLayer
Boolean

isRejected() may be used to verify if creating an instance of the class is rejected.

more details
more detailsLayer
Boolean

isResolved() may be used to verify if creating an instance of the class is resolved.

more details
more detailsLayer
Promise

Loads the resources referenced by this class.

more details
more detailsLayer
Promise<Sublayer>

Loads all of the sublayers.

more details
more detailsMapImageLayer
Object

Registers an event handler on the instance.

more details
more detailsLayer

Fetches all the data for the layer.

more details
more detailsMapImageLayer
Promise

when() may be leveraged once an instance of the class is created.

more details
more detailsLayer

Method Details

cancelLoad()inherited

Cancels a load() operation if it is already in progress.

createExportImageParameters(extent, width, height, options){Object}

Gets the parameters of the exported image to use when calling the export REST operation.

Parameters:
Specification:
extent Extent

The extent of the exported image

width Number

The width of the exported image

height Number

The height of the exported image

options Object
optional

The parameter options is an object with the following properties.

Specification:
rotation Number
optional

The rotation in degrees of the exported image. Available since ArcGIS Server 10.3.

pixelRatio Number
optional

The pixel ratio to apply to the dpi of the exported image.

timeExtent TimeExtent
optional

The time instant or time extent of content to render.

Returns:
TypeDescription
ObjectThe parameters of the exported image. Use this object to call the export REST operation against the map service.
createLayerView(view, options){Promise<LayerView>}inherited

Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it. This method is used internally and there is no use case for invoking it directly.

Parameters:
view *

The parent view.

options Object
optional

An object specifying additional options. See the object specification table below for the required properties of this object.

Specification:
optional

A signal to abort the creation of the layerview.

Returns:
TypeDescription
Promise<LayerView>Resolves with a LayerView instance.
See also:
createServiceSublayers(){Collection<Sublayer>}

Returns a deep clone of a map service's sublayers as defined by the service. This is useful for scenarios when the developer is unfamiliar with the service sublayers and needs to "reset" the layer's sublayers to match those defined by the service.

Returns:
TypeDescription
Collection<Sublayer>A collection of sublayers as defined by the map service.
Example:
Layer.fromPortalItem({
  portalItem: {
    portalId: "dbb9b48477444015912061b182f196b9"
  }
}).then(function(layer){
  var serviceSublayers = layer.createServiceSublayers();
  layer.sublayers = serviceSublayers;
});
emit(type, event){Boolean}inherited
Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:
type String

The name of the event.

event Object
optional

The event payload.

Returns:
TypeDescription
Booleantrue if a listener was notified
fetchAttributionData(){Promise<Object>}inherited

Fetches custom attribution data for the layer when it becomes available.

Returns:
TypeDescription
Promise<Object>Resolves to an object containing custom attribution data for the layer.
fetchImage(extent, width, height, options){Promise<HTMLImageElement>}

This method fetches the image for the specified extent and size.

Parameters:
Specification:
extent Extent

The extent of the view.

width Number

The width of the view in pixels.

height Number

The height of the view in pixels.

options Object
optional

The parameter options is an object with the following properties.

Specification:
rotation Number
optional

The rotation in degrees of the exported image. Available since ArcGIS Server 10.3.

pixelRatio Number
optional

The ratio of the resolution in physical pixels of the image to the resolution it will be displayed at.

timeExtent TimeExtent
optional

The time instant or time extent of content to render.

optional

An AbortSignal to abort the request. If canceled, the promise will be rejected with an error named AbortError. See also AbortController.

Returns:
TypeDescription
Promise<HTMLImageElement>Returns a promise that resolves to an HTMLImageElement.
Example:
// Fetch an image for the layer from the server for a given extent, height, width.
layer.when(function(){
  layer.fetchImage(view.extent, view.width, view.height).then(function(result){
    imageDiv.appendChild(result);
  });
});
findSublayerById(id){Sublayer}

Returns the sublayer with the given layerId.

Parameter:

The id of the sublayer.

Returns:
TypeDescription
SublayerReturns the sublayer at the given layer ID.
Example:
// returns the sublayer with a layerId of 0
var sublayer0 = layer.findSublayerById(0);
hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
TypeDescription
BooleanReturns true if the class supports the input event.
isFulfilled(){Boolean}inherited

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}inherited

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}inherited

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been resolved.
load(signal){Promise}inherited

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

It's possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.

Parameter:
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:
TypeDescription
PromiseResolves when the resources have loaded.
loadAll(){Promise<Sublayer>}
Since: ArcGIS API for JavaScript 4.15

Loads all of the sublayers. See loaded or loadStatus properties to check the status.

Returns:
TypeDescription
Promise<Sublayer>Resolves when all the loadable resources have been loaded. Rejects if at least one of the loadable resources failed to load.
See also:
Example:
// Load all resources but ignore if one or more of them failed to load
mapImageLayer.loadAll()
  .catch(function(error) {
    // Ignore any failed resources
  })
  .then(function() {
    console.log("All loaded");
  });
on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

A event type, or an array of event types, to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event(s).
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});
refresh()
Since: ArcGIS API for JavaScript 4.6

Fetches all the data for the layer.

when(callback, errback){Promise}inherited
Since: ArcGIS API for JavaScript 4.6

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callback that may be used to chain additional functions.
Example:
// Although this example uses MapView, any class instance that is a promise may use when() in the same way
var view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Event Overview

NameTypeSummaryClass
{view: View,layerView: LayerView}

Fires after the layer's LayerView is created and rendered in a view.

more details
more detailsLayer
{view: View,error: Error}

Fires when an error emits during the creation of a LayerView after a layer has been added to the map.

more details
more detailsLayer
{view: View,layerView: LayerView}

Fires after the layer's LayerView is destroyed and no longer renders in a view.

more details
more detailsLayer

Event Details

layerview-createinherited

Fires after the layer's LayerView is created and rendered in a view.

Properties:
view View

The view in which the layerView was created.

layerView LayerView

The LayerView rendered in the view representing the layer in layer.

See also:
Example:
// This function will fire each time a layer view is created for this
// particular view.
layer.on("layerview-create", function(event){
  // The LayerView for the layer that emitted this event
  event.layerView;
});
layerview-create-errorinherited

Fires when an error emits during the creation of a LayerView after a layer has been added to the map.

Properties:
view View

The view that failed to create a layerview for the layer emitting this event.

error Error

An error object describing why the layer view failed to create.

See also:
Example:
// This function fires when an error occurs during the creation of the layer's layerview
layer.on("layerview-create-error", function(event) {
  console.error("LayerView failed to create for layer with the id: ", layer.id, " in this view: ", event.view);
});
layerview-destroyinherited

Fires after the layer's LayerView is destroyed and no longer renders in a view.

Properties:
view View

The view in which the layerView was destroyed.

layerView LayerView

The destroyed LayerView representing the layer.

API Reference search results

NameTypeModule
Loading...