ViewRange

class

Range in the view tree. A range is represented by its start and end positions.

In order to create a new position instance use the createPosition*() factory methods available in:

See source

Properties

Methods

constructor( start, end )

Creates a range spanning from start position to end position.
Note: Constructor creates it's own ViewPosition instances basing on passed values.
See source (with github icon)
Parameters
start : ViewPosition
Start position.
end : null | ViewPosition
End position. If not set, range will be collapsed at the start position.

Defaults to null
Symbol.iterator() → IterableIterator<ViewTreeWalkerValue>

Iterable interface.
Iterates over all view items that are in this range and returns them together with additional information like length or positions, grouped as ViewTreeWalkerValue.
This iterator uses TreeWalker with boundaries set to this range and ignoreElementEnd option set to true.
See source (with github icon)
Returns
IterableIterator<ViewTreeWalkerValue>
clone() → ViewRange

Clones this range.
See source (with github icon)
Returns
ViewRange
containsPosition( position ) → boolean

Checks whether this range contains given position.
See source (with github icon)
Parameters
position : ViewPosition
Position to check.
Returns
boolean
true if given position is contained in this range, false otherwise.
containsRange( otherRange, loose ) → boolean

Checks whether this range contains given range.
See source (with github icon)
Parameters
otherRange : ViewRange
Range to check.
loose : boolean
Whether the check is loose or strict. If the check is strict (false), compared range cannot start or end at the same position as this range boundaries. If the check is loose (true), compared range can start, end or even be equal to this range. Note that collapsed ranges are always compared in strict mode.

Defaults to false
Returns
boolean
true if given range boundaries are contained by this range, false otherwise.
getCommonAncestor() → null | ViewNode | ViewDocumentFragment

Returns a ViewNode or ViewDocumentFragment which is a common ancestor of range's both ends (in which the entire range is contained).
See source (with github icon)
Returns
null | ViewNode | ViewDocumentFragment
getContainedElement() → null | ViewElement

Returns an Element contained by the range. The element will be returned when it is the only node within the range and fully–contained at the same time.
See source (with github icon)
Returns
null | ViewElement

`getDifference( otherRange ) → Array<ViewRange>`

module:engine/view/range~ViewRange#getDifference

Computes which part(s) of this range is not a part of given range. Returned array contains zero, one or two ranges.

Examples:

let foo = downcastWriter.createText( 'foo' );
let img = downcastWriter.createContainerElement( 'img' );
let bar = downcastWriter.createText( 'bar' );
let p = downcastWriter.createContainerElement( 'p', null, [ foo, img, bar ] );

