kotlin-browser/web.ranges/Range

Range

external class Range : AbstractRange(source)

A fragment of a document that can contain nodes and parts of text nodes.

MDN Reference

Constructors

Range

constructor()

Types

Companion

object Companion

CompareMethod

sealed interface CompareMethod

Properties

collapsed

val collapsed: Boolean

Returns true if range is collapsed, and false otherwise.

commonAncestorContainer

val commonAncestorContainer: Node

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

END_TO_END

val END_TO_END: Range.CompareMethod

END_TO_START

val END_TO_START: Range.CompareMethod

endContainer

val endContainer: Node

Returns range's end node.

endOffset

val endOffset: Int

Returns range's end offset.

START_TO_END

val START_TO_END: Range.CompareMethod

START_TO_START

val START_TO_START: Range.CompareMethod

startContainer

val startContainer: Node

Returns range's start node.

startOffset

val startOffset: Int

Returns range's start offset.

Functions

cloneContents

fun cloneContents(): DocumentFragment

MDN Reference

cloneRange

fun cloneRange(): Range

MDN Reference

collapse

fun collapse(toStart: Boolean = definedExternally)

MDN Reference

compareBoundaryPoints

fun compareBoundaryPoints(how: Range.CompareMethod, sourceRange: Range): Short

MDN Reference

comparePoint

fun comparePoint(node: Node, offset: Int): Short

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.

createContextualFragment

fun createContextualFragment(string: String): DocumentFragment

fun deleteContents()

fun detach()

fun extractContents(): DocumentFragment

MDN Reference

getBoundingClientRect

fun getBoundingClientRect(): DOMRect

MDN Reference

getClientRects

fun getClientRects(): DOMRectList

MDN Reference

insertNode

fun insertNode(node: Node)

MDN Reference

intersectsNode

fun intersectsNode(node: Node): Boolean

Returns whether range intersects node.

isPointInRange

fun isPointInRange(node: Node, offset: Int): Boolean

MDN Reference

selectNode

fun selectNode(node: Node)

MDN Reference

selectNodeContents

fun selectNodeContents(node: Node)

MDN Reference

setEnd

fun setEnd(node: Node, offset: Int)

MDN Reference

setEndAfter

fun setEndAfter(node: Node)

MDN Reference

setEndBefore

fun setEndBefore(node: Node)

MDN Reference

setStart

fun setStart(node: Node, offset: Int)

MDN Reference

setStartAfter

fun setStartAfter(node: Node)

MDN Reference

setStartBefore

fun setStartBefore(node: Node)

MDN Reference

surroundContents

fun surroundContents(newParent: Node)

MDN Reference