SimpleLineSymbol

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

SimpleLineSymbol is used for rendering 2D polyline geometries in a 2D MapView. SimpleLineSymbol is also used for rendering outlines for marker symbols and fill symbols.

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

The image below depicts a FeatureLayer whose graphics are styled with SimpleLineSymbols.

sls-sample

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:
// 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"
};

Constructors

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

Specifies the cap style.

more details
more detailsSimpleLineSymbol
Color

The color of the symbol.

more details
more detailsSymbol
String

The name of the class.

more details
more detailsAccessor
String

Specifies the join style.

more details
more detailsSimpleLineSymbol
Number

Size threshold for showing mitered line joins.

more details
more detailsSimpleLineSymbol
String

Specifies the line style.

more details
more detailsSimpleLineSymbol
String

For SimpleLineSymbol, the type is always simple-line.

more details
more detailsSimpleLineSymbol
Number

The width of the symbol in points.

more details
more detailsLineSymbol

Property Details

cap String

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 ValueExample
buttsls-cap-butt
roundsls-cap-round
squaresls-cap-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";
Autocasts from Object|Number[]|String

The color of the symbol. 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.

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
};
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

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 ValueExample
bevelsls-join-bevel
mitersls-join-miter
roundsls-join-round

Known Limitations

This property is currently not supported in 3D SceneViews.

Default Value:round
Example:
symbol.join = "bevel";
miterLimit Numberautocast
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";
style String

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

ValueDescription
dashsls-dash
dash-dotsls-dash-dot
dotsls-dot
long-dashsls-long-dash
long-dash-dotsls-long-dash-dot
long-dash-dot-dotsls-dash-dot-dot
noneThe line has no symbol.
short-dashsls-short-dash
short-dash-dotsls-short-dash-dot
short-dash-dot-dotsls-short-dash-dot-dot
short-dotsls-short-dot
solidsls-solid

Known Limitations

This property is currently not supported in 3D SceneViews.

Default Value:solid
Example:
symbol.style = "short-dash-dot";
type Stringreadonly

For SimpleLineSymbol, the type is always simple-line.

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

NameReturn TypeSummaryClass
SimpleLineSymbol

Creates a deep clone of the symbol.

more details
more detailsSimpleLineSymbol
*

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

Creates a deep clone of the symbol.

Returns:
TypeDescription
SimpleLineSymbolA 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
Loading...