Symbol3DLayer | API Reference | ArcGIS Maps SDK for JavaScript 4.30

Symbol layers are used to define the visualization of Point, Polyline, Polygon, and mesh geometries rendered with 3D symbols. 3D symbols may only be used to render features in a FeatureLayer, SceneLayer, or standalone graphics in a 3D SceneView. There is no support for 3D symbols in 2D MapViews.

All 3D symbols have a symbolLayers property, which is an array of Symbol3DLayer objects. All symbols must have at least one symbol layer added to the symbolLayers property. Think of the symbol object as a container that holds multiple symbol layers which define the appearance of the symbol. One layer may be an outline, another the fill, etc. The relationship of symbol layers to symbol is similar to the relationship of operational layers to a Map.

Each symbol layer type may only be applied to certain Symbol3D and Geometry types. See the table below to learn more about when to use each type of symbol layer.

Symbol3DLayer Type	Symbol3D Type	Flat/Volumetric	Size Units
IconSymbol3DLayer	PointSymbol3D, PolygonSymbol3D	flat	points
ObjectSymbol3DLayer	PointSymbol3D, PolygonSymbol3D	volumetric	meters
LineSymbol3DLayer	LineSymbol3D, PolygonSymbol3D	flat	points
PathSymbol3DLayer	LineSymbol3D	volumetric	meters
FillSymbol3DLayer	PolygonSymbol3D, MeshSymbol3D	flat	-
WaterSymbol3DLayer	PolygonSymbol3D	flat	-
ExtrudeSymbol3DLayer	PolygonSymbol3D	volumetric	meters
TextSymbol3DLayer	PointSymbol3D, PolygonSymbol3D, LabelSymbol3D	flat	points

The size of flat symbol layers is usually defined in either points or pixels (screen space) whereas the size of volumetric symbol layers is defined in meters (real-world space).

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
	String	The name of the class.	Accessor
	String	The 3D symbol layer type.	Symbol3DLayer

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

type Property type Stringreadonly

The 3D symbol layer type. See the table below for a list of possible values.

Value	Description
icon
object
line
path
fill
water
extrude
text

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

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.