// this symbol can be used to visualize polyline
// features or the outline of a fill symbol
var symbol = {
  type: "simple-line",  // autocasts as new SimpleLineSymbol()
  color: "lightblue",
  width: "2px",
  style: "short-dot"
};

Property Overview

Property Details

capString

Specifies the cap style. The cap is the end node of a polyline, or the end of a line segment that does not connect with another segment of the same polyline.

See the table below for possible values.

Possible Value	Example
butt
round
square

Known Limitations

• This property is currently not supported in 3D SceneViews.
• This property does not persist when applied to a symbol used in a layer saved to a web map or portal item. See the web map specification for more details about properties that persist when a SimpleLineSymbol is saved to an ArcGIS Online or Portal item.

Default Value:round

Example:

symbol.cap = "square";

colorColorautocast inherited

Autocasts from Object|Number[]|String

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

Since: ArcGIS API for JavaScript 4.7

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

joinString

Specifies the join style. A join refers to the joint of a polyline, or the end of a line segment that connects to another segment of the same polyline. See the table below for possible values.

Possible Value	Example
bevel
miter
round

Known Limitations

This property is currently not supported in 3D SceneViews.

Default Value:round

Example:

symbol.join = "bevel";

miterLimitNumberautocast

Autocasts from Number|String

Size threshold for showing mitered line joins. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Known Limitations

This property is currently not supported in 3D SceneViews.

Default Value:0.75

Examples:

// miterLimit in points
symbol.miterLimit = 4;

// miterLimit in pixels
symbol.miterLimit = "2px";

// miterLimit in points
symbol.miterLimit = "4pt";

styleString

Specifies the line style. Possible values are listed in the table below:

Value	Description
dash
dash-dot
dot
long-dash
long-dash-dot
long-dash-dot-dot
none	The line has no symbol.
short-dash
short-dash-dot
short-dash-dot-dot
short-dot
solid

Known Limitations

This property is currently not supported in 3D SceneViews.

Default Value:solid

Example:

symbol.style = "short-dash-dot";

typeStringreadonly

For SimpleLineSymbol, the type is always simple-line.

widthNumberautocast inherited

Autocasts from Number|String

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

Method Details

clone(){SimpleLineSymbol}

Creates a deep clone of the symbol.

Returns:

Type	Description
SimpleLineSymbol	A 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:

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() topic in the Guide for more information.

Returns:

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