Skip To ContentArcGIS for DevelopersSign In Dashboard

RasterInfo

Class: esri/layers/support/RasterInfo
Since: ArcGIS API for JavaScript 4.12

Describes general raster data information exposed by the ArcGIS REST API for ImageryLayers. RasterInfo contains information such band count, statistics, data type, dimensions and key properties.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
FeatureSet

The raster attribute table associated with an imagery layer.

more details
more detailsRasterInfo
Number

Raster band count.

more details
more detailsRasterInfo
Number[][]

Raster colormap that can be used to display the imagery layer.

more details
more detailsRasterInfo
String

Raster data type controls how the data is rendered by default.

more details
more detailsRasterInfo
Extent

The minimum and maximum X and Y coordinates of a bounding box containing all the raster data.

more details
more detailsRasterInfo
Object[]

Raster histograms return basic name-value pairs for number of bins, min and max bounding values, counts of pixels in each bin.

more details
more detailsRasterInfo
Object

Raster key properties.

more details
more detailsRasterInfo
Object

The multidimensional information associated with the raster.

more details
more detailsRasterInfo
Point

Raster pixel size.

more details
more detailsRasterInfo
String

Pixel type for the raster data source.

more details
more detailsRasterInfo
SpatialReference

The spatial reference of the raster.

more details
more detailsRasterInfo
Object[]

Raster band statistics.

more details
more detailsRasterInfo

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.

See also:
Example:
layer.when(function() {
  // accesses the raster attribute table of the layer
  var rasterAttributes = layer.serviceRasterInfo.attributeTable.features;
});
bandCount Number

Raster band count.

colormap Number[][]

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.

ValueDescription
genericUses the application defaults for resampling and stretching.
elevationApplies bilinear resampling and a Min-Max stretch.
thematicApplies nearest neighbor resampling and a Deviation stretch.
processedNo stretch is applied.
scientificUses the blue to red color ramp to display the data.
vector-uvUses the U (magnitude component) and V(direction component) components in the vector field renderer.
vector-magdirUses the magnitude and direction in the vector field renderer.

Possible Values:"generic"|"elevation"|"thematic"|"processed"|"scientific"|"vector-uv"|"vector-magdir"

extent Extent

The minimum and maximum X and Y coordinates of a bounding box containing all the raster data.

histograms Object[]

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 Object

The multidimensional information associated with the raster.

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 layer is handled with the multidimensionalDefinition property of the mosaicRule.

pixelSize Point

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.

ValueRange of values that each cell can contain
unknownPixel type is unknown
s8-128 to 127
s16-32768 to 32767
s32-2147483648 to 2147483647
u80 to 255
u160 to 65535
u320 to 4294967295
f32-3.402823466e+38 to 3.402823466e+38
f640 to 18446744073709551616

Possible Values:"unknown"|"s8"|"s16"|"s32"|"u8"|"u16"|"u32"|"f32"|"f64"

spatialReference SpatialReference

The spatial reference of the raster.

statistics Object[]

Raster band statistics. These include the minimum value in the raster, maximum value, mean of all values, and standard deviation.

Properties:
min Number

The minimum pixel value.

max Number

The maximum pixel value.

stddev Number

The standard deviation of calculated pixel values.

avg Number

The average of calculated pixel values.

Method Overview

NameReturn TypeSummaryClass
*

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

more details
more detailsRasterInfo
Object

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

more details
more detailsRasterInfo

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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:
TypeDescription
*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() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...
ails">

API Reference search results

NameTypeModule
Loading...
Feedback on this topic?