locateBetweenOperator | API Reference | ArcGIS Maps SDK for JavaScript 4.31

locateBetweenOperator

AMD: require(["esri/geometry/operators/locateBetweenOperator"], (locateBetweenOperator) => { /* code goes here */ });

ESM: import * as locateBetweenOperator from "@arcgis/core/geometry/operators/locateBetweenOperator.js";

Object: esri/geometry/operators/locateBetweenOperator

Since: ArcGIS Maps SDK for JavaScript 4.31

beta

Performs an OGC locate between operation on M values for the given 2D geometries. Calculates the geometry between given M values. This can also be used for locate along operations, which is a variation of locate between when the start and end M values are equal. This is a linear referencing operation. Polygons and extents are not supported.

Method Overview

Name	Return Type	Summary	Object
	Geometry []	Performs the locate between or locate along operation on the geometry.	locateBetweenOperator

Method Details

executeMany Method executeMany(geometries, startM, endM){Geometry[]}

Performs the locate between or locate along operation on the geometry. For locate along, the start and end M values are equal.

Parameters

geometries Geometry []

The set of input geometries.

startM Number

The M value to start the operation.

endM Number

The M value to end the operation.

Returns

Type	Description
Geometry []	Returns the result of geometries. For 1-dimensional geometries, the result could be either point, multipoint, or polyline. For polylines, the result can be both polyline and multipoint.

Example

// Perform the locate between operation
const geometries = locateBetweenOperator.executeMany([polyline1, polyline2], 100, 200);