import { minimumBoundingCircleExecute, execute, minimumBoundingCircleExecuteMany, executeMany, minimumBoundingCircleSupportsCurves } from "@arcgis/core/geometry/operators/minimumBoundingCircleOperator.js";
Since
ArcGIS Maps SDK for JavaScript 4.31

Create a minimum bounding circle for the input geometry. The output is a polygon with a single closed circular segment containing curves. Implements Welzl's algorithm using a greedy heuristic with expected O(n) time complexity.

Note

If curves are not needed, then densify the output geometry.

Type definitions

MinimumBoundingCircleOptions

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.2

merge

Property
Type
boolean | undefined

If true, the input geometries will be merged into a single geometry before calculating the minimum bounding circle.

Default value
false

Options

deprecated Type definition

Functions

minimumBoundingCircleExecute

Function
Since
ArcGIS Maps SDK for JavaScript 5.2

Performs the minimum bounding circle operation on the geometry.

Signature
minimumBoundingCircleExecute (geometry: GeometryUnion): Polygon

Parameters

ParameterTypeDescriptionRequired
geometry

The input geometry.

Returns
Polygon

Returns the minimum bounding circle polygon with curves.

Example
// Perform the minimum bounding circle operation
const minimumBoundingCircle = minimumBoundingCircleExecute(polygon);

execute

deprecated Function

Performs the minimum bounding circle operation on the geometry.

Signature
execute (geometry: GeometryUnion): Polygon

Parameters

ParameterTypeDescriptionRequired
geometry

The input geometry.

Returns
Polygon

Returns the minimum bounding circle polygon with curves.

Example
// Perform the minimum bounding circle operation
const minimumBoundingCircle = minimumBoundingCircleExecute(polygon);

minimumBoundingCircleExecuteMany

Function
Since
ArcGIS Maps SDK for JavaScript 5.2

Performs the minimum bounding circle operation on the geometry set.

Signature
minimumBoundingCircleExecuteMany (geometries: GeometryUnion[], options?: MinimumBoundingCircleOptions): Polygon[]

Parameters

ParameterTypeDescriptionRequired
geometries

The set of input geometries. All the geometries must have the same spatial reference.

options

Additional options.

Returns
Polygon[]

Returns the minimum bounding circle polygons with curves.

executeMany

deprecated Function

Performs the minimum bounding circle operation on the geometry set.

Signature
executeMany (geometries: GeometryUnion[], options?: MinimumBoundingCircleOptions): Polygon[]

Parameters

ParameterTypeDescriptionRequired
geometries

The set of input geometries. All the geometries must have the same spatial reference.

options

Additional options.

Returns
Polygon[]

Returns the minimum bounding circle polygons with curves.

Variables

minimumBoundingCircleSupportsCurves

Variable
Since
ArcGIS Maps SDK for JavaScript 5.2

Indicates if the operator supports input geometries that contain curves. The value will always be false.

Type
boolean

supportsCurves

deprecated Variable

Indicates if the operator supports input geometries that contain curves. The value will always be false.

Type
ReturnType