Docs4dev
Docs
dom / latest / range / compareboundarypoints.html

Range: compareBoundaryPoints() method

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 of Range.
  • Range.END_TO_START compares the end boundary-point of sourceRange to the start boundary-point of Range.
  • Range.START_TO_END compares the start boundary-point of sourceRange to the end boundary-point of Range.
  • Range.START_TO_START compares the start boundary-point of sourceRange to the start boundary-point of Range.
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

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
compareBoundaryPoints 1 12 1 9 9 1 4.4 18 4 10.1 1 1.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Range/compareBoundaryPoints