Describes general raster data information exposed by the ArcGIS REST API for ImageryLayer, ImageryTileLayer and WCSLayer. RasterInfo contains information such band count, statistics, data type, dimensions and key properties.
- See also:
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
FeatureSet | more details The raster attribute table associated with an imagery layer. | more details | RasterInfo | |
Number | more details Raster band count. | more details | RasterInfo | |
Number[][] | more details Raster colormap that can be used to display the imagery layer. | more details | RasterInfo | |
String | more details Raster data type controls how the data is rendered by default. | more details | RasterInfo | |
String | more details The name of the class. | more details | Accessor | |
Extent | more details The minimum and maximum X and Y coordinates of a bounding box containing all the raster data. | more details | RasterInfo | |
Number | more details Raster height (row count) in pixels. | more details | RasterInfo | |
Object[] | more details Raster histograms return basic name-value pairs for number of bins, min and max bounding values, counts of pixels in each bin. | more details | RasterInfo | |
Object | more details Raster key properties. | more details | RasterInfo | |
RasterMultidimensionalInfo | more details Returns the multidimensional information associated with the raster service. | more details | RasterInfo | |
Number|Number[] | more details The pixel value representing no available information. | more details | RasterInfo | |
Object | more details Raster pixel size. | more details | RasterInfo | |
String | more details Pixel type for the raster data source. | more details | RasterInfo | |
SpatialReference | more details The spatial reference of the raster. | more details | RasterInfo | |
Object[] | more details Raster band statistics. | more details | RasterInfo | |
Number | more details Raster width (column count) in pixels. | more details | RasterInfo |
Property Details
-
attributeTable FeatureSet
-
The raster attribute table associated with an imagery layer. It returns categorical mapping of pixel values such as class, group, or category, or membership.
Example:layer.when(function() { // accesses the raster attribute table of the layer let rasterAttributes = layer.serviceRasterInfo.attributeTable.features; });
-
bandCount Number
-
Raster band count.
-
Raster colormap that can be used to display the imagery layer. Each element in the array defines the pixel value and the red, green, and blue color values.
- See also:
-
dataType String
-
Raster data type controls how the data is rendered by default.
Value Description generic Uses the application defaults for resampling and stretching. elevation Applies bilinear resampling and a Min-Max stretch. thematic Applies nearest neighbor resampling and a Deviation stretch. processed No stretch is applied. scientific Uses the blue to red color ramp to display the data. vector-uv Uses the U (magnitude component) and V(direction component) components in the vector field renderer. vector-magdir Uses the magnitude and direction in the vector field renderer. standard-time Uses the blue to red color ramp to display the data --- pixel value represents time encoded using OLEDate. Possible Values:"generic"|"elevation"|"thematic"|"processed"|"scientific"|"vector-uv"|"vector-u"|"vector-v"|"vector-magdir"|"vector-magnitude"|"vector-direction"|"standard-time"
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
extent Extent
-
The minimum and maximum X and Y coordinates of a bounding box containing all the raster data.
-
height NumberSince: ArcGIS API for JavaScript 4.15
-
Raster height (row count) in pixels.
-
Raster histograms return basic name-value pairs for number of bins, min and max bounding values, counts of pixels in each bin.
- See also:
-
keyProperties Object
-
Raster key properties.
- See also:
-
multidimensionalInfo RasterMultidimensionalInfo
-
Returns the multidimensional information associated with the raster service. If defined, multidimensional information contains various
dimensions
of data for a particular value, such as time, depth, altitude, etc.Defining slices of particular dimensions in the ImageryLayer is handled by setting the multidimensionalDefinition parameter on the layer's mosaicRule. To define dimensional slices in ImageryTileLayer and WCSLayer use the
multidimensionalDefinition
property on respective layers.- See also:
Example:// update the statistics of the layer's stretch renderer. const renderer = layer.renderer.clone(); const dimensions = layer.rasterInfo.multidimensionalInfo; // get the salinity variable's statistics const salinity = dimensions.variables.find((variable) => variable.name === variableName); renderer.statistics = salinity.statistics; layer.renderer = renderer;
-
Since: ArcGIS API for JavaScript 4.15
-
The pixel value representing no available information. Can be a number (same value for all bands) or array (specific value for each band).
-
pixelSize Object
-
Raster pixel size. Specifies the pixel size being identified on the x and y axis. Defaults to the base resolution of the dataset when not specified.
-
pixelType String
-
Pixel type for the raster data source.
Value Range of values that each cell can contain unknown Pixel type is unknown s8 -128 to 127 s16 -32768 to 32767 s32 -2147483648 to 2147483647 u8 0 to 255 u16 0 to 65535 u32 0 to 4294967295 f32 -3.402823466e+38 to 3.402823466e+38 f64 0 to 18446744073709551616 Possible Values:"unknown"|"s8"|"s16"|"s32"|"u8"|"u16"|"u32"|"f32"|"f64"
-
spatialReference SpatialReference
-
The spatial reference of the raster.
-
Raster band statistics. These include the minimum value in the raster, maximum value, mean of all values, and standard deviation.
-
width NumberSince: ArcGIS API for JavaScript 4.15
-
Raster width (column count) in pixels.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
* | more details Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | more details | RasterInfo | |
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | RasterInfo |
Method Details
-
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 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:Type Description * Returns a new instance of this class.
-
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
-
RasterMultidimensionalInfo Object
-
RasterMultidimensionalInfo contains dimensions for each variable in the service describing information about the images collected at multiple times, depths, or heights.
- Properties:
-
variables Object
The multi dimensional variables. It stores information such as name, unit and dimensions. For example, a temperature variable can store temperature data and the salinity variable can store the salinity data measured daily at different depths.
- Specification:
-
name String
Variable name.
description StringVariable description.
unit StringUnit of the variable measured in.
A dimension may be used to represent real physical dimensions such as time or depth/height. It may also be used to represent more abstract quantities such as station id or station-time pair. For example, if your temperature data has a corresponding Date dimension field representing the day it was captured, and your salinity data has a Depth dimension field representing the depth at which it was measured, the Dimensions field for that variable would be Date and Depth.
- Specification:
-
name String
Dimension name.
description StringDimension description.
unit StringDimension unit.
optional An array of single values or tuples [min, max] each defining a range of valid values along the specified dimension.
hasRegularIntervals BooleanIndicates if the dimension is recorded at regular intervals.
interval NumberDimension interval.
intervalUnit StringDimension interval unit.
optional The extent of dimension values.
statistics RasterBandStatistics[]Variable statistics.
histograms RasterHistogram[]Variable histograms.
Example:// update the statistics of the layer's stretch renderer. const renderer = layer.renderer.clone(); const dimensions = layer.rasterInfo.multidimensionalInfo; // get the salinity variable's statistics const salinity = dimensions.variables.find((variable) => variable.name === variableName); renderer.statistics = salinity.statistics; layer.renderer = renderer;