LineStyleMarker3D

AMD: require(["esri/symbols/LineStyleMarker3D"], (LineStyleMarker3D) => { /* code goes here */ });
ESM: import LineStyleMarker3D from "@arcgis/core/symbols/LineStyleMarker3D";
Class: esri/symbols/LineStyleMarker3D
Inheritance: LineStyleMarker3D Accessor
Since: ArcGIS API for JavaScript 4.23

LineStyleMarker3D is used for rendering a simple marker graphic on a LineSymbol3DLayer.

Markers can enhance the cartographic information of a line by providing additional visual cues about the associated feature.

symbols-3d-line-markers

See also
Example
const symbol = {
  type: "line-3d",  // autocasts as new LineSymbol3D()
  symbolLayers: [{
    type: "line",  // autocasts as new LineSymbol3DLayer()
    marker: {  // autocasts as new LineStyleMarker3D()
      type: "style",
      style: "x",
      color: "blue",
      placement: "begin"
    })
  }]
};

Constructors

new LineStyleMarker3D(properties)
Parameter
properties Object
optional

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

Example
const marker = new LineStyleMarker3D({
  color: new Color("red"),
  placement: "begin-end",
  style: "cross"
})

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Color

The color of the marker.

more details
LineStyleMarker3D
String

The name of the class.

more details
Accessor
String

Indicates where the marker is placed.

more details
LineStyleMarker3D
String

Style of the marker.

more details
LineStyleMarker3D
String

The type of marker applied to a line.

more details
LineStyleMarker3D

Property Details

Autocasts from Object|number[]|string

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

Default Value:null
declaredClass Stringreadonly inherited

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

placement String

Indicates where the marker is placed. 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

Style of the marker. Possible values are listed in the table below.

Value Example
arrow lsm-arrow
circle lsm-circle
square lsm-square
diamond lsm-diamond
cross lsm-cross
x lsm-x

Possible Values:"arrow"|"circle"|"square"|"diamond"|"cross"|"x"

Default Value:"arrow"
type Stringreadonly

The type of marker applied to a line.

For LineStyleMarker3D the type is always "style".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
this

Creates a deep clone of this object.

more details
LineStyleMarker3D
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)inherited
Since: ArcGIS API 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

clone(){this}

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns
Type Description
this A deep clone of the class instance that invoked this method.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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(groupKey)inherited
Since: ArcGIS API for JavaScript 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");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.