Class ViewRange

Range in the view tree. A range is represented by its start and end module:engine/view/position~ViewPosition positions.

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

module:engine/view/view~EditingView
module:engine/view/downcastwriter~ViewDowncastWriter
module:engine/view/upcastwriter~ViewUpcastWriter

Hierarchy (View Summary)

ViewTypeCheckable
- ViewRange

Implements

Iterable<ViewTreeWalkerValue>

Constructors

constructor

new ViewRange(start: ViewPosition, end?: ViewPosition): ViewRange
Creates a range spanning from start position to end position.

Note: Constructor creates it's own module:engine/view/position~ViewPosition instances basing on passed values.
Parameters
- start: ViewPosition
  Start position.
- Optionalend: ViewPosition
  End position. If not set, range will be collapsed at the start position.
Returns ViewRange
Overrides ViewTypeCheckable.constructor
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:41

Properties

`Readonly`end

end: ViewPosition

End position.

`Readonly`start

start: ViewPosition

Start position.

Accessors

isCollapsed

get isCollapsed(): boolean
Returns whether the range is collapsed, that is it start and end positions are equal.

Returns boolean
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:57

isFlat

get isFlat(): boolean
Returns whether this range is flat, that is if module:engine/view/range~ViewRange#start start position and module:engine/view/range~ViewRange#end end position are in the same module:engine/view/position~ViewPosition#parent parent.

Returns boolean
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:63

root

get root(): ViewDocumentFragment | ViewNode
Range root element.

Returns ViewDocumentFragment | ViewNode
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:67

Methods

[iterator]

"[iterator]"(): IterableIterator<ViewTreeWalkerValue>
Iterable interface.

Iterates over all module:engine/view/item~ViewItem view items that are in this range and returns them together with additional information like length or module:engine/view/position~ViewPosition positions, grouped as module:engine/view/treewalker~ViewTreeWalkerValue.

This iterator uses module:engine/view/treewalker~ViewTreeWalker TreeWalker with boundaries set to this range and ignoreElementEnd option set to true.

Returns IterableIterator<ViewTreeWalkerValue>
Implementation of Iterable.[iterator]
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:53

clone

clone(): ViewRange
Clones this range.

Returns ViewRange
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:212

containsPosition

containsPosition(position: ViewPosition): boolean
Checks whether this range contains given module:engine/view/position~ViewPosition position.
Parameters
- position: ViewPosition
  Position to check.
Returns boolean
true if given module:engine/view/position~ViewPosition position is contained in this range, false otherwise.
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:121

containsRange

containsRange(otherRange: ViewRange, loose?: boolean): boolean
Checks whether this range contains given module:engine/view/range~ViewRange range.
Parameters
- otherRange: ViewRange
  Range to check.
- Optionalloose: 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.
Returns boolean
true if given module:engine/view/range~ViewRange range boundaries are contained by this range, false otherwise.
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:132

getCommonAncestor

getCommonAncestor(): ViewDocumentFragment | ViewNode
Returns a module:engine/view/node~ViewNode or module:engine/view/documentfragment~ViewDocumentFragment which is a common ancestor of range's both ends (in which the entire range is contained).

Returns ViewDocumentFragment | ViewNode
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:202

getContainedElement

getContainedElement(): ViewElement
Returns an module:engine/view/element~ViewElement 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.

Returns ViewElement
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:208

getDifference

getDifference(otherRange: ViewRange): ViewRange[]

Computes which part(s) of this module:engine/view/range~ViewRange range is not a part of given module:engine/view/range~ViewRange range. Returned array contains zero, one or two module:engine/view/range~ViewRange 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 )

Parameters

otherRange: ViewRange
Range to differentiate against.

Returns ViewRange[]

The difference between ranges.

getEnlarged

