import Symbol3D from "@arcgis/core/symbols/Symbol3D.js";const Symbol3D = await $arcgis.import("@arcgis/core/symbols/Symbol3D.js");- Subclasses:
- LabelSymbol3D, LineSymbol3D, MeshSymbol3D, PointSymbol3D, PolygonSymbol3D
- Since
- ArcGIS Maps SDK for JavaScript 4.0
Symbol3D is the base class for all 3D symbols. It is used to render 2D Point, Polyline, and Polygon features in a FeatureLayer and 3D mesh features in a SceneLayer. All 3D symbols must be used in a SceneView instance; there is no support for 3D rendering in MapViews.
There are five types of 3D symbols. Four of them correspond with a different feature geometry type. The fifth, LabelSymbol3D, may be applied to any geometry type. See the table below to learn about which symbol types are supported for each geometry type.
| Geometry type | Valid symbol types |
|---|---|
| Point | PointSymbol3D, LabelSymbol3D |
| Polyline | LineSymbol3D, LabelSymbol3D |
| Polygon | PolygonSymbol3D, LabelSymbol3D |
| Mesh | MeshSymbol3D, LabelSymbol3D |
All 3D symbols have a symbolLayers property, which is an array of Symbol3DLayers that define the appearance of the symbol. All symbols must have at least one symbol layer added to the symbolLayers property. The Symbol3D object is a container that holds multiple symbol layers that determine the appearance of the symbol. One layer may be an outline, another the fill, etc. The relationship of symbol layers to symbol is similar to the relationship of operational layers to a Map. There are various types of symbol layers that may be used based on the symbol type and geometry of the features. See Symbol3DLayer to learn more about symbol layers.
Properties
| Property | Type | Class |
|---|---|---|
| | ||
declaredClass readonly inherited | ||
StyleOrigin | null | undefined | | |
| | ||
type readonly | "point-3d" | "line-3d" | "polygon-3d" | "mesh-3d" | "label-3d" | |
color
3D symbols do not support colors on the symbol level. Colors may be set on individual symbol layer materials instead. Setting the color property on a 3D symbol will not have any effect. The color property is present for consistency with other symbol types.
Examples
// CSS color stringsymbol.color = "dodgerblue";// HEX stringsymbol.color = "#33cc33";// array of RGBA valuessymbol.color = [51, 204, 51, 0.3];// object with rgba propertiessymbol.color = { r: 51, g: 51, b: 204, a: 0.7}; styleOrigin
- Type
- StyleOrigin | null | undefined
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.
symbolLayers
- Type
- Collection<Symbol3DLayer>
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.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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 | 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.
toJSON
- Signature
-
toJSON (): any
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.