RasterSensorInfo

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

The RasterSensorInfo class provides additional information on the raster sensor associated with an image service referenced by ImageryLayer or ImageryTileLayer. This information includes sensor name, product name, imagery acquisition date, cloud coverage, sun and sensor elevation and azimuth angle.

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
Date

The acquisition date.

more details
RasterSensorInfo
Number

The cloud coverage (0-1).

more details
RasterSensorInfo
String

The name of the class.

more details
Accessor
String

The satellite product name.

more details
RasterSensorInfo
Number

The sensor azimuth.

more details
RasterSensorInfo
Number

The sensor elevation.

more details
RasterSensorInfo
String

The sensor name.

more details
RasterSensorInfo
Number

The sun azimuth.

more details
RasterSensorInfo
Number

The sun elevation.

more details
RasterSensorInfo

Property Details

acquisitionDate Date

The acquisition date.

cloudCover Number

The cloud coverage (0-1).

declaredClass Stringreadonly inherited

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

productName String

The satellite product name.

sensorAzimuth Number

The sensor azimuth.

sensorElevation Number

The sensor elevation.

sensorName String

The sensor name.

sunAzimuth Number

The sun azimuth.

sunElevation Number

The sun elevation.

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
RasterSensorInfo

Creates a deep clone of the raster sensor info object.

more details
RasterSensorInfo
*

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

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

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(){RasterSensorInfo}

Creates a deep clone of the raster sensor info object.

Returns
Type Description
RasterSensorInfo A deep clone of the object that invoked this method. // Creates a deep clone of the layer.rasterInfo.sensorInfo let sensorInfo = layer.rasterInfo.sensorInfo.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.