LineSymbolMarker | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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

Example

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

LineSymbolMarker Constructor new LineSymbolMarker(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Example

const lineSymbolMarker = new LineSymbolMarker({
  color: "blue",
  placement: "begin-end",
  style: "arrow"
});

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Color	The color of the marker.	LineSymbolMarker
String	The name of the class.	Accessor
String	The placement of the marker(s) on the line.	LineSymbolMarker
String	The marker style.	LineSymbolMarker
String	The symbol type.	LineSymbolMarker

Property Details

color Property color Colorautocast Autocasts from Object|Number []|String

The color of the marker. If not specified, the marker will match the color of the line.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

placement Property 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 Property style String

The marker style. Possible values are listed in the table below.

Value	Example
arrow
circle
square
diamond
cross
x

Default Value:"arrow"

type Property type Stringreadonly

The symbol type.

For LineSymbolMarker the type is always "line-marker".

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor 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

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key 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.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor 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 *

optional

A group key.

Returns

Type	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 Inherited Method removeHandles(groupKey) Inherited from Accessor 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 *

optional

A 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");