Skip to content
import { getCapabilities } from "@arcgis/core/layers/ogc/wcsUtils.js";
Since
ArcGIS Maps SDK for JavaScript 4.31

Provides utility functions for the WCSLayer.

See also

Functions

getCapabilities

Function

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

Signature
getCapabilities (url: string, options?: GetCapabilitiesOptions): Promise<WCSCapabilities>
Parameters
ParameterTypeDescriptionRequired
url

The URL to the WCS service endpoint.

options
Returns
Promise<WCSCapabilities>

The WCS Capabilities for the service.

Example
const capabilities = await wcsUtils.getCapabilities(url);
// use capabilities information

Type definitions

GetCapabilitiesOptions

Type definition

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

Supertypes
AbortOptions

customParameters

Property
Type
CustomParameters | null | undefined

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

version

Property
Type
WCSVersion | null | undefined

The version of the WCS service.

WCSVersion

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"1.0.0" | "1.1.0" | "1.1.1" | "1.1.2" | "2.0.1"

WCSCoverageBrief

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage information associated with a WCS service.

id

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The id of the coverage.

lonLatEnvelope

Property
Type
Extent | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

The extent of the coverage.

coverageSubType

Property
Type
string | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

The subtype of the coverage.

WCSOnlineResources

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

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

getCapabilities

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The URL to the getCapabilities endpoint.

describeCoverage

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The URL to the describeCoverage endpoint.

getCoverage

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The URL to the getCoverage endpoint.

WCSCapabilities

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

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

See also

name

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Name of the WCS service.

onlineResources

Property
Type
WCSOnlineResources
Since
ArcGIS Maps SDK for JavaScript 5.0

Online resources for the WCS service.

coverages

