Renders lines with predefined style patterns.
- See also:
const symbol = {
type: "line-3d", // autocasts as new LineSymbol3D()
symbolLayers: [{
type: "line", // autocasts as new LineSymbol3DLayer()
material: { color: "red" },
pattern: { // autocasts as new LineStylePattern3D()
type: "style",
style: "dash"
}
}]
};
Constructors
-
new LineStylePattern3D(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | more details The name of the class. | more details | Accessor | |
String | more details The pattern style. | more details | LineStylePattern3D | |
String | more details The pattern type. | more details | LineStylePattern3D |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
style String
-
The pattern style. Note that the pattern segments' appearance depends on which
cap
style is applied to a LineSymbol3DLayer or whichpatternCap
to a FillSymbol3DLayer outline.Possible values are listed in the table below:
Value Description dash dash-dot dot long-dash long-dash-dot long-dash-dot-dot none The line has no symbol. short-dash short-dash-dot short-dash-dot-dot short-dot solid Possible Values:"dash"|"dash-dot"|"dot"|"long-dash"|"long-dash-dot"|"long-dash-dot-dot"|"none"|"short-dash"|"short-dash-dot"|"short-dash-dot-dot"|"short-dot"|"solid"
- Default Value:solid
-
type Stringreadonly
-
The pattern type.
For LineStylePattern3D the type is always "style".
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
LineStylePattern3D | more details Creates a deep clone of the pattern. | more details | LineStylePattern3D | |
* | more details Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | more details | LineStylePattern3D | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | LineStylePattern3D |
Method Details
-
clone(){LineStylePattern3D}
-
Creates a deep clone of the pattern.
Returns:Type Description LineStylePattern3D A deep clone of the object that invoked this method.
-
fromJSON(json){*}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.Parameter:json ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
Returns:Type Description * Returns a new instance of this class.
-
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.
-
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.