require(["esri/symbols/Symbol3D"], (Symbol3D) => { /* code goes here */ });
import Symbol3D from "@arcgis/core/symbols/Symbol3D.js";
esri/symbols/Symbol3D
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.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
The name of the class. | Accessor | ||
The origin of the style from which the symbol was originally referenced. | Symbol3D | ||
A Collection of Symbol3DLayer objects used to visualize the graphic or feature. | Symbol3D | ||
The symbol type. | Symbol3D |
Property Details
-
styleOrigin
PropertystyleOrigin StyleOrigin -
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.
-
symbolLayers
PropertysymbolLayers Collection<Symbol3DLayer>autocast -
A Collection of Symbol3DLayer objects used to visualize the graphic or feature. Individual symbol layers may be autocast as objects and specified using the
typeproperty.
-
type
Propertytype Stringreadonly -
The symbol type.
Possible Values:"point-3d" |"line-3d" |"polygon-3d" |"mesh-3d" |"label-3d"
Method Overview
| Name | 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. | Symbol | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | Symbol |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
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
jsonparameter 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
InheritedMethodtoJSON(){Object}Inherited from Symbol -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.