ImageAngleParameters | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Input parameters for ImageryLayer.computeAngles() or imageService.computeAngles() methods.

See also

Constructors

ImageAngleParameters Constructor new ImageAngleParameters(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

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

Show inherited properties

Hide inherited properties

Type	Summary	Class
String []	Angle names to be computed.	ImageAngleParameters
String	The name of the class.	Accessor
Point	A point geometry that defines the reference point of rotation to compute the angle direction.	ImageAngleParameters
Number	The rasterId of a raster catalog in the image service.	ImageAngleParameters
SpatialReference	The spatial reference used to compute the angles.	ImageAngleParameters

Property Details

angleNames Property angleNames String[]

Angle names to be computed. By default both north and up angles are computed.

Possible values	Description
["up"]	Angle computed after rotating the map so that the top of the image is always oriented to the direction of sensor when it acquired the image.
["north"]	Angle computed after rotating the map so that the top of the image is always oriented toward north. This angle is essentially the arithmetic rotation from imageCoordinateSystem to pixel space.
["north", "up"]	Angle computed for all directions.

Default Value:["north","up"]

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

point Property point Pointautocast

A point geometry that defines the reference point of rotation to compute the angle direction. By default the centroid of the image is used.

rasterId Property rasterId Number

The rasterId of a raster catalog in the image service. The specified raster catalog's image coordinate system will be used in the calculation.

spatialReference Property spatialReference SpatialReferenceautocast

The spatial reference used to compute the angles. If not specified, the image service's spatial reference will be used.

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
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	ImageAngleParameters
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.	ImageAngleParameters

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

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.

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 Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

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 Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

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.