Range: comparePoint() 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.comparePoint()
method returns -1
,
0
, or 1
depending on whether the referenceNode
is
before, the same as, or after the Range
.
If the reference node is a Node
of type Text
,
Comment
, or CDATASection
, then offset is the number of
characters from the start of reference node. For other Node
types, offset is the number of child nodes between the start of the reference
node.
Syntax
comparePoint(referenceNode, offset)
Parameters
referenceNode
offset
-
An integer greater than or equal to zero representing the offset inside the referenceNode.
Return value
Returns -1
, 0
, or 1
.
Examples
range = document.createRange();
range.selectNode(document.getElementsByTagName("div").item(0));
returnValue = range.comparePoint(document.getElementsByTagName("p").item(0), 1);
Specifications
Specification |
---|
DOM # ref-for-dom-range-comparepoint① |
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
comparePoint |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support