Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: DimensionalDefinition

require(["esri/layers/DimensionalDefinition"], function(DimensionalDefinition) { /* code goes here */ });

Description

(Added at v3.11)
A dimensional definition defines a filter based on one variable and one dimension. There can be one or multiple dimensional slices filtered.

Samples

Search for samples that use this class.

Constructors

NameSummary
new DimensionalDefinition(json)Create a new dimensional definition object from an existing json object.

Properties

NameTypeSummary
dimensionNameString(Optional) The dimension associated with the variable.
isSliceBooleanIndicates whether the values indicate slices (rather than ranges).
valuesObject[]An array of tuples (min, max) each defining a range of valid values along the specified dimension.
variableNameStringThe variable name by which to filter.

Methods

NameReturn typeSummary
toJson()ObjectConverts object to its ArcGIS Server JSON representation.
Constructor Details

new DimensionalDefinition(json)

Create a new dimensional definition object from an existing json object.
Parameters:
<Object> json Required The REST JSON representation for Dimensional Definition.
Options:
<String> dimensionName Optional The dimension associated with the variable.
<Boolean> isSlice Optional Needed if using special data.
<Object[]> values Required Each element can be a single value, or an array of two values (lower and upper bound). The type of these values are based on dimensionName.
<String> variableName Required The name of the variable.
Sample:

var dim = new dimensionalDefinition({
   variableName: "Salinity",
   dimensionName: "StdZ",
   values: [-10,-2,0],
   isSlice: false
})
Property Details

<String> dimensionName

(Optional) The dimension associated with the variable.
Sample:
{
   "variableName" : "Salinity",
   "dimensionName" : "StdZ",
   "values" : [-10],
   "isSlice":false
}

<Boolean> isSlice

Indicates whether the values indicate slices (rather than ranges).
Known values: true | false
Default value: false
Sample:
{
   "variableName" : "Salinity",
   "dimensionName" : "StdZ",
   "values" : [-10],
   "isSlice":false
}

<Object[]> values

An array of tuples (min, max) each defining a range of valid values along the specified dimension.
Sample:
{
   "variableName" : "Salinity",
   "dimensionName" : "StdZ",
   "values" : [-10],
   "isSlice":false
}

<String> variableName

The variable name by which to filter.
Sample:
{
   "variableName" : "Salinity",
   "dimensionName" : "StdZ",
   "values" : [-10],
   "isSlice":false
}
Method Details

toJson()

Converts object to its ArcGIS Server JSON representation.
Return type: Object