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
-
new LineStyleMarker3D(properties)
-
Parameter:properties Objectoptional
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
Name | Type | Summary | Class | |
---|---|---|---|---|
Color | more details The color of the marker. | more details | LineStyleMarker3D | |
String | more details The name of the class. | more details | Accessor | |
String | more details Indicates where the marker is placed. | more details | LineStyleMarker3D | |
String | more details Style of the marker. | more details | LineStyleMarker3D | |
String | more details The type of marker applied to a line. | more details | LineStyleMarker3D |
Property Details
-
The color of the marker. If not specified, the marker will match the color of the line.
- Default Value:null
-
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 circle square diamond cross 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
Name | Return Type | Summary | Class | |
---|---|---|---|---|
this | more details Creates a deep clone of this object. | more details | LineStyleMarker3D | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor |
Method Details
-
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.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));
Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.