PointSymbol3D

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

PointSymbol3D is used to render features with Point geometry in a 3D SceneView. This symbol type is not supported in 2D MapViews.

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

Symbol3DLayer Type Flat/Volumetric Size Units Example
IconSymbol3DLayer flat points s3d-icon-circle
ObjectSymbol3DLayer volumetric meters s3d-object
TextSymbol3DLayer flat points s3d-text

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: "point-3d",  // autocasts as new PointSymbol3D()
  symbolLayers: [{
    type: "object",  // autocasts as new ObjectSymbol3DLayer()
    width: 5,    // diameter of the object from east to west in meters
    height: 10,  // height of object in meters
    depth: 15,   // diameter of the object from north to south in meters
    resource: { primitive: "cube" },
    material: { color: "red" }
  }]
};

Constructors

new PointSymbol3D(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
LineCallout3Dmore details

Settings for adding a callout visualization to the symbol.

more detailsPointSymbol3D
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<(IconSymbol3DLayer|ObjectSymbol3DLayer|TextSymbol3DLayer)>more details

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

more detailsPointSymbol3D
Stringmore details

The symbol type.

more detailsPointSymbol3D
Accessormore details

Shifts the symbol along the vertical world axis by a given height.

more detailsPointSymbol3D

Property Details

callout LineCallout3D
Since: ArcGIS API for JavaScript 4.4

Settings for adding a callout visualization to the symbol. Callouts are drawn from the point feature location that is being symbolized, to the vertical offset of the symbol. This property has no effect if verticalOffset is not set. At the moment only callouts of type line are supported. See LineCallout3D.

See also:
Example:
let symbol = {
  type: "point-3d",  // autocasts as new PointSymbol3D()
  symbolLayers: [...],
  verticalOffset: ...,
  callout: {
    type: "line",  // autocasts as new LineCallout3D()
    size: 1.5,
    color: [150, 150, 150],
    border: {
      color: [50, 50, 50]
    }
  }
};
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 PointSymbol3D the type is always "point-3d".

verticalOffset Accessor
Since: ArcGIS API for JavaScript 4.4

Shifts the symbol along the vertical world axis by a given height. The height is set in screen space units like points or pixels. For points displayed with a callout verticalOffset should be set.

Properties:
screenLength Number

The vertical symbol offset in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

minWorldLength Number
optional

The minimum vertical symbol offset in world units. It acts as a lower bound to avoid vertical offset becoming too small.

In the following animation the green symbol on the left has minWorldLength = 20 and for the orange symbol on the right minWorldLength has not been set:

minWorldLength-on

maxWorldLength Number
optional

The maximum vertical symbol offset in world units. It acts as an upper bound to avoid vertical offset becoming too big.

In the following animation the green symbols have maxWorldLength = 50 and orange symbols don't have maxWorldLength set:

maxWorldLength

See also:
Example:
let symbol = {
  type: "point-3d",  // autocasts as new PointSymbol3D()
  symbolLayers: [...],
  verticalOffset: {
    screenLength: 40,
    maxWorldLength: 100,
    minWorldLength: 20
  },
  callout: ...
};

Method Overview

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

Creates a deep clone of the symbol.

more detailsPointSymbol3D
*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(){PointSymbol3D}

Creates a deep clone of the symbol.

Returns:
Type Description
PointSymbol3D 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.