MeshSymbol3D

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

MeshSymbol3D is used to render 3D mesh features in a SceneLayer in a 3D SceneView. This symbol type is not supported in 2D MapViews.

A MeshSymbol3D must include at least one symbol layer for it to render in the view. One or more of the following symbol layer types may be used to define a 3D line symbol:

Symbol3DLayer Type Flat/Volumetric Size Units Example
FillSymbol3DLayer flat - s3d-fill

The image below depicts a SceneLayer whose graphics are styled with a MeshSymbol3D containing a FillSymbol3DLayer.

3d-mesh

See Symbol3DLayer and Symbol3D to read more general information about 3D symbols, symbol layers and how they relate to one another.

See also:
Example:
let symbol = {
  type: "mesh-3d",  // autocasts as new MeshSymbol3D()
  symbolLayers: [{
    type: "fill",  // autocasts as new FillSymbol3DLayer()
    material: { color: "green" }
  }]
};
sceneLayer.renderer = {
  type: "simple",  // autocasts as new SimpleRenderer()
  symbol: symbol
};

Constructors

new MeshSymbol3D(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
Objectmore details

The origin of the style from which the symbol was originally referenced.

more detailsSymbol3D
Collection<FillSymbol3DLayer>more details

A Collection of Symbol3DLayer objects used to visualize the graphic or feature.

more detailsMeshSymbol3D
Stringmore details

The symbol type.

more detailsMeshSymbol3D

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

styleOrigin Object inherited

The origin of the style from which the symbol was originally referenced. A reference to the style origin can be either by styleName or by styleUrl (but not both). This information is part of the WebScene persistence model and may be used to understand where a symbol was originally sourced from. It does not affect actual appearance or rendering of the symbol.

Properties:
styleName String
optional

a well-known esri-provided style, such as EsriThematicShapesStyle

styleUrl String
optional

url to a style definition

name String

name of the symbol in the style referenced by styleName or styleUrl

Autocasts from Object[]

A Collection of Symbol3DLayer objects used to visualize the graphic or feature. Individual symbol layers may be autocast as objects and specified using the type property.

type Stringreadonly

The symbol type.

For MeshSymbol3D the type is always "mesh-3d".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
MeshSymbol3Dmore details

Creates a deep clone of the symbol.

more detailsMeshSymbol3D
*more details

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

more detailsSymbol
Objectmore details

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

more detailsSymbol

Method Details

clone(){MeshSymbol3D}

Creates a deep clone of the symbol.

Returns:
Type Description
MeshSymbol3D A deep clone of the object that invoked this method.
Example:
// Creates a deep clone of the graphic's symbol
let symLyr = graphic.symbol.clone();
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}inherited

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.