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
-
new PolygonSymbol3D(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | more details The name of the class. | more details | Accessor | |
Object | more details The origin of the style from which the symbol was originally referenced. | more details | Symbol3D | |
Collection<(ExtrudeSymbol3DLayer|FillSymbol3DLayer|IconSymbol3DLayer|LineSymbol3DLayer|ObjectSymbol3DLayer|TextSymbol3DLayer|WaterSymbol3DLayer)> | more details A Collection of Symbol3DLayer objects used to visualize the graphic or feature. | more details | PolygonSymbol3D | |
String | more details The symbol type. | more details | PolygonSymbol3D |
Property Details
-
Since: ArcGIS API for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
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.
-
-
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.
For PolygonSymbol3D the type is always "polygon-3d".
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
PolygonSymbol3D | more details Creates a deep clone of the symbol. | more details | PolygonSymbol3D | |
* | more details Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | more details | Symbol | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | Symbol |
Method Details
-
clone(){PolygonSymbol3D}
-
Creates a deep clone of the symbol.
Returns:Type 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();
-
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 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.
Returns:Type Description * Returns a new instance of this class.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));
Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
-
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.