LineSymbolMarker is used for rendering a simple marker graphic on a SimpleLineSymbol. Markers can enhance the cartographic information of a line by providing additional visual cues about the associated feature.
If you are in a 3D SceneView use a LineSymbol3DLayer which has support for LineStyleMarker3D.
- See also
const lineSymbol = new SimpleLineSymbol({
color: "gray",
width: 1.5,
// Define a blue "x" marker at the beginning of the line
marker: { // autocasts from LineSymbolMarker
style: "x",
color: "blue",
placement: "begin"
}
});
Constructors
-
new LineSymbolMarker(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Exampleconst lineSymbolMarker = new LineSymbolMarker({ color: "blue", placement: "begin-end", style: "arrow" });
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Color | The color of the marker. more details | LineSymbolMarker | |
String | The name of the class. more details | Accessor | |
String | The placement of the marker(s) on the line. more details | LineSymbolMarker | |
String | The marker style. more details | LineSymbolMarker | |
String | The symbol type. more details | LineSymbolMarker |
Property Details
-
The color of the marker. If not specified, the marker will match the color of the line.
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
placement String
-
The placement of the marker(s) on the line. Possible values are listed in the table below.
Value Description begin Single marker at the start of the line end Single marker at the end of the line begin-end Two markers, one at the start and one at the end of the line Possible Values:"begin"|"end"|"begin-end"
- Default Value:"begin-end"
-
style String
-
The marker style. Possible values are listed in the table below.
Value Example arrow circle square diamond cross x Possible Values:"arrow"|"circle"|"square"|"diamond"|"cross"|"x"
- Default Value:"arrow"
-
type Stringreadonly
-
The symbol type.
For LineSymbolMarker the type is always "line-marker".
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]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.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
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"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");