Document.caretRangeFromPoint()

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

The caretRangeFromPoint() method of the Document interface returns a Range object for the document fragment under the specified coordinates.

This method is the WebKit-proprietary implementation of the Document.caretPositionFromPoint method.

Syntax

caretRangeFromPoint(x, y)

Parameters

x

A horizontal position within the current viewport.

y

A vertical position within the current viewport.

Return value

One of the following:

  • A Range.
  • Null, if x or y are negative, outside viewport, or there is no text entry node.

Examples

Visit the Document.caretPositionFromPoint page to view a live sample of this method.

Browser compatibility

BCD tables only load in the browser