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

LineSymbol3D is used to render features with Polyline geometry in a 3D SceneView. This symbol type is not supported in 2D MapViews.

A LineSymbol3D must include at least one symbol layer for it to render in the view. One or more of the following symbol layer types must be used to define a 3D line symbol:

Symbol3DLayer TypeFlat/VolumetricSize UnitsExample
LineSymbol3DLayerflatpointss3d-line
PathSymbol3DLayervolumetricmeterss3d-path
TextSymbol3DLayerflatpointss3d-text

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

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:
var symbol = {
  type: "line-3d",  // autocasts as new LineSymbol3D()
  symbolLayers: [{
    type: "path",  // autocasts as new PathSymbol3DLayer()
    size: 500,    // width of the tube in meters
    material: { color: [ 128,128,128 ] }
  }]
};

Constructors

new LineSymbol3D(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

The name of the class.

more details
more detailsAccessor
Object

The origin of the style from which the symbol was originally referenced.

more details
more detailsSymbol3D
Collection<Symbol3DLayer>

A Collection of Symbol3DLayer objects used to visualize the graphic or feature.

more details
more detailsSymbol3D
String

For LineSymbol3D the type is always line-3d.

more details
more detailsLineSymbol3D

Property Details

declaredClassStringreadonly inherited

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

styleOriginObjectreadonly inherited

The origin of the style from which the symbol was originally referenced. A reference to the style origin can be either by styleName or by styleUrl (but not both). This information is part of the WebScene persistence model and may be used to understand where a symbol was originally sourced from. It does not affect actual appearance or rendering of the symbol.

Properties:
styleName String
optional

a well-known esri-provided style, such as EsriThematicShapesStyle

styleUrl String
optional

url to a style definition

name String

name of the symbol in the style referenced by styleName or styleUrl

A Collection of Symbol3DLayer objects used to visualize the graphic or feature. Individual symbol layers may be autocast as objects and specified using the type property.

typeString

For LineSymbol3D the type is always line-3d.

Method Overview

NameReturn TypeSummaryClass
LineSymbol3D

Creates a deep clone of the symbol.

more details
more detailsLineSymbol3D
*

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 detailsSymbol
Object

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

more details
more detailsSymbol

Method Details

clone(){LineSymbol3D}

Creates a deep clone of the symbol.

Returns:
TypeDescription
LineSymbol3DA deep clone of the object that invoked this method.
Example:
// Creates a deep clone of the graphic's symbol
var symLyr = graphic.symbol.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

There were no match results from your search criteria.