var symbol = new PointSymbol3D({
  symbolLayers: [new ObjectSymbol3DLayer({
    width: 5,  // diameter of the object from east to west in meters
    height: 20,  // height of the object in meters
    depth: 15,  // diameter of the object from north to south in meters
    resource: { primitive: "cylinder" },
    material: { color: "red" }
  })]
});

Property Overview

Property Details

anchorString

The positioning of the object relative to the geometry. origin is only valid when an href resource is specified and uses the pivot point defined by the 3D model.

Possible Values: center | bottom | origin

Default value: center

declaredClassStringreadonly

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

depthNumber

The depth, or diameter from north to south, of the object in meters. If undefined, the depth will be calculated to maintain the original proportions of the object.

Default Value: 10

Example:

// depth of the symbol in meters
symbolLayer.depth = 5000;

headingNumber

The clockwise rotation of the symbol in the horizontal plane (i.e., around the z axis). The rotation is specified in degrees and is relative to the y-axis.

If the symbol resource is aligned such that its forward facing side points in the direction of the y-axis (the y-axis always points North in WGS84 or WebMercator coordinates), its upwards facing side is pointing in the direction of the z-axis, and its right-hand side points in the direction of the x-axis (the x-axis always points East in WGS84 or WebMercator coordinates), then this angle corresponds to the heading of the symbol.

Example:

// heading of the symbol in degrees
symbolLayer.heading = 180;

heightNumber

The height of the object in meters. If undefined, the height will be calculated to maintain the original proportions of the object.

Default Value: 10

Example:

// height of the symbol in meters
symbolLayer.height = 1000;

materialObject

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

Property:

color Color optional The fill color of the object. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with r, g, b, and a properties, or a Color object. If the object has textures, the textures will be multiplied with the color. Default value: white

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
  }
};

resourceObject

The primitive shape (primitive) or external 3D model (href) used to visualize the points. If both properties are present, primitive takes precedence and href is ignored. When using the href property, external 3D models must be present in a specific format, which can be generated using the ArcGIS Pro SDK. See these instructions to learn how to generate a custom 3D model for use in this property.

Properties:

primitive String optional Uses a built-in shape. See the table below for possible values. Value Description sphere cylinder cube cone inverted-cone diamond tetrahedron

href String optional The URL to the 3D model. See these instructions to learn how to create a custom 3D model.

Default Value: { primitive: "sphere" }

See also:

• Sample: Visualize features with realistic 3D symbols

rollNumber

Since: ArcGIS API for JavaScript 4.4

The rotation of the symbol in the lateral vertical plane (i.e., around the y axis). The rotation is specified in degrees and is relative to the x-axis. At 0 degrees, the model is level. A positive value lifts the left part and lowers the right part of the model.

If the symbol resource is aligned such that its forward facing side points in the direction of the y-axis (the y-axis always points North in WGS84 or WebMercator coordinates), its upwards facing side is pointing in the direction of the z-axis, and its right-hand side points in the direction of the x-axis (the x-axis always points East in WGS84 or WebMercator coordinates), then this angle corresponds to the roll of the symbol.

Example:

// roll of the symbol in degrees
symbolLayer.roll = 90;

tiltNumber

Since: ArcGIS API for JavaScript 4.4

The rotation of the symbol in the longitudinal vertical plane (i.e., around the x axis). The rotation is specified in degrees and is relative to the y-axis. At 0 degrees, the model is level. A positive value points lifts the front and lowers the back of the model.

If the symbol resource is aligned such that its forward facing side points in the direction of the y-axis (the y-axis always points North in WGS84 or WebMercator coordinates), its upwards facing side is pointing in the direction of the z-axis, and its right-hand side points in the direction of the x-axis (the x-axis always points East in WGS84 or WebMercator coordinates), then this angle corresponds to the tilt of the symbol.

Example:

// tilt of the symbol in degrees
symbolLayer.tilt = 45;

typeStringreadonly

For ObjectSymbol3DLayer the type is always object.

widthNumber

The width, or diameter from east to west, of the object in meters. If undefined, the width will be calculated to maintain the original proportions of the object.

Default Value: 10

Example:

// width of the symbol in meters
symbolLayer.width = 5000;

Method Overview

Method Details

clone(){ObjectSymbol3DLayer}

Creates a deep clone of the symbol layer.

Returns:

Type	Description
ObjectSymbol3DLayer	A deep clone of the object that invoked this method.

Example:

// Creates a deep clone of the graphic's first symbol layer
var symLyr = graphic.symbol.symbolLayers.getItemAt(0).clone();

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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.

toJSON(){Object}inherited

Converts an instance of this class to its ArcGIS Portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:

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