SketchEdges3D | References | ArcGIS Maps SDK for JavaScript

import SketchEdges3D from "@arcgis/core/symbols/edges/SketchEdges3D.js";

Inheritance:: SketchEdges3D→Edges3D→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

SketchEdges3D is a symbol type that visualizes edges of 3D Object SceneLayers, extruded polygons or mesh geometries with a sketched line. It can be used to emphasize the form of 3D objects and to improve the three-dimensional spatial understanding. A sketched line aims to look like a hand-drawn line. In architecture this is useful for visualizing planned urban projects.

This symbol can only be set on the FillSymbol3DLayer.edges within a MeshSymbol3D or on the ExtrudeSymbol3DLayer.edges on PolygonSymbol3D.

Example

let symbol = {
  type: "mesh-3d", // autocasts as new MeshSymbol3D()
  symbolLayers: [{
    type: "fill", // autocasts as new FillSymbol3DLayer()
    material: {
      color: [244, 247, 134]
    },
    edges: {
      type: "sketch", // autocasts as new SketchEdges3D()
      color: [50, 50, 50, 0.5],
      size: 1.5,
      extensionLength: 2
    }
  }]
};

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`SketchEdges3DProperties`

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
`color` inherited	`Color \| null \| undefined`	Edges3D
`declaredClass` readonly inherited	`string`	Accessor
`extensionLength` inherited	`number`	Edges3D
`size` inherited	`number`	Edges3D
`type` readonly	`"sketch"`

color

autocast inherited Property

Type: Color | null | undefined

Inherited from: Edges3D

The color of the edges. 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.

Default value: "black"

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

extensionLength

autocast inherited Property

Type: number

Inherited from: Edges3D

A size in points by which to extend edges beyond their original end points.

Default value: 0

size

autocast inherited Property

Type: number

Inherited from: Edges3D

The size of the edges in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Default value: 1px

type

readonly Property

Type: "sketch"

The symbol type.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): SketchEdges3D`
`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

Method

Signature: clone (): SketchEdges3D

Creates a deep clone of the object.

Returns: SketchEdges3D
A deep clone of the object 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.