ExtrudeSymbol3DLayer

AMD: require(["esri/symbols/ExtrudeSymbol3DLayer"], (ExtrudeSymbol3DLayer) => { /* code goes here */ });
ESM: import ExtrudeSymbol3DLayer from "@arcgis/core/symbols/ExtrudeSymbol3DLayer.js";
Class: esri/symbols/ExtrudeSymbol3DLayer
Inheritance: ExtrudeSymbol3DLayer Symbol3DLayer Accessor
Since: ArcGIS Maps SDK for JavaScript 4.0

ExtrudeSymbol3DLayer is used to render Polygon geometries by extruding them upward from the ground, creating a 3D volumetric object. This is done with a PolygonSymbol3D in a SceneView. MapView does not support 3D symbols.

The color of the symbol is set in the material property. The height of the extrusion is always defined in meters with the size property. Extrusion height and color can also be data-driven by adding size and/or color visual variables to any Renderer that uses this symbol layer.

An ExtrudeSymbol3DLayer must be added to the symbolLayers property of a PolygonSymbol3D. Multiple symbol layers may be used in a single symbol. The image below depicts a polygon FeatureLayer representing building footprints. The features are symbolized with a PolygonSymbol3D containing an ExtrudeSymbol3DLayer. The extrusion is based on the height of buildings.

renderer-vv-size-3d

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: 100000,  // 100,000 meters in height
    material: { color: "red" }
  }]
};

Constructors

ExtrudeSymbol3DLayer

Constructor
new ExtrudeSymbol3DLayer(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
Boolean

Indicates whether the symbol layer geometry casts shadows in the scene.

ExtrudeSymbol3DLayer
String

The name of the class.

Accessor
Edges3D

Sets the contour edges on polygons symbolized with ExtrudeSymbol3DLayer.

ExtrudeSymbol3DLayer
Object

The material used to shade the extrusion.

ExtrudeSymbol3DLayer
Number

The height of the extrusion in meters.

ExtrudeSymbol3DLayer
String

The symbol type.

ExtrudeSymbol3DLayer

Property Details

castShadows

Property
castShadows Boolean
Since: ArcGIS Maps SDK for JavaScript 4.11 ExtrudeSymbol3DLayer since 4.0, castShadows added at 4.11.

Indicates whether the symbol layer geometry casts shadows in the scene. Setting this property to false will disable shadows for the symbol layer even if direct shadows are enabled in SceneView.environment.

Default Value:true
Example
// disables shadow casting
symbolLayer.castShadows = false;

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.

edges

Property
edges Edges3Dautocast
Since: ArcGIS Maps SDK for JavaScript 4.7 ExtrudeSymbol3DLayer since 4.0, edges added at 4.7.

Sets the contour edges on polygons symbolized with ExtrudeSymbol3DLayer.

Example
let symbol = {
  type: "polygon-3d", // autocasts as new PolygonSymbol3D()
  symbolLayers: [{
    type: "extrude", // autocasts as new ExtrudeSymbol3DLayer()
    material: {
      color: [244, 247, 134]
    },
    edges: {
      type: "solid", // autocasts as new SolidEdges3D()
      color: [50, 50, 50, 0.5]
    }
  }]
};

material

Property
material Objectautocast

The material used to shade the extrusion. This property defines the extrusion's color.

Property
color Color
optional
Default Value:white
Autocasts from Object|Number[]|String

The fill color of the extrusion. This can be autocast with an array of rgb(a) values, named string, hex string or an hsl(a) string, an object with r, g, b, and a properties, or a Color object.

Examples
// CSS color string
symbolLayer.material = {
  color: "dodgerblue"
};
// HEX string
symbolLayer.material = {
  color: "#33cc33";
}
// array of RGBA values
symbolLayer.material = {
  color: [51, 204, 51, 0.3];
}
// object with rgba properties
symbolLayer.material = {
  color: {
    r: 51,
    g: 51,
    b: 204,
    a: 0.7
  }
};

size

Property
size Number

The height of the extrusion in meters. Negative values will extrude the polygon surface downward towards or below the ground.

Default Value:1
Example
// polygon is extruded 50,000 meters
symbolLayer.size = 50000;

type

Property
type Stringreadonly

The symbol type.

For ExtrudeSymbol3DLayer the type is always "extrude".

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
ExtrudeSymbol3DLayer

Creates a deep clone of the symbol layer.

ExtrudeSymbol3DLayer
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

Symbol3DLayer
Boolean

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

Symbol3DLayer

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(){ExtrudeSymbol3DLayer}

Creates a deep clone of the symbol layer.

Returns
Type Description
ExtrudeSymbol3DLayer A deep clone of the object that invoked this method.
Example
// Creates a deep clone of the graphic's first symbol layer
let symLyr = graphic.symbol.symbolLayers.at(0).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 Symbol3DLayer

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.