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

Represents an image service resource as a layer. An ImageryLayer retrieves and displays data from image services. An image service supports accessing the mosaicked image, its catalog, and the individual rasters in the catalog. An image service supports dynamic access and tiled access. Dynamic access provides more functionalities, and tiled access provides faster and more scalable access to precooked tiles.

layers-imagery

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

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.

ImageryLayer rendering

ImageryLayer can be rendered on the server or on the client. This section talks about different approaches you can take when rendering an ImageryLayer in your application.

Applying renderingRule

Image service supports dynamic processing which can be applied through the layer’s renderingRule property. A rendering rule defines how the requested image should be rendered or processed. You can process images using raster functions published with the image service. You can also use well-known raster functions, such as the hillshade function for elevation data, the stretch function for multispectral data, and the colormap function for thematic data. When renderingRule is applied to the layer, the network request is made to the server for the image to be processed.

Applying renderer

ImageryLayer supports various renderers. By default, an ImageryLayer uses server side rendering. ImageryLayer parses a renderer specified by a user and leverages a renderingRule specified by the server or the user to achieve the expected rendering for the images. The server processes and renders the ImageryLayer and returns a ready-to-draw jpg or png image to the client.

When an ImageryLayer is created with lerc format, the client gets access to the raw data which can be used for client-side analysis and rendering. A default renderer that leverages available imagery information is applied to an ImageryLayer with lerc format if the pixelFilter function is not specified. The user can change this default renderer on the client-side by applying a renderer or pixelFilter. The pixelFilter is a good alternative if the existing renderers do not meet your requirements. If both renderer and pixelFilter are applied to the layer then the pixelFilter will take priority and its logic will be applied.

Applying pixelFilter

The pixelFilter can be used to colorize raw image pixels when ImageryLayer's format is set to lerc. It is a function that processes the pixelData. The pixelData object contains a pixelBlock property that gives you access to all of the pixels in the raster on the client. Inside the pixelFilter you may loop through all the pixels and process them. This function is a useful alternative if the existing renderers do not meet your requirements, because it gives you control over how to color image pixels. If both a renderer and pixelFilter are applied to the layer then the pixelFilter will take priority and its logic will be applied.

See also:

Constructors

