generalizeOperator

AMD: require(["esri/geometry/operators/generalizeOperator"], (generalizeOperator) => { /* code goes here */ });
ESM: import * as generalizeOperator from "@arcgis/core/geometry/operators/generalizeOperator.js";
Object: esri/geometry/operators/generalizeOperator
Since: ArcGIS Maps SDK for JavaScript 4.31
beta

Generalizes 2D geometries using Douglas-Peucker algorithm.

Method Overview

Name Return Type Summary Object

Performs the generalize operation on the input geometry.

generalizeOperator

Performs the generalize operation on the input geometries.

generalizeOperator

Method Details

execute

Method
execute(geometry, maxDeviation, options){Geometry |null}

Performs the generalize operation on the input geometry.

Parameters
Specification
geometry Geometry

The input geometry to be generalized.

maxDeviation Number

The maximum allowed deviation from the generalized geometry to the original geometry. If maxDeviation <= 0 the operator returns the input geometry. Unless the unit option is set, the default is the spatial reference unit of geometry.

options Object
optional

Additional options.

Specification
removeDegenerateParts Boolean
optional
Default Value: false

Preserves degenerate parts. The operator will try to output three distinct vertices for closed polyline paths and polygon rings, and it will output two distinct vertices for open polyline paths.

When set to true, the degenerate parts of the geometry will be removed from the output. This may not be desirable for displaying the geometry.

unit LengthUnit
optional

The length unit of maxDeviation. An error will be thrown if this is set for Geographic Coordinate Systems.

Returns
Type Description
Geometry | null Returns the generalized geometry or null.
Example
// Generalize a polyline geometry
const generalizedPolyline = generalizeOperator.execute(polyline, 10);

executeMany

Method
executeMany(geometries, maxDeviation, options){Geometry[]}

Performs the generalize operation on the input geometries.

Parameters
Specification
geometries Geometry[]

The input geometries to be generalized.

maxDeviation Number

The maximum allowed deviation from the generalized geometry to the original geometry. If the value is less than or equal to zero, then the operator returns the input geometries. Unless the unit option is set, the default is the spatial reference unit of geometries.

options Object
optional

Additional options.

Specification
removeDegenerateParts Boolean
optional
Default Value: false

Preserves degenerate parts. The operator will try to output three distinct vertices for closed polyline paths and polygon rings, and it will output two distinct vertices for open polyline paths.

When set to true, the degenerate parts of the geometries will be removed from the output. This may not be desirable for displaying the geometries.

unit LengthUnit
optional

The length unit of maxDeviation. An error will be thrown if this is set for Geographic Coordinate Systems.

Returns
Type Description
Geometry[] Returns an array of generalized geometries. Geometries with a dimension of < 1 are simply passed along.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.