Range: compareBoundaryPoints() method
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2017.
The
Range.compareBoundaryPoints()
method compares the
boundary points of the Range
with those of another range.
Syntax
js
compareBoundaryPoints(how, sourceRange)
Parameters
how
-
A constant describing the comparison method:
Range.END_TO_END
compares the end boundary-point of sourceRange to the end boundary-point ofRange
.Range.END_TO_START
compares the end boundary-point of sourceRange to the start boundary-point ofRange
.Range.START_TO_END
compares the start boundary-point of sourceRange to the end boundary-point ofRange
.Range.START_TO_START
compares the start boundary-point of sourceRange to the start boundary-point ofRange
.
sourceRange
-
A
Range
to compare boundary points with the range.
Return value
A number, -1
, 0
, or 1
, indicating whether the
corresponding boundary-point of the Range
is respectively before, equal
to, or after the corresponding boundary-point of sourceRange.
Exceptions
NotSupportedError
DOMException
-
Thrown if the value of the
how
parameter is invalid.
Examples
js
const range = document.createRange();
range.selectNode(document.querySelector("div"));
const sourceRange = document.createRange();
sourceRange.selectNode(document.getElementsByTagName("div")[1]);
const compare = range.compareBoundaryPoints(Range.START_TO_END, sourceRange);
Specifications
Specification |
---|
DOM Standard # dom-range-compareboundarypoints |
Browser compatibility
BCD tables only load in the browser