ESM: import PointSymbol3D from "@arcgis/core/symbols/PointSymbol3D.js";
CDN: const PointSymbol3D = await $arcgis.import("@arcgis/core/symbols/PointSymbol3D.js");
Class: @arcgis/core/symbols/PointSymbol3D
Since: ArcGIS Maps SDK 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:
See Symbol3DLayer and Symbol3D to read more general information about 3D symbols, symbol layers and how they relate to one another.
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" }
}]
}; new PointSymbol3D(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsSince: ArcGIS Maps SDK for JavaScript 4.4 PointSymbol3D since 4.0, callout added at 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.
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]
}
}
};Inherited
Property declaredClass Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.
The name of the class. The declared class name is formatted as esri.folder.className.
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.
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".
Since: ArcGIS Maps SDK for JavaScript 4.4 PointSymbol3D since 4.0, verticalOffset added at 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.
Example
let symbol = {
type: "point-3d", // autocasts as new PointSymbol3D()
symbolLayers: [...],
verticalOffset: {
screenLength: 40,
maxWorldLength: 100,
minWorldLength: 20
},
callout: ...
};Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey 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.
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();Inherited
Method fromJSON(json){* |null |undefined}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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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");
}Inherited
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA 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");RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4