WCSLayer

AMD: require(["esri/layers/WCSLayer"], (WCSLayer) => { /* code goes here */ });
ESM: import WCSLayer from "@arcgis/core/layers/WCSLayer.js";
Class: esri/layers/WCSLayer
Inheritance: WCSLayer Layer Accessor
Since: ArcGIS Maps SDK for JavaScript 4.17

WCS presents raster data from a OGC Web Coverage Service. Raster data are projected and rendered on the client-side. It supports versions 1.0.0, 1.1.0, 1.1.1, 1.1.2 and 2.0.1. For version 2.0.1, it supports servers that support GEOTIFF coverage and implements the following extensions: Scaling, Interpolation, Range Subsetting, CRS, and KVP/Get.

To avoid cross-origin issues when using WCSLayer, you may set up a CORS enabled server or a proxy. ArcGIS Server (10.3.1+) image service based WCSLayers have CORS enabled by default.

See also

Constructors

new WCSLayer(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
let layer = new WCSLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/services/ScientificData/SeaTemperature/ImageServer/WCSServer"
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Number[]

Defines a band combination using 0-based band indexes.

more details
WCSLayer
String

The copyright text as defined by the service.

more details
WCSLayer
String

The coverage identifier for the layer.

more details
WCSLayer
CoverageInfo

Coverage information retrieved from the WCS Server.

more details
WCSLayer
Object

Use this property to append custom parameters to all WCS requests.

more details
WCSLayer
String

The name of the class.

more details
Accessor
Extent

The full extent of the layer.

more details
Layer
String

The unique ID assigned to the layer.

more details
Layer
String

Defines how to interpolate pixel values.

more details
WCSLayer
String

Indicates how the layer should display in the LayerList widget.

more details
Layer
Boolean

Indicates whether the layer's resources have loaded.

more details
Layer
Error

The Error object returned if an error occurred while loading.

more details
Layer
String

Represents the status of a load operation.

more details
Layer
Object[]

A list of warnings which occurred while loading.

more details
Layer
Number

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

more details
WCSLayer
Number

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

more details
WCSLayer
DimensionalDefinition[]

The multidimensional definitions associated with the layer.

more details
WCSLayer
Number

The opacity of the layer.

more details
Layer
Map|Basemap|Ground|GroupLayer

The parent to which the layer belongs.

more details
Layer
Boolean

Enable persistence of the layer in a WebMap or WebScene.

more details
WCSLayer
PortalItem

The portal item from which the layer is loaded.

more details
WCSLayer
Field[]

An array of raster fields in the layer that consists of service pixel value.

more details
WCSLayer
RasterInfo

Raster information retrieved from data source.

more details
WCSLayer
ClassBreaksRenderer|RasterStretchRenderer

The renderer assigned to the layer.

more details
WCSLayer
TimeExtent

The layer's time extent.

more details
WCSLayer
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
WCSLayer
TimeInterval

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

more details
WCSLayer
String

The title of the layer used to identify it in places such as the LayerList widget.

more details
Layer
String For WCSLayer the type is always "wcs". more detailsWCSLayer
String

The URL of the WCS service endpoint of the layer.

more details
WCSLayer
Boolean

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

more details
WCSLayer
String

The version of Web Coverage Service currently being used.

more details
WCSLayer
Boolean

Indicates if the layer is visible in the View.

more details
Layer

Property Details

bandIds Number[]

Defines a band combination using 0-based band indexes.

The copyright text as defined by the service.

coverageId String

The coverage identifier for the layer. It defaults to the first coverage.

coverageInfo CoverageInfo
Since: ArcGIS Maps SDK for JavaScript 4.26

Coverage information retrieved from the WCS Server.

customParameters Object

Use this property to append custom parameters to all WCS requests. The custom parameters are applied to GetCapabilities, DescribeCoverage, GetCoverage operations of WCS services.

Example
// request for particular images in a mosaic dataset
// Numbers are the object IDs of the image service catalog table
layer.customParameters = {images: "1,2,3"};
declaredClass Stringreadonly inherited

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

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;
});

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

interpolation String

Defines how to interpolate pixel values.

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

listMode String inherited

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