new ImageryLayer(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 ImageryLayer({
  // URL to the imagery service
  url: "https://landsat2.arcgis.com/arcgis/rest/services/Landsat8_Views/ImageServer"
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Number

The compression quality value.

more details
more detailsImageryLayer
Number

Controls the tolerance of the lerc compression algorithm.

more details
more detailsImageryLayer
String

The copyright text as defined by the service.

more details
more detailsImageryLayer
String

The name of the class.

more details
more detailsAccessor
String

The SQL where clause used to filter rasters.

more details
more detailsImageryLayer
Field[]

An array of fields in the layer.

more details
more detailsImageryLayer
String

The format of the exported image.

more details
more detailsImageryLayer
Extent

The full extent of the layer.

more details
more detailsLayer
Boolean

Indicates if the layer has multidimensionalInfo.

more details
more detailsImageryLayer
String

The unique ID assigned to the layer.

more details
more detailsLayer
Number

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

more details
more detailsImageryLayer
Number

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

more details
more detailsImageryLayer
String

Defines how to interpolate pixel values.

more details
more detailsImageryLayer
Boolean

Indicates whether the layer will be included in the legend.

more details
more detailsImageryLayer
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 detailsLayer
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 detailsImageryLayer
Number

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

more details
more detailsImageryLayer
MosaicRule

Defines how overlapping images should be mosaicked.

more details
more detailsImageryLayer
Object

The multidimensional information associated with the layer if the layer's hasMultidimensions property is true.

more details
more detailsImageryLayer
Number|Number[]

The pixel value representing no available information.

more details
more detailsImageryLayer
String

Interpretation of the noData setting.

more details
more detailsImageryLayer
String

The name of an oidfield containing a unique value or identifier for each raster in the layer.

more details
more detailsImageryLayer
Number

The opacity of the layer.

more details
more detailsLayer
Function

A function that processes pixelData.

more details
more detailsImageryLayer
String

Raster source pixel type.

more details
more detailsImageryLayer
Boolean

Indicates whether to display popups when features in the layer are clicked.

more details
more detailsImageryLayer
PopupTemplate

The popup template for the layer.

more details
more detailsImageryLayer
PortalItem

The portal item from which the layer is loaded.

more details
more detailsImageryLayer
String

Prefix used to define the fields from the raster attribute table.

more details
more detailsImageryLayer
Field[]

A complete list of fields that consists of raster catalog fields, item pixel value, service pixel value, service pixel value with various server defined function templates, and raster attribute table fields.

more details
more detailsImageryLayer
Number

Refresh interval of the layer in minutes.

more details
more detailsImageryLayer
Renderer

The renderer assigned to the layer.

more details
more detailsImageryLayer
RasterFunction

Specifies the rule for how the requested image should be rendered.

more details
more detailsImageryLayer
RasterInfo

Source raster information of the image service.

more details
more detailsImageryLayer
Object

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

more details
more detailsImageryLayer
SpatialReference

The spatial reference of the image service.

more details
more detailsImageryLayer
TimeInfo

The time info provides information such as date fields that store start and end time for each feature and the full time extent for the layer.

more details
more detailsImageryLayer
String

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

more details
more detailsLayer
StringFor ImageryLayer the type is always "imagery". more detailsmore detailsImageryLayer
String

The URL to the REST endpoint of the layer.

more details
more detailsImageryLayer
Number

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

more details
more detailsImageryLayer
Boolean

Indicates if the layer is visible in the View.

more details
more detailsLayer

Property Details

compressionQuality Number

The compression quality value. Controls how much loss the image will be subjected to by the compression algorithm. Valid value ranges of compression quality are from 0 to 100. Only valid when using jpg or jpgpng image format.

compressionTolerance Number

Controls the tolerance of the lerc compression algorithm. The tolerance defines the maximum possible error of pixel values in the compressed image. It's a double value.

Default Value:0.01

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.

definitionExpression String

The SQL where clause used to filter rasters. Only the rasters that satisfy the definition expression are displayed in the View. This property overrides the mosaicRule's where property if both properties are set on the layer.

fields Field[]

An array of fields in the layer. Each field represents an attribute that may contain a value for each raster in the layer.

See also:
format String

The format of the exported image.

Possible Values:"png"|"png8"|"png24"|"png32"|"jpg"|"jpgpng"|"lerc"|"tiff"

The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the view to match a layer's extent so that its features appear to fill the view. See the sample snippet below.

Example:
// Once the layer loads, set the view's extent to the layer's fullextent
layer.when(function(){
  view.extent = layer.fullExtent;
});
hasMultidimensions Boolean

Indicates if the layer has multidimensionalInfo.

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

imageMaxHeight Number
Since: ArcGIS API for JavaScript 4.4

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

Default Value:4100
imageMaxWidth Number
Since: ArcGIS API for JavaScript 4.4

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

Default Value:15000
interpolation String
Since: ArcGIS API for JavaScript 4.12

Defines how to interpolate pixel values.

Possible Values:"nearest"|"bilinear"|"cubic"|"majority"

legendEnabled Boolean
Since: ArcGIS API for JavaScript 4.12

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 inherited

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;

Defines how overlapping images should be mosaicked.

multidimensionalInfo Object

The multidimensional information associated with the layer if the layer's hasMultidimensions property is true. If defined, multidimensional information contains various dimensions of data for a particular value, such as time, depth, altitude, etc. Defining slices of particular dimensions in the layer is handled with the multidimensionalDefinition property of the mosaicRule.

Default Value:null
Since: ArcGIS API for JavaScript 4.12

The pixel value representing no available information. Can be a number (same value for all bands) or array (specific value for each band).

noDataInterpretation String
Since: ArcGIS API for JavaScript 4.12

Interpretation of the noData setting.

ValueDescription
anyPixel is transparent if any band matches noData value.
allPixel is transparent only if all bands match noData value.

Possible Values:"any"|"all"

objectIdField String

The name of an oid field containing a unique value or identifier for each raster in the layer.

See also:

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;
pixelFilter Function

A function that processes pixelData. The pixelData object contains a pixelBlock property that gives you access to all of the pixels in the raster on the client.

Inside the pixelFilter you may loop through all the pixels found in the pixelBlock property of the pixelData object and process them. This function may be used to hide some pixels from the view, alter their values, and change their color. The pixelFilter should be used when the imagery layer's format is lerc or tiff as these formats return raw pixel data to the client.

See also:
Example:
var layer = new ImageryLayer({
  url: // url to the image service
  pixelFilter: colorize  // see the colorize() function below
});

// This function is applied to the pixelFilter property of the layer.
// It takes the original value of each pixel and converts it to an RGB
// representation to color the layer on a blue - red ramp. Blue pixels
// represent low values and red pixels represent high values. View the sample
// referenced above to see how this function works

function colorize(pixelData) {
  // If there isn't pixelData, a pixelBlock, nor pixels, exit the function
  if (pixelData === null || pixelData.pixelBlock === null || pixelData.pixelBlock.pixels === null) {
    return;
  }

  // The pixelBlock stores the values of all pixels visible in the view
  var pixelBlock = pixelData.pixelBlock;

  // Get the min and max values of the data in the current view
  var minValue = pixelBlock.statistics[0].minValue;
  var maxValue = pixelBlock.statistics[0].maxValue;

  // The mask is an array that determines which pixels are visible to the client
  var mask = pixelBlock.mask;

  // The pixels visible in the view
  var pixels = pixelBlock.pixels;

  // The number of pixels in the pixelBlock
  var numPixels = pixelBlock.width * pixelBlock.height;

  // Calculate the factor by which to determine the red and blue
  // values in the colorized version of the layer
  var factor = 255.0 / (maxValue - minValue);

  // Get the pixels containing temperature values in the only band of the data
  var band1 = pixels[0];

  // Create empty arrays for each of the RGB bands to set on the pixelBlock
  var rBand = [];
  var gBand = [];
  var bBand = [];

  // Loop through all the pixels in the view
  for (i = 0; i < numPixels; i++) {
    // Get the pixel value recorded at the pixel location
    var tempValue = band1[i];
    // Calculate the red value based on the factor
    var red = (tempValue - minValue) * factor;

    // Sets a color between blue (lowest) and red (highest) in each band
    rBand[i] = red;
    gBand[i] = 0;
    bBand[i] = 255 - red;
  }

  // Set the new pixel values on the pixelBlock (now three bands)
  pixelData.pixelBlock.pixels = [rBand, gBand, bBand];
  pixelData.pixelBlock.pixelType = "u8"; // u8 is used for color
}
pixelType String

Raster source pixel type.

ValueRange of values that each cell can contain
unknownPixel type is unknown
s8-128 to 127
s16-32768 to 32767
s32-2147483648 to 2147483647
u80 to 255
u160 to 65535
u320 to 4294967295
f32-3.402823466e+38 to 3.402823466e+38
f640 to 18446744073709551616

Possible Values:"unknown"|"s8"|"s16"|"s32"|"u8"|"u16"|"u32"|"f32"|"f64"

popupEnabled Boolean

Indicates whether to display popups when features in the layer are clicked.

Default Value:true
popupTemplate PopupTemplateautocast

The popup template for the layer. When set on the layer, the popupTemplate allows users to access attributes and display their values using text and/or charts in the view's popup when a pixel is clicked. See this sample for an example of how PopupTemplate interacts with an ImageryLayer.

A default popup template is automatically used if no popupTemplate has been defined when Popup.defaultPopupTemplateEnabled is set to true.

See also:
Example:
// displays the temperature stored in the clicked pixel
layer.popupTemplate: {
  title: "Sea Surface Temperature",
  content: "{Raster.ServicePixelValue}° Celsius"
}
portalItem PortalItem

The portal item from which the layer is loaded. If the portal item references a Feature Service or Scene Service, then you can specify a single layer to load with the layerId property.

Examples:
// while this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "caa9bd9da1f4487cb4989824053bb847"
  }  // the first layer in the service is returned
});
// set hostname when using an on-premise portal (default is ArcGIS Online)
// esriConfig.portalUrl = "http://myHostName.esri.com/arcgis";

