ESM: import SimpleLineSymbol from "@arcgis/core/symbols/SimpleLineSymbol.js";
CDN: const SimpleLineSymbol = await $arcgis.import("@arcgis/core/symbols/SimpleLineSymbol.js");
Class: @arcgis/core/symbols/SimpleLineSymbol
Since: ArcGIS Maps SDK for JavaScript 4.0
Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.Show inherited properties Hide inherited properties
Property DetailsSpecifies 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.
Known Limitations
Possible Values:"butt" |"round" |"square"
Example
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.
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
};Inherited
Property declaredClass Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.
The name of the class. The declared class name is formatted as esri.folder.className.
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 Values:"miter" |"round" |"bevel"
Example
Since: ArcGIS Maps SDK for JavaScript 4.16 SimpleLineSymbol since 4.0, marker added at 4.16.
Specifies the color, style, and placement of a symbol marker on the line.
Known Limitations
Example
// Places a blue diamond marker at the beginning of the line symbol
simpleLineSymbol.marker = {
color: "blue",
placement: "begin",
style: "diamond"
} miterLimit Number
Maximum allowed ratio of the width of a miter join to the line width. Miter joins can get very wide at sharp line angles; this can be visually unpleasant or interfere with cartography. In the example below, the width of the miter join is about 3.6 times the width of the line.
A miter limit of X means that a miter join can be at most X times as wide as the line itself. Beyond that threshold, it is replaced with a bevel join. Referring to the previous example, setting the miter limit to 3.6 or greater has no effect on the generated visuals; setting the miter limit to 3.5 or smaller causes the replacement with a bevel join.
Known Limitations
This property is currently not supported in 3D SceneViews.
Example
// Miter joins that would be twice as wide as the line itself are
// replaced by bevel joins.
symbol.miterLimit = 2;Specifies the line style. Possible values are listed in the table below:
Possible Values:"dash" |"dash-dot" |"dot" |"long-dash" |"long-dash-dot" |"long-dash-dot-dot" |"none" |"short-dash" |"short-dash-dot" |"short-dash-dot-dot" |"short-dot" |"solid"
Example
symbol.style = "short-dash-dot";The width of the symbol in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).
Examples
// width in points
symbol.width = 4;// width in pixels
symbol.width = "2px";// width in points
symbol.width = "4pt";Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles
const handle = reactiveUtils.when(
() => !view.updating,
() => {
wkidSelect.disabled = false;
},
{ once: true }
);
this.addHandles(handle);
// Destroy the object
this.destroy();
Parameters
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
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
let symLyr = graphic.symbol.clone();Inherited
Method fromJSON(json){* |null |undefined}static
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. 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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
obj.removeHandles("watch-view-updates");
}Inherited
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA group key or an array or collection of group keys to remove.
Example
obj.removeHandles(); // removes handles from default group
obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4