Property
Type
WCSCoverageBrief[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Information about the available coverages.

gridCoverages

Property
Type
WCSCoverageBrief[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Information about the available grid coverages.

supportedVersions

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

The versions supported by the WCS service.

version

Property
Type
WCSVersion
Since
ArcGIS Maps SDK for JavaScript 5.0

The WCS service version.

supportedFormats

Property
Type
string[] | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Formats supported by the WCS service.

profiles

Property
Type
string[] | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Application profiles supported by the WCS service.

supportedInterpolations

Property
Type
string[] | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Interpolations supported by the WCS service.

WCSCoverageInfo

Type definition

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.

id

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Service coverage id.

title

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Service coverage title.

description

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Service coverage description.

bandNames

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage band names.

rasterInfo

Property
Type
RasterInfo
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage raster info.

supportedFormats

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Formats supported by a service.

coverageDescription

Property
Type
WCSCoverageDescriptionV100 | WCSCoverageDescriptionV110 | WCSCoverageDescriptionV201
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage description for different versions.

version

Property
Type
WCSVersion
Since
ArcGIS Maps SDK for JavaScript 5.0

The service version.

useEPSGAxis

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates if the EPSG axis is used.

lonLatEnvelope

Property
Type
Extent | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Spatial extent of the coverage.

supportedInterpolations

Property
Type
RasterInterpolation[] | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Interpolation supported by a service.

WCSRangeSet

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

name

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Range set name.

label

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Range set label.

axis

Property
Type
WCSRangeAxis[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Provides additional information on compound valued range set.

nullValues

Property
Type
number[] | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

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

WCSRangeAxis

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

name

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Range axis name.

label

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Range axis label.

values

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Range axis values.

WCSDomainSet

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

spatialDomain

Property
Type
WCSSpatialDomain
Since
ArcGIS Maps SDK for JavaScript 5.0

Spatial domain of a coverage.

temporalDomain

Property
Type
WCSTemporalDomain | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Temporal domain or extent of a coverage.

WCSSpatialDomain

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

envelope

Property
Type
Extent
Since
ArcGIS Maps SDK for JavaScript 5.0

Spatial domain extent.

columns

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

Spatial domain columns.

rows

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

Spatial domain rows.

offset

Property
Type
{ x: number; y: number; }
Since
ArcGIS Maps SDK for JavaScript 5.0

Spatial domain x, y offset.

origin

Property
Type
{ x: number; y: number; }
Since
ArcGIS Maps SDK for JavaScript 5.0

Spatial domain x, y origin.

WCSTemporalDomain

Type definition

Temporal domain or extent of a coverage.

begin

Property
Type
Date
Since
ArcGIS Maps SDK for JavaScript 5.0

Start date for the temporal domain of a coverage.

end

Property
Type
Date
Since
ArcGIS Maps SDK for JavaScript 5.0

End date for the temporal domain of a coverage.

values

Property
Type
Date[] | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Date values available in the temporal domain.

resolution

Property
Type
number | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

The numerical value of the temporal domain or extent.

units

Property
Type
string | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Temporal units such as day, month, year etc.

WCSCoverageDescriptionV100

Type definition

Coverage description for WCS service version 1.0.0.

name

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage name.

label

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage label.

description

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage description.

supportedFormats

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Formats supported by a coverage.

supportedInterpolations

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Interpolations supported by a coverage.

supportedCRSs

Property
Type
WCSCoverageDescriptionV100SupportedCRSs
Since
ArcGIS Maps SDK for JavaScript 5.0

Coordinate reference systems supported by a coverage.

lonLatEnvelope

Property
Type
Extent
Since
ArcGIS Maps SDK for JavaScript 5.0

Spatial extent of the coverage.

rangeSet

Property
Type
WCSRangeSet[]
Since
ArcGIS Maps SDK for JavaScript 5.0

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).

domainSet

Property
Type
WCSDomainSet
Since
ArcGIS Maps SDK for JavaScript 5.0

Describes the spatial and temporal domain of a coverage.

version

readonly Property
Type
"1.0"
Since
ArcGIS Maps SDK for JavaScript 5.0

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

WCSCoverageDescriptionV100SupportedCRSs

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

requestResponseCRSs

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

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

nativeCRSs

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

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.

WCSRangeSetV110

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

identifier

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Range identifier.

description

Property
Type
string | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Range description.

definition

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Range definition.

abstract

Property
Type
string | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Range abstract.

title

Property
Type
string | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Range title.

supportedInterpolations

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Interpolations supported by the range.

nullValues

Property
Type
number[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Null values.

statistics

Property
Type
RasterBandStatistics[] | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Statistics.

axis

Property
Type
WCSRangeSetV110Axis[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Provides additional information on compound valued range.

WCSRangeSetV110Axis

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

identifier

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The range axis identifier.

uom

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The axis unit of measurement.

dataType

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The axis data type.

values

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

The axis values.

bandNoDataValues

Property
Type
number[] | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

The axis bandNoDataValues.

WCSSpatialDomainV110

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Supertypes
WCSSpatialDomain

gridBaseCRS

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Specifies spatial resolution of the coordinate reference system.

useEPSGAxis

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates if the EPSG axis is used.

WCSDomainSetV110

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

spatialDomain

Property
Type
WCSSpatialDomainV110
Since
ArcGIS Maps SDK for JavaScript 5.0

Spatial extent or domain of a coverage.

temporalDomain

Property
Type
WCSTemporalDomain | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Temporal domain or extent of the coverage.

WCSCoverageDescriptionV110

Type definition

Coverage description for WCS service version 1.1.0.

title

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage title.

abstract

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage abstract.

identifier

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage identifier.

supportedFormats

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Formats supported by a coverage.

supportedCRSs

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Coordinate reference systems supported by a coverage.

domain

Property
Type
WCSDomainSetV110
Since
ArcGIS Maps SDK for JavaScript 5.0

Describes the spatial and temporal domain of a coverage.

range

Property
Type
WCSRangeSetV110[]
Since
ArcGIS Maps SDK for JavaScript 5.0

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).

resolution

Property
Type
PixelSize
Since
ArcGIS Maps SDK for JavaScript 5.0

Resolution x, y.

metadata

Property
Type
string | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage metadata.

version

readonly Property
Type
"1.1"
Since
ArcGIS Maps SDK for JavaScript 5.0

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

WCSBoundedByV201

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

envelope

Property
Type
Extent
Since
ArcGIS Maps SDK for JavaScript 5.0

The spatial extent of a coverage.

axisLabels

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

The coverage's axis name.

uomLabels

Property
Type
string[] | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

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

envelopeAllDims

Property
Type
WCSBoundedByV201EnvelopeAllDims
Since
ArcGIS Maps SDK for JavaScript 5.0

The spatial extent dimensions.

beginPosition

Property
Type
Date | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Start date for the temporal extent of a coverage.

endPosition

Property
Type
Date | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

End date for the temporal extent of the coverage.

isEastFirst

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Is east first.

WCSBoundedByV201EnvelopeAllDims

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

mins

Property
Type
number[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Spatial extent min x and y.

maxs

Property
Type
number[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Spatial extent min x and y.

WCSRangeFieldV201

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

name

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Range type name.

description

Property
Type
string | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Range type description.

uom

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Unit of measurement for the range type.

nilValue

Property
Type
number | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Number that represents null value.

allowedValues

Property
Type
number[] | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Allowed values for the range type.

WCSDomainSetV201

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

columns

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

Domain columns of a coverage.

rows

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

Domain rows of a coverage.

origin

Property
Type
number[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Domain origin.

offset

Property
Type
number[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Domain offset.

resolution

Property
Type
PixelSize
Since
ArcGIS Maps SDK for JavaScript 5.0

Domain x, y resolution.

gridSamples

Property
Type
number[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Domain grid samples.

axisLabels

Property
Type
string[]
Since
ArcGIS Maps SDK for JavaScript 5.0

Axis labels.

hasSameAxisLabelsAsBoundedBy

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Has same axis labels as bounded by.

WCSEOCoverageMetadata

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

observation

Property
Type
WCSEOCoverageMetadataObservation
Since
ArcGIS Maps SDK for JavaScript 5.0

Earth observation.

WCSEOCoverageMetadataObservation

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

phenomenonTime

Property
Type
WCSTemporalDomain | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Earth observation phenomenon time.

resultTime

Property
Type
WCSTemporalDomain | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Earth observation resultTime.

footprint

Property
Type
Polygon | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Earth observation footprint.

identifier

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Earth observation identifier.

acquisitionType

Property
Type
string | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Earth observation acquisition type.

status

Property
Type
string | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Earth observation status.

WCSCoverageDescriptionV201

Type definition

Coverage description for WCS service version 2.0.1

coverageId

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage id.

boundedBy

Property
Type
WCSBoundedByV201
Since
ArcGIS Maps SDK for JavaScript 5.0

Spatial and temporal extent of a coverage.

domainSet

Property
Type
WCSDomainSetV201
Since
ArcGIS Maps SDK for JavaScript 5.0

Domains associated with a coverage.

rangeType

Property
Type
WCSRangeFieldV201[][]
Since
ArcGIS Maps SDK for JavaScript 5.0

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

serviceParameters

Property
Type
Record<string, any>
Since
ArcGIS Maps SDK for JavaScript 5.0

Service parameters.

resolution

Property
Type
PixelSize
Since
ArcGIS Maps SDK for JavaScript 5.0

Service x,y resolution.

coverageFunction

Property
Type
any | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage function.

extension

Property
Type
string | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Coverage extension.

eoMetadata

Property
Type
WCSEOCoverageMetadata | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

The WCS 2.0 Earth Observation coverage metadata.

version

readonly Property
Type
"2.0"
Since
ArcGIS Maps SDK for JavaScript 5.0

Service version.