minimumBoundingCircleOperator | References | ArcGIS Maps SDK for JavaScript

import { execute, executeMany, supportsCurves } 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 the Welzl's algorithm using greedy heuristic with expected O(n) time complexity.

Note

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

Type definitions

Options

Type definition

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

Functions

Name	Return Type	Object
`Options`
`execute`	`Polygon`
`executeMany`	`Polygon[]`
`supportsCurves`

execute

Function

Performs the minimum bounding circle operation on the geometry.

Signature: execute (geometry: GeometryUnion): Polygon

Parameters

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The input geometry.

Returns: Polygon
Returns the minimum bounding circle polygon with curves.

Example

// Perform the minimum bounding circle operation
const minimumBoundingCircle = minimumBoundingCircleOperator.execute(polygon);

executeMany

Function

Performs the minimum bounding circle operation on the geometry set.

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

Parameters

Parameter	Type	Description	Required
geometries	`GeometryUnion[]`	The set of input geometries. All the geometries must have the same spatial reference.
options	`Options`	Additional options.

Returns: Polygon[]
Returns the minimum bounding circle polygons with curves.

Variables

supportsCurves

Variable

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

Type: boolean