// while this example uses FeatureLayer, this same pattern can be
// used for SceneLayers
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // loads the third item in the given feature service
  layerId: 2
});
rasterAttributeTableFieldPrefix String

Prefix used to define the fields from the raster attribute table. It's primarily used for popups

rasterFields Field[]readonly

A complete list of fields that consists of raster catalog fields, item pixel value, service pixel value, service pixel value with various server defined function templates, and raster attribute table fields. This list is used for layer's popupTemplate.

Example:
layer.when(function(){
  // print out field names returned in layer.rasterFields
  layer.rasterFields.forEach(function(field){
    console.log(field.name);
  });
});
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;
Since: ArcGIS API for JavaScript 4.11

The renderer assigned to the layer. The renderer defines how to visualize pixels in the layer. Depending on the renderer type, the pixels may be stretched across the color ramp, classified or have different symbols based on values.

If both renderer and pixelFilter is applied to an ImageryLayer then pixelFilter will override the renderer.

Specifies the rule for how the requested image should be rendered. When renderingRule applied, the server returns an updated service information that reflects a custom processing as defined by the rendering rule.

See also:
Example:
var remapRF = new RasterFunction({
  functionName: "Remap",
  functionArguments: {
    InputRanges: [-3,10,11,37], // remap pixels with values -3 to 10 to now have value of 1
    OutputValues: [1,2],        // remap pixel values from 11 to 37 to have a value of 2
    Raster: "$$"  // Apply Remap to the image service
  },
  outputPixelType: "u8"
});

