Skip To ContentArcGIS for DevelopersSign In Dashboard

PathSymbol3DLayer

require(["esri/symbols/PathSymbol3DLayer"], function(PathSymbol3DLayer) { /* code goes here */ });
Class: esri/symbols/PathSymbol3DLayer
Inheritance: PathSymbol3DLayer Symbol3DLayer Accessor
Since: ArcGIS API for JavaScript 4.0

PathSymbol3DLayer renders Polyline geometries by extruding a 2D profile along the line. A PathSymbol3DLayer must be added to the symbolLayers property of a LineSymbol3D. This is a 3D symbol, therefore it is only supported in a SceneView.

Different styles can be created by combining the profile, width and height properties. A path can have a circle profile that displays the path as a tube and can be used for visualizations of pipelines or any other tube-like features. Setting the profile to quad displays the path with a rectangular shape. By varying height and width different styles can be created like a wall or a strip. Below are some of the path visualizations that could be created by combining these properties:

3d-path-profiles

The color of the path is set in the material property. The color can be data-driven by adding color visual variables to any Renderer that uses this symbol layer. The width and the height can also be driven with size visual variable.

More properties like cap, join and profileRotation can be set to enhance the PathSymbol3DLayer visualization.

In the image below the FeatureLayer depicts transit lines in a city. The polyline features are visualized with PathSymbol3DLayer set on a LineSymbol3D.

symbols-3d-path

Path visualization in 3D sample shows how the different properties change the style of the PathSymbol3DLayer.

Autocasting support

As of version 4.5 of the ArcGIS API for JavaScript, autocasting is universally supported for all renderers, symbols, and symbol layers in the API. So there is no need to include this module in the require() and define() module loaders of your application unless you intend to use the static method(s) of this module.

See also:
Example:
// 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"
  }]
};

Constructors

new PathSymbol3DLayer(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.
NameTypeSummaryClass
String

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

more details
more detailsanchor
String

Controls the shape at the start and end point of the path.

more details
more detailscap
Boolean

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

more details
more detailsPathSymbol3DLayer
String

The name of the class.

more details
more detailsAccessor
Number

The vertical dimension of the cross-section of the path in meters.

more details
more detailsheight
String

Controls the shape of the connection between two segments of the path.

more details
more detailsjoin
Object

The material used to shade the path.

more details
more detailsPathSymbol3DLayer
String

Cross-section profile of the path geometry.

more details
more detailsprofile
String

Defines how the profile is rotated as it is extruded along the Polyline geometry.

more details
more detailsprofileRotation
Number

Sets the width and height of the path in meters.

more details
more detailsPathSymbol3DLayer
String

For PathSymbol3DLayer, the type is always path.

more details
more detailsPathSymbol3DLayer
Number

The horizontal dimension of the cross-section of the path in meters.

more details
more detailswidth

Property Details

anchor Stringinner
Since: ArcGIS API for JavaScript 4.12

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

Possible ValueExample
centeranchor-center
bottomanchor-bottom
Default Value:"center"
cap Stringinner
Since: ArcGIS API for JavaScript 4.12

Controls the shape at the start and end point of the path. See the table below for possible values.

Possible ValueExample
buttline3d-cap-butt
roundline3d-cap-round
squareline3d-cap-square
noneline3d-cap-square
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 Numberinner
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 Stringinner
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 ValueExample
bevelline3d-join-bevel
miterline3d-join-miter
roundline3d-join-round
Default Value:"miter"

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 Stringinner
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 Stringinner
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 profileOrientation to all minimizes the twist along the line and ensures that the diameter of the resulting visualization corresponds to width and height. Setting profileOrientation 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:

profileRotation-heading

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

profileRotation-all

Possible values: heading | all

Default Value:"all"
size Number
Deprecated
  • since version 4.12

Sets the width and height of the path in meters. Since this property is deprecated use width or height instead.

type Stringreadonly

For PathSymbol3DLayer, the type is always path.

width Numberinner
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

NameReturn TypeSummaryClass
PathSymbol3DLayer

Creates a deep clone of the symbol layer.

more details
more detailsPathSymbol3DLayer
*

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

more details
more detailsSymbol3DLayer
Object

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

more details
more detailsSymbol3DLayer

Method Details

Creates a deep clone of the symbol layer.

Returns:
TypeDescription
PathSymbol3DLayerA 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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...