ViewNode

The document instance to which this node belongs.

Index of the node in the parent element or null if the node has no parent.

Accessing this property throws an error if this node's parent element does not contain it. This means that view tree got broken.

Node's next sibling, or null if it is the last child.

Parent element. Null by default. Set by _insertChild.

Node's previous sibling, or null if it is the first child.

Top-most ancestor of the node. If the node has no parent it is the root itself.

Creates a tree view node.

Parameters

document : ViewDocument

The document instance to which this node belongs.

Delegates selected events to another Emitter. For instance:

emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );

then eventX is delegated (fired by) emitterB and emitterC along with data:

emitterA.fire( 'eventX', data );

and eventY is delegated (fired by) emitterC along with data:

emitterA.fire( 'eventY', data );

Parameters

events : Array<string>

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain

Fires an event, executing all callbacks registered for it.

The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

Type parameters

TEvent : extends BaseEvent

The type describing the event. See BaseEvent.

Parameters

eventOrInfo : GetNameOrEventInfo<TEvent>

The name of the event or EventInfo object if event is delegated.

args : TEvent[ 'args' ]

Additional arguments to be passed to the callbacks.

Returns

GetEventInfo<TEvent>[ 'return' ]

By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).

Returns ancestors array of this node.

Parameters

options : object

Options object.

Properties

[ options.includeSelf ] : boolean

When set to true this node will be also included in parent's array.

[ options.parentFirst ] : boolean

When set to true, array will be sorted from node's parent to root element, otherwise root element will be the first item in the array.

Defaults to {}

Returns

Array<ViewNode | ViewDocumentFragment>

Array with ancestors.

Returns a ViewElement or ViewDocumentFragment which is a common ancestor of both nodes.

Parameters

node : ViewNode

The second node.

options : object

Options object.

Properties

[ options.includeSelf ] : boolean

When set to true both nodes will be considered "ancestors" too. Which means that if e.g. node A is inside B, then their common ancestor will be B.

Defaults to {}

Returns

null | ViewElement | ViewDocumentFragment

Gets a path to the node. The path is an array containing indices of consecutive ancestors of this node, beginning from root, down to this node's index.

const abc = downcastWriter.createText( 'abc' );
const foo = downcastWriter.createText( 'foo' );
const h1 = downcastWriter.createElement( 'h1', null, downcastWriter.createText( 'header' ) );
const p = downcastWriter.createElement( 'p', null, [ abc, foo ] );
const div = downcastWriter.createElement( 'div', null, [ h1, p ] );
foo.getPath(); // Returns [ 1, 3 ]. `foo` is in `p` which is in `div`. `p` starts at offset 1, while `foo` at 3.
h1.getPath(); // Returns [ 0 ].
div.getPath(); // Returns [].

Returns

Array<number>

The path.

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

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

Parameters

type : 'element' | 'view:element'

Returns

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

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

Parameters

type : 'attributeElement' | 'view:attributeElement'

Returns

this is ViewAttributeElement

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

Parameters

type : 'containerElement' | 'view:containerElement'

Returns

this is ViewContainerElement | ViewEditableElement | ViewRootEditableElement

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

Parameters

type : 'rootElement' | 'view:rootElement'

Returns

this is ViewRootEditableElement

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

Parameters

type : 'uiElement' | 'view:uiElement'

Returns

this is ViewUIElement

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

Parameters

type : 'rawElement' | 'view:rawElement'

Returns

this is ViewRawElement

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

Parameters

type : 'emptyElement' | 'view:emptyElement'

Returns

this is ViewEmptyElement

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

Parameters

type : 'editableElement' | 'view:editableElement'

Returns

this is ViewEditableElement | ViewRootEditableElement

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

Parameters

type : '$text' | 'view:$text'

Returns

this is ViewText

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

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

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

Parameters

type : 'range' | 'view:range'

Returns

this is ViewRange

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

Parameters

type : 'documentSelection' | 'view:documentSelection'

Returns

this is ViewDocumentSelection

Checks whether the object is of type ViewAttributeElement and has the specified name.

Type parameters

N : extends string

Parameters

type : 'attributeElement' | 'view:attributeElement'

name : N

Returns

boolean

Checks whether the object is of type ViewEditableElement or its subclass and has the specified name.

Type parameters

N : extends string

Parameters

type : 'editableElement' | 'view:editableElement'

name : N

Returns

boolean

Checks whether the object is of type ViewRawElement and has the specified name.

Type parameters

N : extends string

Parameters

type : 'rawElement' | 'view:rawElement'

name : N

Returns

boolean

Checks whether the object is of type ViewUIElement and has the specified name.

Type parameters

N : extends string

Parameters

type : 'uiElement' | 'view:uiElement'

name : N

Returns

boolean

Checks whether the object is of type ViewRootEditableElement and has the specified name.