getEnlarged(): ViewRange
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]
```
Note that in the sample above:
-  have type of module:engine/view/containerelement~ViewContainerElement,
-  have type of module:engine/view/attributeelement~ViewAttributeElement,
-  have type of module:engine/view/uielement~ViewUIElement.
Returns ViewRange
Enlarged range.
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:87

getIntersection

getIntersection(otherRange: ViewRange): ViewRange

Returns an intersection of this module:engine/view/range~ViewRange range and given module:engine/view/range~ViewRange 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.

Parameters

otherRange: ViewRange
Range to check for intersection.

Returns ViewRange

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

getItems

getItems(options?: ViewTreeWalkerOptions): IterableIterator<ViewItem>
Returns an iterator that iterates over all module:engine/view/item~ViewItem view items that are in this range and returns them.

This method uses module:engine/view/treewalker~ViewTreeWalker with boundaries set to this range and ignoreElementEnd option set to true. However it returns only module:engine/view/item~ViewItem items, not module:engine/view/treewalker~ViewTreeWalkerValue.

You may specify additional options for the tree walker. See module:engine/view/treewalker~ViewTreeWalker for a full list of available options.
Parameters
- Optionaloptions: ViewTreeWalkerOptions
 Object with configuration options. See module:engine/view/treewalker~ViewTreeWalker.
Returns IterableIterator<ViewItem>
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:226

getPositions

getPositions(options?: ViewTreeWalkerOptions): IterableIterator<ViewPosition>
Returns an iterator that iterates over all module:engine/view/position~ViewPosition positions that are boundaries or contained in this range.

This method uses module:engine/view/treewalker~ViewTreeWalker with boundaries set to this range. However it returns only module:engine/view/position~ViewPosition positions, not module:engine/view/treewalker~ViewTreeWalkerValue.

You may specify additional options for the tree walker. See module:engine/view/treewalker~ViewTreeWalker for a full list of available options.
Parameters
- Optionaloptions: ViewTreeWalkerOptions
 Object with configuration options. See module:engine/view/treewalker~ViewTreeWalker.
Returns IterableIterator<ViewPosition>
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:239

getTrimmed

getTrimmed(): ViewRange
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}
```
Note that in the sample above:
-  have type of module:engine/view/containerelement~ViewContainerElement,
-  have type of module:engine/view/attributeelement~ViewAttributeElement,
-  have type of module:engine/view/uielement~ViewUIElement.
Returns ViewRange
Shrunk range.
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:107

getWalker

getWalker(options?: ViewTreeWalkerOptions): ViewTreeWalker
Creates a module:engine/view/treewalker~ViewTreeWalker TreeWalker instance with this range as a boundary.
Parameters
- Optionaloptions: ViewTreeWalkerOptions
  Object with configuration options. See module:engine/view/treewalker~ViewTreeWalker.
Returns ViewTreeWalker
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:197

is

is(
    type: "node" | "view:node",
): this is
    | ViewElement
    | ViewNode
    | ViewRootEditableElement
    | ViewText
    | ViewAttributeElement
    | ViewContainerElement
    | ViewEditableElement
    | ViewEmptyElement
    | ViewRawElement
    | ViewUIElement
Checks whether this object is of type module:engine/view/node~ViewNode or its subclass.

This method is useful when processing view objects that are of unknown type. For example, a function may return a module:engine/view/documentfragment~ViewDocumentFragment or a module:engine/view/node~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
```
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
```
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
```
Parameters
- type: "node" | "view:node"
Returns this is
    | ViewElement
    | ViewNode
    | ViewRootEditableElement
    | ViewText
    | ViewAttributeElement
    | ViewContainerElement
    | ViewEditableElement
    | ViewEmptyElement
    | ViewRawElement
    | ViewUIElement
Label
NODE
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:54
is(
 type: "element" | "view:element",
): this is
 | ViewElement
 | ViewRootEditableElement
 | ViewAttributeElement
 | ViewContainerElement
 | ViewEditableElement
 | ViewEmptyElement
 | ViewRawElement
 | ViewUIElement
Checks whether this object is of type module:engine/view/element~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
```
Assuming that the object being checked is an element, you can also check its module:engine/view/element~ViewElement#name name:
```
element.is( 'element', 'img' ); // -> true if this is an <img> element
text.is( 'element', 'img' ); -> false
```
Parameters
- type: "element" | "view:element"
Returns this is
 | ViewElement
 | ViewRootEditableElement
 | ViewAttributeElement
 | ViewContainerElement
 | ViewEditableElement
 | ViewEmptyElement
 | ViewRawElement
 | ViewUIElement
