RasterBandInfo | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Number	The maximum wavelength of the band.	RasterBandInfo
Number	The minimum wavelength of the band.	RasterBandInfo
String	The name of the band.	RasterBandInfo
Number	The radiance bias of the band.	RasterBandInfo
Number	The radiance gain of the band.	RasterBandInfo
Number	The reflectance bias of the band.	RasterBandInfo
Number	The reflectance gain of the band.	RasterBandInfo
Number	The solar irradiance of the band.	RasterBandInfo

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

maxWavelength Property maxWavelength Number

The maximum wavelength of the band.

minWavelength Property minWavelength Number

The minimum wavelength of the band.

name Property name String

The name of the band.

radianceBias Property radianceBias Number

The radiance bias of the band.

radianceGain Property radianceGain Number

The radiance gain of the band.

reflectanceBias Property reflectanceBias Number

The reflectance bias of the band.

reflectanceGain Property reflectanceGain Number

The reflectance gain of the band.

solarIrradiance Property solarIrradiance Number

The solar irradiance of the band.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
RasterBandInfo	Creates a deep clone of the raster band info object.	RasterBandInfo
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	RasterBandInfo
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	RasterBandInfo

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

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 Method 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 Method 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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

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 Inherited Method removeHandles(groupKey) Inherited from Accessor

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 Method 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.