ESM: import LineSymbol3DLayer from "@arcgis/core/symbols/LineSymbol3DLayer.js";
CDN: const LineSymbol3DLayer = await $arcgis.import("@arcgis/core/symbols/LineSymbol3DLayer.js");
Class: @arcgis/core/symbols/LineSymbol3DLayer
Since: ArcGIS Maps SDK for JavaScript 4.0
LineSymbol3DLayer renders Polyline geometries using a flat 2D line with a LineSymbol3D in a 3D SceneView. MapView does not support 3D symbols.
The color of the line is set in the material property. The width of the line may be defined in either points or pixels with the size property. Line width and color can also be data-driven by adding size and/or color visual variables to any Renderer that uses this symbol layer.
A LineSymbol3DLayer must be added to the symbolLayers property of a LineSymbol3D. Multiple symbol layers may be used in a single symbol. The image below depicts a line FeatureLayer whose features are symbolized with a LineSymbol3D containing a LineSymbol3DLayer.
See Symbol3DLayer and Symbol3D to read more general information about 3D symbols, symbol layers and how they relate to one another.
Example
const symbol = {
type: "line-3d", // autocasts as new LineSymbol3D()
symbolLayers: [{
type: "line", // autocasts as new LineSymbol3DLayer()
size: 2, // points
material: { color: "black" },
cap: "round",
join: "round",
pattern: { // autocasts as new LineStylePattern3D()
type: "style",
style: "dash"
},
marker: { // autocasts as new LineStyleMarker3D()
type: "style",
style: "arrow",
placement: "end",
color: "red" // black line with red arrows
}
}]
}; new LineSymbol3DLayer(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsSince: ArcGIS Maps SDK for JavaScript 4.12 LineSymbol3DLayer since 4.0, cap added at 4.12.
The style used to draw the endpoint of a line. This also applies to the tips of each pattern segment along the line. See the table below for possible values.
Possible Values:"butt" |"round" |"square"
Inherited
Property declaredClass Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.
The name of the class. The declared class name is formatted as esri.folder.className.
Since: ArcGIS Maps SDK for JavaScript 4.12 LineSymbol3DLayer since 4.0, join added at 4.12.
The style used to draw the intersection of two line segments within a line geometry. See the table below for possible values.
Possible Values:"miter" |"round" |"bevel"
Since: ArcGIS Maps SDK for JavaScript 4.23 LineSymbol3DLayer since 4.0, marker added at 4.23.
Optional markers to be placed at the start and/or end of each line geometry.
By default, no markers are placed. If markers are added, marker size is proportional to the width of the line. While markers inherit the line's color by default, you can use the color attribute to set a different one.
Example
const symbol = {
type: "line-3d", // autocasts as new LineSymbol3D()
symbolLayers: [{
type: "line", // autocasts as new LineSymbol3DLayer()
material: { color: "black" },
marker: { // autocasts as new LineStyleMarker3D()
type: "style",
style: "arrow",
placement: "end",
color: "red" // black line with red arrows
}
}]
};The material used to shade the line. This property defines the line's color.
The color of the line. This can be autocast with an array of rgb(a) values, named string, hex string or an hsl(a) string, an object with r, g, b, and a properties, or a Color object.
Examples
// CSS color string
symbolLayer.material = {
color: "dodgerblue"
};// HEX string
symbolLayer.material = {
color: "#33cc33";
}// array of RGBA values
symbolLayer.material = {
color: [51, 204, 51, 0.3];
}// object with rgba properties
symbolLayer.material = {
color: {
r: 51,
g: 51,
b: 204,
a: 0.7
}
};Since: ArcGIS Maps SDK for JavaScript 4.22 LineSymbol3DLayer since 4.0, pattern added at 4.22.
The pattern used to render the line stroke. By default, the lines are shown as solid.
Example
const symbol = {
type: "line-3d", // autocasts as new LineSymbol3D()
symbolLayers: [{
type: "line", // autocasts as new LineSymbol3DLayer()
size: 2, // points
material: { color: "black" },
pattern: { // autocasts as new LineStylePattern3D()
type: "style",
style: "dash"
}
}]
};The width of the line in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).
Examples
// width in points
symbolLayer.size = 4;// width in pixels
symbolLayer.size = "2px";// width in points
symbolLayer.size = "4pt";Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
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 the symbol layer.
Returns
Type Description LineSymbol3DLayer A deep clone of the object that invoked this method.Example
// Creates a deep clone of the graphic's first symbol layer
let symLyr = graphic.symbol.symbolLayers.at(0).clone();Inherited
Method fromJSON(json){* |null |undefined}static
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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
Method removeHandles(groupKey)
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 *
optionalA 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");RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4