LineSymbol3DLayer | API Reference | ArcGIS Maps SDK for JavaScript 4.31

LineSymbol3DLayer renders Polyline geometries using a flat 2D line with a LineSymbol3D in a 3D SceneView. MapView does not support 3D symbols.

The color of the line is set in the material property. The width of the line may be defined in either points or pixels with the size property. Line width and color can also be data-driven by adding size and/or color visual variables to any Renderer that uses this symbol layer.

A LineSymbol3DLayer must be added to the symbolLayers property of a LineSymbol3D. It may also be added to PolygonSymbol3D symbols to create outlines of polygon features. Multiple symbol layers may be used in a single symbol. The image below depicts a line FeatureLayer whose features are symbolized with a LineSymbol3D containing a LineSymbol3DLayer.

symbols-3d-lines

See Symbol3DLayer and Symbol3D to read more general information about 3D symbols, symbol layers and how they relate to one another.

See also

Example

const symbol = {
  type: "line-3d",  // autocasts as new LineSymbol3D()
  symbolLayers: [{
    type: "line",  // autocasts as new LineSymbol3DLayer()
    size: 2,  // points
    material: { color: "black" },
    cap: "round",
    join: "round",
    pattern: {  // autocasts as new LineStylePattern3D()
      type: "style",
      style: "dash"
    },
    marker: {  // autocasts as new LineStyleMarker3D()
      type: "style",
      style: "arrow",
      placement: "end",
      color: "red"  // black line with red arrows
    }
  }]
};

Constructors

LineSymbol3DLayer Constructor new LineSymbol3DLayer(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	The style used to draw the endpoint of a line.	LineSymbol3DLayer
String	The name of the class.	Accessor
String	The style used to draw the intersection of two line segments within a line geometry.	LineSymbol3DLayer
LineStyleMarker3D	Optional markers to be placed at the start and/or end of each line geometry.	LineSymbol3DLayer
Object	The material used to shade the line.	LineSymbol3DLayer
LineStylePattern3D	The pattern used to render the line stroke.	LineSymbol3DLayer
Number	The width of the line in points.	LineSymbol3DLayer
String	The symbol type.	LineSymbol3DLayer

Property Details

cap Property cap String Since: ArcGIS Maps SDK for JavaScript 4.12 LineSymbol3DLayer since 4.0, cap added at 4.12.

The style used to draw the endpoint of a line. This also applies to the tips of each pattern segment along the line. See the table below for possible values.

Possible Value	Example
butt
round
square

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

Default Value:"butt"

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.

join Property join String Since: ArcGIS Maps SDK for JavaScript 4.12 LineSymbol3DLayer since 4.0, join added at 4.12.

The style used to draw the intersection of two line segments within a line geometry. See the table below for possible values.

Possible Value	Example
bevel
miter
round

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

Default Value:"miter"

marker Property marker LineStyleMarker3D Since: ArcGIS Maps SDK for JavaScript 4.23 LineSymbol3DLayer since 4.0, marker added at 4.23.

Optional markers to be placed at the start and/or end of each line geometry.

By default, no markers are placed. If markers are added, marker size is proportional to the width of the line. While markers inherit the line's color by default, you can use the color attribute to set a different one.

Example

const symbol = {
  type: "line-3d",  // autocasts as new LineSymbol3D()
  symbolLayers: [{
    type: "line",  // autocasts as new LineSymbol3DLayer()
    material: { color: "black" },
    marker: {  // autocasts as new LineStyleMarker3D()
      type: "style",
      style: "arrow",
      placement: "end",
      color: "red"  // black line with red arrows
    }
  }]
};

material Property material Objectautocast

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

Property: color Color|null|undefined

optional
Autocasts from Object|Number []|String

The color of the line. 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
  }
};

pattern Property pattern LineStylePattern3D Since: ArcGIS Maps SDK for JavaScript 4.22 LineSymbol3DLayer since 4.0, pattern added at 4.22.

The pattern used to render the line stroke. By default, the lines are shown as solid.

Example

const symbol = {
  type: "line-3d",  // autocasts as new LineSymbol3D()
  symbolLayers: [{
    type: "line",  // autocasts as new LineSymbol3DLayer()
    size: 2,  // points
    material: { color: "black" },
    pattern: {  // autocasts as new LineStylePattern3D()
      type: "style",
      style: "dash"
    }
  }]
};

size Property size Numberautocast Autocasts from Number|String

The width of the line in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Default Value:"1px"

Examples

// width in points
symbolLayer.size = 4;

// width in pixels
symbolLayer.size = "2px";

// width in points
symbolLayer.size = "4pt";

type Property type Stringreadonly

The symbol type.

For LineSymbol3DLayer the type is always "line".

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
LineSymbol3DLayer	Creates a deep clone of the symbol layer.	LineSymbol3DLayer
*	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(){LineSymbol3DLayer}

Creates a deep clone of the symbol layer.

Returns

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