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	Example
IconSymbol3DLayer	PointSymbol3D, PolygonSymbol3D	flat	points
ObjectSymbol3DLayer	PointSymbol3D, PolygonSymbol3D	volumetric	meters
LineSymbol3DLayer	LineSymbol3D, PolygonSymbol3D	flat	points
PathSymbol3DLayer	LineSymbol3D	volumetric	meters
FillSymbol3DLayer	PolygonSymbol3D, MeshSymbol3D	flat	-
ExtrudeSymbol3DLayer	PolygonSymbol3D	volumetric	meters
TextSymbol3DLayer	PointSymbol3D, LineSymbol3D, PolygonSymbol3D, LabelSymbol3D	flat	points

Each symbol layer has a material property that defines the color of the symbol.

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

See also:

• Symbol Playground

• Symbol3D
• Renderer
• Graphic

• ArcGIS blog - Working with icons, lines, and fill symbols

• ArcGIS blog - Working with objects, paths, and extrusion

• ArcGIS blog - Using attributes to represent real-world sizes of features

Property Overview

Property Details

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

materialObjectautocast

The material used to shade the geometry. For material properties, see the documentation of the individual symbol layer classes.

typeStringreadonly

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

Value	Description
icon
object
line
path
fill
extrusion
text

Method Overview

Method Details

fromJSON(json){*}static

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

toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.