Node (engine/view)

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

Properties

• readonly

  document : Documentmodule:engine/view/node~Node#document

  See source

  The document instance to which this node belongs.

• readonly

  index : null | numbermodule:engine/view/node~Node#index

  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 | Nodemodule:engine/view/node~Node#nextSibling

  See source

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

• readonly

  parent : null | Element | DocumentFragmentmodule:engine/view/node~Node#parent

  See source

  Parent element. Null by default. Set by _insertChild.

• readonly

  previousSibling : null | Nodemodule:engine/view/node~Node#previousSibling

  See source

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

• readonly

  root : Element | DocumentFragmentmodule:engine/view/node~Node#root

  See source

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

Methods

• protected

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

  See source

  Creates a tree view node.

  Parameters

  document : Document

  The document instance to which this node belongs.

• inherited

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

  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' ]module:engine/view/node~Node#fire

  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<Node | DocumentFragment>module:engine/view/node~Node#getAncestors

  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<Node | DocumentFragment>

  Array with ancestors.

• getCommonAncestor( node, options = { [options.includeSelf] } ) → null | Element | DocumentFragmentmodule:engine/view/node~Node#getCommonAncestor

  See source

  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 {}

  Returns

  null | Element | DocumentFragment

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

  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 Element | AttributeElement | ContainerElement | EditableElement | EmptyElement | RawElement | RootEditableElement | UIElementmodule:engine/view/node~Node#is:ELEMENT

  See source

  Checks whether this object is of type Element 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 Element | AttributeElement | ContainerElement | EditableElement | EmptyElement | RawElement | RootEditableElement | UIElement

• inherited

  is( type ) → this is AttributeElementmodule:engine/view/node~Node#is:ATTRIBUTE_ELEMENT

  See source

  Checks whether this object is of type AttributeElement.

  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 AttributeElement

• inherited

  is( type ) → this is ContainerElement | EditableElement | RootEditableElementmodule:engine/view/node~Node#is:CONTAINER_ELEMENT

  See source

  Checks whether this object is of type ContainerElement 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 ContainerElement | EditableElement | RootEditableElement

• inherited

  is( type ) → this is RootEditableElementmodule:engine/view/node~Node#is:ROOT_ELEMENT

  See source

  Checks whether this object is of type RootEditableElement.

  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 RootEditableElement

• inherited

  is( type ) → this is UIElementmodule:engine/view/node~Node#is:UI_ELEMENT

  See source

  Checks whether this object is of type UIElement.

  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 UIElement

• inherited

  is( type ) → this is RawElementmodule:engine/view/node~Node#is:RAW_ELEMENT

  See source

  Checks whether this object is of type RawElement.

  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 RawElement

• inherited

  is( type ) → this is EmptyElementmodule:engine/view/node~Node#is:EMPTY_ELEMENT

  See source

  Checks whether this object is of type EmptyElement.

  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 EmptyElement

• inherited

  is( type ) → this is EditableElement | RootEditableElementmodule:engine/view/node~Node#is:EDITABLE_ELEMENT

  See source

  Checks whether this object is of type EditableElement 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 EditableElement | RootEditableElement

• inherited

  is( type ) → this is Textmodule:engine/view/node~Node#is:TEXT

  See source

  Checks whether this object is of type Text.

  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 Text

• inherited

  is( type ) → this is TextProxymodule:engine/view/node~Node#is:TEXT_PROXY

  See source

  Checks whether this object is of type TextProxy.

  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 TextProxy

• inherited

  is( type ) → this is Rangemodule:engine/view/node~Node#is:RANGE

  See source

  Checks whether this object is of type Range.

  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 Range

• inherited

  is( type ) → this is DocumentSelectionmodule:engine/view/node~Node#is:DOCUMENT_SELECTION

  See source

  Checks whether this object is of type DocumentSelection.

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

• inherited

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

  See source

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

  Type parameters

  N : extends string

  Parameters

  type : 'attributeElement' | 'view:attributeElement'

  name : N

  Returns

  boolean

• inherited

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

  See source

  Checks whether the object is of type EditableElement 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 ) → booleanmodule:engine/view/node~Node#is:RAW_ELEMENT_NAME

  See source

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

  Type parameters

  N : extends string

  Parameters

  type : 'rawElement' | 'view:rawElement'

  name : N

  Returns

  boolean

