Class

Node (engine/model)

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

class

Model node. Most basic structure of model tree.

This is an abstract class that is a base for other classes representing different nodes in model.

Note: If a node is detached from the model tree, you can manipulate it using it's API. However, it is very important that nodes already attached to model tree should be only changed through Writer API.

Changes done by Node methods, like _insertChild or _setAttribute do not generate operations which are essential for correct editor work if you modify nodes in document root.

The flow of working on Node (and classes that inherits from it) is as such:

  1. You can create a Node instance, modify it using it's API.
  2. Add Node to the model using Batch API.
  3. Change Node that was already added to the model using Batch API.

Similarly, you cannot use Batch API on a node that has not been added to the model tree, with the exception of inserting that node to the model tree.

Be aware that using remove from Batch API does not allow to use Node API because the information about Node is still kept in model document.

In case of element node, adding and removing children also counts as changing a node and follows same rules.

Filtering

Properties

  • document : Document | null

    readonly

    Document that owns this node or null if the node has no parent or is inside a DocumentFragment.

  • endOffset : Number | null

    readonly

    Offset at which this node ends in it's parent. It is equal to the sum of this node's start offset and offset size. Equals to null if the node has no parent.

  • index : Number | null

    readonly

    Index of this node in it's parent 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 model tree got broken.

  • nextSibling : Node | null

    readonly

    Node's next sibling or null if the node is a last child of it's parent or if the node has no parent.

  • offsetSize : Number

    readonly

    Offset size of this node. Represents how much "offset space" is occupied by the node in it's parent. It is important for position. When node has offsetSize greater than 1, position can be placed between that node start and end. offsetSize greater than 1 is for nodes that represents more than one entity, i.e. text node.

  • parent : Element | DocumentFragment | null

    readonly

    Parent of this node. It could be Element or DocumentFragment. Equals to null if the node has no parent.

  • previousSibling : Node | null

    readonly

    Node's previous sibling or null if the node is a first child of it's parent or if the node has no parent.

  • root : Node | DocumentFragment

    readonly

    The top-most ancestor of the node. If node has no parent it is the root itself. If the node is a part of DocumentFragment, it's root is equal to that DocumentFragment.

  • startOffset : Number | null

    readonly

    Offset at which this node starts in it's parent. It is equal to the sum of offsetSize of all it's previous siblings. Equals to null if node has no parent.

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

  • _attrs : Map

    private

    Attributes set on this node.

Methods

  • constructor( [ attrs ] )

    Creates a model node.

    This is an abstract class, so this constructor should not be used directly.

    Parameters

    [ attrs ] : Object

    Node's attributes. See toMap for a list of accepted values.

  • getAncestors( options = { [options.includeSelf], [options.parentFirst] } ) → Array

    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.

    Defaults to false

    [ 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 false

    Returns

    Array

    Array with ancestors.

  • getAttribute( key ) → *

    Gets an attribute value for given key or undefined if that attribute is not set on node.

    Parameters

    key : String

    Key of attribute to look for.

    Returns

    *

    Attribute value or undefined.

  • getAttributeKeys() → Iterable.<String>

    Returns iterator that iterates over this node's attribute keys.

    Returns

    Iterable.<String>
  • getAttributes() → Iterable.<*>

    Returns iterator that iterates over this node's attributes.

    Attributes are returned as arrays containing two items. First one is attribute key and second is attribute value. This format is accepted by native Map object and also can be passed in Node constructor.

    Returns

    Iterable.<*>
  • getCommonAncestor( node, options = { [options.includeSelf] } ) → Element | DocumentFragment | null

    Returns a Element or DocumentFragment which is a common ancestor of both nodes.

    Parameters

    node : Node

    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 false

    Returns

    Element | DocumentFragment | null
  • getPath() → Array.<Number>

    Gets path to the node. The path is an array containing starting offsets of consecutive ancestors of this node, beginning from root, down to this node's starting offset. The path can be used to create Position instance.

    const abc = new Text( 'abc' );
    const foo = new Text( 'foo' );
    const h1 = new Element( 'h1', null, new Text( 'header' ) );
    const p = new Element( 'p', null, [ abc, foo ] );
    const div = new Element( '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.

  • hasAttribute( key ) → Boolean

    Checks if the node has an attribute with given key.

    Parameters

    key : String

    Key of attribute to check.

    Returns

    Boolean

    true if attribute with given key is set on node, false otherwise.

  • is( type ) → Boolean

    Checks whether this object is of the given type.

    This method is useful when processing model objects that are of unknown type. For example, a function may return a DocumentFragment or a Node 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 view 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:

    modelElement.is( 'model:element' ); // -> true
    modelElement.is( 'view:element' ); // -> false

    By using this method it is also possible to check a name of an element:

    imageElement.is( 'image' ); // -> true
    imageElement.is( 'element', 'image' ); // -> same as above
    imageElement.is( 'model:element', 'image' ); // -> same as above, but more precise

    The list of model objects which implement the is() method:

    Parameters

    type : String

    Returns

    Boolean
  • isAfter( node ) → Boolean

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

    Parameters

    node : Node

    Node to compare with.

    Returns

    Boolean
  • isBefore( node ) → Boolean

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

    Parameters

    node : Node

    Node to compare with.

    Returns

    Boolean
  • toJSON() → Object

    Converts Node to plain object and returns it.

    Returns

    Object

    Node converted to plain object.

  • _clearAttributes()

    protected

    Removes all attributes from the node.

  • _clone() → Node

    protected

    Creates a copy of this node, that is a node with exactly same attributes, and returns it.

    Returns

    Node

    Node with same attributes as this node.

  • _remove()

    protected

    Removes this node from it's parent.

    Related:

  • _removeAttribute( key ) → Boolean

    protected

    Removes an attribute with given key from the node.

    Parameters

    key : String

    Key of attribute to remove.

    Returns

    Boolean

    true if the attribute was set on the element, false otherwise.

    Related:

  • _setAttribute( key, value )

    protected

    Sets attribute on the node. If attribute with the same key already is set, it's value is overwritten.

    Parameters

    key : String

    Key of attribute to set.

    value : *

    Attribute value.

    Related:

  • _setAttributesTo( [ attrs ] )

    protected

    Removes all attributes from the node and sets given attributes.

    Parameters

    [ attrs ] : Object

    Attributes to set. See toMap for a list of accepted values.

    Related: