ViewNode (engine/view)

@ckeditor/ckeditor5-engine/src/view/node

class

Abstract view node class.

This is an abstract class. Its constructor should not be used directly. Use the ViewDowncastWriter or ViewUpcastWriter to create new instances of view nodes.

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Properties

readonly
document : ViewDocument

See source
The document instance to which this node belongs.
readonly
index : null | number

See source
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.
readonly
nextSibling : null | ViewNode

See source
Node's next sibling, or null if it is the last child.
readonly
parent : null | ViewElement | ViewDocumentFragment

See source
Parent element. Null by default. Set by _insertChild.
readonly
previousSibling : null | ViewNode

See source
Node's previous sibling, or null if it is the first child.
readonly
root : ViewElement | ViewDocumentFragment

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

Methods

protected
constructor( document )

See source
Creates a tree view node.

Parameters

document : ViewDocument

The document instance to which this node belongs.
inherited
delegate( events ) → EmitterMixinDelegateChain
See source
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
inherited
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]

See source
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).
getAncestors( options = { [options.includeSelf], [options.parentFirst] } ) → Array<ViewNode | ViewDocumentFragment>

See source
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.
getCommonAncestor( node, options = { [options.includeSelf] } ) → null | ViewElement | ViewDocumentFragment

See source
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

`getPath() → Array<number>`

See source

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.

inherited
is( type ) → this is ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement
See source
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

inherited
`is( type ) → this is ViewAttributeElement`

See source

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

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

See source

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

inherited
`is( type ) → this is ViewRootEditableElement`

See source

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

inherited
`is( type ) → this is ViewUIElement`

See source

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

inherited
`is( type ) → this is ViewRawElement`

See source

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

inherited
`is( type ) → this is ViewEmptyElement`

See source

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

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

See source

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

inherited
`is( type ) → this is ViewText`

See source

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

inherited
is( type ) → this is ViewTextProxy
See source
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
inherited
is( type ) → this is ViewRange
See source
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

inherited
`is( type ) → this is ViewDocumentSelection`

See source

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

inherited
is( type, name ) → boolean

See source
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
inherited
is( type, name ) → boolean

See source
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
inherited
is( type, name ) → boolean

See source
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
inherited
is( type, name ) → boolean

See source
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
inherited
is( type, name ) → boolean

See source
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
inherited
is( type, name ) → boolean

See source
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
inherited
is( type, name ) → boolean

See source
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
inherited
is( type, name ) → boolean

See source
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
inherited
is( type ) → this is ViewSelection | ViewDocumentSelection
See source
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
inherited
is( type ) → this is ViewPosition
See source
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
inherited
is( type ) → this is ViewDocumentFragment
See source
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
inherited
is( type ) → this is ViewText | ViewNode | ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement
See source
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
isAfter( node ) → boolean

See source
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
isAttached() → boolean

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

Returns

boolean
isBefore( node ) → boolean

See source
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
isSimilar( other ) → boolean

See source
Checks if provided node is similar to this node.

Parameters

other : ViewNode

Returns

boolean

True if nodes are similar.
inherited
listenTo( emitter, event, callback, [ options ] ) → void
See source
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
inherited
off( event, callback ) → void

See source
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
inherited
on( event, callback, [ options ] ) → void

See source
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
inherited
once( event, callback, [ options ] ) → void

See source
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
inherited
stopDelegating( [ event ], [ emitter ] ) → void
See source
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
inherited
stopListening( [ emitter ], [ event ], [ callback ] ) → void
See source
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
toJSON() → unknown

See source
Custom toJSON method to solve child-parent circular dependencies.

Returns

unknown

Clone of this object with the parent property removed.
internal
_clone( [ deep ] ) → ViewNode

See source
Clones this node.

Parameters

[ deep ] : boolean

Returns

ViewNode

Clone of this node.
internal
_fireChange( type, node, [ data ] = { data.index } ) → void
See source

Parameters

type : ViewDocumentChangeType

Type of the change.

node : ViewNode

Changed node.

[ data ] : object

Additional data.

Properties

data.index : number

Returns

void

Fires
- change
internal
_remove() → void

See source
Removes node from parent.

Returns

void

Events

change( eventInfo, changedNode, [ data ] )

See source
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
change:attributes( eventInfo, changedNode, [ data ] )

See source
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
change:children( eventInfo, changedNode, [ data ] )

See source
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
change:text( eventInfo, changedNode, [ data ] )

See source
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

Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.

With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.

ViewNode (engine/view)

Filtering

Properties

readonly document : ViewDocumentmodule:engine/view/node~ViewNode#document

readonly index : null | numbermodule:engine/view/node~ViewNode#index

readonly nextSibling : null | ViewNodemodule:engine/view/node~ViewNode#nextSibling

readonly parent : null | ViewElement | ViewDocumentFragmentmodule:engine/view/node~ViewNode#parent

readonly previousSibling : null | ViewNodemodule:engine/view/node~ViewNode#previousSibling

readonly root : ViewElement | ViewDocumentFragmentmodule:engine/view/node~ViewNode#root

Methods

protected constructor( document )module:engine/view/node~ViewNode#constructor

Parameters

