Range: comparePoint() method
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
js
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
js
range = document.createRange();
range.selectNode(document.getElementsByTagName("div").item(0));
returnValue = range.comparePoint(document.getElementsByTagName("p").item(0), 1);
Specifications
Specification |
---|
DOM Standard # ref-for-dom-range-comparepoint① |
Browser compatibility
BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.