Symbol3D

Class: esri/symbols/Symbol3D
Inheritance: Symbol3D Symbol Accessor
Since: ArcGIS API for JavaScript 4.0

Symbol3D is the base class for all 3D symbols. It is used to render 2D Point, Polyline, and Polygon features in a FeatureLayer and 3D mesh features in a SceneLayer. All 3D symbols must be used in a SceneView instance; there is no support for 3D rendering in MapViews.

There are five types of 3D symbols. Four of them correspond with a different feature geometry type. The fifth, LabelSymbol3D, may be applied to any geometry type. See the table below to learn about which symbol types are supported for each geometry type.

Geometry type Valid symbol types
Point PointSymbol3D, LabelSymbol3D
Polyline LineSymbol3D, LabelSymbol3D
Polygon PolygonSymbol3D, LabelSymbol3D
Mesh MeshSymbol3D, LabelSymbol3D

All 3D symbols have a symbolLayers property, which is an array of Symbol3DLayers that define the appearance of the symbol. All symbols must have at least one symbol layer added to the symbolLayers property. The Symbol3D object is a container that holds multiple symbol layers that determine 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. There are various types of symbol layers that may be used based on the symbol type and geometry of the features. See Symbol3DLayer to learn more about symbol layers.

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.

more details
more detailsAccessor
Object

The origin of the style from which the symbol was originally referenced.

more details
more detailsSymbol3D
Collection<Symbol3DLayer>

A Collection of Symbol3DLayer objects used to visualize the graphic or feature.

more details
more detailsSymbol3D
String

The symbol type.

more details
more detailsSymbol3D

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.

styleOrigin Object

The origin of the style from which the symbol was originally referenced. A reference to the style origin can be either by styleName or by styleUrl (but not both). This information is part of the WebScene persistence model and may be used to understand where a symbol was originally sourced from. It does not affect actual appearance or rendering of the symbol.

Properties:
styleName String
optional

a well-known esri-provided style, such as EsriThematicShapesStyle

styleUrl String
optional

url to a style definition

name String

name of the symbol in the style referenced by styleName or styleUrl

Autocasts from Object[]

A Collection of Symbol3DLayer objects used to visualize the graphic or feature. Individual symbol layers may be autocast as objects and specified using the type property.

type Stringreadonly

The symbol type.

Possible Values:"point-3d"|"line-3d"|"polygon-3d"|"mesh-3d"|"label-3d"

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
*

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

more details
more detailsSymbol
Object

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

more details
more detailsSymbol

Method Details

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.
toJSON(){Object}inherited

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.