Label
ELEMENT
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:78

is(
type: "attributeElement" | "view:attributeElement",
): this is ViewAttributeElement

Checks whether this object is of type module:engine/view/attributeelement~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 module:engine/view/attributeelement~ViewAttributeElement#name name:

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

Parameters

type: "attributeElement" | "view:attributeElement"

Returns this is ViewAttributeElement

Label

ATTRIBUTE_ELEMENT

is(
    type: "containerElement" | "view:containerElement",
): this is
    | ViewRootEditableElement
    | ViewContainerElement
    | ViewEditableElement
Checks whether this object is of type module:engine/view/containerelement~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 module:engine/view/containerelement~ViewContainerElement#name 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
```
Parameters
- type: "containerElement" | "view:containerElement"
Returns this is ViewRootEditableElement | ViewContainerElement | ViewEditableElement
Label
CONTAINER_ELEMENT
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:132

is(
type: "editableElement" | "view:editableElement",
): this is ViewRootEditableElement | ViewEditableElement

Checks whether this object is of type module:engine/view/editableelement~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 module:engine/view/editableelement~ViewEditableElement#name name:

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

Parameters

type: "editableElement" | "view:editableElement"

Returns this is ViewRootEditableElement | ViewEditableElement

Label

EDITABLE_ELEMENT

is(type: "emptyElement" | "view:emptyElement"): this is ViewEmptyElement

Checks whether this object is of type module:engine/view/emptyelement~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 module:engine/view/emptyelement~ViewEmptyElement#name name:

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

Parameters

type: "emptyElement" | "view:emptyElement"

Returns this is ViewEmptyElement

Label

EMPTY_ELEMENT

is(type: "rawElement" | "view:rawElement"): this is ViewRawElement

Checks whether this object is of type module:engine/view/rawelement~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 module:engine/view/rawelement~ViewRawElement#name name:

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

Parameters

type: "rawElement" | "view:rawElement"

Returns this is ViewRawElement

Label

RAW_ELEMENT

is(type: "rootElement" | "view:rootElement"): this is ViewRootEditableElement

Checks whether this object is of type module:engine/view/rooteditableelement~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 module:engine/view/rooteditableelement~ViewRootEditableElement#name 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

Parameters

type: "rootElement" | "view:rootElement"

Returns this is ViewRootEditableElement

Label

ROOT_ELEMENT

is(type: "uiElement" | "view:uiElement"): this is ViewUIElement

Checks whether this object is of type module:engine/view/uielement~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 module:engine/view/uielement~ViewUIElement#name 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

Parameters

type: "uiElement" | "view:uiElement"

Returns this is ViewUIElement

Label

UI_ELEMENT

is(type: "$text" | "view:$text"): this is ViewText
Checks whether this object is of type module:engine/view/text~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
```
Parameters
- type: "$text" | "view:$text"
Returns this is ViewText
Label
TEXT
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:285
is(
type: "documentFragment" | "view:documentFragment",
): this is ViewDocumentFragment
hecks whether this object is of type module:engine/view/documentfragment~ViewDocumentFragment.
```
docFrag.is( 'documentFragment' ); // -> true
docFrag.is( 'view:documentFragment' ); // -> true

docFrag.is( 'model:documentFragment' ); // -> false
docFrag.is( 'element' ); // -> false
docFrag.is( 'node' ); // -> false
```
Parameters
- type: "documentFragment" | "view:documentFragment"
Returns this is ViewDocumentFragment
Label
DOCUMENT_FRAGMENT
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:300
is(type: "$textProxy" | "view:$textProxy"): this is ViewTextProxy
Checks whether this object is of type module:engine/view/textproxy~ViewTextProxy.
```
textProxy.is( '$textProxy' ); // -> true
textProxy.is( 'view:$textProxy' ); // -> true

textProxy.is( 'model:$textProxy' ); // -> false
textProxy.is( 'element' ); // -> false
textProxy.is( 'range' ); // -> false
```
Note: Until version 20.0.0 this method wasn't accepting '$textProxy' type. The legacy 'textProxy' type is still accepted for backward compatibility.
Parameters
- type: "$textProxy" | "view:$textProxy"
Returns this is ViewTextProxy
Label
TEXT_PROXY
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:318
is(type: "position" | "view:position"): this is ViewPosition
Checks whether this object is of type module:engine/view/position~ViewPosition.
```
position.is( 'position' ); // -> true
position.is( 'view:position' ); // -> true

position.is( 'model:position' ); // -> false
position.is( 'element' ); // -> false
position.is( 'range' ); // -> false
```
Parameters
- type: "position" | "view:position"
Returns this is ViewPosition
Label
POSITION
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:333
is(type: "range" | "view:range"): this is ViewRange
Checks whether this object is of type module:engine/view/range~ViewRange.
```
range.is( 'range' ); // -> true
range.is( 'view:range' ); // -> true

range.is( 'model:range' ); // -> false
range.is( 'element' ); // -> false
range.is( 'selection' ); // -> false
```
Parameters
- type: "range" | "view:range"
Returns this is ViewRange
Label
RANGE
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:348
is(
type: "selection" | "view:selection",
): this is ViewDocumentSelection | ViewSelection
Checks whether this object is of type module:engine/view/selection~ViewSelection or module:engine/view/documentselection~ViewDocumentSelection.
```
selection.is( 'selection' ); // -> true
selection.is( 'view:selection' ); // -> true

selection.is( 'model:selection' ); // -> false
selection.is( 'element' ); // -> false
selection.is( 'range' ); // -> false
```
Parameters
- type: "selection" | "view:selection"
Returns this is ViewDocumentSelection | ViewSelection
Label
SELECTION
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:364
is(
type: "documentSelection" | "view:documentSelection",
): this is ViewDocumentSelection
Checks whether this object is of type module:engine/view/documentselection~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
```
Parameters
- type: "documentSelection" | "view:documentSelection"
Returns this is ViewDocumentSelection
Label
DOCUMENT_SELECTION
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:381
is<N extends string>(
 type: "element" | "view:element",
 name: N,
): this is (
 | ViewElement
 | ViewRootEditableElement
 | ViewAttributeElement
 | ViewContainerElement
 | ViewEditableElement
 | ViewEmptyElement
 | ViewRawElement
 | ViewUIElement
) & { name: N }
Checks whether the object is of type module:engine/view/element~ViewElement or its subclass and has the specified name.
Type Parameters
- N extends string
Parameters
- type: "element" | "view:element"
- name: N
Returns this is (
 | ViewElement
 | ViewRootEditableElement
 | ViewAttributeElement
 | ViewContainerElement
 | ViewEditableElement
 | ViewEmptyElement
 | ViewRawElement
 | ViewUIElement
) & { name: N }
Label
ELEMENT_NAME
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:387
is<N extends string>(
type: "attributeElement" | "view:attributeElement",
name: N,
): this is ViewAttributeElement & { name: N }
Checks whether the object is of type module:engine/view/attributeelement~ViewAttributeElement and has the specified name.
Type Parameters
- N extends string
Parameters
- type: "attributeElement" | "view:attributeElement"
- name: N
Returns this is ViewAttributeElement & { name: N }
Label
ATTRIBUTE_ELEMENT_NAME
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:395
is<N extends string>(
 type: "containerElement" | "view:containerElement",
 name: N,
): this is (
 ViewRootEditableElement
 | ViewContainerElement
 | ViewEditableElement
) & { name: N }
Checks whether the object is of type module:engine/view/containerelement~ViewContainerElement or its subclass and has the specified name.
Type Parameters
- N extends string
Parameters
- type: "containerElement" | "view:containerElement"
- name: N
Returns this is (ViewRootEditableElement | ViewContainerElement | ViewEditableElement) & {
name: N;
}
Label
CONTAINER_ELEMENT_NAME
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:404
is<N extends string>(
type: "editableElement" | "view:editableElement",
name: N,
): this is (ViewRootEditableElement | ViewEditableElement) & { name: N }
Checks whether the object is of type module:engine/view/editableelement~ViewEditableElement or its subclass and has the specified name.
Type Parameters
- N extends string
Parameters
- type: "editableElement" | "view:editableElement"
- name: N
Returns this is (ViewRootEditableElement | ViewEditableElement) & { name: N }
Label
EDITABLE_ELEMENT_NAME
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:413
is<N extends string>(
type: "emptyElement" | "view:emptyElement",
name: N,
): this is ViewEmptyElement & { name: N }
Checks whether the object is of type module:engine/view/emptyelement~ViewEmptyElement has the specified name.
Type Parameters
- N extends string
Parameters
- type: "emptyElement" | "view:emptyElement"
- name: N
Returns this is ViewEmptyElement & { name: N }
Label
EMPTY_ELEMENT_NAME
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:421
is<N extends string>(
type: "rawElement" | "view:rawElement",
name: N,
): this is ViewRawElement & { name: N }
Checks whether the object is of type module:engine/view/rawelement~ViewRawElement and has the specified name.
Type Parameters
- N extends string
Parameters
- type: "rawElement" | "view:rawElement"
- name: N
Returns this is ViewRawElement & { name: N }
Label
RAW_ELEMENT_NAME
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:429
is<N extends string>(
type: "rootElement" | "view:rootElement",
name: N,
): this is ViewRootEditableElement & { name: N }
Checks whether the object is of type module:engine/view/rooteditableelement~ViewRootEditableElement and has the specified name.
Type Parameters
- N extends string
Parameters
- type: "rootElement" | "view:rootElement"
- name: N
Returns this is ViewRootEditableElement & { name: N }
Label
ROOT_ELEMENT_NAME
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:438
is<N extends string>(
type: "uiElement" | "view:uiElement",
name: N,
): this is ViewUIElement & { name: N }
Checks whether the object is of type module:engine/view/uielement~ViewUIElement and has the specified name.
Type Parameters
- N extends string
Parameters
- type: "uiElement" | "view:uiElement"
- name: N
Returns this is ViewUIElement & { name: N }
Label
UI_ELEMENT_NAME
Inherited from ViewTypeCheckable.is
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/typecheckable.d.ts:446

isEqual

isEqual(otherRange: ViewRange): boolean
Two ranges are equal if their start and end positions are equal.
Parameters
- otherRange: ViewRange
  Range to compare with.
Returns boolean
true if ranges are equal, false otherwise
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:114

isIntersecting

isIntersecting(otherRange: ViewRange): boolean
Checks and returns whether this range intersects with the given range.
Parameters
- otherRange: ViewRange
  Range to compare with.
Returns boolean
True if ranges intersect.
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:246

toJSON

toJSON(): unknown
Converts ViewRange instance to plain object and returns it.

Returns unknown
ViewRange instance converted to plain object.
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:252

`Static`_createFromParentsAndOffsets

_createFromParentsAndOffsets(
    startElement: ViewDocumentFragment | ViewElement,
    startOffset: number,
    endElement: ViewDocumentFragment | ViewElement,
    endOffset: number,
): ViewRange
Internal
Creates a range from the given parents and offsets.
Parameters
- startElement: ViewDocumentFragment | ViewElement
  Start position parent element.
- startOffset: number
  Start position offset.
- endElement: ViewDocumentFragment | ViewElement
  End position parent element.
- endOffset: number
  End position offset.
Returns ViewRange
Created range.
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:263

`Static`_createFromPositionAndShift

_createFromPositionAndShift(position: ViewPosition, shift: number): ViewRange
Internal
Creates a new range, spreading from specified module:engine/view/position~ViewPosition position to a position moved by given shift. If shift is a negative value, shifted position is treated as the beginning of the range.
Parameters
- position: ViewPosition
  Beginning of the range.
- shift: number
  How long the range should be.
Returns ViewRange
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:272

`Static`_createIn

_createIn(element: ViewDocumentFragment | ViewElement): ViewRange
Internal
Creates a range inside an module:engine/view/element~ViewElement element which starts before the first child of that element and ends after the last child of that element.
Parameters
- element: ViewDocumentFragment | ViewElement
  Element which is a parent for the range.
Returns ViewRange
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:280

`Static`_createOn

_createOn(item: ViewItem): ViewRange
Internal
Creates a range that starts before given module:engine/view/item~ViewItem view item and ends after it.
Parameters
- item: ViewItem
Returns ViewRange
- Defined in node_modules/@ckeditor/ckeditor5-engine/src/view/range.d.ts:286

Class ViewRange

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ViewRange

Properties

Readonlyend

Readonlystart

Accessors

isCollapsed

Returns boolean

isFlat

Returns boolean

root

Returns ViewDocumentFragment | ViewNode

Methods

[iterator]

Returns IterableIterator<ViewTreeWalkerValue>

clone

Returns ViewRange

containsPosition

Parameters

Returns boolean

containsRange

Parameters

Returns boolean

getCommonAncestor

Returns ViewDocumentFragment | ViewNode

getContainedElement

Returns ViewElement

getDifference

Parameters

Returns ViewRange[]

getEnlarged

Returns ViewRange

getIntersection

Parameters

Returns ViewRange

getItems

Parameters

Returns IterableIterator<ViewItem>

getPositions

Parameters

Returns IterableIterator<ViewPosition>

getTrimmed

Returns ViewRange

getWalker

Parameters

Returns ViewTreeWalker

is

Parameters

Returns this is | ViewElement | ViewNode | ViewRootEditableElement | ViewText | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewUIElement

Label

Parameters

Returns this is | ViewElement | ViewRootEditableElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewUIElement

Label

Parameters

Returns this is ViewAttributeElement

Label

Parameters

Returns this is ViewRootEditableElement | ViewContainerElement | ViewEditableElement

Label

Parameters

Returns this is ViewRootEditableElement | ViewEditableElement

Label

Parameters

Returns this is ViewEmptyElement

Label

Parameters

Returns this is ViewRawElement

Label

Parameters

Returns this is ViewRootEditableElement

`Readonly`end

`Readonly`start

Returns this is
| ViewElement
| ViewNode
| ViewRootEditableElement
| ViewText
| ViewAttributeElement
| ViewContainerElement
| ViewEditableElement
| ViewEmptyElement
| ViewRawElement
| ViewUIElement

Returns this is
| ViewElement
| ViewRootEditableElement
| ViewAttributeElement
| ViewContainerElement
| ViewEditableElement
| ViewEmptyElement
| ViewRawElement
| ViewUIElement

Returns this is (
| ViewElement
| ViewRootEditableElement
| ViewAttributeElement
| ViewContainerElement
| ViewEditableElement
| ViewEmptyElement
| ViewRawElement
| ViewUIElement
) & { name: N }

Returns this is (ViewRootEditableElement | ViewContainerElement | ViewEditableElement) & {
name: N;
}

`Static`_createFromParentsAndOffsets

`Static`_createFromPositionAndShift