MeshSymbol3D

AMD: require(["esri/symbols/MeshSymbol3D"], (MeshSymbol3D) => { /* code goes here */ });
ESM: import MeshSymbol3D from "@arcgis/core/symbols/MeshSymbol3D.js";
Class: esri/symbols/MeshSymbol3D
Inheritance: MeshSymbol3D Symbol3D Symbol Accessor
Since: ArcGIS Maps SDK 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
String

The name of the class.

more details
Accessor
StyleOrigin

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

more details
Symbol3D
Collection<FillSymbol3DLayer>

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

more details
MeshSymbol3D
String

The symbol type.

more details
MeshSymbol3D

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS Maps SDK for JavaScript 4.7

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

styleOrigin StyleOrigin 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.

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

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
MeshSymbol3D

Creates a deep clone of the symbol.

more details
MeshSymbol3D
*

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

more details
Symbol
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
Symbol

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

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.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

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.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
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.