Value Description
show The layer is visible in the table of contents.
hide The layer is hidden in the table of contents.
hide-children If 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.

Value Description
not-loaded The object's resources have not loaded.
loading The object's resources are currently loading.
loaded The object's resources have loaded without errors.
failed The 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;
multidimensionalDefinition DimensionalDefinition[]
Since: ArcGIS Maps SDK for JavaScript 4.20

The multidimensional definitions associated with the layer. Filters the layer by slicing data along defined variables and dimensions such as time, depth, altitude, etc. For example, you can display a particular variable such as temperature or salinity measured at a fixed dimension (e.g. time, depth).

See also
Examples
// set the `multidimensionalDefinition` to visualize a sea water
// temperature at -5000m on April 7th 2014.
const dimension = [
  {
     variableName: "temperature",
     dimensionName: "Std_Time",
     values: [1396828800000]
  },
  {
     variableName: "temperature",
     dimensionName:"Std_Z",
     values:[-5000]
  }
];
layer.multidimensionalDefinition = dimension;
// get the layer's multidimensionalDefinition and locate the
// Salinity dimension and filter the data by salinity.
const multidimensionalDefinition = layer.multidimensionalDefinition;
const variableName =  "Salinity";
// filter the data by salinity dimension
multidimensionalDefinition.forEach((def) => def.variableName = variableName);
layer.multidimensionalDefinition = multidimensionalDefinition;

// update the statistics of the layer's stretch renderer.
const renderer = layer.renderer.clone();
const dimensions = layer.rasterInfo.multidimensionalInfo;
// get the salinity variable's statistics
const salinity = dimensions.variables.find((variable) => variable.name === variableName);
renderer.statistics = salinity.statistics;
layer.renderer = renderer;
opacity Number inherited

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;
Since: ArcGIS Maps SDK for JavaScript 4.27

The parent to which the layer belongs.

persistenceEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.28

Enable persistence of the layer in a WebMap or WebScene.

Default Value:true
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.

Beginning with version 4.17, it is possible to load tables from feature service items hosted in ArcGIS Online and ArcGIS Enterprise. This only applies to feature layers, and will successfully load if FeatureLayer.isTable returns true.

Examples
// While this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids.
const layer = 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.
const layer = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // loads the third item in the given feature service
  layerId: 2
});
// Initialize GeoJSONLayer by referencing a portalItem id pointing to geojson file.
const layer = new GeoJSONLayer({
  portalItem: new PortalItem({
    id: "81e769cd7031482797e1b0768f23c7e1",
    // optionally define the portal, of the item.
    // if not specified, the default portal defined is used.
    // see https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl
    portal: new Portal({
      url: "https://jsapi.maps.arcgis.com/"
    })
  }
});
// This snippet loads a table hosted in ArcGIS Online.
const table = new FeatureLayer({
  portalItem: { // autocasts as esri/portal/PortalItem
    id: "123f4410054b43d7a0bacc1533ceb8dc"
  }
});

// Before adding the table to the map, it must first be loaded and confirm it is the right type.
table.load().then(function() {
  if (table.isTable) {
    map.tables.add(table);
  }
});
rasterFields Field[]

An array of raster fields in the layer that consists of service pixel value.

rasterInfo RasterInforeadonly
Since: ArcGIS Maps SDK for JavaScript 4.19

Raster information retrieved from data source.

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

See also
timeExtent TimeExtentautocast
Since: ArcGIS Maps SDK for JavaScript 4.22

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 ImageryTileLayer({
  url: "https://tiledimageservices.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/NLDAS2011_daily_wind_magdir/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)
  }
});
timeInfo TimeInfoautocast
Since: ArcGIS Maps SDK for JavaScript 4.22

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

Default Value:null
Since: ArcGIS Maps SDK for JavaScript 4.22

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).
let 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"
      }
    }
  }
});

The title of the layer used to identify it in places such as the LayerList widget.

If the layer is loaded from a portal item, the title of the portal item will be used. 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 WCSLayer the type is always "wcs".

url String

The URL of the WCS service endpoint of the layer.

useViewTime Boolean
Since: ArcGIS Maps SDK for JavaScript 4.22

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 String

The version of Web Coverage Service currently being used. The supported versions are: 1.0.0, 1.1.0, 1.1.1, 1.1.2 and 2.0.1.

visible Boolean inherited

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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor

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

more details
Layer
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
Layer
PopupTemplate

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

more details
WCSLayer

Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer).

more details
Layer
Boolean

Emits an event on the instance.

more details
Layer
Promise<object>

Fetches pixels for a given extent.

more details
WCSLayer
Boolean

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

more details
Layer
Boolean

Returns true if a named group of handles exist.

more details
Accessor
Promise<RasterIdentifyResult>

Identify pixel values at a given location.

more details
WCSLayer
Boolean

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

more details
Layer
Boolean

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

more details
Layer
Boolean

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

more details
Layer
Promise

Loads the resources referenced by this class.

more details
Layer
Object

Registers an event handler on the instance.

more details
Layer

Removes a group of handles owned by the object.

more details
Accessor
Promise

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

more details
Layer

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

cancelLoad()inherited

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

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
signal AbortSignal
optional

A signal to abort the creation of the layerview.

Returns
Type Description
Promise<LayerView> Resolves with a LayerView instance.
See also
createPopupTemplate(options){PopupTemplate}

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

Starting with version 4.28, date fields are formatted using the short-date-short-time preset dateFormat rather than long-month-day-year in popup templates created with the createPopupTemplate() method. For example, previously a date that may have appeared as "December 30, 1997" will now appear as "12/30/1997 6:00 PM".

Parameter
optional

Options for creating the popup template.

Returns
Type Description
PopupTemplate The popup template, or null if the layer does not have any fields.
destroy()inherited

Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer). The layer can no longer be used once it has been destroyed.

The destroyed layer will be removed from its parent object like Map, WebMap, WebScene, Basemap, Ground, or GroupLayer.

See also
emit(type, event){Boolean}inherited

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
Type Description
Boolean true if a listener was notified
fetchPixels(extent, width, height, options){Promise<object>}
Since: ArcGIS Maps SDK for JavaScript 4.19

Fetches pixels for a given extent.

Parameters
Specification
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
interpolation String
optional

Added at version 4.23. Defines how to interpolate pixel values.

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

signal AbortSignal
optional

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

Returns
Type Description
Promise<object> Resolves to an object containing the parameters of the exported pixels including PixelBlock. The pixelBlock contains the value of each pixel in the image.
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
Type Description
Boolean Returns true if the class supports the input event.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
identify(point, options){Promise<RasterIdentifyResult>}

Identify pixel values at a given location. This method identifies the content of an image service for the input location and in a specified dimensional definition.

Starting at version 4.25, the identify method returns pixel values from specific dimensional definitions for a transposed multidimensional service referenced in an ImageryTileLayer. Set the transposedVariableName parameter along with the multidimensionalDefinition to get pixel values from specific dimensional slices. To get pixel values from all dimensional slices, just set the transposedVariableName. The ImageryTileLayer's rasterInfo.hasMultidimensionalTranspose property must be true when setting the transposedVariableName parameter.

Parameters
point Point autocast
Autocasts from Object

Input point that defines the location to be identified.

optional

Optional settings for the identify request. At version 4.25, the transposedVariableName was added to get pixel values from specific dimensional definitions if the ImageryTileLayer references a transposed multidimensional image service. Set the transposedVariableName and multidimensionalDefinition get pixel values for the specified dimensional definitions from a transposed multidimensional service. If multidimensionalDefinition is not specified, pixel values will be returned from all the dimensional slices.

Returns
Type Description
Promise<RasterIdentifyResult> Returns a promise that resolves to a RasterIdentifyResult containing a location and pixel values. The identify returns a value for only one slice at a time for WCSLayer and for non-transposed multidimensional ImageryTileLayer. If the transposedVariableName parameter is set for the transposed multidimensional ImageryTileLayer, the result returns all pixel values from all multidimensional slices.
See also
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
Type Description
Boolean Indicates 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
Type Description
Boolean Indicates 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
Type Description
Boolean Indicates 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.

The load() method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.

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
signal AbortSignal
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
Type Description
Promise Resolves 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

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns
Type Description
Object Returns an event handler with a remove() method that should be called to stop listening for the event(s).
Property Type Description
remove Function When 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);
});
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
when(callback, errback){Promise}inherited

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
Type Description
Promise Returns 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
let 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
});

Type Definitions

CoverageDescriptionV100 Object
Since: ArcGIS Maps SDK for JavaScript 4.26

Coverage description for WCS service version 1.0.0.

Properties
name String

Coverage name.

label String

Coverage label.

description String

Coverage description.

supportedFormats String[]

Formats supported by a coverage.

supportedInterpolations String[]

Interpolations supported by a coverage.

supportedCRSs Object

Coordinate reference systems supported by a coverage.

Specification
requestResponseCRSs String[]

Coordinate reference systems in which the coverage can both accept GetCoverage requests and deliver coverage responses.

nativeCRSs String[]

The native coordinate reference system of a coverage – that is, the coordinate reference systems in which coverages can be obtained without any distortion or degradation of the data.

lonLatEnvelope Extent

Spatial extent of the coverage.

rangeSet Object

Defines the properties (categories, measures, or values) assigned to each location in the domain. It can numeric or text values, or it can be a compound values such as income by race, or radiance by wave length. A compound range set may have more than one control parameter or set of “bins”, for quantities related to values of several parameters (such as counts of wildlife tabulated both by size and by species).

Properties
name String

Range set name.

label String

Range set label.

nullValues Number[]
optional

The null values is used when valid values are not available.

axis Object[]

Provides additional information on compound valued range set.

Specification
name String

Range axis name.

label String

Range axis label.

values String[]

Range axis values.

domainSet Object

Describes the spatial and temporal domain of a coverage.

Specification
spatialDomain Object

Spatial domain of a coverage.

Properties
envelope Extent

Spatial domain extent.

columns Number

Spatial domain columns.

rows Number

Spatial domain rows.

offset Object

Spatial domain x, y offset.

Specification
x Number

Spatial domain x offset.

y Object

Spatial domain y offset.

origin Object

Spatial domain x, y origin.

Specification
x Number

Spatial domain x origin.

y Object

Spatial domain y origin.

temporalDomain TemporalDomain
optional

Temporal domain or extent of a coverage.

version "1.0"

Coverage version. It is always "1.0" for CoverageDescriptionV100.

CoverageDescriptionV110 Object
Since: ArcGIS Maps SDK for JavaScript 4.26

Coverage description for WCS service version 1.1.0.

Properties
title String

Coverage title.

abstract String

Coverage abstract.

identifier String

Coverage identifier.

supportedFormats String[]

Formats supported by a coverage.

supportedCRSs String[]

Coordinate reference systems supported by a coverage.

domain Object

Describes the spatial and temporal domain of a coverage.

Properties
spatialDomain Object

Spatial extent or domain of a coverage.

Properties
envelope Extent

Spatial domain extent.

columns Number

Spatial domain columns.

rows Number

Spatial domain rows.

offset Object

Spatial domain x, y offset.

Specification
x Number

Spatial domain x offset.

y Object

Spatial domain y offset.

origin Object

Spatial domain x, y origin.

Specification
x Number

Spatial domain x origin.

y Object

Spatial domain y origin.

gridBaseCRS String

Specifies spatial resolution of the coordinate reference system.

useEPSGAxis Boolean

Indicates if the EPSG axis is used.

temporalDomain TemporalDomain

Temporal domain or extent of the coverage.

range Object

Defines the properties (categories, measures, or values) assigned to each location in the domain. It can numeric or text values, or it can be a compound values such as income by race, or radiance by wave length. A compound range set may have more than one control parameter or set of “bins”, for quantities related to values of several parameters (such as counts of wildlife tabulated both by size and by species).

Properties
identifier String

Range identifier.

description String
optional

Range description.

definition String

Range definition.

abstract String
optional

Range abstract.

title String
optional

Range title.

supportedInterpolations String[]

Interpolations supported by the range.

nullValues Number[]
optional

Null values.

axis Object

Provides additional information on compound valued range.

Specification
identifier String

The range axis identifier.

uom String

The axis unit of measurement.

dataType String

The axis data type.

values String[]

The axis values.

bandNoDataValues Number[]
optional

The axis bandNoDataValues.

resolution Object

Resolution x, y.

Specification
x Object

Resolution x.

y Object

Resolution y.

metadata String
optional

Coverage metadata.

version "1.1"

Coverage version. It is always "1.1" for CoverageDescriptionV110.

CoverageDescriptionV201 Object
Since: ArcGIS Maps SDK for JavaScript 4.26

Coverage description for WCS service version 2.0.1

Properties
coverageId String

Coverage id.

boundedBy Object

Spatial and temporal extent of a coverage.

Specification
extent Extent

The spatial extent of a coverage.

axisLabels String[]

The coverage's axis name.

uomLabels String[]

List of unit of measure (uom) labels for all the axis.

envelopeAllDims Object

The spatial extent dimensions.

Specification
mins Number[]

Spatial extent min x and y.

maxs Number[]

Spatial extent min x and y.

beginPosition Date
optional

Start date for the temporal extent of a coverage.

endPosition Date
optional

End date for the temporal extent of the coverage.

isEastFirst Boolean

Is east first.

domainSet Object

Domains associated with a coverage.

Specification
columns Number

Domain columns of a coverage.

rows Number

Domain rows of a coverage.

origin Number[]

Domain origin.

offset Number[]

Domain offset.

resolution Object

Domain x, y resolution.

Specification
x Number

Resolution x.

y Number

Resolution.y.

gridSamples Number[]

Domain grid samples.

axisLabels String[]

Axis labels.

hasSameAxisLabelsAsBoundedBy Boolean

Has same axis labels as bounded by.

rangeType Object

Describes the semantics of the range set values supported by a coverage.

Specification
name String

Range type name.

description String
optional

Range type description.

uom String

Unit of measurement for the range type.

nilValue Number
optional

Number that represents null value.

allowedValues Number[]
optional

Allowed values for the range type.

serviceParameters Object

Service parameters.

resolution Object

Service x,y resolution.

Specification
x Number

Resolution x.

y Number

Resolution y.

coverageFunction Object
optional

Coverage function.

extension String
optional

Coverage extension.

EOCoverageMetadata Object

The WCS 2.0 Earth Observation coverage metadata.

Specification
observation Object

Earth observation.

Specification
phenomenonTime TemporalDomain
optional

Earth observation phenomenon time.

resultTime TemporalDomain
optional

Earth observation resultTime.

footprint Polygon
optional

Earth observation footprint.

identifier String

Earth observation identifier.

observation.acquisitionType String
optional

Earth observation acquisition type.

observation.status String
optional

Earth observation status.

version "2.0"

Service version.

CoverageInfo Object
Since: ArcGIS Maps SDK for JavaScript 4.26

Coverage information associated with a WCS service. It returns information related to coordinate reference systems, spatial and range domains, and formats supported by a service.

Properties
id String

Service coverage id.

title String

Service coverage title.

description String

Service coverage description.

lonLatEnvelope Extent

Spatial extent of the coverage.

bandNames String[]

Coverage band names.

rasterInfo RasterInfo

Coverage raster info.

supportedFormats String[]

Formats supported by a service.

supportedInterpolations String

Interpolation supported by a service.

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

Coverage description for different versions.

version "1.0.0"|"1.1.0"|"1.1.1"|"1.1.2"|"2.0.1"

The service version.

useEPSGAxis Boolean

Indicates if the EPSG axis is used.

TemporalDomain Object
Since: ArcGIS Maps SDK for JavaScript 4.26

Temporal domain or extent of a coverage.

Properties
begin Date

Start date for the temporal domain of a coverage.

end Date

End date for the temporal domain of a coverage.

values Date[]
optional

Date values available in the temporal domain.

resolution Number
optional

The numerical value of the temporal domain or extent.

units strings
optional

Temporal units such as day, month, year etc.

Event Overview

Show inherited events Hide inherited events
Name Type Summary Class
{view: View,layerView: LayerView}

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

more details
Layer
{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
Layer
{view: View,layerView: LayerView}

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

more details
Layer

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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.