Range

Types

t

Read more on MDN

type t = private {
  startContainer: WebAPI.DOMTree.node,
  startOffset: int,
  endContainer: WebAPI.DOMTree.node,
  endOffset: int,
  collapsed: bool,
  commonAncestorContainer: WebAPI.DOMTree.node,
}

Record fields

startContainer

WebAPI.DOMTree.node

Returns range's start node. Read more on MDN

startOffset

int

Returns range's start offset. Read more on MDN

endContainer

WebAPI.DOMTree.node

Returns range's end node. Read more on MDN

endOffset

int

Returns range's end offset. Read more on MDN

collapsed

bool

Returns true if range is collapsed, and false otherwise. Read more on MDN

commonAncestorContainer

WebAPI.DOMTree.node

Returns the node, furthest away from the document, that is an ancestor of both range's start node and end node. Read more on MDN

Values

asAbstractRange

let asAbstractRange: t => WebAPI.AbstractRange.t

Parameters

t

Return type

WebAPI.AbstractRange.t

cloneContents

Read more on MDN

let cloneContents: t => WebAPI.DOMTree.documentFragment

Parameters

t

Return type

WebAPI.DOMTree.documentFragment

cloneRange

Read more on MDN

let cloneRange: t => t

Parameters

t

Return type

t

collapse

Read more on MDN

let collapse: (t, ~toStart: bool=?) => unit

Parameters

toption<bool>

Return type

unit

compareBoundaryPoints

Read more on MDN

let compareBoundaryPoints: (t, ~how: int, ~sourceRange: t) => int

Parameters

tintt

Return type

int

comparePoint

Returns −1 if the point is before the range, 0 if the point is in the range, and 1 if the point is after the range. Read more on MDN

let comparePoint: (t, ~node: WebAPI.DOMTree.node, ~offset: int) => int

Parameters

tWebAPI.DOMTree.nodeint

Return type

int

createContextualFragment

Read more on MDN

let createContextualFragment: (t, string) => WebAPI.DOMTree.documentFragment

Parameters

tstring

Return type

WebAPI.DOMTree.documentFragment

deleteContents

Read more on MDN

let deleteContents: t => unit

Parameters

t

Return type

unit

detach

Read more on MDN

let detach: t => unit

Parameters

t

Return type

unit

extractContents

Read more on MDN

let extractContents: t => WebAPI.DOMTree.documentFragment

Parameters

t

Return type

WebAPI.DOMTree.documentFragment

getBoundingClientRect

Read more on MDN

let getBoundingClientRect: t => WebAPI.DOM.domRect

Parameters

t

Return type

WebAPI.DOM.domRect

getClientRects

Read more on MDN

let getClientRects: t => WebAPI.DOM.domRectList

Parameters

t

Return type

WebAPI.DOM.domRectList

insertNode

Read more on MDN

let insertNode: (t, WebAPI.DOMTree.node) => unit

Parameters

tWebAPI.DOMTree.node

Return type

unit

intersectsNode

Returns whether range intersects node. Read more on MDN

let intersectsNode: (t, WebAPI.DOMTree.node) => bool

Parameters

tWebAPI.DOMTree.node

Return type

bool

isPointInRange

Read more on MDN

let isPointInRange: (t, ~node: WebAPI.DOMTree.node, ~offset: int) => bool

Parameters

tWebAPI.DOMTree.nodeint

Return type

bool

make

let make: unit => t

Parameters

unit

Return type

t

selectNode

Read more on MDN

let selectNode: (t, WebAPI.DOMTree.node) => unit

Parameters

tWebAPI.DOMTree.node

Return type

unit

selectNodeContents

Read more on MDN

let selectNodeContents: (t, WebAPI.DOMTree.node) => unit

Parameters

tWebAPI.DOMTree.node

Return type

unit

setEnd

Read more on MDN

let setEnd: (t, ~node: WebAPI.DOMTree.node, ~offset: int) => unit

Parameters

tWebAPI.DOMTree.nodeint

Return type

unit

setEndAfter

Read more on MDN

let setEndAfter: (t, WebAPI.DOMTree.node) => unit

Parameters

tWebAPI.DOMTree.node

Return type

unit

setEndBefore

Read more on MDN

let setEndBefore: (t, WebAPI.DOMTree.node) => unit

Parameters

tWebAPI.DOMTree.node

Return type

unit

setStart

Read more on MDN

let setStart: (t, ~node: WebAPI.DOMTree.node, ~offset: int) => unit

Parameters

tWebAPI.DOMTree.nodeint

Return type

unit

setStartAfter

Read more on MDN

let setStartAfter: (t, WebAPI.DOMTree.node) => unit

Parameters

tWebAPI.DOMTree.node

Return type

unit

setStartBefore

Read more on MDN

let setStartBefore: (t, WebAPI.DOMTree.node) => unit

Parameters

tWebAPI.DOMTree.node

Return type

unit

surroundContents

Read more on MDN

let surroundContents: (t, WebAPI.DOMTree.node) => unit

Parameters

tWebAPI.DOMTree.node

Return type

unit