Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: SimpleLineSymbol
[ AMD Module Require | Legacy Module Require ]
dojo.require("esri.symbols.SimpleLineSymbol")
Description
(Added at v1.0)
Line symbols are used to draw linear features on the graphics layer. SimpleLineSymbol is either a solid line or a predefined pattern of dashes and dots.
Explore the SimpleLineSymbol in the ArcGIS Symbol Playground. This is a place to explore and learn how to work with various properties and methods before implementing it into custom code. Try out new features, customize them, and copy the generated code into your own application. This sample provides a starting point so as to allow use of these features as quickly as possible.Samples
Search for samples that use this class.Class hierarchy
esri.symbol.Symbol |_esri.symbol.LineSymbol |_esri.symbol.SimpleLineSymbol
Subclasses
Constructors
| Name | Summary |
|---|---|
| new esri.symbol.SimpleLineSymbol() | Creates a new empty SimpleLineSymbol object. |
| new esri.symbol.SimpleLineSymbol(style, color, width) | Creates a new SimpleLineSymbol object with parameters. |
| new esri.symbol.SimpleLineSymbol(json) | Creates a new SimpleLineSymbol object using a JSON object. |
Constants
| Name | Description |
|---|---|
STYLE_DASH | The line is made of dashes. |
STYLE_DASHDOT | The line is made of a dash-dot pattern. |
STYLE_DASHDOTDOT | The line is made of a dash-dot-dot pattern. |
STYLE_DOT | The line is made of dots. |
STYLE_LONGDASH | Line is constructed of a series of dashes. |
STYLE_LONGDASHDOT | Line is constructed of a series of short dashes. |
STYLE_NULL | The line has no symbol. |
STYLE_SHORTDASH | Line is constructed of a series of short dashes. |
STYLE_SHORTDASHDOT | Line is constructed of a dash followed by a dot. |
STYLE_SHORTDASHDOTDOT | Line is constructed of a series of a dash and two dots. |
STYLE_SHORTDOT | Line is constructed of a series of short dots. |
STYLE_SOLID | The line is solid. |
Properties
| Name | Type | Summary |
|---|---|---|
| color | Color | Symbol color. |
| marker | Object | Indicates marker symbols present at the beginning and/or end of a SimpleLineSymbol. |
| style | String | The line style. |
| type | String | The type of symbol. |
| width | Number | Width of line symbol in pixels. |
Methods
| Name | Return type | Summary |
|---|---|---|
| setColor(color) | Symbol | Sets the symbol color. |
| setMarker(options) | None | Sets marker symbols at the beginning and/or end of a SimpleLineSymbol. |
| setStyle(style) | SimpleLineSymbol | Sets the line symbol style. |
| setWidth(width) | LineSymbol | Sets the LineSymbol width. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Constructor Details
Creates a new empty SimpleLineSymbol object.
Sample:
var sls = new esri.symbol.SimpleLineSymbol();
Creates a new SimpleLineSymbol object with parameters.
Parameters:
< |
Required | See Constants table for values. |
< |
Required | Symbol color. |
< |
Required | Width of the line in pixels. |
Sample:
var sls = new esri.symbol.SimpleLineSymbol(esri.symbol.SimpleLineSymbol.STYLE_DASH, new esri.Color([255,0,0]), 3);
Creates a new SimpleLineSymbol object using a JSON object.
Parameters:
< |
Required | JSON object representing the SimpleLineSymbol. View the Symbol Objects (Common data types in ArcGIS) for details on creating a JSON symbol. Note that when specifying symbol width and height using JSON the values should be entered in points, the JavaScript API then converts the point values to pixels. |
Property Details
<Color
ColorSymbol color.
<Object
ObjectIndicates marker symbols present at the beginning and/or end of a SimpleLineSymbol. See the object specification table in the setMarker() method for details of the properties of this object. (Added at v3.23)
<String
StringThe type of symbol.
Known values:
simplemarkersymbol | picturemarkersymbol | simplelinesymbol | cartographiclinesymbol | simplefillsymbol | picturefillsymbol | textsymbolMethod Details
Sets the symbol color.
Return type:
SymbolParameters:
< |
Required | Symbol color. |
Sample:
symbol.setColor(new esri.Color([255,255,0,0.5]));
Sets marker symbols at the beginning and/or end of a SimpleLineSymbol. (Added at v3.23)
Parameters:
< |
Required | The options defining the marker style and placement. See the object specification table below. |
Object Specifications:
<
options>< |
Required | Indicates where the marker is placed on the line symbol. Valid values are begin, end, and begin-end. |
< |
Required | Indicates the style of the marker to place on the line symbol. As of version 3.23, the only supported style is arrow. |
Sets the line symbol style.
Return type:
SimpleLineSymbolParameters:
< |
Required | Line style. See the Constants table for valid values. |
Sets the LineSymbol width.
Return type:
LineSymbolParameters:
< |
Required | Width of line symbol in pixels. |
Sample:
var outline = new esri.symbol.SimpleLineSymbol().setWidth(1);