imageLayer.renderingRule = remapRF; // Set rendering rule to the raster function
serviceRasterInfo RasterInforeadonly
Since: ArcGIS API for JavaScript 4.12

Source raster information of the image service. The layer must be loaded before serviceRasterInfo can be accessed.

See also:
sourceJSON Object
Since: ArcGIS API for JavaScript 4.13

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

spatialReference SpatialReferenceautocastreadonly

The spatial reference of the image service.

Since: ArcGIS API for JavaScript 4.11

The time info provides information such as date fields that store start and end time for each feature and the full time extent for the layer. The timeInfo along with its startField and endField properties must be set at the time of layer initialization if it is being set for GeoJSONLayer, CSVLayer or FeatureLayer initialized from client-side features. The full time extent for the timeInfo is automatically calculated based on start and end fields. 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"
  }
});

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

type Stringreadonly

For ImageryLayer the type is always "imagery".

url String

The URL to the REST endpoint of the layer. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online.

Example:
// This url must point to an Image Service
var layer = new ImageryLayer({
  url: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/CharlotteLAS/ImageServer"
});
version Numberreadonly

The version of ArcGIS Server in which the image 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

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
PopupTemplate

Creates a default popup template for the layer, populated with all the fields of the layer.

more details
more detailsImageryLayer
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<Object>

Returns an image using the export REST operation that displays data from an ImageryLayer.

more details
more detailsImageryLayer
Promise<RasterInfo>

Generates raster info for the specified rendering rule.

more details
more detailsImageryLayer
Promise<Object>

Gets the image coordinate system information of a catalog item in an image service.

more details
more detailsImageryLayer
Promise<RasterInfo>

Get the raster info of a catalog item in an image service.

more details
more detailsImageryLayer
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
Object

Registers an event handler on the instance.

more details
more detailsLayer

Executes the pixelFilter function and redraws the layer.

more details
more detailsImageryLayer

Fetches all the data for the layer.

more details
more detailsImageryLayer
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.

createLayerView(view, options)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.

