require(["esri/geometry/Geometry"], (Geometry) => { /* code goes here */ });
import Geometry from "@arcgis/core/geometry/Geometry.js";
esri/geometry/Geometry
The base class for geometry objects. This class has no constructor. To construct geometries see Point, Polyline, or Polygon.
- See also
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Object | The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation. more details | Geometry | |
String | The name of the class. more details | Accessor | |
Extent | The extent of the geometry. more details | Geometry | |
Boolean | Indicates if the geometry has M values. more details | Geometry | |
Boolean | Indicates if the geometry has z-values (elevation). more details | Geometry | |
SpatialReference | The spatial reference of the geometry. more details | Geometry | |
String | The geometry type. more details | Geometry |
Property Details
-
cache Objectreadonly
-
The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation. An example is the extent of a polygon.
-
Since: ArcGIS Maps SDK for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
extent Extentreadonly
-
The extent of the geometry. For a point, the extent is null.
-
hasM Boolean
-
Indicates if the geometry has M values.
-
hasZ Boolean
-
Indicates if the geometry has z-values (elevation).
Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.
-
spatialReference SpatialReferenceautocast
-
The spatial reference of the geometry.
- Default Value:WGS84 (wkid: 4326)
-
type Stringreadonly
-
The geometry type.
Possible Values:"point"|"multipoint"|"polyline"|"polygon"|"extent"|"mesh"
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Geometry | Creates a deep clone of the geometry. more details | Geometry | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | Geometry | |
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 | Geometry |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]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.
-
clone(){Geometry}
-
Creates a deep clone of the geometry.
ReturnsType Description Geometry A new instance of a Geometry object equal to the object used to call .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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.