LineTemplatePattern3D | References | ArcGIS Maps SDK for JavaScript

import LineTemplatePattern3D from "@arcgis/core/symbols/patterns/LineTemplatePattern3D.js";

const LineTemplatePattern3D = await $arcgis.import("@arcgis/core/symbols/patterns/LineTemplatePattern3D.js");

Inheritance: LineTemplatePattern3D→LinePattern3D→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.2

Renders lines using a custom repeating sequence of dashes and gaps.

See also

LineSymbol3DLayer

Example

const symbol = {
  type: "line-3d", // autocasts as new LineSymbol3D()
  symbolLayers: [{
    type: "line", // autocasts as new LineSymbol3DLayer()
    size: 4,
    material: { color: "red" },
    pattern: {
      type: "template", // autocasts as new LineTemplatePattern3D()
      dashTemplate: [10, 6, 2, 6] // lengths relative to the line width
    }
  }]
};

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	LineTemplatePattern3DProperties

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
dashTemplate	number[]
declaredClass readonly inherited	string	Accessor
type readonly	"template"

dashTemplate

Property

Type: number[]

The custom dash and gap lengths.

Values alternate between visible dash lengths and transparent gap lengths, starting with a dash. Each value is a multiple of the line width. For instance, a value of 1 equals one line width.

In case an odd number of values is provided, the sequence is repeated to form a complete dash-gap cycle. Decimals are supported and negative values are converted to their absolute values.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

type

readonly Property

Type: "template"

The pattern type.

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone inherited	clone(): this	ClonableMixin
toJSON inherited	toJSON(): any	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	any	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: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

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: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.