Interface Range

    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

    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

    Readonlycollapsed

    collapsed: boolean

    Returns true if range is collapsed, and false otherwise.

    MDN Reference

    ReadonlycommonAncestorContainer

    commonAncestorContainer: Node

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

    MDN Reference

    ReadonlyEND_TO_END

    END_TO_END: 2

    ReadonlyEND_TO_START

    END_TO_START: 3

    ReadonlyendContainer

    endContainer: Node

    Returns range's end node.

    MDN Reference

    ReadonlyendOffset

    endOffset: number

    Returns range's end offset.

    MDN Reference

    ReadonlySTART_TO_END

    START_TO_END: 1

    ReadonlySTART_TO_START

    START_TO_START: 0

    ReadonlystartContainer

    startContainer: Node

    Returns range's start node.

    MDN Reference

    ReadonlystartOffset

    startOffset: number

    Returns range's start offset.

    MDN Reference

    Methods

    cloneContents

    cloneRange

    collapse

    • collapse(toStart?: boolean): void

    • MDN Reference

      Parameters

      • OptionaltoStart: boolean

      Returns void

    compareBoundaryPoints

    • compareBoundaryPoints(how: number, sourceRange: Range): number

    • MDN Reference

      Parameters

      • how: number
      • sourceRange: Range

      Returns number

    comparePoint

    • comparePoint(node: Node, offset: number): number

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

      MDN Reference

      Parameters

      • node: Node
      • offset: number

      Returns number

    createContextualFragment

    deleteContents

    detach

    extractContents

    getBoundingClientRect

    getClientRects

    insertNode

    intersectsNode

    • intersectsNode(node: Node): boolean

    • Returns whether range intersects node.

      MDN Reference

      Parameters

      Returns boolean

    isPointInRange

    • isPointInRange(node: Node, offset: number): boolean

    • MDN Reference

      Parameters

      • node: Node
      • offset: number

      Returns boolean

    selectNode

    selectNodeContents

    setEnd

    setEndAfter

    setEndBefore

    setStart

    setStartAfter

    setStartBefore

    surroundContents

    toString

    • toString(): string

    • Returns a string representation of an object.

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods