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 Objectoptional
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
Name | Type | Summary | Class | |
---|---|---|---|---|
Number[] | more details Defines a band combination using 0-based band indexes. | more details | WCSLayer | |
String | more details The copyright text as defined by the service. | more details | WCSLayer | |
String | more details The coverage identifier for the layer. | more details | WCSLayer | |
Object | more details Use this property to append custom parameters to all WCS requests. | more details | WCSLayer | |
String | more details The name of the class. | more details | Accessor | |
Field[] | more details An array of raster fields in the layer that consists of service pixel value. | more details | fields | |
Extent | more details The full extent of the layer. | more details | Layer | |
String | more details The unique ID assigned to the layer. | more details | Layer | |
String | more details Defines how to interpolate pixel values. | more details | WCSLayer | |
String | more details Indicates how the layer should display in the LayerList widget. | more details | Layer | |
Boolean | more details Indicates whether the layer's resources have loaded. | more details | Layer | |
Error | more details The Error object returned if an error occurred while loading. | more details | Layer | |
String | more details Represents the status of a load operation. | more details | Layer | |
Object[] | more details A list of warnings which occurred while loading. | more details | Layer | |
Number | more details The maximum scale (most zoomed in) at which the layer is visible in the view. | more details | WCSLayer | |
Number | more details The minimum scale (most zoomed out) at which the layer is visible in the view. | more details | WCSLayer | |
DimensionalDefinition[] | more details The multidimensional definitions associated with the layer. | more details | WCSLayer | |
Number | more details The opacity of the layer. | more details | Layer | |
PortalItem | more details The portal item from which the layer is loaded. | more details | WCSLayer | |
RasterInfo | more details Raster information retrieved from data source. | more details | WCSLayer | |
ClassBreaksRenderer|RasterStretchRenderer | more details The renderer assigned to the layer. | more details | WCSLayer | |
TimeExtent | more details The layer's time extent. | more details | WCSLayer | |
TimeInfo | more details 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 | more details A temporary offset of the time data based on a certain TimeInterval. | more details | WCSLayer | |
String | more details The title of the layer used to identify it in places such as the LayerList widget. | more details | Layer | |
String | more details For WCSLayer the type is always "wcs". | more details | WCSLayer | |
String | more details The URL of the REST endpoint of the layer. | more details | WCSLayer | |
Boolean | more details Determines if the layer will update its temporal data based on the view's timeExtent. | more details | WCSLayer | |
String | more details The version of Web Coverage Service currently being used. | more details | WCSLayer | |
Boolean | more details Indicates if the layer is visible in the View. | more details | Layer |
Property Details
-
Defines a band combination using 0-based band indexes.
-
copyright String
-
The copyright text as defined by the service.
-
coverageId String
-
The coverage identifier for the layer. It defaults to the first coverage.
-
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"};
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
An array of raster fields in the layer that consists of service pixel value.
-
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"
-
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
-
Indicates whether the layer's resources have loaded. When
true
, all the properties of the object can be accessed.- Default Value:false
-
The Error object returned if an error occurred while loading.
- Default Value:null
-
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
-
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 API for JavaScript 4.20
-
The multidimensional definitions associated with the layer. If defined, the multidimensional definitions contain various dimensions of data for a particular value, such as time, depth, altitude, etc. Use the multidimensionalDefinition to define a slice to be displayed by the layer. For example, you can display a particular variable such as temperature or salinity measured at a fixed dimension (e.g. time, depth). These data types are commonly used in atmospheric, oceanographic, and earth sciences.
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;
-
The opacity of the layer. This value can range between
1
and0
, where0
is 100 percent transparent and1
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. 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 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. const lyr = new FeatureLayer({ portalItem: { // autocasts as new PortalItem() id: "8d26f04f31f642b6828b7023b84c2188" }, // loads the third item in the given feature service layerId: 2 });
// 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); } });
-
rasterInfo RasterInforeadonlySince: ArcGIS API 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.
-
timeExtent TimeExtentautocastSince: ArcGIS API 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 theuseViewTime
istrue
, 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) } });
-
Since: ArcGIS API 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
-
timeOffset TimeIntervalautocastSince: ArcGIS API 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.
-
url String
-
The URL of the REST endpoint of the layer. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online.
-
useViewTime BooleanSince: ArcGIS API 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 istrue
, 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.
-
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
Name | Return Type | Summary | Class | |
---|---|---|---|---|
more details Cancels a load() operation if it is already in progress. | more details | Layer | ||
Promise<LayerView> | more details 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 | more details Creates a default popup template for the layer, populated with all the fields of the layer. | more details | WCSLayer | |
more details Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer). | more details | Layer | ||
Boolean | more details Emits an event on the instance. | more details | Layer | |
Promise<Object> | more details Fetches pixels for a given extent. | more details | WCSLayer | |
Boolean | more details Indicates whether there is an event listener on the instance that matches the provided event name. | more details | Layer | |
Promise<Object> | more details Identify pixel values at a given location. | more details | WCSLayer | |
Boolean | more details
| more details | Layer | |
Boolean | more details
| more details | Layer | |
Boolean | more details
| more details | Layer | |
Promise | more details Loads the resources referenced by this class. | more details | Layer | |
Object | more details Registers an event handler on the instance. | more details | Layer | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
Promise | more details
| more details | Layer |
Method Details
-
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 ObjectoptionalAn object specifying additional options. See the object specification table below for the required properties of this object.
Specification:signal AbortSignaloptionalA 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.
Parameter:options CreatePopupTemplateOptionsoptionalOptions 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.
-
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameters:type StringThe name of the event.
event ObjectoptionalThe event payload.
Returns:Type Description Boolean true
if a listener was notified
-
Since: ArcGIS API for JavaScript 4.19
-
Fetches pixels for a given extent.
Parameters:Specification:extent ExtentThe extent of the image to export.
width NumberThe width of the image in pixels.
height NumberThe height of the image in pixels.
options ObjectoptionalThe parameter options is an object with the following properties.
Specification:interpolation StringoptionalAdded at version 4.23. Defines how to interpolate pixel values.
Possible Values:"nearest"|"bilinear"|"cubic"|"majority"
signal AbortSignaloptionalAn 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.
-
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameter:type StringThe name of the event.
Returns:Type Description Boolean Returns true if the class supports the input event.
-
Identify pixel values at a given location. It identifies the content of an image service for the input location and in specified dimensional definitions.
Parameters:point PointInput point that defines the location to be identified.
optional Autocasts from ObjectOptional settings for the identify request.
Returns:Type Description Promise<Object> Returns a promise that resolves to a RasterIdentifyResult containing a location and pixel values.
-
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()
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()
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.
-
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 aLoadable
instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.Parameter:signal AbortSignaloptionalSignal 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.
-
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 FunctionThe 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); });
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));
Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
-
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.Parameters:callback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe 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 });
Event Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
{view: View,layerView: LayerView} |
more details
Fires after the layer's LayerView is created and rendered in a view. |
more details | Layer | |
{view: View,error: Error} |
more details
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} |
more details
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 LayerViewThe 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 ErrorAn 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); });