ModelDocumentFragment

• childCount : number

  readonly

  module:engine/model/documentfragment~ModelDocumentFragment#childCount

  Number of this document fragment's children.

  See source (with github icon)

• document : null

  readonly

  module:engine/model/documentfragment~ModelDocumentFragment#document

  Artificial owner of ModelDocumentFragment. Returns null. Added for compatibility reasons.

  See source (with github icon)

• isEmpty : boolean

  readonly

  module:engine/model/documentfragment~ModelDocumentFragment#isEmpty

  Is true if there are no nodes inside this document fragment, false otherwise.

  See source (with github icon)

• markers : Map<string, ModelRange>

  readonly

  module:engine/model/documentfragment~ModelDocumentFragment#markers

  ModelDocumentFragment static markers map. This is a list of names and ranges which will be set as Markers to model markers collection when ModelDocumentFragment will be inserted to the document.

  See source (with github icon)

• maxOffset : number

  readonly

  module:engine/model/documentfragment~ModelDocumentFragment#maxOffset

  Sum of offset sizes of all of this document fragment's children.

  See source (with github icon)

• name : undefined

  module:engine/model/documentfragment~ModelDocumentFragment#name

  Artificial element name. Returns undefined. Added for compatibility reasons.

  See source (with github icon)

• nextSibling : null

  readonly

  module:engine/model/documentfragment~ModelDocumentFragment#nextSibling

  Artificial next sibling. Returns null. Added for compatibility reasons.

  See source (with github icon)

• parent : null

  readonly

  module:engine/model/documentfragment~ModelDocumentFragment#parent

  Artificial parent of ModelDocumentFragment. Returns null. Added for compatibility reasons.

  See source (with github icon)

• previousSibling : null

  readonly

  module:engine/model/documentfragment~ModelDocumentFragment#previousSibling

  Artificial previous sibling. Returns null. Added for compatibility reasons.

  See source (with github icon)

• root : ModelDocumentFragment

  readonly

  module:engine/model/documentfragment~ModelDocumentFragment#root

  Artificial root of ModelDocumentFragment. Returns itself. Added for compatibility reasons.

  See source (with github icon)

• rootName : undefined

  module:engine/model/documentfragment~ModelDocumentFragment#rootName

  Artificial root name. Returns undefined. Added for compatibility reasons.

  See source (with github icon)

• _children : ModelNodeList

  privatereadonly

  module:engine/model/documentfragment~ModelDocumentFragment#_children

  List of nodes contained inside the document fragment.

  See source (with github icon)

• constructor( [ children ] )

  internal

  module:engine/model/documentfragment~ModelDocumentFragment#constructor

  Creates an empty ModelDocumentFragment.

  Note: Constructor of this class shouldn't be used directly in the code. Use the createDocumentFragment method instead.

  See source (with github icon)

  Parameters

  [ children ] : ModelNode | Iterable<ModelNode>

  Nodes to be contained inside the ModelDocumentFragment.

• Symbol.iterator() → IterableIterator<ModelNode>

  module:engine/model/documentfragment~ModelDocumentFragment#Symbol.iterator

  Returns an iterator that iterates over all nodes contained inside this document fragment.

  See source (with github icon)

  Returns

  IterableIterator<ModelNode>

• getAncestors() → Array<never>

  module:engine/model/documentfragment~ModelDocumentFragment#getAncestors

  Returns empty array. Added for compatibility reasons.

  See source (with github icon)

  Returns

  Array<never>

• getChild( index ) → null | ModelNode

  module:engine/model/documentfragment~ModelDocumentFragment#getChild

  Gets the child at the given index. Returns null if incorrect index was passed.

  See source (with github icon)

  Parameters

  index : number

  Index in this document fragment.

  Returns

  null | ModelNode

  Child node.

• getChildAtOffset( offset ) → null | ModelNode

  module:engine/model/documentfragment~ModelDocumentFragment#getChildAtOffset

  Gets the child at the given offset. Returns null if incorrect index was passed.

  See source (with github icon)

  Parameters

  offset : number

  Offset in this document fragment.

  Returns

  null | ModelNode

  Child node.

• getChildIndex( node ) → null | number

  module:engine/model/documentfragment~ModelDocumentFragment#getChildIndex

  Returns an index of the given child node. Returns null if given node is not a child of this document fragment.

  See source (with github icon)

  Parameters

  node : ModelNode

  Child node to look for.

  Returns

  null | number

  Child node's index.