inherited delegate( events ) → EmitterMixinDelegateChainmodule:engine/view/node~ViewNode#delegate

Parameters

Returns

inherited fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]module:engine/view/node~ViewNode#fire

Type parameters

Parameters

Returns

getAncestors( options = { [options.includeSelf], [options.parentFirst] } ) → Array<ViewNode | ViewDocumentFragment>module:engine/view/node~ViewNode#getAncestors

Parameters

Returns

getCommonAncestor( node, options = { [options.includeSelf] } ) → null | ViewElement | ViewDocumentFragmentmodule:engine/view/node~ViewNode#getCommonAncestor

Parameters

Returns

getPath() → Array<number>module:engine/view/node~ViewNode#getPath

Returns

inherited is( type ) → this is ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElementmodule:engine/view/node~ViewNode#is:ELEMENT

Parameters

Returns

inherited is( type ) → this is ViewAttributeElementmodule:engine/view/node~ViewNode#is:ATTRIBUTE_ELEMENT

Parameters

Returns

inherited is( type ) → this is ViewContainerElement | ViewEditableElement | ViewRootEditableElementmodule:engine/view/node~ViewNode#is:CONTAINER_ELEMENT

Parameters

Returns

inherited is( type ) → this is ViewRootEditableElementmodule:engine/view/node~ViewNode#is:ROOT_ELEMENT

Parameters

Returns

inherited is( type ) → this is ViewUIElementmodule:engine/view/node~ViewNode#is:UI_ELEMENT

Parameters

Returns

inherited is( type ) → this is ViewRawElementmodule:engine/view/node~ViewNode#is:RAW_ELEMENT

Parameters

Returns

inherited is( type ) → this is ViewEmptyElementmodule:engine/view/node~ViewNode#is:EMPTY_ELEMENT

Parameters

Returns

inherited is( type ) → this is ViewEditableElement | ViewRootEditableElementmodule:engine/view/node~ViewNode#is:EDITABLE_ELEMENT

Parameters

Returns

inherited is( type ) → this is ViewTextmodule:engine/view/node~ViewNode#is:TEXT

Parameters

Returns

inherited is( type ) → this is ViewTextProxymodule:engine/view/node~ViewNode#is:TEXT_PROXY

Parameters

Returns

inherited is( type ) → this is ViewRangemodule:engine/view/node~ViewNode#is:RANGE

Parameters

Returns

inherited is( type ) → this is ViewDocumentSelectionmodule:engine/view/node~ViewNode#is:DOCUMENT_SELECTION

Parameters

Returns

inherited is( type, name ) → booleanmodule:engine/view/node~ViewNode#is:ATTRIBUTE_ELEMENT_NAME

Type parameters

Parameters

Returns

inherited is( type, name ) → booleanmodule:engine/view/node~ViewNode#is:EDITABLE_ELEMENT_NAME

Type parameters

Parameters

Returns

inherited is( type, name ) → booleanmodule:engine/view/node~ViewNode#is:RAW_ELEMENT_NAME

Type parameters

Parameters

Returns

inherited is( type, name ) → booleanmodule:engine/view/node~ViewNode#is:UI_ELEMENT_NAME

Type parameters

Parameters

Returns

inherited is( type, name ) → booleanmodule:engine/view/node~ViewNode#is:ROOT_ELEMENT_NAME

readonly
`document : ViewDocument`

readonly
`index : null | number`

readonly
`nextSibling : null | ViewNode`

readonly
`parent : null | ViewElement | ViewDocumentFragment`

readonly
`previousSibling : null | ViewNode`

readonly
`root : ViewElement | ViewDocumentFragment`

protected
`constructor( document )`

inherited
`delegate( events ) → EmitterMixinDelegateChain`

inherited
`fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]`

`getAncestors( options = { [options.includeSelf], [options.parentFirst] } ) → Array<ViewNode | ViewDocumentFragment>`

`getCommonAncestor( node, options = { [options.includeSelf] } ) → null | ViewElement | ViewDocumentFragment`

`getPath() → Array<number>`

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

inherited
`is( type ) → this is ViewAttributeElement`

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

inherited
`is( type ) → this is ViewRootEditableElement`

inherited
`is( type ) → this is ViewUIElement`

inherited
`is( type ) → this is ViewRawElement`

inherited
`is( type ) → this is ViewEmptyElement`

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

inherited
`is( type ) → this is ViewText`

inherited
`is( type ) → this is ViewTextProxy`

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

inherited
`is( type ) → this is ViewDocumentFragment`

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

`isAfter( node ) → boolean`

`isAttached() → boolean`

`isBefore( node ) → boolean`

`isSimilar( other ) → boolean`

inherited
`listenTo( emitter, event, callback, [ options ] ) → void`

inherited
`off( event, callback ) → void`

inherited
`on( event, callback, [ options ] ) → void`

inherited
`once( event, callback, [ options ] ) → void`

inherited
`stopDelegating( [ event ], [ emitter ] ) → void`

inherited
`stopListening( [ emitter ], [ event ], [ callback ] ) → void`

`toJSON() → unknown`

internal
`_clone( [ deep ] ) → ViewNode`

internal
`_fireChange( type, node, [ data ] = { data.index } ) → void`

internal
`_remove() → void`