import * as labelPointOperator from "@arcgis/core/geometry/operators/labelPointOperator.js";
const labelPointOperator = await $arcgis.import("@arcgis/core/geometry/operators/labelPointOperator.js");
@arcgis/core/geometry/operators/labelPointOperator
Calculates a label point for the given 2D geometries. The point is guaranteed to be on the interior of the geometry. It can be used to place a label on a feature and help to ensure readability on the map.
Based on the input geometry type, the label point is defined as follows:
- Extent - the center of the extent.
- Multipoint - the point which is closest to the center of the geometry's envelope.
- Point - the point itself.
- Polygon - a point near the centroid of the ring with greatest area.
- Polyline - a vertex near the middle of the longest segment.
Property Overview
| Name | Type | Summary | Object |
|---|---|---|---|
Indicates if the operator supports input geometries that contain curves. | labelPointOperator |
Property Details
-
supportsCurves
PropertysupportsCurves Booleanreadonly -
Indicates if the operator supports input geometries that contain curves. The value will always be
true.
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
Performs the label point operation on the geometry. | labelPointOperator | ||
Performs the label point operation on the geometry set. | labelPointOperator |
Method Details
-
execute
Methodexecute(geometry){Point} -
Performs the label point operation on the geometry.
Parametergeometry GeometryUnionThe input geometry.
ReturnsType Description Point Returns the label point. Example// Perform the label point operation const labelPoint = labelPointOperator.execute(polygon);
-
Performs the label point operation on the geometry set.
Parametergeometries GeometryUnion[]The set of input geometries. All the geometries must have the same spatial reference.
Returns