wcsUtils

AMD: require(["esri/layers/ogc/wcsUtils"], (wcsUtils) => { /* code goes here */ });
ESM: import * as wcsUtils from "@arcgis/core/layers/ogc/wcsUtils.js";
Object: esri/layers/ogc/wcsUtils
Since: ArcGIS Maps SDK for JavaScript 4.31

Provides utility functions for the WCSLayer.

See also

Method Overview

Name Return Type Summary Object

Fetches the capabilities metadata offered by the WCS service, including supported versions and coverages information.

wcsUtils

Method Details

getCapabilities

Method
getCapabilities(url, options){Promise<WCSCapabilities>}

Fetches the capabilities metadata offered by the WCS service, including supported versions and coverages information.

Parameters
Specification
url String

The URL to the WCS service endpoint.

options Object
optional
Specification
version "1.0.0"|"1.1.0"|"1.1.1"|"1.1.2"|"2.0.1"
optional

The version of the WCS service.

customParameters Object
optional

A list of key-value pairs of parameters to append to the url.

signal AbortSignal
optional

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

Returns
Type Description
Promise<WCSCapabilities> The WCS Capabilities for the service.
Example
const capabilities = await wcsUtils.getCapabilities(url);
// use capabilities information

Type Definitions

CoverageBrief

Type Definition
CoverageBrief

Coverage information associated with a WCS service.

Properties
id String
optional

The id of the coverage.

lonLatEnvelope Extent
optional

The extent of the coverage.

coverageSubType String
optional

The subtype of the coverage.

OnlineResources

Type Definition
OnlineResources

A list of URLs for the WCS service resources. It is necessary for a WCS client to communicate correctly with your WCS service.

Properties
getCapabilities String

The URL to the getCapabilities endpoint.

describeCoverage String

The URL to the describeCoverage endpoint.

getCoverage String

The URL to the getCoverage endpoint.

WCSCapabilities

Type Definition
WCSCapabilities

WCS service information about the available coverages, versions, extensions and more.

Properties
name String

Name of the WCS service.

onlineResources OnlineResources

Online resources for the WCS service.

coverages CoverageBrief[]

Information about the available coverages.

gridCoverages CoverageBrief[]

Information about the available grid coverages.

supportedVersions String[]

The versions supported by the WCS service.

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

The WCS service version.

supportedFormats String[]
optional

Formats supported by the WCS service.

profiles String[]
optional

Application profiles supported by the WCS service.

supportedInterpolations String[]
optional

Interpolations supported by the WCS service.

See also

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