Trilium Frontend API
    Preparing search index...

    Interface Selection

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

    MDN Reference

    interface Selection {
        anchorNode: Node;
        anchorOffset: number;
        direction: string;
        focusNode: Node;
        focusOffset: number;
        isCollapsed: boolean;
        rangeCount: number;
        type: string;
        addRange(range: Range): void;
        collapse(node: Node, offset?: number): void;
        collapseToEnd(): void;
        collapseToStart(): void;
        containsNode(node: Node, allowPartialContainment?: boolean): boolean;
        deleteFromDocument(): void;
        empty(): void;
        extend(node: Node, offset?: number): void;
        getComposedRanges(options?: GetComposedRangesOptions): StaticRange[];
        getRangeAt(index: number): Range;
        modify(alter?: string, direction?: string, granularity?: string): void;
        removeAllRanges(): void;
        removeRange(range: Range): void;
        selectAllChildren(node: Node): void;
        setBaseAndExtent(
            anchorNode: Node,
            anchorOffset: number,
            focusNode: Node,
            focusOffset: number,
        ): void;
        setPosition(node: Node, offset?: number): void;
        toString(): string;
    }
    Index

    Properties

    anchorNode anchorOffset direction focusNode focusOffset isCollapsed rangeCount type

    Methods

    addRange collapse collapseToEnd collapseToStart containsNode deleteFromDocument empty extend getComposedRanges getRangeAt modify removeAllRanges removeRange selectAllChildren setBaseAndExtent setPosition toString

    Properties

    anchorNode: Node

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

    MDN Reference

    anchorOffset: number

    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.

    MDN Reference

    direction: string

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

    MDN Reference

    focusNode: Node

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

    MDN Reference

    focusOffset: number

    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.

    MDN Reference

    isCollapsed: boolean

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

    MDN Reference

    rangeCount: number

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

    MDN Reference

    type: string

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

    MDN Reference

    Methods

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

      MDN Reference

      Parameters

      Returns void

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

      MDN Reference

      Parameters

      • node: Node
      • Optionaloffset: number

      Returns void

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

      MDN Reference

      Returns void

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

      MDN Reference

      Returns void

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

      MDN Reference

      Parameters

      • node: Node
      • OptionalallowPartialContainment: boolean

      Returns boolean

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

      MDN Reference

      Returns void

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

      MDN Reference

      Returns void

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

      MDN Reference

      Parameters

      • node: Node
      • Optionaloffset: number

      Returns void

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

      MDN Reference

      Parameters

      • index: number

      Returns Range

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

      MDN Reference

      Parameters

      • Optionalalter: string
      • Optionaldirection: string
      • Optionalgranularity: string

      Returns void

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

      MDN Reference

      Returns void

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

      MDN Reference

      Parameters

      Returns void

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

      MDN Reference

      Parameters

      Returns void

    • 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.

      MDN Reference

      Parameters

      • anchorNode: Node
      • anchorOffset: number
      • focusNode: Node
      • focusOffset: number

      Returns void

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

      MDN Reference

      Parameters

      • node: Node
      • Optionaloffset: number

      Returns void

    • Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods