LineSymbol3DLayer

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

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"
  }]
});

Constructors

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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The style used to draw the endpoint of a line.

more details
more detailsLineSymbol3DLayer
String

The name of the class.

more details
more detailsAccessor
String

The style used to draw the intersection of two line segments within a line geometry.

more details
more detailsLineSymbol3DLayer
Object

The material used to shade the line.

more details
more detailsLineSymbol3DLayer
Number

The width of the line in points.

more details
more detailsLineSymbol3DLayer
String

The symbol type.

more details
more detailsLineSymbol3DLayer

Property Details

cap String
Since: ArcGIS API for JavaScript 4.12

The style used to draw the endpoint of a line. See the table below for possible values.

Possible Value Example
butt sls-cap-butt
round sls-cap-round
square sls-cap-square

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

Default Value:butt
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.

join String
Since: ArcGIS API for JavaScript 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 sls-join-bevel
miter sls-join-miter
round sls-join-round

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

Default Value:miter
material Objectautocast

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

Property:
color Color
optional
Default Value:white
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
  }
};
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 Stringreadonly

The symbol type.

For LineSymbol3DLayer the type is always "line".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
LineSymbol3DLayer

Creates a deep clone of the symbol layer.

more details
more detailsLineSymbol3DLayer
*

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:
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
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() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.