Trilium Frontend API
    Preparing search index...

    Interface Range

    The Range interface represents a fragment of a document that can contain nodes and parts of text nodes.

    MDN Reference

    interface Range {
        collapsed: boolean;
        commonAncestorContainer: Node;
        END_TO_END: 2;
        END_TO_START: 3;
        endContainer: Node;
        endOffset: number;
        START_TO_END: 1;
        START_TO_START: 0;
        startContainer: Node;
        startOffset: number;
        cloneContents(): DocumentFragment;
        cloneRange(): Range;
        collapse(toStart?: boolean): void;
        compareBoundaryPoints(how: number, sourceRange: Range): number;
        comparePoint(node: Node, offset: number): number;
        createContextualFragment(string: string): DocumentFragment;
        deleteContents(): void;
        detach(): void;
        extractContents(): DocumentFragment;
        getBoundingClientRect(): DOMRect;
        getClientRects(): DOMRectList;
        insertNode(node: Node): void;
        intersectsNode(node: Node): boolean;
        isPointInRange(node: Node, offset: number): boolean;
        selectNode(node: Node): void;
        selectNodeContents(node: Node): void;
        setEnd(node: Node, offset: number): void;
        setEndAfter(node: Node): void;
        setEndBefore(node: Node): void;
        setStart(node: Node, offset: number): void;
        setStartAfter(node: Node): void;
        setStartBefore(node: Node): void;
        surroundContents(newParent: Node): void;
        toString(): string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    collapsed commonAncestorContainer END_TO_END END_TO_START endContainer endOffset START_TO_END START_TO_START startContainer startOffset

    Methods

    cloneContents cloneRange collapse compareBoundaryPoints comparePoint createContextualFragment deleteContents detach extractContents getBoundingClientRect getClientRects insertNode intersectsNode isPointInRange selectNode selectNodeContents setEnd setEndAfter setEndBefore setStart setStartAfter setStartBefore surroundContents toString

    Properties

    collapsed: boolean

    The read-only collapsed property of the AbstractRange interface returns true if the range's start position and end position are the same.

    MDN Reference

    commonAncestorContainer: Node

    The Range.commonAncestorContainer read-only property returns the deepest — or furthest down the document tree — Node that contains both boundary points of the Range. This means that if startContainer and endContainer both refer to the same node, this node is the common ancestor container.

    MDN Reference

    END_TO_END: 2
    END_TO_START: 3
    endContainer: Node

    The read-only endContainer property of the AbstractRange interface returns the Node in which the end of the range is located.

    MDN Reference

    endOffset: number

    The endOffset property of the AbstractRange interface returns the offset into the end node of the range's end position.

    MDN Reference

    START_TO_END: 1
    START_TO_START: 0
    startContainer: Node

    The read-only startContainer property of the AbstractRange interface returns the Node in which the start of the range is located.

    MDN Reference

    startOffset: number

    The read-only startOffset property of the AbstractRange interface returns the offset into the start node of the range's start position.

    MDN Reference

    Methods

    • The cloneContents() method of the Range interface copies the selected Node children of the range's commonAncestorContainer and puts them in a new DocumentFragment object.

      MDN Reference

      Returns DocumentFragment

    • The Range.cloneRange() method returns a Range object with boundary points identical to the cloned Range.

      MDN Reference

      Returns Range

    • The collapse() method of the Range interface collapses the Range to one of its boundary points.

      MDN Reference

      Parameters

      • OptionaltoStart: boolean

      Returns void

    • The compareBoundaryPoints() method of the Range interface compares the boundary points of the Range with those of another range.

      MDN Reference

      Parameters

      • how: number
      • sourceRange: Range

      Returns number

    • The comparePoint() method of the Range interface determines whether a specified point is before, within, or after the Range. The point is specified by a reference node and an offset within that node.

      MDN Reference

      Parameters

      • node: Node
      • offset: number

      Returns number

    • The Range.createContextualFragment() method of the Range interface returns a DocumentFragment representing the parsed input HTML or XML.

      MDN Reference

      Parameters

      • string: string

      Returns DocumentFragment

    • The Range.deleteContents() method removes all completely-selected nodes within this range from the document. For the partially selected nodes at the start or end of the range, only the selected portion of the text is deleted, while the node itself remains intact. Afterwards, the range is collapsed to the end of the last selected node.

      MDN Reference

      Returns void

    • The Range.detach() method does nothing. It used to disable the Range object and enable the browser to release associated resources. The method has been kept for compatibility.

      Returns void

      MDN Reference

    • The extractContents() method of the Range interface is similar to a combination of Range.cloneContents() and Range.deleteContents(). It removes the child Nodes of the range from the document, clones them, and returns them as a new DocumentFragment object. For partially selected nodes, only the selected text is deleted, but all containing parent nodes up to the common ancestor are cloned as well, resulting in two copies of these nodes, one in the original document and one in the extracted fragment.

      MDN Reference

      Returns DocumentFragment

    • The Range.getBoundingClientRect() method returns a DOMRect object that bounds the contents of the range; this is a rectangle enclosing the union of the bounding rectangles for all the elements in the range.

      MDN Reference

      Returns DOMRect

    • The Range.getClientRects() method returns a list of DOMRect objects representing the area of the screen occupied by the range. This is created by aggregating the results of calls to Element.getClientRects() for all the elements in the range.

      MDN Reference

      Returns DOMRectList

    • The Range.insertNode() method inserts a node at the start of the Range.

      MDN Reference

      Parameters

      Returns void

    • The Range.intersectsNode() method returns a boolean indicating whether the given Node intersects the Range.

      MDN Reference

      Parameters

      Returns boolean

    • The isPointInRange() method of the Range interface determines whether a specified point is within the Range. The point is specified by a reference node and an offset within that node. It is equivalent to calling Range.comparePoint() and checking if the result is 0.

      MDN Reference

      Parameters

      • node: Node
      • offset: number

      Returns boolean

    • The Range.selectNode() method sets the Range to contain the Node and its contents. The parent Node of the start and end of the Range will be the same as the parent of the referenceNode.

      MDN Reference

      Parameters

      Returns void

    • The Range.selectNodeContents() method sets the Range to contain the contents of a Node.

      MDN Reference

      Parameters

      Returns void

    • The Range.setEnd() method sets the end position of a Range to be located at the given offset into the specified node. Setting the end point above (higher in the document) than the start point will result in a collapsed range with the start and end points both set to the specified end position.

      MDN Reference

      Parameters

      • node: Node
      • offset: number

      Returns void

    • The Range.setEndAfter() method sets the end position of a Range relative to another Node. The parent Node of end of the Range will be the same as that for the referenceNode.

      MDN Reference

      Parameters

      Returns void

    • The Range.setEndBefore() method sets the end position of a Range relative to another Node. The parent Node of end of the Range will be the same as that for the referenceNode.

      MDN Reference

      Parameters

      Returns void

    • The Range.setStart() method sets the start position of a Range.

      MDN Reference

      Parameters

      • node: Node
      • offset: number

      Returns void

    • The Range.setStartAfter() method sets the start position of a Range relative to a Node. The parent Node of the start of the Range will be the same as that for the referenceNode.

      MDN Reference

      Parameters

      Returns void

    • The Range.setStartBefore() method sets the start position of a Range relative to another Node. The parent Node of the start of the Range will be the same as that for the referenceNode.

      MDN Reference

      Parameters

      Returns void

    • The surroundContents() method of the Range interface surrounds the selected content by a provided node. It extracts the contents of the range, replaces the children of newParent with the extracted contents, inserts newParent at the location of the extracted contents, and makes the range select newParent.

      MDN Reference

      Parameters

      Returns void

    • Returns a string representation of an object.

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods