LineStylePattern3D

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

Renders lines with predefined style patterns.

See also:
Example:
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 Object
optional

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

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
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The pattern style.

more detailsLineStylePattern3D
Stringmore details

The pattern type.

more detailsLineStylePattern3D

Property Details

declaredClass Stringreadonly inherited

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 which patternCap to a FillSymbol3DLayer outline.

Possible values are listed in the table below:

Value Description
dash sls-dash
dash-dot sls-dash-dot
dot sls-dot
long-dash sls-long-dash
long-dash-dot sls-long-dash-dot
long-dash-dot-dot sls-dash-dot-dot
none The line has no symbol.
short-dash sls-short-dash
short-dash-dot sls-short-dash-dot
short-dash-dot-dot sls-short-dash-dot-dot
short-dot sls-short-dot
solid sls-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
LineStylePattern3Dmore details

Creates a deep clone of the pattern.

more detailsLineStylePattern3D
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsLineStylePattern3D
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsLineStylePattern3D

Method Details

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 Object

A 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.
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.

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