LineSymbol

Class: esri/symbols/LineSymbol
Inheritance: LineSymbol Symbol Accessor
Subclasses: SimpleLineSymbol
Since: ArcGIS API for JavaScript 4.0

Line symbols are used to draw Polyline features in a FeatureLayer in a 2D MapView.

The only subclass of LineSymbol is SimpleLineSymbol.

SimpleLineSymbol may also be used to symbolize 2D polyline features in a 3D SceneView. However, it is recommended you use LineSymbol3D instead.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Color

The color of the symbol.

more details
more detailsLineSymbol
String

The name of the class.

more details
more detailsAccessor
String

The symbol type.

more details
more detailsLineSymbol
Number

The width of the symbol in points.

more details
more detailsLineSymbol

Property Details

The color of the symbol. This can be autocast with a named string; hex string; array of rgb or rgba values; an object with r, g, b, and a properties; or a Color object.

Default Value: "black"
Examples:
// CSS color string
symbol.color = "dodgerblue";
// HEX string
symbol.color = "#33cc33";
// array of RGBA values
symbol.color = [51, 204, 51, 0.3];
// object with rgba properties
symbol.color = {
  r: 51,
  g: 51,
  b: 204,
  a: 0.7
};

declaredClassStringreadonly inherited

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

typeString

The symbol type.

Possible values: simple-line

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

Default Value: 0.75
Examples:
// width in points
symbol.width = 4;
// width in pixels
symbol.width = "2px";
// width in points
symbol.width = "4pt";

Method Overview

NameReturn TypeSummaryClass
*

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

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.