require(["esri/symbols/LineStyleMarker3D"], (LineStyleMarker3D) => { /* code goes here */ });
import LineStyleMarker3D from "@arcgis/core/symbols/LineStyleMarker3D.js";
esri/symbols/LineStyleMarker3D
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.
- See also
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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Exampleconst marker = new LineStyleMarker3D({ color: new Color("red"), placement: "begin-end", style: "cross" })
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The color of the marker. | LineStyleMarker3D | ||
The name of the class. | Accessor | ||
Indicates where the marker is placed. | LineStyleMarker3D | ||
Style of the marker. | LineStyleMarker3D | ||
The type of marker applied to a line. | LineStyleMarker3D |
Property Details
-
The color of the marker. If not specified, the marker will match the color of the line.
- Default Value:null
-
placement
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
style String
-
Style of the marker. 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
type Stringreadonly
-
The type of marker applied to a line.
For LineStyleMarker3D the type is always "style".
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
this | Creates a deep clone of this object. | LineStyleMarker3D | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
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.
-
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.
ReturnsType Description this A deep clone of the class instance that invoked this method.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 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");