• inherited

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

  See source

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

  Type parameters

  N : extends string

  Parameters

  type : 'uiElement' | 'view:uiElement'

  name : N

  Returns

  boolean

• inherited

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

  See source

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

  Type parameters

  N : extends string

  Parameters

  type : 'rootElement' | 'view:rootElement'

  name : N

  Returns

  boolean

• inherited

  is( type, name ) → booleanmodule:engine/view/node~Node#is:EMPTY_ELEMENT_NAME

  See source

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

  Type parameters

  N : extends string

  Parameters

  type : 'emptyElement' | 'view:emptyElement'

  name : N

  Returns

  boolean

• inherited

  is( type, name ) → booleanmodule:engine/view/node~Node#is:CONTAINER_ELEMENT_NAME

  See source

  Checks whether the object is of type ContainerElement 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 ) → booleanmodule:engine/view/node~Node#is:ELEMENT_NAME

  See source

  Checks whether the object is of type Element 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 Selection | DocumentSelectionmodule:engine/view/node~Node#is:SELECTION

  See source

  Checks whether this object is of type Selection or DocumentSelection.

  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 Selection | DocumentSelection

• inherited

  is( type ) → this is Positionmodule:engine/view/node~Node#is:POSITION

  See source

  Checks whether this object is of type Position.

  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 Position

• inherited

  is( type ) → this is DocumentFragmentmodule:engine/view/node~Node#is:DOCUMENT_FRAGMENT

  See source

  hecks whether this object is of type DocumentFragment.

  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 DocumentFragment

• inherited

  is( type ) → this is Text | Node | Element | AttributeElement | ContainerElement | EditableElement | EmptyElement | RawElement | RootEditableElement | UIElementmodule:engine/view/node~Node#is:NODE

  See source

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

  This method is useful when processing view 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 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 Text | Node | Element | AttributeElement | ContainerElement | EditableElement | EmptyElement | RawElement | RootEditableElement | UIElement

• isAfter( node ) → booleanmodule:engine/view/node~Node#isAfter

  See source

  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

• isAttached() → booleanmodule:engine/view/node~Node#isAttached

  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 ) → booleanmodule:engine/view/node~Node#isBefore

  See source

  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

• isSimilar( other ) → booleanmodule:engine/view/node~Node#isSimilar

  See source

  Checks if provided node is similar to this node.

  Parameters

  other : Node

  Returns

  boolean

  True if nodes are similar.

• inherited

  listenTo( emitter, event, callback, [ options ] ) → voidmodule:engine/view/node~Node#listenTo:BASE_EMITTER

  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 ) → voidmodule:engine/view/node~Node#off

  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 ] ) → voidmodule:engine/view/node~Node#on

  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 ] ) → voidmodule:engine/view/node~Node#once

  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 ] ) → voidmodule:engine/view/node~Node#stopDelegating

  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 ] ) → voidmodule:engine/view/node~Node#stopListening:BASE_STOP

  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() → unknownmodule:engine/view/node~Node#toJSON

  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 ] ) → Nodemodule:engine/view/node~Node#_clone

  See source

  Clones this node.

  Parameters

  [ deep ] : boolean

  Returns

  Node

  Clone of this node.

• internal

  _fireChange( type, node ) → voidmodule:engine/view/node~Node#_fireChange

  See source

  Parameters

  type : ChangeType

  Type of the change.

  node : Node

  Changed node.

  Returns

  void

  Fires

  • change

• internal

  _remove() → voidmodule:engine/view/node~Node#_remove

  See source

  Removes node from parent.

  Returns

  void

Events

• change( eventInfo, changedNode )module:engine/view/node~Node#event:change

  See source

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

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

  Parameters

  eventInfo : EventInfo

  An object containing information about the fired event.

  changedNode : Node

• change:attributes( eventInfo, changedNode )module:engine/view/node~Node#event:change:attributes

  See source

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

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

  Parameters

  eventInfo : EventInfo

  An object containing information about the fired event.

  changedNode : Node

• change:children( eventInfo, changedNode )module:engine/view/node~Node#event:change:children

  See source

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

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

  Parameters

  eventInfo : EventInfo

  An object containing information about the fired event.

  changedNode : Node

• change:text( eventInfo, changedNode )module:engine/view/node~Node#event:change:text

  See source

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

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

  Parameters

  eventInfo : EventInfo

  An object containing information about the fired event.

  changedNode : Node