import MultidimensionalSubset from "@arcgis/core/layers/support/MultidimensionalSubset.js";const MultidimensionalSubset = await $arcgis.import("@arcgis/core/layers/support/MultidimensionalSubset.js");- Inheritance:
- MultidimensionalSubset→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.25
A subset of multidimensional raster data created by slicing the data along defined variables and dimensions.
Only dimensional slices that meet the multidimensionalSubset requirements will be available on a multidimensional ImageryLayer.multidimensionalSubset
or ImageryTileLayer.multidimensionalSubset when the multiDimensionalSubset property is set on the layer.
For example, if you have an ImageryLayer that contains 30 years of monthly precipitation data,
and you only want to expose data for each January to see how precipitation has changed for that month, you can set the multiDimensionalSubset on the imagery layer.
When the multiDimensionalSubset is defined on a layer, the ImageryTileLayer.multidimensionalDefinition
property of the ImageryTileLayer or the mosaicRule.multidimensionalDefinition
of the ImageryLayer must be within the defined multidimensionalSubset, otherwise nothing will be displayed on the map or available for analysis.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
declaredClass readonly inherited | ||
dimensions readonly | | |
| | ||
variables readonly | string[] | |
areaOfInterest
The spatial area of interest. The area of interest can only be set on an ImageryLayer. Only the imagery within the area of interest will be available when set.
Note:
This property will not be honored on an ImageryTileLayer.
dimensions
- Type
- SubsetDimension[]
The aggregated dimension names and their extents or ranges computed from the subsetDefinitions.
subsetDefinitions
- Type
- DimensionalDefinition[] | null | undefined
The variable and dimension subset definitions to set the layer. Only the dimensional definitions defined here will be available on the layer.
variables
- Type
- string[]
The aggregated variables list computed from the subsetDefinitions.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
Creates a new instance of this class and initializes it with values from a JSON object
generated from an ArcGIS product. The object passed into the input json
parameter often comes from a response to a query operation in the REST API or a
toJSON()
method from another ArcGIS product. See the Using fromJSON()
topic in the Guide for details and examples of when and how to use this function.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects. | |
- Returns
- any
Returns a new instance of this class.
clone
- Signature
-
clone (): MultidimensionalSubset
Creates a deep clone of the MultidimensionalSubset object.
- Returns
- MultidimensionalSubset
A clone of the object that invoked this method.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.
Type definitions
SubsetDimension
Dimension name and its extent or range computed from the subsetDefinitions and it is added to dimensions.