RasterBandInfo

AMD: require(["esri/layers/support/RasterBandInfo"], (RasterBandInfo) => { /* code goes here */ });
ESM: import RasterBandInfo from "@arcgis/core/layers/support/RasterBandInfo.js";
Class: esri/layers/support/RasterBandInfo
Inheritance: RasterBandInfo Accessor
Since: ArcGIS Maps SDK for JavaScript 4.27

RasterBandInfo class provides additional information for each raster band in an image service referenced by ImageryLayer or ImageryTileLayer. A band is represented by a single matrix of pixel values, and a raster with multiple bands contains multiple spatially coincident matrices of pixel values representing the same spatial area. Image services can include information such as the band name, band index value, wavelength range, the radiance gain, radiance bias, and solar irradiance. All other raster datasets will only contain the band index value.

See also

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
String

The name of the class.

more details
Accessor
Number

The maximum wavelength of the band.

more details
RasterBandInfo
Number

The minimum wavelength of the band.

more details
RasterBandInfo
String

The name of the band.

more details
RasterBandInfo
Number

The radiance bias of the band.

more details
RasterBandInfo
Number

The radiance gain of the band.

more details
RasterBandInfo
Number

The reflectance bias of the band.

more details
RasterBandInfo
Number

The reflectance gain of the band.

more details
RasterBandInfo
Number

The solar irradiance of the band.

more details
RasterBandInfo

Property Details

declaredClass Stringreadonly inherited

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

maxWavelength Number

The maximum wavelength of the band.

minWavelength Number

The minimum wavelength of the band.

name String

The name of the band.

radianceBias Number

The radiance bias of the band.

radianceGain Number

The radiance gain of the band.

reflectanceBias Number

The reflectance bias of the band.

reflectanceGain Number

The reflectance gain of the band.

solarIrradiance Number

The solar irradiance of the band.

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
RasterBandInfo

Creates a deep clone of the raster band info object.

more details
RasterBandInfo
*

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

more details
RasterBandInfo
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
RasterBandInfo

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

this.addHandles(handle);

// Destroy the object
this.destroy();
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.

clone(){RasterBandInfo}

Creates a deep clone of the raster band info object.

Returns
Type Description
RasterBandInfo A deep clone of the object that invoked this method. // Creates a deep clone of the layer.rasterInfo.bandInfos[0] let bandInfo = layer.rasterInfo.bandInfos[0].clone();
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.

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