Circle

AMD: require(["esri/geometry/Circle"], (Circle) => { /* code goes here */ });
ESM: import Circle from "@arcgis/core/geometry/Circle.js";
Class: esri/geometry/Circle
Inheritance: Circle Polygon Geometry Accessor
Since: ArcGIS Maps SDK for JavaScript 4.0

A circle is a Polygon created by specifying a center point and a radius. The point can be provided as a Point object or an array of latitude/longitude values.

The SpatialReference of the center will determine the spatial reference of the circle. If you provide an array of longitude/latitude coordinates as the center, the spatial reference will default to WGS84 (wkid 4326). You cannot set the spatialReference property of the circle itself. It must always be set in the center point.

See also
Example
const circleGeometry = new Circle({
  center: [ -113, 36 ],
  geodesic: true,
  numberOfPoints: 100,
  radius: 100,
  radiusUnit: "kilometers"
});

view.graphics.add(new Graphic({
  geometry: circleGeometry,
  symbol: {
    type: "simple-fill",
    style: "none",
    outline: {
      width: 3,
      color: "red"
    }
  }
}));

Constructors

Circle

Constructor
new Circle(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

The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation.

Geometry

The center point of the circle.

Circle

The centroid of the polygon.

Polygon

The name of the class.

Accessor

The extent of the geometry.

Geometry

Applicable when the spatial reference of the center point is either set to Web Mercator (wkid: 3857) or geographic/geodesic (wkid: 4326).

Circle

Indicates if the geometry has M values.

Geometry

Indicates if the geometry has z-values (elevation).

Geometry

Checks to see if polygon rings cross each other and indicates if the polygon is self-intersecting, which means the ring of the polygon crosses itself.

Polygon

This value defines the number of points along the curve of the circle.

Circle

The radius of the circle.

Circle

Unit of the radius.

Circle

An array of rings.

Polygon

The spatial reference of the geometry.

Geometry

The string value representing the type of geometry.

Polygon

Property Details

cache

Inherited
Property
cache Objectreadonly
Inherited from Geometry

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.

center

Property
center Pointautocast
Autocasts from Object|Number[]

The center point of the circle. The center must be specified either as a Point or an array of longitude/latitude coordinates. The spatial reference of the center will determine the spatial reference of the circle. If you provide an array of longitude/latitude coordinates, the spatial reference will default to WGS84 (wkid 4326).

centroid

Inherited
Property
centroid Point
Inherited from Polygon

The centroid of the polygon. For a polygon with multiple rings, it represents the centroid of the largest ring.

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
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.

extent

Inherited
Property
extent Extentreadonly
Inherited from Geometry

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

geodesic

Property
geodesic Boolean

Applicable when the spatial reference of the center point is either set to Web Mercator (wkid: 3857) or geographic/geodesic (wkid: 4326). When either of those spatial references is used, set geodesic to true to minimize distortion. Other coordinate systems will not create geodesic circles.

Default Value:false

hasM

Inherited
Property
hasM Boolean
Inherited from Geometry

Indicates if the geometry has M values.

hasZ

Inherited
Property
hasZ Boolean
Inherited from Geometry

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.

isSelfIntersecting

Inherited
Property
isSelfIntersecting Boolean
Inherited from Polygon

Checks to see if polygon rings cross each other and indicates if the polygon is self-intersecting, which means the ring of the polygon crosses itself.

numberOfPoints

Property
numberOfPoints Number

This value defines the number of points along the curve of the circle.

Default Value:60

radius

Property
radius Number

The radius of the circle.

Default Value:1000

radiusUnit

Property
radiusUnit String

Unit of the radius.

Possible Values:"feet" |"kilometers" |"meters" |"miles" |"nautical-miles" |"yards"

Default Value:meters

rings

Inherited
Property
rings Number[][][]
Inherited from Polygon

An array of rings. Each ring is a two-dimensional array of numbers representing the coordinates of each vertex in the ring in the spatial reference of the view. The first vertex of each ring should always be the same as the last vertex. Each vertex is an array of two, three, or four numbers. The table below shows the various structures of a vertex array.

Case Vertex array
without z and without m [x, y]
without z and with m [x, y, m]
with z and without m [x, y, z]
with z and with m [x, y, z, m]
Example
//3D polygon rings with m-values (note that the second ring does not have m-values defined for it)
const rings = [
 [  // first ring
  [-97.06138,32.837,35.1,4.8],
  [-97.06133,32.836,35.2,4.1],
  [-97.06124,32.834,35.3,4.2],
  [-97.06138,32.837,35.1,4.8]  // same as first vertex
 ], [  // second ring
  [-97.06326,32.759,35.4],
  [-97.06298,32.755,35.5],
  [-97.06153,32.749,35.6],
  [-97.06326,32.759,35.4]  // same as first vertex
 ]
];

const polygon = new Polygon({
  hasZ: true,
  hasM: true,
  rings: rings,
  spatialReference: { wkid: 4326 }
});

spatialReference

Inherited
Property
spatialReference SpatialReferenceautocast
Inherited from Geometry

The spatial reference of the geometry.

Default Value:WGS84 (wkid: 4326)

type

Inherited
Property
type Stringreadonly
Inherited from Polygon

The string value representing the type of geometry.

For Polygon the type is always "polygon".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

Adds a ring to the Polygon.

Polygon

Creates a deep clone of Circle.

Circle

Checks on the client if the input point is inside the polygon.

Polygon
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

Geometry

Returns a point specified by a ring and point in the path.

Polygon

Returns true if a named group of handles exist.

Accessor

Inserts a new point into the polygon.

Polygon

Checks if a Polygon ring is clockwise.

Polygon

Removes a group of handles owned by the object.

Accessor

Removes a point from the polygon at the given pointIndex within the ring identified by ringIndex.

Polygon

Removes a ring from the Polygon.

Polygon

Updates a point in the polygon.

Polygon

Converts an instance of this class to its ArcGIS portal JSON representation.

Geometry

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
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
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

addRing

Inherited
Method
addRing(points){Polygon}
Inherited from Polygon

Adds a ring to the Polygon. The ring can be one of the following: an array of numbers or an array of points. When added the index of the ring is incremented by one.

Parameter

A polygon ring. The first and last coordinates/points in the ring must be the same. This can either be defined as an array of Point geometries or an array of XY coordinates.

Returns
Type Description
Polygon Returns the polygon with the new ring included.

clone

Method
clone(){Circle}

Creates a deep clone of Circle.

Returns
Type Description
Circle A new instance of a Circle object equal to the object used to call .clone().

contains

Inherited
Method
contains(point){Boolean}
Inherited from Polygon

Checks on the client if the input point is inside the polygon. A point on the polygon line is considered inside.

Parameter
point Point

The point to test whether it is contained within the testing polygon.

Returns
Type Description
Boolean Returns true if the point is located inside the polygon.

fromJSON

Inherited
Method
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.

getPoint

Inherited
Method
getPoint(ringIndex, pointIndex){Point}
Inherited from Polygon

Returns a point specified by a ring and point in the path.

Parameters
ringIndex Number

The index of the ring containing the desired point.

pointIndex Number

The index of the desired point within the ring.

Returns
Type Description
Point Returns the point at the specified ring index and point index.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
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 *
optional

A group key.

Returns
Type 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");
}

