The rotation visual variable defines how features rendered with marker symbols or text symbols in a MapView are rotated. The rotation value is determined by mapping the values to data in a field, or by other arithmetic means with an Arcade expression.
This object may be used to depict variables such as wind direction, vehicle heading, etc.
Known Limitations
In a SceneView rotation visual variables are not currently supported with marker symbols, text symbols, 3D icon symbol layers and 3D text symbol layers.
const rotationVisualVariable = {
type: "rotation",
field: "heading",
rotationType: "geographic"
};
renderer.visualVariables = [ rotationVisualVariable ];
Constructors
-
new RotationVariable(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | Only applicable when working in a SceneView. more details | RotationVariable | |
String | The name of the class. more details | 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. more details | VisualVariable | |
Object | An object providing options for displaying the visual variable in the Legend. more details | VisualVariable | |
String | Defines the origin and direction of rotation depending on how the angle of rotation was measured. more details | RotationVariable | |
String | The visual variable type. more details | RotationVariable | |
String | An Arcade expression following the specification defined by the Arcade Visualization Profile. more details | VisualVariable | |
String | The title identifying and describing the associated Arcade expression as defined in the valueExpression property. more details | VisualVariable |
Property Details
-
axis String
-
Only applicable when working in a SceneView. 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
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
The name of the numeric attribute field that contains the data values used to determine the color/opacity/size/rotation of each feature.
-
An object providing options for displaying the visual variable in the Legend.
- Properties
-
showLegend Boolean
Indicates whether to show the visual variable in the legend.
title StringThe title describing the visualization of the visual variable in the Legend. This takes precedence over a field alias or valueExpressionTitle.
-
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 Stringreadonly
-
The visual variable type.
For RotationVariable the type is always "rotation".
-
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
-
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
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
RotationVariable | Creates a deep clone of the RotationVariable. more details | RotationVariable | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | RotationVariable | |
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 | RotationVariable |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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(){RotationVariable}
-
Creates a deep clone of the RotationVariable.
ReturnsType 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(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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.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.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.