AMD: require(["esri/symbols/Symbol3DLayer"], (Symbol3DLayer) => { /* code goes here */ });
ESM: import Symbol3DLayer from "@arcgis/core/symbols/Symbol3DLayer";
Class: esri/symbols/Symbol3DLayer
Inheritance: Symbol3DLayer Accessor
Since: ArcGIS API for JavaScript 4.0

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 s3d-icon-circle
ObjectSymbol3DLayer PointSymbol3D, PolygonSymbol3D volumetric meters s3d-object
LineSymbol3DLayer LineSymbol3D, PolygonSymbol3D flat points s3d-line
PathSymbol3DLayer LineSymbol3D volumetric meters s3d-path
FillSymbol3DLayer PolygonSymbol3D, MeshSymbol3D flat - s3d-fill
WaterSymbol3DLayer PolygonSymbol3D flat - s3d-water
ExtrudeSymbol3DLayer PolygonSymbol3D volumetric meters s3d-extrusion
TextSymbol3DLayer PointSymbol3D, PolygonSymbol3D, LabelSymbol3D flat points s3d-text

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
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The 3D symbol layer type.

more detailsSymbol3DLayer

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

type Stringreadonly

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

Value Description
icon s3d-icon
object s3d-object
line s3d-line
path s3d-path
fill s3d-fill
water s3d-water
extrude s3d-extrusion
text s3d-text

Possible Values:"icon"|"object"|"line"|"path"|"fill"|"water"|"extrude"|"text"

Method Overview

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsSymbol3DLayer
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsSymbol3DLayer

Method Details


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.

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.

Type Description
* Returns a new instance of this class.

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

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.