PathSymbol3DLayer | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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.

See also

Example

// create a PathSymbol3DLayer with a strip style
let 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
let 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

PathSymbol3DLayer Constructor 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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	Defines offset of the path cross section relative to the Polyline geometry.	PathSymbol3DLayer
String	Controls the shape at the start and end point of the path.	PathSymbol3DLayer
Boolean	Indicates whether the symbol layer geometry casts shadows in the scene.	PathSymbol3DLayer
String	The name of the class.	Accessor
Number	The vertical dimension of the cross-section of the path in meters.	PathSymbol3DLayer
String	Controls the shape of the connection between two segments of the path.	PathSymbol3DLayer
Object	The material used to shade the path.	PathSymbol3DLayer
String	Cross-section profile of the path geometry.	PathSymbol3DLayer
String	Defines how the profile is rotated as it is extruded along the Polyline geometry.	PathSymbol3DLayer
String	The symbol type.	PathSymbol3DLayer
Number	The horizontal dimension of the cross-section of the path in meters.	PathSymbol3DLayer

Property Details

anchor Property anchor String Since: ArcGIS Maps SDK for JavaScript 4.12 PathSymbol3DLayer since 4.0, anchor added at 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 Property cap String Since: ArcGIS Maps SDK for JavaScript 4.12 PathSymbol3DLayer since 4.0, cap added at 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 Property castShadows Boolean Since: ArcGIS Maps SDK for JavaScript 4.11 PathSymbol3DLayer 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.

height Property height Number Since: ArcGIS Maps SDK for JavaScript 4.12 PathSymbol3DLayer since 4.0, height added at 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
let 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
let 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 Property join String Since: ArcGIS Maps SDK for JavaScript 4.12 PathSymbol3DLayer since 4.0, join added at 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 Property material Objectautocast

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

Property: color Color|null|undefined

optional
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 Property profile String Since: ArcGIS Maps SDK for JavaScript 4.12 PathSymbol3DLayer since 4.0, profile added at 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 Property profileRotation String Since: ArcGIS Maps SDK for JavaScript 4.12 PathSymbol3DLayer since 4.0, profileRotation added at 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:

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"

type Property type Stringreadonly

The symbol type.

For PathSymbol3DLayer the type is always "path".

width Property width Number Since: ArcGIS Maps SDK for JavaScript 4.12 PathSymbol3DLayer since 4.0, width added at 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
let 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
let 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

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
PathSymbol3DLayer	Creates a deep clone of the symbol layer.	PathSymbol3DLayer
*	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(){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
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.