Skip To ContentArcGIS for DevelopersSign In Dashboard

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 TypeSymbol3D TypeFlat/VolumetricSize UnitsExample
IconSymbol3DLayerPointSymbol3D, PolygonSymbol3Dflatpointss3d-icon-circle
ObjectSymbol3DLayerPointSymbol3D, PolygonSymbol3Dvolumetricmeterss3d-object
LineSymbol3DLayerLineSymbol3D, PolygonSymbol3Dflatpointss3d-line
PathSymbol3DLayerLineSymbol3Dvolumetricmeterss3d-path
FillSymbol3DLayerPolygonSymbol3D, MeshSymbol3Dflat-s3d-fill
WaterSymbol3DLayerPolygonSymbol3Dflat-s3d-water
ExtrudeSymbol3DLayerPolygonSymbol3Dvolumetricmeterss3d-extrusion
TextSymbol3DLayerPointSymbol3D, PolygonSymbol3D, LabelSymbol3Dflatpointss3d-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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

The 3D symbol layer type.

more details
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.

ValueDescription
icons3d-icon
objects3d-object
lines3d-line
paths3d-path
fills3d-fill
waters3d-water
extrudes3d-extrusion
texts3d-text

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

Method Overview

NameReturn TypeSummaryClass
*

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

more details
more detailsSymbol3DLayer
Object

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

more details
more detailsSymbol3DLayer

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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...