Document: caretRangeFromPoint() method

{{APIRef("DOM")}}{{Non-standard_header}}

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

This method is the WebKit-proprietary implementation of the {{domxref("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 {{domxref("Range")}}.
• Null, if x or y are negative, outside viewport, or there is no text entry node.

Examples

Visit the {{domxref("Document.caretPositionFromPoint#Examples", "Document.caretPositionFromPoint")}} page to view a live sample of this method.

Specifications

Not part of any specification.

Browser compatibility

{{Compat}}