require(["esri/symbols/PolygonSymbol3D"], (PolygonSymbol3D) => { /* code goes here */ });
import PolygonSymbol3D from "@arcgis/core/symbols/PolygonSymbol3D.js";
esri/symbols/PolygonSymbol3D
PolygonSymbol3D is used to render features with Polygon geometry in a 3D SceneView. This symbol type is not supported in 2D MapViews. Polygon features may also be rendered as points with icons or objects at the centroid of each polygon.
A PolygonSymbol3D must include at least one symbol layer for it to render in the view. One or more of the following symbol layer types must be used to define a 3D polygon symbol:
Symbol3DLayer Type | Flat/Volumetric | Size Units | Example |
---|---|---|---|
FillSymbol3DLayer | flat | - | |
ExtrudeSymbol3DLayer | volumetric | meters | |
WaterSymbol3DLayer | flat | - | |
LineSymbol3DLayer | flat | points | |
IconSymbol3DLayer | flat | points | |
ObjectSymbol3DLayer | volumetric | meters | |
TextSymbol3DLayer | flat | points |
See Symbol3DLayer and Symbol3D to read more general information about 3D symbols, symbol layers and how they relate to one another.
- See also
let symbol = {
type: "polygon-3d", // autocasts as new PolygonSymbol3D()
symbolLayers: [{
type: "extrude", // autocasts as new ExtrudeSymbol3DLayer()
size: 1000, // Height of the extrusion in meters
material: { color: "blue" }
}]
};
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
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. | PolygonSymbol3D | ||
The symbol type. | PolygonSymbol3D |
Property Details
-
styleOrigin
InheritedPropertystyleOrigin StyleOrigin
Inherited from Symbol3D -
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
symbolLayers Collection<(ExtrudeSymbol3DLayer|FillSymbol3DLayer|IconSymbol3DLayer|LineSymbol3DLayer|ObjectSymbol3DLayer|TextSymbol3DLayer|WaterSymbol3DLayer)>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
type
property.Note that LineSymbol3DLayer is deprecated for being used with PolygonSymbol3D. Use FillSymbol3DLayer.outline instead. Note that TextSymbol3DLayer is deprecated for being used with PolygonSymbol3D.
-
type
type Stringreadonly
-
The symbol type.
For PolygonSymbol3D the type is always "polygon-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 deep clone of the symbol. | PolygonSymbol3D | ||
* | 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.
-
clone
clone(){PolygonSymbol3D}
-
Creates a deep clone of the symbol.
ReturnsType Description PolygonSymbol3D A deep clone of the object that invoked this method. Example// Creates a deep clone of the graphic's symbol const symbolLayer = graphic.symbol.clone();
-
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.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 true
if 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.