Interface Range

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

MDN Reference

interface Range {
    END_TO_END: 2;
    END_TO_START: 3;
    START_TO_END: 1;
    START_TO_START: 0;
    collapsed: boolean;
    commonAncestorContainer: Node;
    endContainer: Node;
    endOffset: number;
    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(fragment: 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-Diagram

UML class diagram of Range
Legend
icon for an interface in the UML class diagram interface
icon for a public property in the UML class diagram public property
icon for a public method in the UML class diagram public method

Hierarchy (view full)

Properties

END_TO_END END_TO_START START_TO_END START_TO_START collapsed commonAncestorContainer endContainer endOffset 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

Readonly END_TO_END

END_TO_END: 2

Readonly END_TO_START

END_TO_START: 3

Readonly START_TO_END

START_TO_END: 1

Readonly START_TO_START

START_TO_START: 0

Readonly collapsed

collapsed: boolean

Returns true if range is collapsed, and false otherwise.

MDN Reference

Readonly commonAncestorContainer

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

Readonly endContainer

endContainer: Node

Returns range's end node.

MDN Reference

Readonly endOffset

endOffset: number

Returns range's end offset.

MDN Reference

Readonly startContainer

startContainer: Node

Returns range's start node.

MDN Reference

Readonly startOffset

startOffset: number

Returns range's start offset.

MDN Reference

Methods

cloneContents

cloneRange

collapse

  • collapse(toStart?: boolean): void

  • MDN Reference

    Parameters

    • Optional toStart: 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

  • deleteContents(): void

  • MDN Reference

    Returns void

detach

  • detach(): void

  • MDN Reference

    Returns void

extractContents

getBoundingClientRect

getClientRects

  • getClientRects(): DOMRectList

  • MDN Reference

    Returns DOMRectList

insertNode

  • insertNode(node: Node): void

  • MDN Reference

    Parameters

    Returns void

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

  • selectNode(node: Node): void

  • MDN Reference

    Parameters

    Returns void

selectNodeContents

  • selectNodeContents(node: Node): void

  • MDN Reference

    Parameters

    Returns void

setEnd

  • setEnd(node: Node, offset: number): void

  • MDN Reference

    Parameters

    • node: Node
    • offset: number

    Returns void

setEndAfter

  • setEndAfter(node: Node): void

  • MDN Reference

    Parameters

    Returns void

setEndBefore

  • setEndBefore(node: Node): void

  • MDN Reference

    Parameters

    Returns void

setStart

  • setStart(node: Node, offset: number): void

  • MDN Reference

    Parameters

    • node: Node
    • offset: number

    Returns void

setStartAfter

  • setStartAfter(node: Node): void

  • MDN Reference

    Parameters

    Returns void

setStartBefore

  • setStartBefore(node: Node): void

  • MDN Reference

    Parameters

    Returns void

surroundContents

  • surroundContents(newParent: Node): void

  • MDN Reference

    Parameters

    Returns void

toString

  • toString(): string

  • Returns string

Settings

Member Visibility

Theme

On This Page

END_TO_ENDEND_TO_STARTSTART_TO_ENDSTART_TO_STARTcollapsedcommonAncestorContainerendContainerendOffsetstartContainerstartOffsetcloneContentscloneRangecollapsecompareBoundaryPointscomparePointcreateContextualFragmentdeleteContentsdetachextractContentsgetBoundingClientRectgetClientRectsinsertNodeintersectsNodeisPointInRangeselectNodeselectNodeContentssetEndsetEndAftersetEndBeforesetStartsetStartAftersetStartBeforesurroundContentstoString