Interface Range

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

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)

AbstractRange
- Range

Properties

`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`END_TO_END

END_TO_END: 2

`Readonly`END_TO_START

END_TO_START: 3

`Readonly`endContainer

endContainer: Node

Returns range's end node.

MDN Reference

`Readonly`endOffset

endOffset: number

Returns range's end offset.

MDN Reference

`Readonly`START_TO_END

START_TO_END: 1

`Readonly`START_TO_START

START_TO_START: 0

`Readonly`startContainer

startContainer: Node

Returns range's start node.

MDN Reference

`Readonly`startOffset

startOffset: number

Returns range's start offset.

MDN Reference

Methods

cloneContents

cloneContents(): DocumentFragment
MDN Reference

Returns DocumentFragment
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19477

cloneRange

cloneRange(): Range
MDN Reference

Returns Range
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19479

collapse

collapse(toStart?: boolean): void
MDN Reference
Parameters
- OptionaltoStart: boolean
Returns void
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19481

compareBoundaryPoints

compareBoundaryPoints(how: number, sourceRange: Range): number
MDN Reference
Parameters
- how: number
- sourceRange: Range
Returns number
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19483

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
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19489

createContextualFragment

createContextualFragment(string: string): DocumentFragment
MDN Reference
Parameters
- string: string
Returns DocumentFragment
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19491

deleteContents

deleteContents(): void
MDN Reference

Returns void
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19493

detach

detach(): void
MDN Reference

Returns void
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19495

extractContents

extractContents(): DocumentFragment
MDN Reference

Returns DocumentFragment
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19497

getBoundingClientRect

getBoundingClientRect(): DOMRect
MDN Reference

Returns DOMRect
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19499

getClientRects

getClientRects(): DOMRectList
MDN Reference

Returns DOMRectList
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19501

insertNode

insertNode(node: Node): void
MDN Reference
Parameters
- node: Node
Returns void
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19503

intersectsNode

intersectsNode(node: Node): boolean
Returns whether range intersects node.

MDN Reference
Parameters
- node: Node
Returns boolean
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19509

isPointInRange

isPointInRange(node: Node, offset: number): boolean
MDN Reference
Parameters
- node: Node
- offset: number
Returns boolean
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19511

selectNode

selectNode(node: Node): void
MDN Reference
Parameters
- node: Node
Returns void
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19513

selectNodeContents

selectNodeContents(node: Node): void
MDN Reference
Parameters
- node: Node
Returns void
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19515

setEnd

setEnd(node: Node, offset: number): void
MDN Reference
Parameters
- node: Node
- offset: number
Returns void
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19517

setEndAfter

setEndAfter(node: Node): void
MDN Reference
Parameters
- node: Node
Returns void
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19519

setEndBefore

setEndBefore(node: Node): void
MDN Reference
Parameters
- node: Node
Returns void
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19521

setStart

setStart(node: Node, offset: number): void
MDN Reference
Parameters
- node: Node
- offset: number
Returns void
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19523

setStartAfter

setStartAfter(node: Node): void
MDN Reference
Parameters
- node: Node
Returns void
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19525

setStartBefore

setStartBefore(node: Node): void
MDN Reference
Parameters
- node: Node
Returns void
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19527

surroundContents

surroundContents(newParent: Node): void
MDN Reference
Parameters
- newParent: Node
Returns void
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19529

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:19530

Interface Range

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Readonlycollapsed

ReadonlycommonAncestorContainer

ReadonlyEND_TO_END

ReadonlyEND_TO_START

ReadonlyendContainer

ReadonlyendOffset

ReadonlySTART_TO_END

ReadonlySTART_TO_START

ReadonlystartContainer

ReadonlystartOffset

Methods

cloneContents

Returns DocumentFragment

cloneRange

Returns Range

collapse

Parameters

Returns void

compareBoundaryPoints

Parameters

Returns number

comparePoint

Parameters

Returns number

createContextualFragment

Parameters

Returns DocumentFragment

deleteContents

Returns void

detach

Returns void

extractContents

Returns DocumentFragment

getBoundingClientRect

Returns DOMRect

getClientRects

Returns DOMRectList

insertNode

Parameters

Returns void

intersectsNode

Parameters

Returns boolean

isPointInRange

Parameters

Returns boolean

selectNode

Parameters

Returns void

selectNodeContents

Parameters

Returns void

setEnd

Parameters

Returns void

setEndAfter

Parameters

Returns void

setEndBefore

Parameters

Returns void

setStart

Parameters

Returns void

setStartAfter

Parameters

Returns void

setStartBefore

Parameters

Returns void

surroundContents

Parameters

Returns void

toString

`Readonly`collapsed

`Readonly`commonAncestorContainer

`Readonly`END_TO_END

`Readonly`END_TO_START

`Readonly`endContainer

`Readonly`endOffset

`Readonly`START_TO_END

`Readonly`START_TO_START

`Readonly`startContainer

`Readonly`startOffset