Range: isPointInRange() 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 isPointInRange()
method of the Range
interface determines whether a specified point is within the Range
. The point is specified by a reference node and an offset within that node. It is equivalent to calling Range.comparePoint()
and checking if the result is 0
.
Syntax
isPointInRange(referenceNode, offset)
Parameters
referenceNode
-
The
Node
that theoffset
is relative to. offset
-
An integer greater than or equal to zero describing the position inside
referenceNode
of the point to be checked. IfreferenceNode
is aNode
of typeText
,Comment
, orCDATASection
, thenoffset
is the number of characters from the start ofreferenceNode
. For otherNode
types,offset
is the number of child nodes from the start of thereferenceNode
.
Return value
A boolean.
Examples
const text = new Text("0123456789");
const thisRange = new Range();
thisRange.setStart(text, 1);
thisRange.setEnd(text, 6);
thisRange.isPointInRange(text, 3); // true
thisRange.isPointInRange(text, 0); // false
thisRange.isPointInRange(text, 6); // true
thisRange.isPointInRange(text, 7); // false
Specifications
Specification |
---|
DOM # dom-range-ispointinrange |