MultidimensionalSubset

AMD: require(["esri/layers/support/MultidimensionalSubset"], (MultidimensionalSubset) => { /* code goes here */ });
ESM: import MultidimensionalSubset from "@arcgis/core/layers/support/MultidimensionalSubset";
Class: esri/layers/support/MultidimensionalSubset
Inheritance: MultidimensionalSubset Accessor
Since: ArcGIS API 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 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

new MultidimensionalSubset(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Extent|Polygon

The spatial area of interest.

more details
MultidimensionalSubset
String

The name of the class.

more details
Accessor
SubsetDimension[]

The aggregated dimension names and their extents or ranges computed from the subsetDefinitions.

more details
MultidimensionalSubset
DimensionalDefinition[]

The variable and dimension subset definitions to set the layer.

more details
MultidimensionalSubset
String[]

The aggregated variables list computed from the subsetDefinitions.

more details
MultidimensionalSubset

Property Details

areaOfInterest Extent|Polygonautocast
Autocasts from Object

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.

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

dimensions SubsetDimension[]readonly

The aggregated dimension names and their extents or ranges computed from the subsetDefinitions.

Autocasts from Object[]

The variable and dimension subset definitions to set the layer. Only the dimensional definitions defined here will be available on the layer.

variables String[]readonly

The aggregated variables list computed from the subsetDefinitions.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
MultidimensionalSubset

Creates a deep clone of the MultidimensionalSubset object.

more details
MultidimensionalSubset
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
MultidimensionalSubset
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
MultidimensionalSubset

Method Details

addHandles(handleOrHandles, groupKey)inherited

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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

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

Creates a deep clone of the MultidimensionalSubset object.

Returns
Type Description
MultidimensionalSubset A clone of the object that invoked this method.
fromJSON(json){*}static

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.

Parameter
json Object

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
Type Description
* Returns a new instance of this class.
hasHandles(groupKey){Boolean}inherited

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if 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");
}
removeHandles(groupKey)inherited

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Type Definitions

SubsetDimension Object

Dimension name and its extent or range computed from the subsetDefinitions and it is added to dimensions.

Properties
name String

The dimension name.

extent Number[]

The computed extent or ranges for the given dimension.

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