Search

Search something to see results

GitHub

Range

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

MDN Reference

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

Hierarchy (View Summary)

Index

Properties

<internal>.Range.collapsed<internal>.Range.endContainer<internal>.Range.endOffset<internal>.Range.startContainer<internal>.Range.startOffset<internal>.Range.commonAncestorContainer<internal>.Range.START_TO_START<internal>.Range.START_TO_END<internal>.Range.END_TO_END<internal>.Range.END_TO_START

Methods

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

Properties

collapsed: boolean

Returns true if range is collapsed, and false otherwise.

MDN Reference

endContainer: Node

Returns range's end node.

MDN Reference

endOffset: number

Returns range's end offset.

MDN Reference

startContainer: Node

Returns range's start node.

MDN Reference

startOffset: number

Returns range's start offset.

MDN Reference

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

START_TO_START: 0
START_TO_END: 1
END_TO_END: 2
END_TO_START: 3

Methods

cloneContents(): DocumentFragment

MDN Reference

Returns DocumentFragment

cloneRange(): Range

MDN Reference

Returns Range

collapse(toStart?: boolean): void

MDN Reference

Parameters

  • OptionaltoStart: boolean

Returns void

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

MDN Reference

Parameters

  • how: number
  • sourceRange: Range

Returns number

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(string: string): DocumentFragment

MDN Reference

Parameters

  • string: string

Returns DocumentFragment

deleteContents(): void

MDN Reference

Returns void

detach(): void

MDN Reference

Returns void

extractContents(): DocumentFragment

MDN Reference

Returns DocumentFragment

getBoundingClientRect(): DOMRect

MDN Reference

Returns DOMRect

getClientRects(): DOMRectList

MDN Reference

Returns DOMRectList

insertNode(node: Node): void

MDN Reference

Parameters

Returns void

intersectsNode(node: Node): boolean

Returns whether range intersects node.

MDN Reference

Parameters

Returns boolean

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

MDN Reference

Parameters

  • node: Node
  • offset: number

Returns boolean

selectNode(node: Node): void

MDN Reference

Parameters

Returns void

selectNodeContents(node: Node): void

MDN Reference

Parameters

Returns void

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

MDN Reference

Parameters

  • node: Node
  • offset: number

Returns void

setEndAfter(node: Node): void

MDN Reference

Parameters

Returns void

setEndBefore(node: Node): void

MDN Reference

Parameters

Returns void

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

MDN Reference

Parameters

  • node: Node
  • offset: number

Returns void

setStartAfter(node: Node): void

MDN Reference

Parameters

Returns void

setStartBefore(node: Node): void

MDN Reference

Parameters

Returns void

surroundContents(newParent: Node): void

MDN Reference

Parameters

Returns void

toString(): string

Returns a string representation of an object.

Returns string