Interface Range

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

Hierarchy

AbstractRange
- Range

Properties

`Readonly` END_TO_END

END_TO_END: number

`Readonly` END_TO_START

END_TO_START: number

`Readonly` START_TO_END

START_TO_END: number

`Readonly` START_TO_START

START_TO_START: number

`Readonly` collapsed

collapsed: boolean

Returns true if range is collapsed, and false otherwise.

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

`Readonly` endContainer

endContainer: Node

Returns range's end node.

`Readonly` endOffset

endOffset: number

Returns range's end offset.

`Readonly` startContainer

startContainer: Node

Returns range's start node.

`Readonly` startOffset

startOffset: number

Returns range's start offset.

Methods

cloneContents

cloneContents(): DocumentFragment
Returns DocumentFragment
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11553

cloneRange

cloneRange(): Range
Returns Range
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11554

collapse

collapse(toStart?: boolean): void
Parameters
- Optional toStart: boolean
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11555

compareBoundaryPoints

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

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.
Parameters
- node: Node
- offset: number
Returns number
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11558

createContextualFragment

createContextualFragment(fragment: string): DocumentFragment
Parameters
- fragment: string
Returns DocumentFragment
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11559

deleteContents

deleteContents(): void
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11560

detach

detach(): void
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11561

extractContents

extractContents(): DocumentFragment
Returns DocumentFragment
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11562

getBoundingClientRect

getBoundingClientRect(): DOMRect
Returns DOMRect
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11563

getClientRects

getClientRects(): DOMRectList
Returns DOMRectList
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11564

insertNode

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

intersectsNode

intersectsNode(node: Node): boolean
Returns whether range intersects node.
Parameters
- node: Node
Returns boolean
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11567

isPointInRange

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

selectNode

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

selectNodeContents

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

setEnd

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

setEndAfter

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

setEndBefore

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

setStart

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

setStartAfter

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

setStartBefore

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

surroundContents

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

toString

toString(): string
Returns string
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11578

Interface Range

Hierarchy

Index

Properties

Methods

Properties

Readonly END_TO_END

Readonly END_TO_START

Readonly START_TO_END

Readonly START_TO_START

Readonly collapsed

Readonly commonAncestorContainer

Readonly endContainer

Readonly endOffset

Readonly startContainer

Readonly startOffset

Methods

cloneContents

Returns DocumentFragment

cloneRange

Returns Range

collapse

Parameters

Optional toStart: boolean

Returns void

compareBoundaryPoints

Parameters

how: number

sourceRange: Range

Returns number

comparePoint

Parameters

node: Node

offset: number

Returns number

createContextualFragment

Parameters

fragment: string

Returns DocumentFragment

deleteContents

Returns void

detach

Returns void

extractContents

Returns DocumentFragment

getBoundingClientRect

Returns DOMRect

getClientRects

Returns DOMRectList

insertNode

Parameters

node: Node

Returns void

intersectsNode

Parameters

node: Node

Returns boolean

isPointInRange

Parameters

node: Node

offset: number

Returns boolean

selectNode

Parameters

node: Node

Returns void

selectNodeContents

Parameters

node: Node

Returns void

setEnd

Parameters

node: Node

offset: number

Returns void

setEndAfter

Parameters

node: Node

Returns void

setEndBefore

`Readonly` END_TO_END

`Readonly` END_TO_START

`Readonly` START_TO_END

`Readonly` START_TO_START

`Readonly` collapsed

`Readonly` commonAncestorContainer

`Readonly` endContainer

`Readonly` endOffset

`Readonly` startContainer

`Readonly` startOffset

`Optional` toStart: boolean