Types
import type { DimensionInterval, Duration, DimensionExtent, TimeDimensionExtent, Dimension } from "@arcgis/core/layers/wms/types.js";

Type definitions

DimensionInterval

Type definition
Type parameters
<T, K>
Since
ArcGIS Maps SDK for JavaScript 5.0

The time dimension interval.

min

Property
Type
T
Since
ArcGIS Maps SDK for JavaScript 5.0

Start of interval.

max

Property
Type
T
Since
ArcGIS Maps SDK for JavaScript 5.0

End of interval.

resolution

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

Interval duration defined by the following properties.

Duration

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

years

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

Number of years.

months

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

Number of months.

days

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

Number of days.

hours

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

Number of hours.

minutes

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

Number of minutes.

seconds

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

Number of seconds.

DimensionExtent

Type definition
Type parameters
<T, K>
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
T[] | DimensionInterval<T, K>[]

TimeDimensionExtent

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Dimension

Type definition
Type parameters
<T>
Since
ArcGIS Maps SDK for JavaScript 5.0

extent

Property
Type
T
Since
ArcGIS Maps SDK for JavaScript 5.0

Available value(s) for the time dimension.

default

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

Default value(s) for the time dimension. The default value will be used if the request does not include a value for the time dimension.

multipleValues

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

Indicates whether multiple values of the dimension may be requested.

nearestValue

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

Indicates whether the nearest value of the dimension will be returned in response to a request for a nearby value.

GenericDimension

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Generic dimension information.

name

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Name of dimensional axis.

ElevationDimension

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Elevation dimension information.

name

Property
Type
"elevation"
Since
ArcGIS Maps SDK for JavaScript 5.0

Name of dimensional axis.

TimeDimension

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Time dimension information. For example, the WMS service might be published to show hourly weather information. The TimeDimension can be used to update View.timeExtent, WMSLayer.timeExtent, or to configure a TimeSlider widget.

Supertypes
Omit<Dimension<TimeDimensionExtent>‚ "unitSymbol">

name

Property
Type
"time"
Since
ArcGIS Maps SDK for JavaScript 5.0

Name of dimensional axis.

units

Property
Type
"ISO8601"
Since
ArcGIS Maps SDK for JavaScript 5.0

Units of dimensional axis.

WMSDimension

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0