insertPoint

Inherited
Method
insertPoint(ringIndex, pointIndex, point){Polygon}
Inherited from Polygon

Inserts a new point into the polygon.

Parameters
ringIndex Number

The index of the ring in which to insert the point.

pointIndex Number

The index of the point to insert within the ring.

point Point|Number[]

The point to insert.

Returns
Type Description
Polygon Returns the updated polygon.

isClockwise

Inherited
Method
isClockwise(ring){Boolean}
Inherited from Polygon

Checks if a Polygon ring is clockwise.

Parameter

A polygon ring. It can either be defined as an array of Point geometries or an array of XY coordinates.

Returns
Type Description
Boolean Returns true if the ring is clockwise and false for counterclockwise.

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
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 *
optional

A 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");

removePoint

Inherited
Method
removePoint(ringIndex, pointIndex){Point[]}
Inherited from Polygon

Removes a point from the polygon at the given pointIndex within the ring identified by ringIndex.

Parameters
ringIndex Number

The index of the ring containing the point to remove.

pointIndex Number

The index of the point to remove within the ring.

Returns
Type Description
Point[] Returns the geometry of the removed point.

removeRing

Inherited
Method
removeRing(index){Point[]}
Inherited from Polygon

Removes a ring from the Polygon. The index specifies which ring to remove.

Parameter
index Number

The index of the ring to remove.

Returns
Type Description
Point[] Returns array of points representing the removed ring.

setPoint

Inherited
Method
setPoint(ringIndex, pointIndex, point){Polygon}
Inherited from Polygon

Updates a point in the polygon.

Parameters
ringIndex Number

The index of the ring containing the point to update.

pointIndex Number

The index of the point to update within the ring.

point Point|Number[]

The new point geometry.

Returns
Type Description
Polygon Returns the updated polygon.

toJSON

Inherited
Method
toJSON(){Object}
Inherited from Geometry

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.