import PolygonSymbol3D from "@arcgis/core/symbols/PolygonSymbol3D.js";const PolygonSymbol3D = await $arcgis.import("@arcgis/core/symbols/PolygonSymbol3D.js");- Since
- ArcGIS Maps SDK for JavaScript 4.0
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 | - |  |
| IconSymbol3DLayer | flat | points |  |
| ObjectSymbol3DLayer | volumetric | meters |  |
See Symbol3DLayer and Symbol3D to read more general information about 3D symbols, symbol layers and how they relate to one another.
Example
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
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
color inherited | ||
declaredClass readonly inherited | ||
styleOrigin inherited | StyleOrigin | null | undefined | |
| | ||
type readonly | "polygon-3d" | |
color
3D symbols do not support colors on the symbol level. Colors may be set on individual symbol layer materials instead. Setting the color property on a 3D symbol will not have any effect. The color property is present for consistency with other symbol types.
Examples
// CSS color stringsymbol.color = "dodgerblue";// HEX stringsymbol.color = "#33cc33";// array of RGBA valuessymbol.color = [51, 204, 51, 0.3];// object with rgba propertiessymbol.color = { r: 51, g: 51, b: 204, a: 0.7}; styleOrigin
- Type
- StyleOrigin | null | undefined
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
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.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | 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
- any
Returns a new instance of this class.
clone
- Signature
-
clone (): PolygonSymbol3D
Creates a deep clone of the symbol.
- Returns
- PolygonSymbol3D
A deep clone of the object that invoked this method.
Example
// Creates a deep clone of the graphic's symbolconst symbolLayer = graphic.symbol.clone(); toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.