require(["esri/layers/support/MultidimensionalSubset"], (MultidimensionalSubset) => { /* code goes here */ });
import MultidimensionalSubset from "@arcgis/core/layers/support/MultidimensionalSubset.js";
esri/layers/support/MultidimensionalSubset
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
or ImageryTileLayer 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 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.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
The spatial area of interest. | MultidimensionalSubset | ||
The name of the class. | Accessor | ||
The aggregated dimension names and their extents or ranges computed from the subsetDefinitions. | MultidimensionalSubset | ||
The variable and dimension subset definitions to set the layer. | MultidimensionalSubset | ||
The aggregated variables list computed from the subsetDefinitions. | MultidimensionalSubset |
Property Details
-
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
Propertydimensions SubsetDimension[]readonly -
The aggregated dimension names and their extents or ranges computed from the subsetDefinitions.
-
subsetDefinitions
PropertysubsetDefinitions DimensionalDefinition[] |null |undefinedautocast -
The variable and dimension subset definitions to set the layer. Only the dimensional definitions defined here will be available on the layer.
-
The aggregated variables list computed from the subsetDefinitions.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Creates a deep clone of the MultidimensionalSubset object. | MultidimensionalSubset | ||
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | MultidimensionalSubset | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | MultidimensionalSubset |
Method Details
-
Inherited from Accessor
-
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.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
clone
Methodclone(){MultidimensionalSubset} -
Creates a deep clone of the MultidimensionalSubset object.
ReturnsType Description MultidimensionalSubset A clone of the object that invoked this method.
-
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
jsonparameter 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.Parameterjson ObjectA 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
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.
Type Definitions
-
SubsetDimension
Type DefinitionSubsetDimension Object -
Dimension name and its extent or range computed from the subsetDefinitions and it is added to dimensions.