// create a PathSymbol3DLayer with a strip style
var stripPath = {
  type: "line-3d",  // autocasts as new LineSymbol3D()
  symbolLayers: [{
    type: "path",  // autocasts as new PathSymbol3DLayer()
    profile: "quad",  // creates a rectangular shape
    width: 20,  // path width in meters
    height: 5,  // path height in meters
    material: { color: "#ff7380" },
    cap: "square",
    profileRotation: "heading"
  }]
};

// create a PathSymbol3DLayer with a pipe style
var pipePath = {
  type: "line-3d",  // autocasts as new LineSymbol3D()
  symbolLayers: [{
    type: "path",  // autocasts as new PathSymbol3DLayer()
    profile: "circle",  // creates a rectangular shape
    width: 20,  // path width will also set the height to the same value
    material: { color: "#ff7380" },
    cap: "round"
  }]
};

Property Overview

Property Details

anchor String

Since: ArcGIS API for JavaScript 4.12

Defines offset of the path cross section relative to the Polyline geometry.

Possible Value	Example
center
bottom
top

Possible Values:"center"|"bottom"|"top"

Default Value:"center"

cap String

Since: ArcGIS API for JavaScript 4.12

Controls the shape at the start and end point of the path. none will not render the faces that close the path. See the table below for possible values.

Possible Value	Example
butt
round
square
none

Possible Values:"none"|"butt"|"square"|"round"

Default Value:"butt"

castShadows Boolean

Since: ArcGIS API for JavaScript 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 Stringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

height Number

Since: ArcGIS API for JavaScript 4.12

The vertical dimension of the cross-section of the path in meters. If only the width is set, then the height is set to the same value as the width. If neither width nor height are set, then the path is not displayed.

Examples:

// create a path with a wall style
var wallPath = {
  type: "line-3d",  // autocasts as new LineSymbol3D()
  symbolLayers: [{
    type: "path",  // autocasts as new PathSymbol3DLayer()
    profile: "quad",  // creates a rectangular shape
    width: 1,  // path width in meters
    height: 20,  // path height in meters
    material: { color: "#a382cc" }
  }]
};

// create a path with a pipe style
var wallPath = {
  type: "line-3d",  // autocasts as new LineSymbol3D()
  symbolLayers: [{
    type: "path",  // autocasts as new PathSymbol3DLayer()
    profile: "circle",
    height: 20,  // path width in meters this also sets the width to 20 meters
    material: { color: "##a382cc" }
  }]
};

join String

Since: ArcGIS API for JavaScript 4.12

Controls the shape of the connection between two segments of the path. See the table below for possible values.

Possible Value	Example
bevel
miter
round

Possible Values:"miter"|"bevel"|"round"

Default Value:"miter"

material Objectautocast

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

Property:

color Color optional Default Value:white Autocasts from Object|Number[]|String The color of the path. 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
  }
};

profile String

Since: ArcGIS API for JavaScript 4.12

Cross-section profile of the path geometry. Setting it to circle creates a path with a pipe shape and setting it to quad gives the path a rectangular shape.

Possible Values:"circle"|"quad"

Default Value:"circle"

profileRotation String

Since: ArcGIS API for JavaScript 4.12

Defines how the profile is rotated as it is extruded along the Polyline geometry. The rotation axes (heading, tilt, roll) can be limited to constrain the orientation of the profile in the scene. Setting profileRotation to all minimizes the twist along the line and ensures that the diameter of the resulting visualization corresponds to width and height. Setting profileRotation to "heading" ensures that the profile stays upright (no tilt or twist).

Typically, all is used for circle profiles and heading is used for quad profiles.

As an example, when setting heading on a path with a quad profile the path is oriented upright:

The same path with profileRotation set to all will rotate in all three degrees of freedom:

Possible Values:"heading"|"all"

Default Value:"all"

size Number

Deprecated since version 4.12. Use width or height instead.

Sets the width and height of the path in meters.

type Stringreadonly

The symbol type.

For PathSymbol3DLayer the type is always "path".

width Number

Since: ArcGIS API for JavaScript 4.12

The horizontal dimension of the cross-section of the path in meters. If only the height is set, then the width is set to the same value as the height. If neither width nor height are set, then the path is not displayed.

Examples:

// create a path with a strip style
var wallPath = {
  type: "line-3d",  // autocasts as new LineSymbol3D()
  symbolLayers: [{
    type: "path",  // autocasts as new PathSymbol3DLayer()
    profile: "quad",  // creates a rectangular shape
    width: 20,  // path width in meters
    height: 1,  // path height in meters
    material: { color: "#a382cc" }
  }]
};

// create a path with a square style
var wallPath = {
  type: "line-3d",  // autocasts as new LineSymbol3D()
  symbolLayers: [{
    type: "path",  // autocasts as new PathSymbol3DLayer()
    profile: "quad",  // creates a rectangular shape
    width: 20,  // this property also sets the height to 20 meters
    material: { color: "#a382cc" }
  }]
};

Method Overview

Method Details

clone(){PathSymbol3DLayer}

Creates a deep clone of the symbol layer.

Returns:

Type	Description
PathSymbol3DLayer	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.