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: CartographicLineSymbol
[ AMD Module Require | Legacy Module Require ]
require(["esri/symbols/CartographicLineSymbol"], function(CartographicLineSymbol) { /* code goes here */ });
Description
(Added at v1.0)
Line symbols are used to draw linear features on the graphics layer. CartographicLineSymbol, like SimpleLineSymbol, is either a solid line or a predefined pattern of dashes and dots. Line joins and line caps can be added to further define the line symbol.
Explore the CartographicLineSymbol 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/symbols/Symbol |_esri/symbols/LineSymbol |_esri/symbols/SimpleLineSymbol |_esri/symbols/CartographicLineSymbol
Constructors
| Name | Summary |
|---|---|
| new CartographicLineSymbol() | Creates a new empty CartographicLineSymbol object. |
| new CartographicLineSymbol(style?, color?, width?, cap?, join?, miterLimit?) | Creates a new CartographicLineSymbol object with parameters. |
| new CartographicLineSymbol(json) | Creates a new CartographicLineSymbol object using a JSON object. |
Constants
| Name | Description |
|---|---|
CAP_BUTT | Line ends square at the end point. |
CAP_ROUND | Line is rounded just beyond the end point. |
CAP_SQUARE | Line is squared just beyond the end point. |
JOIN_BEVEL | The joined lines are beveled. |
JOIN_MITER | The joined lines are not rounded or beveled. |
JOIN_ROUND | The joined lines are rounded. |
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 | The line is made of a long dash pattern. |
STYLE_LONGDASHDOT | The line is made of a long dash-dot pattern. |
STYLE_NULL | The line has no symbol. |
STYLE_SHORTDASH | The line is made of a short dash pattern. |
STYLE_SHORTDASHDOT | The line is made of a short dash-dot pattern. |
STYLE_SHORTDASHDOTDOT | The line is made of a short dash-dot-dot pattern. |
STYLE_SHORTDOT | The line is made of a short dot pattern. |
STYLE_SOLID | The line is solid. |
Properties
| Name | Type | Summary |
|---|---|---|
| cap | String | The cap style. |
| color | Color | Symbol color. |
| join | String | The join style. |
| marker | Object | Indicates marker symbols present at the beginning and/or end of a SimpleLineSymbol. |
| miterLimit | String | Size threshold for showing mitered line joins. |
| style | String | The line style. |
| type | String | The type of symbol. |
| width | Number | Width of line symbol in pixels. |
Methods
| Name | Return type | Summary |
|---|---|---|
| setCap(cap) | CartographicLineSymbol | Sets the cap style. |
| setColor(color) | Symbol | Sets the symbol color. |
| setJoin(join) | CartographicLineSymbol | Sets the join style. |
| setMarker(options) | None | Sets marker symbols at the beginning and/or end of a SimpleLineSymbol. |
| setMiterLimit(miterLimit) | CartographicLineSymbol | Sets the size threshold for showing mitered line joins. |
| 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 CartographicLineSymbol object.
Sample:
require([
"esri/symbols/CartographicLineSymbol", ...
], function(CartographicLineSymbol, ... ) {
var cls = new CartographicLineSymbol();
...
});
Creates a new CartographicLineSymbol object with parameters.
Parameters:
< |
Optional | See Constants table for values. |
< |
Optional | Symbol color. |
< |
Optional | Width of the line in pixels. |
< |
Optional | See Constants table for values. |
< |
Optional | See Constants table for values. |
< |
Optional | Size threshold for showing mitered line joins. |
Sample:
require([
"esri/symbols/CartographicLineSymbol", "esri/Color", ...
], function(CartographicLineSymbol, Color, ... ) {
var cls = new CartographicLineSymbol(CartographicLineSymbol.STYLE_SOLID, new Color([255,0,0]), 10, CartographicLineSymbol.CAP_ROUND, CartographicLineSymbol.JOIN_MITER, 5);
...
});
Creates a new CartographicLineSymbol object using a JSON object.
Parameters:
< |
Required | JSON object representing the CartographicLineSymbol. 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
<String
StringThe cap style. See the Constants table for valid values and explanations.
Known values:
CAP_BUTT|CAP_ROUND|CAP_SQUAREDefault value:
CAP_BUTT<Color
ColorSymbol color.
<String
StringThe join style. See the Constants table for valid values and explanations.
Known values:
JOIN_BEVEL|JOIN_MITER|JOIN_ROUNDDefault value:
JOIN_MITER<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 cap style.
Return type:
CartographicLineSymbolParameters:
< |
Required | Cap style. See the Constants table for valid values. |
Sets the symbol color.
Return type:
SymbolParameters:
< |
Required | Symbol color. |
Sample:
require([
"esri/Color", ...
], function(Color, ... ) {
symbol.setColor(new Color([255,255,0,0.5]));
...
});
Sets the join style.
Return type:
CartographicLineSymbolParameters:
< |
Required | Join style. See the Constants table for valid values. |
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. |
Sample:
lineSymbol.setMarker({
style: "arrow",
placement: "end"
});
Sets the size threshold for showing mitered line joins.
Return type:
CartographicLineSymbolParameters:
< |
Required | Miter limit. |
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:
require([
"esri/symbols/SimpleLineSymbol", ...
], function(SimpleLineSymbol, ... ) {
var outline = new SimpleLineSymbol().setWidth(1);
...
});