Type parameters

N : extends string

Parameters

type : 'rootElement' | 'view:rootElement'

name : N

Returns

boolean

Checks whether the object is of type ViewEmptyElement has the specified name.

Type parameters

N : extends string

Parameters

type : 'emptyElement' | 'view:emptyElement'

name : N

Returns

boolean

Checks whether the object is of type ViewContainerElement or its subclass and has the specified name.

Type parameters

N : extends string

Parameters

type : 'containerElement' | 'view:containerElement'

name : N

Returns

boolean

Checks whether the object is of type ViewElement or its subclass and has the specified name.

Type parameters

N : extends string

Parameters

type : 'element' | 'view:element'

name : N

Returns

boolean

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

Parameters

type : 'selection' | 'view:selection'

Returns

this is ViewSelection | ViewDocumentSelection

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

Parameters

type : 'position' | 'view:position'

Returns

this is ViewPosition

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

Parameters

type : 'documentFragment' | 'view:documentFragment'

Returns

this is ViewDocumentFragment

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

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 ViewText | ViewNode | ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement

Returns whether this node is after given node. false is returned if nodes are in different trees (for example, in different ViewDocumentFragments).

Parameters

node : ViewNode

Node to compare with.

Returns

boolean

Returns true if the node is in a tree rooted in the document (is a descendant of one of its roots).

Returns

boolean

Returns whether this node is before given node. false is returned if nodes are in different trees (for example, in different ViewDocumentFragments).

Parameters

node : ViewNode

Node to compare with.

Returns

boolean

Checks if provided node is similar to this node.

Parameters

other : ViewNode

Returns

boolean

True if nodes are similar.

Registers a callback function to be executed when an event is fired in a specific (emitter) object.

Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.

// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );

An event callback can stop the event and set the return value of the fire method.

Type parameters

TEvent : extends BaseEvent

The type describing the event. See BaseEvent.

Parameters

emitter : Emitter

The object that fires the event.

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void

Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

Parameters

event : string

The name of the event.

callback : Function

The function to stop being called.

Returns

void

Registers a callback function to be executed when an event is fired.

Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).

Type parameters

TEvent : extends BaseEvent

The type descibing the event. See BaseEvent.

Parameters

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void

Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

Type parameters

TEvent : extends BaseEvent

The type descibing the event. See BaseEvent.

Parameters

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void

Stops delegating events. It can be used at different levels:

• To stop delegating all events.
• To stop delegating a specific event to all emitters.
• To stop delegating a specific event to a specific emitter.

Parameters

[ event ] : string

The name of the event to stop delegating. If omitted, stops it all delegations.

[ emitter ] : Emitter

(requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.

Returns

void

Stops listening for events. It can be used at different levels:

• To stop listening to a specific callback.
• To stop listening to a specific event.
• To stop listening to all events fired by a specific object.
• To stop listening to all events fired by all objects.

Parameters

[ emitter ] : Emitter

The object to stop listening to. If omitted, stops it for all objects.

[ event ] : string

(Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

[ callback ] : Function

(Requires the event) The function to be removed from the call list for the given event.

Returns

void

Converts ViewNode to plain object and returns it.

Returns

unknown

ViewNode converted to plain object.

Clones this node.

Parameters

[ deep ] : boolean

Returns

ViewNode

Clone of this node.

Parameters

type : ViewDocumentChangeType

Type of the change.

node : ViewNode

Changed node.

[ data ] : object

Additional data.

Properties

data.index : number

Returns

void

Fires

• change

Removes node from parent.

Returns

void

Fired when list of elements children, attributes or text changes.

Change event is bubbled – it is fired on all ancestors.

All change events as the first parameter receive the node that has changed (the node for which children, attributes or text changed).

If change:children event is fired, there is an additional second parameter, which is an object with additional data related to change.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

changedNode : ViewNode

[ data ] : object

Fired when list of elements children, attributes or text changes.

Change event is bubbled – it is fired on all ancestors.

All change events as the first parameter receive the node that has changed (the node for which children, attributes or text changed).

If change:children event is fired, there is an additional second parameter, which is an object with additional data related to change.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

changedNode : ViewNode

[ data ] : object

Fired when list of elements children, attributes or text changes.

Change event is bubbled – it is fired on all ancestors.

All change events as the first parameter receive the node that has changed (the node for which children, attributes or text changed).

If change:children event is fired, there is an additional second parameter, which is an object with additional data related to change.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

changedNode : ViewNode

[ data ] : object

Fired when list of elements children, attributes or text changes.

Change event is bubbled – it is fired on all ancestors.

All change events as the first parameter receive the node that has changed (the node for which children, attributes or text changed).

If change:children event is fired, there is an additional second parameter, which is an object with additional data related to change.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

changedNode : ViewNode

[ data ] : object