PolygonSymbol3D

AMD: require(["esri/symbols/PolygonSymbol3D"], (PolygonSymbol3D) => { /* code goes here */ });
ESM: import PolygonSymbol3D from "@arcgis/core/symbols/PolygonSymbol3D.js";
Class: esri/symbols/PolygonSymbol3D
Inheritance: PolygonSymbol3D Symbol3D Symbol Accessor
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 - s3d-fill
ExtrudeSymbol3DLayer volumetric meters s3d-extrusion
WaterSymbol3DLayer flat - s3d-water
LineSymbol3DLayer flat points s3d-line
IconSymbol3DLayer flat points s3d-icon
ObjectSymbol3DLayer volumetric meters s3d-object
TextSymbol3DLayer flat points s3d-text

See Symbol3DLayer and Symbol3D to read more general information about 3D symbols, symbol layers and how they relate to one another.

See also
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

PolygonSymbol3D

Constructor
new PolygonSymbol3D(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

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

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

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

The name of the class. The declared class name is formatted as esri.folder.className.

styleOrigin

Inherited
Property
styleOrigin 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.

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.

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

Property
type Stringreadonly

The symbol type.

For PolygonSymbol3D the type is always "polygon-3d".

Method Overview

Show inherited methods Hide inherited methods
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

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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

Method
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

Inherited
Method
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.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON

Inherited
Method
toJSON(){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.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.