kotlin-browser/web.selection/Selection

Selection

class Selection(source)

A Selection object represents the range of text selected by the user or the current position of the caret.

MDN Reference

Properties

anchorNode

val anchorNode: Node?

The Selection.anchorNode read-only property returns the Node in which the selection begins.

anchorOffset

val anchorOffset: Int

The Selection.anchorOffset read-only property returns the number of characters that the selection's anchor is offset within the In the case of Selection.anchorNode being another type of node, Selection.anchorOffset returns the number of Node.childNodes the selection's anchor is offset within the Selection.anchorNode.

direction

val direction: String

The direction read-only property of the Selection interface is a string that provides the direction of the current selection.

focusNode

val focusNode: Node?

The Selection.focusNode read-only property returns the Node in which the selection ends.

focusOffset

val focusOffset: Int

The Selection.focusOffset read-only property returns the number of characters that the selection's focus is offset within the In the case of Selection.focusNode being another type of node, Selection.focusOffset returns the number of Node.childNodes the selection's focus is offset within the Selection.focusNode.

isCollapsed

val isCollapsed: Boolean

The Selection.isCollapsed read-only property returns a boolean value which indicates whether or not there is currently any text selected.

rangeCount

val rangeCount: Int

The Selection.rangeCount read-only property returns the number of ranges in the selection.

type

val type: String

The type read-only property of the type of the current selection.

Functions

addRange

fun addRange(range: Range)

The Selection.addRange() method adds a ``js-nolint addRange(range) `` - range - : A Range object that will be added to the Selection.

collapse

fun collapse(node: Node?, offset: Int = definedExternally)

The Selection.collapse() method collapses the current selection to a single point.

collapseToEnd

fun collapseToEnd()

The Selection.collapseToEnd() method collapses the selection to the end of the last range in the selection.

collapseToStart

fun collapseToStart()

The Selection.collapseToStart() method collapses the selection to the start of the first range in the selection.

containsNode

fun containsNode(node: Node, allowPartialContainment: Boolean = definedExternally): Boolean

The Selection.containsNode() method indicates whether a specified node is part of the selection.

deleteFromDocument

fun deleteFromDocument()

The deleteFromDocument() method of the ``js-nolint deleteFromDocument() `` None.

empty

fun empty()

The Selection.empty() method removes all ranges from the selection, leaving the Selection.anchorNode and Selection.focusNode properties equal to null and nothing selected.

extend

fun extend(node: Node, offset: Int = definedExternally)

The Selection.extend() method moves the focus of the selection to a specified point.

getComposedRanges

fun getComposedRanges(options: GetComposedRangesOptions = definedExternally): ReadonlyArray<StaticRange>

The Selection.getComposedRanges() method returns an array of StaticRange objects representing the current selection ranges, and can return ranges that potentially cross shadow boundaries.

getRangeAt

fun getRangeAt(index: Int): Range

The getRangeAt() method of the Selection interface returns a range object representing a currently selected range.

modify

fun modify(alter: String = definedExternally, direction: String = definedExternally, granularity: String = definedExternally)

The Selection.modify() method applies a change to the current selection or cursor position, using simple textual commands.

removeAllRanges

fun removeAllRanges()

The Selection.removeAllRanges() method removes all ranges from the selection, leaving the Selection.anchorNode and Selection.focusNode properties equal to null and nothing selected.

removeRange

fun removeRange(range: Range)

The Selection.removeRange() method removes a range from a selection.

selectAllChildren

fun selectAllChildren(node: Node)

The Selection.selectAllChildren() method adds all the children of the specified node to the selection.

setBaseAndExtent

fun setBaseAndExtent(anchorNode: Node, anchorOffset: Int, focusNode: Node, focusOffset: Int)

The setBaseAndExtent() method of the Selection interface sets the selection to be a range including all or parts of two specified DOM nodes, and any content located between them.

setPosition

fun setPosition(node: Node?, offset: Int = definedExternally)

The Selection.setPosition() method collapses the current selection to a single point.