RotationVariable | API Reference | ArcGIS Maps SDK for JavaScript 4.31

The rotation visual variable, determined by mapping the values to data in a field or by other arithmetic means with an Arcade expression, controls how features rendered with marker symbols or text symbols in a MapView , as well as with marker symbols, ObjectSymbol3DLayer or IconSymbol3DLayer in a SceneView, are rotated. The final rotation is derived by adding the mapped or calculated rotation value to the symbol's initial angle.

This object may be used to depict variables such as wind direction, vehicle heading, trend indicators, etc.

Known Limitations

In a SceneView rotation visual variables are not currently supported with text symbols and 3D text symbol layers.

See also

Example

const rotationVisualVariable = {
  type: "rotation",
  field: "heading",
  rotationType: "geographic"
};
renderer.visualVariables = [ rotationVisualVariable ];

Constructors

RotationVariable Constructor new RotationVariable(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	Only applicable when working in a SceneView with an ObjectSymbol3DLayer.	RotationVariable
String	The name of the class.	Accessor
String	The name of the numeric attribute field that contains the data values used to determine the color/opacity/size/rotation of each feature.	VisualVariable
Object	An object providing options for displaying the visual variable in the Legend.	VisualVariable
String	Defines the origin and direction of rotation depending on how the angle of rotation was measured.	RotationVariable
String	The visual variable type.	RotationVariable
String	An Arcade expression following the specification defined by the Arcade Visualization Profile.	VisualVariable
String	The title identifying and describing the associated Arcade expression as defined in the valueExpression property.	VisualVariable

Property Details

axis Property axis String

Only applicable when working in a SceneView with an ObjectSymbol3DLayer. Defines the axis the rotation visual variable should be applied to when rendering features with an ObjectSymbol3DLayer.

If the symbol resource is aligned such that its forward facing side points in the direction of the y-axis (the y-axis always points North in WGS84 or WebMercator coordinates), its upwards facing side is pointing in the direction of the z-axis, and its right-hand side points in the direction of the x-axis (the x-axis always points East in WGS84 or WebMercator coordinates), then the following rotation axis will rotate the symbol as indicated by their name.

Possible Value	Description
heading	The rotation of the symbol in the horizontal plane (i.e., around the z axis).
tilt	The rotation of the symbol in the longitudinal vertical plane (i.e., around the x axis).
roll	The rotation of the symbol in the lateral vertical plane (i.e., around the y axis).

Possible Values:"heading" |"tilt" |"roll"

Default Value:"heading"

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

field Inherited Property field String Inherited from VisualVariable

The name of the numeric attribute field that contains the data values used to determine the color/opacity/size/rotation of each feature.

legendOptions Inherited Property legendOptions Objectautocast Inherited from VisualVariable

An object providing options for displaying the visual variable in the Legend.

Properties: showLegend Boolean|null|undefined

Indicates whether to show the visual variable in the legend.

title String|null|undefined

The title describing the visualization of the visual variable in the Legend. This takes precedence over a field alias or valueExpressionTitle.

rotationType Property rotationType String

Defines the origin and direction of rotation depending on how the angle of rotation was measured. See the table below for a list of possible values. This property only applies to rotations around the heading axis.

Value	Description
geographic	Rotates the symbol from the north in a clockwise direction.
arithmetic	Rotates the symbol from the east in a counter-clockwise direction.

Possible Values:"geographic" |"arithmetic"

Default Value:"geographic"

type Property type Stringreadonly

The visual variable type.

For RotationVariable the type is always "rotation".

valueExpression Inherited Property valueExpression String Inherited from VisualVariable

An Arcade expression following the specification defined by the Arcade Visualization Profile. Expressions in visual variables may reference field values using the $feature profile variable and must return a number.

The values returned from this expression are the data used to drive the visualization as defined in the stops. This takes precedence over field. Therefore, this property is typically used as an alternative to field in visual variables.

See also

Arcade - Visualization Profile

valueExpressionTitle Inherited Property valueExpressionTitle String Inherited from VisualVariable

The title identifying and describing the associated Arcade expression as defined in the valueExpression property. This is displayed as the title of the corresponding visual variable in the Legend in the absence of a provided title in the legendOptions property.

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

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.

clone Method clone(){RotationVariable}

Creates a deep clone of the RotationVariable.

Returns

Type	Description
RotationVariable	A deep clone of the rotation visual variable that invoked this method.

Example

// Creates a deep clone of the visual variable
let renderer = renderer.visualVariables[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 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.