• getChildStartOffset( node ) → null | number

  module:engine/model/documentfragment~ModelDocumentFragment#getChildStartOffset

  Returns the starting offset of given child. Starting offset is equal to the sum of offset sizes of all node's siblings that are before it. Returns null if given node is not a child of this document fragment.

  See source (with github icon)

  Parameters

  node : ModelNode

  Child node to look for.

  Returns

  null | number

  Child node's starting offset.

• getChildren() → IterableIterator<ModelNode>

  module:engine/model/documentfragment~ModelDocumentFragment#getChildren

  Returns an iterator that iterates over all of this document fragment's children.

  See source (with github icon)

  Returns

  IterableIterator<ModelNode>

• getNodeByPath( relativePath ) → ModelNode | ModelDocumentFragment

  module:engine/model/documentfragment~ModelDocumentFragment#getNodeByPath

  Returns a descendant node by its path relative to this element.

  // <this>a<b>c</b></this>
  this.getNodeByPath( [ 0 ] );     // -> "a"
  this.getNodeByPath( [ 1 ] );     // -> <b>
  this.getNodeByPath( [ 1, 0 ] );  // -> "c"
  

  Copy code

  See source (with github icon)

  Parameters

  relativePath : Array<number>

  Path of the node to find, relative to this element.

  Returns

  ModelNode | ModelDocumentFragment

• getPath() → Array<number>

  module:engine/model/documentfragment~ModelDocumentFragment#getPath

  Returns path to a ModelDocumentFragment, which is an empty array. Added for compatibility reasons.

  See source (with github icon)

  Returns

  Array<number>

• is( type ) → this is ModelElement | ModelRootElement

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:ELEMENT

  Checks whether the object is of type ModelElement or its subclass.

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

  Copy code

  Assuming that the object being checked is an element, you can also check its name:

  element.is( 'element', 'imageBlock' ); // -> true if this is an <imageBlock> element
  text.is( 'element', 'imageBlock' ); -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'element' | 'model:element'

  Returns

  this is ModelElement | ModelRootElement

• is( type ) → this is ModelText

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:TEXT

  Checks whether the object is of type ModelText.

  text.is( '$text' ); // -> true
  text.is( 'node' ); // -> true
  text.is( 'model:$text' ); // -> true
  text.is( 'model:node' ); // -> true
  
  text.is( 'view:$text' ); // -> false
  text.is( 'documentSelection' ); // -> false
  

  Copy code

  Note: Until version 20.0.0 this method wasn't accepting '$text' type. The legacy 'text' type is still accepted for backward compatibility.

  See source (with github icon)

  Parameters

  type : '$text' | 'model:$text'

  Returns

  this is ModelText

