Geometry | References | ArcGIS Maps SDK for JavaScript

import Geometry from "@arcgis/core/geometry/Geometry.js";

Inheritance:: Geometry→Accessor

Subclasses:: Polygon, Extent, Mesh, Multipoint, Point, Polyline

Since: ArcGIS Maps SDK for JavaScript 4.0

The base class for geometry objects. This class has no constructor. To construct geometries see Point, Polyline, or Polygon.

See also

Graphic

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`cache` readonly	`Record<string, any>`
`declaredClass` readonly inherited	`string`	Accessor
`extent` readonly	`Extent \| null \| undefined`
`hasM`	`boolean`
`hasZ`	`boolean`
`spatialReference`	`SpatialReference`
`type` readonly	`"point" \| "multipoint" \| "polyline" \| "polygon" \| "extent" \| "mesh"`

cache

readonly Property

Type: Record<string, any>

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.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

extent

readonly Property

Type: Extent | null | undefined

The extent of the geometry. For a point, the extent is null.

hasM

Property

Type: boolean

Indicates if the geometry has M values.

Default value: false

hasZ

Property

Type: 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.

Default value: false

spatialReference

autocast Property

Type: SpatialReference

The spatial reference of the geometry.

Default value: SpatialReference.WGS84 // wkid: 4326

type

readonly Property

Type: "point" | "multipoint" | "polyline" | "polygon" | "extent" | "mesh"

The geometry type.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): Geometry`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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	`any`	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.

clone

Method

Signature: clone (): Geometry

Creates a deep clone of the geometry.

Returns: Geometry
A new instance of a Geometry object equal to the object used to call .clone().

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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.