XAndY.almostEqual Function

Return true if two XAndYs have equal x,y parts within a specified tolerance.

almostEqual(a: Readonly<WritableXAndY>, b: Readonly<WritableXAndY>, tol?: number): boolean

@returns true if the difference in each coordinate of a and b is smaller than tol.

Parameter Type Description
a Readonly<WritableXAndY> The first XAndY to compare
b Readonly<WritableXAndY> The second XAndY to compare
tol number tolerance for comparison. If undefined, smallMetricDistance is used.

Returns - boolean

true if the difference in each coordinate of a and b is smaller than tol.

Defined in

Last Updated: 07 October, 2025