Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: DimensionalDefinition
[ AMD Module Require | Legacy Module Require ]
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
| Name | Summary |
|---|---|
| new DimensionalDefinition(json) | Create a new dimensional definition object from an existing json object. |
Properties
| Name | Type | Summary |
|---|---|---|
| dimensionName | String | (Optional) The dimension associated with the variable. |
| isSlice | Boolean | Indicates whether the values indicate slices (rather than ranges). |
| values | Object[] | An array of tuples (min, max) each defining a range of valid values along the specified dimension. |
| variableName | String | The variable name by which to filter. |
Methods
| Name | Return type | Summary |
|---|---|---|
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Constructor Details
Create a new dimensional definition object from an existing json object.
Parameters:
< |
Required | The REST JSON representation for Dimensional Definition. |
Options:
< |
Optional | The dimension associated with the variable. |
< |
Optional | Needed if using special data. |
< |
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. |
< |
Required | The name of the variable. |
Sample:
var dim = new dimensionalDefinition({
variableName: "Salinity",
dimensionName: "StdZ",
values: [-10,-2,0],
isSlice: false
})
Property Details
<String
String(Optional) The dimension associated with the variable.
Sample:
{
"variableName" : "Salinity",
"dimensionName" : "StdZ",
"values" : [-10],
"isSlice":false
}
<Boolean
BooleanIndicates whether the values indicate slices (rather than ranges).
Known values:
true | falseDefault value:
falseSample:
{
"variableName" : "Salinity",
"dimensionName" : "StdZ",
"values" : [-10],
"isSlice":false
}
<Object[]
Object[]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
StringThe variable name by which to filter.
Sample:
{
"variableName" : "Salinity",
"dimensionName" : "StdZ",
"values" : [-10],
"isSlice":false
}
Method Details