let range = view.createRange( view.createPositionAt( foo, 2 ), view.createPositionAt( bar, 1 ); // "o", img, "b" are in range.
let otherRange = view.createRange( // "oo", img, "ba" are in range.
	view.createPositionAt( foo, 1 ),
	view.createPositionAt( bar, 2 )
);
let transformed = range.getDifference( otherRange );
// transformed array has no ranges because `otherRange` contains `range`

otherRange = view.createRange( view.createPositionAt( foo, 1 ), view.createPositionAt( p, 2 ); // "oo", img are in range.
transformed = range.getDifference( otherRange );
// transformed array has one range: from ( p, 2 ) to ( bar, 1 )

otherRange = view.createRange( view.createPositionAt( p, 1 ), view.createPositionAt( p, 2 ) ); // img is in range.
transformed = range.getDifference( otherRange );
// transformed array has two ranges: from ( foo, 1 ) to ( p, 1 ) and from ( p, 2 ) to ( bar, 1 )

See source

Parameters

otherRange : ViewRange: Range to differentiate against.

Returns

Array<ViewRange>: The difference between ranges.

getEnlarged() → ViewRange
module:engine/view/range~ViewRange#getEnlarged
Creates a maximal range that has the same content as this range but is expanded in both ways (at the beginning and at the end).
For example:
```
Foo{Bar} -> Foo[Bar]
foo{bar} -> foo[bar]
```
Copy code
Note that in the sample above:
-  have type of ViewContainerElement,
-  have type of ViewAttributeElement,
-  have type of ViewUIElement.
See source (with github icon)
Returns
ViewRange
Enlarged range.

`getIntersection( otherRange ) → null | ViewRange`

module:engine/view/range~ViewRange#getIntersection

Returns an intersection of this range and given range. Intersection is a common part of both of those ranges. If ranges has no common part, returns null.

Examples:

let foo = downcastWriter.createText( 'foo' );
let img = downcastWriter.createContainerElement( 'img' );
let bar = downcastWriter.createText( 'bar' );
let p = downcastWriter.createContainerElement( 'p', null, [ foo, img, bar ] );

let range = view.createRange( view.createPositionAt( foo, 2 ), view.createPositionAt( bar, 1 ); // "o", img, "b" are in range.
let otherRange = view.createRange( view.createPositionAt( foo, 1 ), view.createPositionAt( p, 2 ); // "oo", img are in range.
let transformed = range.getIntersection( otherRange ); // range from ( foo, 1 ) to ( p, 2 ).

otherRange = view.createRange( view.createPositionAt( bar, 1 ), view.createPositionAt( bar, 3 ); "ar" is in range.
transformed = range.getIntersection( otherRange ); // null - no common part.

See source

Parameters

otherRange : ViewRange: Range to check for intersection.

Returns

null | ViewRange: A common part of given ranges or null if ranges have no common part.

getItems( options ) → IterableIterator<ViewItem>

Returns an iterator that iterates over all view items that are in this range and returns them.
This method uses ViewTreeWalker with boundaries set to this range and ignoreElementEnd option set to true. However it returns only items, not ViewTreeWalkerValue.
You may specify additional options for the tree walker. See ViewTreeWalker for a full list of available options.
See source (with github icon)
Parameters
options : ViewTreeWalkerOptions
Object with configuration options. See ViewTreeWalker.

Defaults to {}
Returns
IterableIterator<ViewItem>
getPositions( options ) → IterableIterator<ViewPosition>

Returns an iterator that iterates over all positions that are boundaries or contained in this range.
This method uses ViewTreeWalker with boundaries set to this range. However it returns only positions, not ViewTreeWalkerValue.
You may specify additional options for the tree walker. See ViewTreeWalker for a full list of available options.
See source (with github icon)
Parameters
options : ViewTreeWalkerOptions
Object with configuration options. See ViewTreeWalker.

Defaults to {}
Returns
IterableIterator<ViewPosition>
getTrimmed() → ViewRange
module:engine/view/range~ViewRange#getTrimmed
Creates a minimum range that has the same content as this range but is trimmed in both ways (at the beginning and at the end).
For example:
```
Foo[Bar] -> Foo{Bar}
foo[bar] -> foo{bar}
```
Copy code
Note that in the sample above:
-  have type of ViewContainerElement,
-  have type of ViewAttributeElement,
-  have type of ViewUIElement.
See source (with github icon)
Returns
ViewRange
Shrunk range.
getWalker( options ) → ViewTreeWalker

Creates a TreeWalker instance with this range as a boundary.
See source (with github icon)
Parameters
options : ViewTreeWalkerOptions
Object with configuration options. See ViewTreeWalker.

Defaults to {}
Returns
ViewTreeWalker
is( type ) → this is ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement
inherited
module:engine/view/range~ViewRange#is:ELEMENT
Checks whether this object is of type ViewElement or its subclass.
```
element.is( 'element' ); // -> true
element.is( 'node' ); // -> true
element.is( 'view:element' ); // -> true
element.is( 'view:node' ); // -> true

element.is( 'model:element' ); // -> false
element.is( 'documentSelection' ); // -> false
```
Copy code
Assuming that the object being checked is an element, you can also check its name:
```
element.is( 'element', 'img' ); // -> true if this is an <img> element
text.is( 'element', 'img' ); -> false
```
Copy code
See source (with github icon)
Parameters
type : 'element' | 'view:element'
Returns
this is ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement

`is( type ) → this is ViewContainerElement | ViewEditableElement | ViewRootEditableElement`
inherited

module:engine/view/range~ViewRange#is:CONTAINER_ELEMENT

Checks whether this object is of type ViewContainerElement or its subclass.

containerElement.is( 'containerElement' ); // -> true
containerElement.is( 'element' ); // -> true
containerElement.is( 'node' ); // -> true
containerElement.is( 'view:containerElement' ); // -> true
containerElement.is( 'view:element' ); // -> true
containerElement.is( 'view:node' ); // -> true

containerElement.is( 'model:element' ); // -> false
containerElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is a container element, you can also check its name:

containerElement.is( 'element', 'div' ); // -> true if this is a div container element
containerElement.is( 'contaienrElement', 'div' ); // -> same as above
text.is( 'element', 'div' ); -> false

See source

Parameters

type : 'containerElement' | 'view:containerElement'

Returns

this is ViewContainerElement | ViewEditableElement | ViewRootEditableElement

`is( type ) → this is ViewEditableElement | ViewRootEditableElement`
inherited

module:engine/view/range~ViewRange#is:EDITABLE_ELEMENT

Checks whether this object is of type ViewEditableElement or its subclass.

editableElement.is( 'editableElement' ); // -> true
editableElement.is( 'element' ); // -> true
editableElement.is( 'node' ); // -> true
editableElement.is( 'view:editableElement' ); // -> true
editableElement.is( 'view:element' ); // -> true
editableElement.is( 'view:node' ); // -> true

editableElement.is( 'model:element' ); // -> false
editableElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is an editbale element, you can also check its name:

editableElement.is( 'element', 'div' ); // -> true if this is a div element
editableElement.is( 'editableElement', 'div' ); // -> same as above
text.is( 'element', 'div' ); -> false

See source

Parameters

type : 'editableElement' | 'view:editableElement'

Returns

this is ViewEditableElement | ViewRootEditableElement

`is( type ) → this is ViewAttributeElement`
inherited

module:engine/view/range~ViewRange#is:ATTRIBUTE_ELEMENT

Checks whether this object is of type ViewAttributeElement.

attributeElement.is( 'attributeElement' ); // -> true
attributeElement.is( 'element' ); // -> true
attributeElement.is( 'node' ); // -> true
attributeElement.is( 'view:attributeElement' ); // -> true
attributeElement.is( 'view:element' ); // -> true
attributeElement.is( 'view:node' ); // -> true

attributeElement.is( 'model:element' ); // -> false
attributeElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is an attribute element, you can also check its name:

attributeElement.is( 'element', 'b' ); // -> true if this is a bold element
attributeElement.is( 'attributeElement', 'b' ); // -> same as above
text.is( 'element', 'b' ); -> false

See source

Parameters

type : 'attributeElement' | 'view:attributeElement'

Returns

this is ViewAttributeElement

`is( type ) → this is ViewRootEditableElement`
inherited

module:engine/view/range~ViewRange#is:ROOT_ELEMENT

Checks whether this object is of type ViewRootEditableElement.

rootEditableElement.is( 'rootElement' ); // -> true
rootEditableElement.is( 'editableElement' ); // -> true
rootEditableElement.is( 'element' ); // -> true
rootEditableElement.is( 'node' ); // -> true
rootEditableElement.is( 'view:editableElement' ); // -> true
rootEditableElement.is( 'view:element' ); // -> true
rootEditableElement.is( 'view:node' ); // -> true

rootEditableElement.is( 'model:element' ); // -> false
rootEditableElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is a root editable element, you can also check its name:

rootEditableElement.is( 'element', 'div' ); // -> true if this is a div root editable element
rootEditableElement.is( 'rootElement', 'div' ); // -> same as above
text.is( 'element', 'div' ); -> false

See source

Parameters

type : 'rootElement' | 'view:rootElement'

Returns

this is ViewRootEditableElement

is( type ) → this is ViewTextProxy
inherited
module:engine/view/range~ViewRange#is:TEXT_PROXY
Checks whether this object is of type ViewTextProxy.
```
textProxy.is( '$textProxy' ); // -> true
textProxy.is( 'view:$textProxy' ); // -> true

textProxy.is( 'model:$textProxy' ); // -> false
textProxy.is( 'element' ); // -> false
textProxy.is( 'range' ); // -> false
```
Copy code
Note: Until version 20.0.0 this method wasn't accepting '$textProxy' type. The legacy 'textProxy' type is still accepted for backward compatibility.
See source (with github icon)
Parameters
type : '$textProxy' | 'view:$textProxy'
Returns
this is ViewTextProxy
is( type ) → this is ViewPosition
inherited
module:engine/view/range~ViewRange#is:POSITION
Checks whether this object is of type ViewPosition.
```
position.is( 'position' ); // -> true
position.is( 'view:position' ); // -> true

position.is( 'model:position' ); // -> false
position.is( 'element' ); // -> false
position.is( 'range' ); // -> false
```
Copy code
See source (with github icon)
Parameters
type : 'position' | 'view:position'
Returns
this is ViewPosition
is( type ) → this is ViewDocumentFragment
inherited
module:engine/view/range~ViewRange#is:DOCUMENT_FRAGMENT
hecks whether this object is of type ViewDocumentFragment.
```
docFrag.is( 'documentFragment' ); // -> true
docFrag.is( 'view:documentFragment' ); // -> true

docFrag.is( 'model:documentFragment' ); // -> false
docFrag.is( 'element' ); // -> false
docFrag.is( 'node' ); // -> false
```
Copy code
See source (with github icon)
Parameters
type : 'documentFragment' | 'view:documentFragment'
Returns
this is ViewDocumentFragment
is( type ) → this is ViewText
inherited
module:engine/view/range~ViewRange#is:TEXT
Checks whether this object is of type ViewText.
```
text.is( '$text' ); // -> true
text.is( 'node' ); // -> true
text.is( 'view:$text' ); // -> true
text.is( 'view:node' ); // -> true

text.is( 'model:$text' ); // -> false
text.is( 'element' ); // -> false
text.is( 'range' ); // -> false
```
Copy code
See source (with github icon)
Parameters
type : '$text' | 'view:$text'
Returns
this is ViewText

`is( type ) → this is ViewUIElement`
inherited

module:engine/view/range~ViewRange#is:UI_ELEMENT

Checks whether this object is of type ViewUIElement.

uiElement.is( 'uiElement' ); // -> true
uiElement.is( 'element' ); // -> true
uiElement.is( 'node' ); // -> true
uiElement.is( 'view:uiElement' ); // -> true
uiElement.is( 'view:element' ); // -> true
uiElement.is( 'view:node' ); // -> true

uiElement.is( 'model:element' ); // -> false
uiElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is an ui element, you can also check its name:

uiElement.is( 'element', 'span' ); // -> true if this is a span ui element
uiElement.is( 'uiElement', 'span' ); // -> same as above
text.is( 'element', 'span' ); -> false

See source

Parameters

type : 'uiElement' | 'view:uiElement'

Returns

this is ViewUIElement

`is( type ) → this is ViewRawElement`
inherited

module:engine/view/range~ViewRange#is:RAW_ELEMENT

Checks whether this object is of type ViewRawElement.

rawElement.is( 'rawElement' ); // -> true
rawElement.is( 'element' ); // -> true
rawElement.is( 'node' ); // -> true
rawElement.is( 'view:rawElement' ); // -> true
rawElement.is( 'view:element' ); // -> true
rawElement.is( 'view:node' ); // -> true

rawElement.is( 'model:element' ); // -> false
rawElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is a raw element, you can also check its name:

rawElement.is( 'img' ); // -> true if this is an img element
rawElement.is( 'rawElement', 'img' ); // -> same as above
text.is( 'img' ); -> false

See source

Parameters

type : 'rawElement' | 'view:rawElement'

Returns

this is ViewRawElement

`is( type ) → this is ViewEmptyElement`
inherited

module:engine/view/range~ViewRange#is:EMPTY_ELEMENT

Checks whether this object is of type ViewEmptyElement.

emptyElement.is( 'emptyElement' ); // -> true
emptyElement.is( 'element' ); // -> true
emptyElement.is( 'node' ); // -> true
emptyElement.is( 'view:emptyElement' ); // -> true
emptyElement.is( 'view:element' ); // -> true
emptyElement.is( 'view:node' ); // -> true

emptyElement.is( 'model:element' ); // -> false
emptyElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is an empty element, you can also check its name:

emptyElement.is( 'element', 'img' ); // -> true if this is a img element
emptyElement.is( 'emptyElement', 'img' ); // -> same as above
text.is( 'element', 'img' ); -> false

See source

Parameters

type : 'emptyElement' | 'view:emptyElement'

Returns

this is ViewEmptyElement

is( type ) → this is ViewRange
inherited
module:engine/view/range~ViewRange#is:RANGE
Checks whether this object is of type ViewRange.
```
range.is( 'range' ); // -> true
range.is( 'view:range' ); // -> true

range.is( 'model:range' ); // -> false
range.is( 'element' ); // -> false
range.is( 'selection' ); // -> false
```
Copy code
See source (with github icon)
Parameters
type : 'range' | 'view:range'
Returns
this is ViewRange
is( type ) → this is ViewDocumentSelection
inherited
module:engine/view/range~ViewRange#is:DOCUMENT_SELECTION
Checks whether this object is of type ViewDocumentSelection.
```
`docSelection.is( 'selection' ); // -> true
docSelection.is( 'documentSelection' ); // -> true
docSelection.is( 'view:selection' ); // -> true
docSelection.is( 'view:documentSelection' ); // -> true

docSelection.is( 'model:documentSelection' ); // -> false
docSelection.is( 'element' ); // -> false
docSelection.is( 'node' ); // -> false
```
Copy code
See source (with github icon)
Parameters
type : 'documentSelection' | 'view:documentSelection'
Returns
this is ViewDocumentSelection
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewAttributeElement and has the specified name.
See source (with github icon)
Type parameters
N : extends string
Parameters
type : 'attributeElement' | 'view:attributeElement'
name : N
Returns
boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewEditableElement or its subclass and has the specified name.
See source (with github icon)
Type parameters
N : extends string
Parameters
type : 'editableElement' | 'view:editableElement'
name : N
Returns
boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewRawElement and has the specified name.
See source (with github icon)
Type parameters
N : extends string
Parameters
type : 'rawElement' | 'view:rawElement'
name : N
Returns
boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewUIElement and has the specified name.
See source (with github icon)
Type parameters
N : extends string
Parameters
type : 'uiElement' | 'view:uiElement'
name : N
Returns
boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewRootEditableElement and has the specified name.
See source (with github icon)
Type parameters
N : extends string
Parameters
type : 'rootElement' | 'view:rootElement'
name : N
Returns
boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewEmptyElement has the specified name.
See source (with github icon)
Type parameters
N : extends string
Parameters
type : 'emptyElement' | 'view:emptyElement'
name : N
Returns
boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewContainerElement or its subclass and has the specified name.
See source (with github icon)
Type parameters
N : extends string
Parameters
type : 'containerElement' | 'view:containerElement'
name : N
Returns
boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewElement or its subclass and has the specified name.
See source (with github icon)
Type parameters
N : extends string
Parameters
type : 'element' | 'view:element'
name : N
Returns
boolean
is( type ) → this is ViewSelection | ViewDocumentSelection
inherited
module:engine/view/range~ViewRange#is:SELECTION
Checks whether this object is of type ViewSelection or ViewDocumentSelection.
```
selection.is( 'selection' ); // -> true
selection.is( 'view:selection' ); // -> true

selection.is( 'model:selection' ); // -> false
selection.is( 'element' ); // -> false
selection.is( 'range' ); // -> false
```
Copy code
See source (with github icon)
Parameters
type : 'selection' | 'view:selection'
Returns
this is ViewSelection | ViewDocumentSelection
is( type ) → this is ViewText | ViewNode | ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement
inherited
module:engine/view/range~ViewRange#is:NODE
Checks whether this object is of type ViewNode or its subclass.
This method is useful when processing view objects that are of unknown type. For example, a function may return a ViewDocumentFragment or a ViewNode that can be either a text node or an element. This method can be used to check what kind of object is returned.
```
someObject.is( 'element' ); // -> true if this is an element
someObject.is( 'node' ); // -> true if this is a node (a text node or an element)
someObject.is( 'documentFragment' ); // -> true if this is a document fragment
```
Copy code
Since this method is also available on a range of model objects, you can prefix the type of the object with model: or view: to check, for example, if this is the model's or view's element:
```
viewElement.is( 'view:element' ); // -> true
viewElement.is( 'model:element' ); // -> false
```
Copy code
By using this method it is also possible to check a name of an element:
```
imgElement.is( 'element', 'img' ); // -> true
imgElement.is( 'view:element', 'img' ); // -> same as above, but more precise
```
Copy code
See source (with github icon)
Parameters
type : 'node' | 'view:node'
Returns
this is ViewText | ViewNode | ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement
isEqual( otherRange ) → boolean

Two ranges are equal if their start and end positions are equal.
See source (with github icon)
Parameters
otherRange : ViewRange
Range to compare with.
Returns
boolean
true if ranges are equal, false otherwise
isIntersecting( otherRange ) → boolean

Checks and returns whether this range intersects with the given range.
See source (with github icon)
Parameters
otherRange : ViewRange
Range to compare with.
Returns
boolean
True if ranges intersect.
toJSON() → unknown

Converts ViewRange instance to plain object and returns it.
See source (with github icon)
Returns
unknown
ViewRange instance converted to plain object.

Static methods

_createFromParentsAndOffsets( startElement, startOffset, endElement, endOffset ) → ViewRange
internalstatic

Creates a range from the given parents and offsets.
See source (with github icon)
Parameters
startElement : ViewElement | ViewDocumentFragment
Start position parent element.
startOffset : number
Start position offset.
endElement : ViewElement | ViewDocumentFragment
End position parent element.
endOffset : number
End position offset.
Returns
ViewRange
Created range.
_createFromPositionAndShift( position, shift ) → ViewRange
internalstatic

Creates a new range, spreading from specified position to a position moved by given shift. If shift is a negative value, shifted position is treated as the beginning of the range.
See source (with github icon)
Parameters
position : ViewPosition
Beginning of the range.
shift : number
How long the range should be.
Returns
ViewRange
_createIn( element ) → ViewRange
internalstatic

Creates a range inside an element which starts before the first child of that element and ends after the last child of that element.
See source (with github icon)
Parameters
element : ViewElement | ViewDocumentFragment
Element which is a parent for the range.
Returns
ViewRange
_createOn( item ) → ViewRange
internalstatic

Creates a range that starts before given view item and ends after it.
See source (with github icon)
Parameters
item : ViewItem
Returns
ViewRange

ViewRange

Properties

end : ViewPositionreadonly

isCollapsed : booleanreadonly

isFlat : booleanreadonly

root : ViewNode | ViewDocumentFragmentreadonly

start : ViewPositionreadonly

Methods

constructor( start, end )

Parameters

Symbol.iterator() → IterableIterator<ViewTreeWalkerValue>

Returns

clone() → ViewRange

Returns

containsPosition( position ) → boolean

Parameters

Returns

containsRange( otherRange, loose ) → boolean

Parameters

Returns

getCommonAncestor() → null | ViewNode | ViewDocumentFragment

Returns

getContainedElement() → null | ViewElement

Returns

getDifference( otherRange ) → Array<ViewRange>

Parameters

Returns

getEnlarged() → ViewRange

Returns

getIntersection( otherRange ) → null | ViewRange

Parameters

Returns

getItems( options ) → IterableIterator<ViewItem>

Parameters

Returns

getPositions( options ) → IterableIterator<ViewPosition>

Parameters

Returns

getTrimmed() → ViewRange

Returns

getWalker( options ) → ViewTreeWalker

Parameters

Returns

is( type ) → this is ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElementinherited

Parameters

Returns

is( type ) → this is ViewContainerElement | ViewEditableElement | ViewRootEditableElementinherited

Parameters

Returns

is( type ) → this is ViewEditableElement | ViewRootEditableElementinherited

Parameters

Returns

is( type ) → this is ViewAttributeElementinherited

Parameters

Returns

is( type ) → this is ViewRootEditableElementinherited

Parameters

Returns

is( type ) → this is ViewTextProxyinherited

Parameters

Returns

is( type ) → this is ViewPositioninherited

Parameters

Returns

is( type ) → this is ViewDocumentFragmentinherited

Parameters

Returns

is( type ) → this is ViewTextinherited

Parameters

Returns

is( type ) → this is ViewUIElementinherited

Parameters

Returns

is( type ) → this is ViewRawElementinherited

Parameters

Returns

is( type ) → this is ViewEmptyElementinherited

Parameters

Returns

is( type ) → this is ViewRangeinherited

`end : ViewPosition`
readonly

`isCollapsed : boolean`
readonly

`isFlat : boolean`
readonly

`root : ViewNode | ViewDocumentFragment`
readonly

`start : ViewPosition`
readonly

`constructor( start, end )`

`Symbol.iterator() → IterableIterator<ViewTreeWalkerValue>`

`clone() → ViewRange`

`containsPosition( position ) → boolean`

`containsRange( otherRange, loose ) → boolean`

`getCommonAncestor() → null | ViewNode | ViewDocumentFragment`

`getContainedElement() → null | ViewElement`

`getDifference( otherRange ) → Array<ViewRange>`

`getEnlarged() → ViewRange`

`getIntersection( otherRange ) → null | ViewRange`

`getItems( options ) → IterableIterator<ViewItem>`

`getPositions( options ) → IterableIterator<ViewPosition>`

`getTrimmed() → ViewRange`

`getWalker( options ) → ViewTreeWalker`

`is( type ) → this is ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement`
inherited

`is( type ) → this is ViewContainerElement | ViewEditableElement | ViewRootEditableElement`
inherited

`is( type ) → this is ViewEditableElement | ViewRootEditableElement`
inherited

`is( type ) → this is ViewAttributeElement`
inherited

`is( type ) → this is ViewRootEditableElement`
inherited

`is( type ) → this is ViewTextProxy`
inherited

`is( type ) → this is ViewPosition`
inherited

`is( type ) → this is ViewDocumentFragment`
inherited

`is( type ) → this is ViewText`
inherited

`is( type ) → this is ViewUIElement`
inherited

`is( type ) → this is ViewRawElement`
inherited

`is( type ) → this is ViewEmptyElement`
inherited

`is( type ) → this is ViewRange`
inherited

`is( type ) → this is ViewDocumentSelection`
inherited

`is( type, name ) → boolean`
inherited

`is( type, name ) → boolean`
inherited

`is( type, name ) → boolean`
inherited

`is( type, name ) → boolean`
inherited

`is( type, name ) → boolean`
inherited

`is( type, name ) → boolean`
inherited

`is( type, name ) → boolean`
inherited

`is( type, name ) → boolean`
inherited

`is( type ) → this is ViewSelection | ViewDocumentSelection`
inherited

`is( type ) → this is ViewText | ViewNode | ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement`
inherited

`isEqual( otherRange ) → boolean`

`isIntersecting( otherRange ) → boolean`

`toJSON() → unknown`

`_createFromParentsAndOffsets( startElement, startOffset, endElement, endOffset ) → ViewRange`
internalstatic

`_createFromPositionAndShift( position, shift ) → ViewRange`
internalstatic

`_createIn( element ) → ViewRange`
internalstatic

`_createOn( item ) → ViewRange`
internalstatic