See also:
createPopupTemplate(options){PopupTemplate}
Since: ArcGIS API for JavaScript 4.11

Creates a default popup template for the layer, populated with all the fields of the layer.

Parameters:
Specification:
options Object
optional

the options.

Specification:
maximumFields Number
optional
Default Value: 75

the maximum number of fields to include in the popup template.

ignoreFieldTypes String[]
optional

field types to ignore when creating the popup. By default the geometry, blob, raster, guid and xml field types are ignored.

Returns:
TypeDescription
PopupTemplatethe popup template, or null if the layer does not have any fields.
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<Object>}

Returns an image using the export REST operation that displays data from an ImageryLayer.

Parameters:
extent Extent

The extent of the image to export.

width Number

The width of the image in pixels.

height Number

The height of the image in pixels.

options Object
optional

The parameter options is an object with the following properties.

Specification:
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<Object>Resolves to an object containing the parameters of the exported image including the PixelBlock. The pixelBlock contains the value of each pixel in the image. Use this object to call the export REST operation.
generateRasterInfo(renderingRule){Promise<RasterInfo>}
Since: ArcGIS API for JavaScript 4.12

Generates raster info for the specified rendering rule.

Parameter:
renderingRule RasterFunction

Rendering rule for the requested raster info.

Returns:
TypeDescription
Promise<RasterInfo>When resolved, a RasterInfo containing info specific to the requested rendering rule is returned.
getCatalogItemICSInfo(rasterId, abortOptions){Promise<Object>}
Since: ArcGIS API for JavaScript 4.13

Gets the image coordinate system information of a catalog item in an image service. The returned object can be used to set the 2D MapView's spatialReference and extent so that the image can be displayed in its original coordinate system. The image service must have a catalog capability.

Parameters:
rasterId Number

Raster catalog id.

abortOptions AbortSignal
optional

Signal object that can be used to abort the asynchronous task.

Returns:
TypeDescription
Promise<Object>When resolved, returns an object containing image coordinate system of the raster catalog item.
See also:
Example:
// get image coordinate system of the specified catalog item
// for example Raster.OBJECTID = 1600
layer.getCatalogItemICSInfo(imageId).then(function(info) {
// create a spatialReference object and set its
// imageCoordinateSystem property
 var sr = { // autocasts to esri/geometry/SpatialReference
   imageCoordinateSystem: { id: imageId }
 };

 // Calculate an extent for the mapview based on the image's extent
 // in its original coordinate system
 const width = document.getElementById("viewDiv").getBoundingClientRect().width;
 const height = document.getElementById("viewDiv").getBoundingClientRect().height;
 const newExt = info.icsExtent.clone();
 const scaleFactor = 5;
 newExt.xmin = (newExt.xmin + newExt.xmax - width * scaleFactor) / 2;
 newExt.xmax = newExt.xmin + width * scaleFactor;
 newExt.ymin = (newExt.ymin + newExt.ymax - height * scaleFactor) / 2;
 newExt.ymax = newExt.ymin + height * scaleFactor;
 newExt.spatialReference = sr;

 // set the MapView's spatialReference to the image's coordinate system
 // and the extent to the extent calculated above
 view = new MapView({
   container: "viewDiv",
   map: map,
   spatialReference: sr,
   extent: newExt
 });
});
getCatalogItemRasterInfo(rasterId, abortOptions){Promise<RasterInfo>}
Since: ArcGIS API for JavaScript 4.13

Get the raster info of a catalog item in an image service. Each raster catalog item represents a feature in the raster catalog. Each such feature has an associated raster. The image service must have a catalog capability.

Parameters:
rasterId Number

Raster catalog id.

abortOptions AbortSignal
optional

Signal object that can be used to abort the asynchronous task.

Returns:
TypeDescription
Promise<RasterInfo>When resolved, a RasterInfo containing info specific to the catalog item is returned.
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.
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);
});
redraw()

Executes the pixelFilter function and redraws the layer.

Example:
// function defined in layer.pixelFilter is re-executed
layer.redraw();
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 then() 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...