• is( type ) → this is ModelPosition | ModelLivePosition

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:POSITION

  Checks whether the object is of type ModelPosition or its subclass.

  position.is( 'position' ); // -> true
  position.is( 'model:position' ); // -> true
  
  position.is( 'view:position' ); // -> false
  position.is( 'documentSelection' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'position' | 'model:position'

  Returns

  this is ModelPosition | ModelLivePosition

• is( type ) → this is ModelRootElement

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:ROOT_ELEMENT

  Checks whether the object is of type ModelRootElement.

  rootElement.is( 'rootElement' ); // -> true
  rootElement.is( 'element' ); // -> true
  rootElement.is( 'node' ); // -> true
  rootElement.is( 'model:rootElement' ); // -> true
  rootElement.is( 'model:element' ); // -> true
  rootElement.is( 'model:node' ); // -> true
  
  rootElement.is( 'view:element' ); // -> false
  rootElement.is( 'documentFragment' ); // -> false
  

  Copy code

  Assuming that the object being checked is an element, you can also check its name:

  rootElement.is( 'rootElement', '$root' ); // -> same as above
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'rootElement' | 'model:rootElement'

  Returns

  this is ModelRootElement

• is( type ) → this is ModelLiveRange

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:LIVE_RANGE

  Checks whether the object is of type ModelLiveRange.

  liveRange.is( 'range' ); // -> true
  liveRange.is( 'model:range' ); // -> true
  liveRange.is( 'liveRange' ); // -> true
  liveRange.is( 'model:liveRange' ); // -> true
  
  liveRange.is( 'view:range' ); // -> false
  liveRange.is( 'documentSelection' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'liveRange' | 'model:liveRange'

  Returns

  this is ModelLiveRange

• is( type ) → this is Marker

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:MARKER

  Checks whether the object is of type Marker.

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

  Copy code

  See source (with github icon)

  Parameters

  type : 'marker' | 'model:marker'

  Returns

  this is Marker

• is( type ) → this is ModelTextProxy

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:TEXT_PROXY

  Checks whether the object is of type ModelTextProxy.

  textProxy.is( '$textProxy' ); // -> true
  textProxy.is( 'model:$textProxy' ); // -> true
  
  textProxy.is( 'view:$textProxy' ); // -> false
  textProxy.is( 'range' ); // -> false
  

  Copy code

  Note: Until version 20.0.0 this method wasn't accepting '$textProxy' type. The legacy 'textProxt' type is still accepted for backward compatibility.

  See source (with github icon)

  Parameters

  type : '$textProxy' | 'model:$textProxy'

  Returns

  this is ModelTextProxy

• is( type ) → this is ModelDocumentSelection

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:DOCUMENT_SELECTION

  Checks whether the object is of type ModelDocumentSelection.

  selection.is( 'selection' ); // -> true
  selection.is( 'documentSelection' ); // -> true
  selection.is( 'model:selection' ); // -> true
  selection.is( 'model:documentSelection' ); // -> true
  
  selection.is( 'view:selection' ); // -> false
  selection.is( 'element' ); // -> false
  selection.is( 'node' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'documentSelection' | 'model:documentSelection'

  Returns

  this is ModelDocumentSelection

• is( type ) → this is ModelSelection | ModelDocumentSelection

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:SELECTION

  Checks whether the object is of type ModelSelection or ModelDocumentSelection.

  selection.is( 'selection' ); // -> true
  selection.is( 'model:selection' ); // -> true
  
  selection.is( 'view:selection' ); // -> false
  selection.is( 'range' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'selection' | 'model:selection'

  Returns

  this is ModelSelection | ModelDocumentSelection

• is( type ) → this is ModelDocumentFragment

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:DOCUMENT_FRAGMENT

  Checks whether the object is of type ModelDocumentFragment.

  docFrag.is( 'documentFragment' ); // -> true
  docFrag.is( 'model:documentFragment' ); // -> true
  
  docFrag.is( 'view:documentFragment' ); // -> false
  docFrag.is( 'element' ); // -> false
  docFrag.is( 'node' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'documentFragment' | 'model:documentFragment'

  Returns

  this is ModelDocumentFragment

• is( type ) → this is ModelRange | ModelLiveRange

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:RANGE

  Checks whether the object is of type ModelRange or its subclass.

  range.is( 'range' ); // -> true
  range.is( 'model:range' ); // -> true
  
  range.is( 'view:range' ); // -> false
  range.is( 'documentSelection' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'range' | 'model:range'

  Returns

  this is ModelRange | ModelLiveRange

• is( type ) → this is ModelLivePosition

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:LIVE_POSITION

  Checks whether the object is of type ModelLivePosition.

  livePosition.is( 'position' ); // -> true
  livePosition.is( 'model:position' ); // -> true
  livePosition.is( 'liveposition' ); // -> true
  livePosition.is( 'model:livePosition' ); // -> true
  
  livePosition.is( 'view:position' ); // -> false
  livePosition.is( 'documentSelection' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'livePosition' | 'model:livePosition'

  Returns

  this is ModelLivePosition

• is( type, name ) → boolean

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:ELEMENT_NAME

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

  element.is( 'element', 'imageBlock' ); // -> true if this is an <imageBlock> element
  text.is( 'element', 'imageBlock' ); -> false
  

  Copy code

  See source (with github icon)

  Type parameters

  N : extends string

  Parameters

  type : 'element' | 'model:element'

  name : N

  Returns

  boolean

• is( type, name ) → boolean

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:ROOT_ELEMENT_NAME

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

  rootElement.is( 'rootElement', '$root' );
  

  Copy code

  See source (with github icon)

  Type parameters

  N : extends string

  Parameters

  type : 'rootElement' | 'model:rootElement'

  name : N

  Returns

  boolean

• is( type ) → this is ModelNode | ModelText | ModelElement | ModelRootElement

  inherited

  module:engine/model/documentfragment~ModelDocumentFragment#is:NODE

  Checks whether the object is of type ModelNode or its subclass.

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

  Copy code

  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
  

  Copy code

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

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

  Copy code

  See source (with github icon)

  Parameters

  type : 'node' | 'model:node'

  Returns

  this is ModelNode | ModelText | ModelElement | ModelRootElement

• isAttached() → false

  module:engine/model/documentfragment~ModelDocumentFragment#isAttached

  Returns false as ModelDocumentFragment by definition is not attached to a document. Added for compatibility reasons.

  See source (with github icon)

  Returns

  false

• offsetToIndex( offset ) → number

  module:engine/model/documentfragment~ModelDocumentFragment#offsetToIndex

  Converts offset "position" to index "position".

  Returns index of a node that occupies given offset. If given offset is too low, returns 0. If given offset is too high, returns index after last child.

  const textNode = new Text( 'foo' );
  const pElement = new Element( 'p' );
  const docFrag = new ModelDocumentFragment( [ textNode, pElement ] );
  docFrag.offsetToIndex( -1 ); // Returns 0, because offset is too low.
  docFrag.offsetToIndex( 0 ); // Returns 0, because offset 0 is taken by `textNode` which is at index 0.
  docFrag.offsetToIndex( 1 ); // Returns 0, because `textNode` has `offsetSize` equal to 3, so it occupies offset 1 too.
  docFrag.offsetToIndex( 2 ); // Returns 0.
  docFrag.offsetToIndex( 3 ); // Returns 1.
  docFrag.offsetToIndex( 4 ); // Returns 2. There are no nodes at offset 4, so last available index is returned.
  

  Copy code

  See source (with github icon)

  Parameters

  offset : number

  Offset to look for.

  Returns

  number

  Index of a node that occupies given offset.

• toJSON() → unknown

  module:engine/model/documentfragment~ModelDocumentFragment#toJSON

  Converts ModelDocumentFragment instance to plain object and returns it. Takes care of converting all of this document fragment's children.

  See source (with github icon)

  Returns

  unknown

  ModelDocumentFragment instance converted to plain object.

• _appendChild( items ) → void

  internal

  module:engine/model/documentfragment~ModelDocumentFragment#_appendChild

  Inserts one or more nodes at the end of this document fragment.

  See source (with github icon)

  Parameters

  items : string | ModelItem | Iterable<( string | ModelItem )>

  Items to be inserted.

  Returns

  void

• _insertChild( index, items ) → void

  internal

  module:engine/model/documentfragment~ModelDocumentFragment#_insertChild

  Inserts one or more nodes at the given index and sets parent of these nodes to this document fragment.

  See source (with github icon)

  Parameters

  index : number

  Index at which nodes should be inserted.

  items : string | ModelItem | Iterable<( string | ModelItem )>

  Items to be inserted.

  Returns

  void

• _removeChildren( index, howMany ) → Array<ModelNode>

  internal

  module:engine/model/documentfragment~ModelDocumentFragment#_removeChildren

  Removes one or more nodes starting at the given index and sets parent of these nodes to null.

  See source (with github icon)

  Parameters

  index : number

  Index of the first node to remove.

  howMany : number

  Number of nodes to remove.

  Defaults to 1

  Returns

  Array<ModelNode>

  Array containing removed nodes.

• _removeChildrenArray( nodes ) → void

  internal

  module:engine/model/documentfragment~ModelDocumentFragment#_removeChildrenArray

  Removes children nodes provided as an array and sets the parent of these nodes to null.

  These nodes do not need to be direct siblings.

  This method is faster than removing nodes one by one, as it recalculates offsets only once.

  See source (with github icon)

  Parameters

  nodes : Array<ModelNode>

  Array of nodes.

  Returns

  void

Static methods

• fromJSON( json ) → ModelDocumentFragment

  static

  module:engine/model/documentfragment~ModelDocumentFragment.fromJSON

  Creates a ModelDocumentFragment instance from given plain object (i.e. parsed JSON string). Converts ModelDocumentFragment children to proper nodes.

  See source (with github icon)

  Parameters

  json : any

  Plain object to be converted to ModelDocumentFragment.

  Returns

  ModelDocumentFragment

  ModelDocumentFragment instance created using given plain object.