Report an issue
Class

Text (engine/model)

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

class

Model text node. Type of node that contains text data.

Important: see Node to read about restrictions using Text and Node API.

Note: keep in mind that Text instances might indirectly got removed from model tree when model is changed. This happens when model writer is used to change model and the text node is merged with another text node. Then, both text nodes are removed and a new text node is inserted into the model. Because of this behavior, keeping references to Text is not recommended. Instead, consider creating live position placed before the text node.

Filtering

Properties

  • Returns a text data contained in the node.

  • document : Document | null

    readonly inherited

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

  • endOffset : Number | null

    readonly inherited

    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 inherited

    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 inherited

    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 inherited

    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.

    Overrides: Node#offsetSize
  • parent : Element | DocumentFragment | null

    readonly inherited

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

  • previousSibling : Node | null

    readonly inherited

    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 inherited

    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 inherited

    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.

  • _data : String

    protected

    Text data contained in this text node.

  • _attrs : Map

    private inherited

    Attributes set on this node.

Methods

  • constructor( data, [ attrs ] )

    protected

    Creates a text node.

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

    Parameters

    data : String

    Node's text.

    [ attrs ] : Object

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

    Overrides: Node#constructor
  • getAncestors( options = { [options.includeSelf], [options.parentFirst] } ) → Array

    inherited

    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 ) → *

    inherited

    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>

    inherited

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

    Returns

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

    inherited

    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

    inherited

    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>

    inherited

    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

    inherited

    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

    inherited

    Checks whether given model tree object is of given type.

    This method is useful when processing model tree objects that are of unknown type. For example, a function may return DocumentFragment or Node that can be either text node or element. This method can be used to check what kind of object is returned.

    obj.is( 'node' ); // true for any node, false for document fragment and text fragment
    obj.is( 'documentFragment' ); // true for document fragment, false for any node
    obj.is( 'element' ); // true for any element, false for text node or document fragment
    obj.is( 'element', 'paragraph' ); // true only for element which name is 'paragraph'
    obj.is( 'paragraph' ); // shortcut for obj.is( 'element', 'paragraph' )
    obj.is( 'text' ); // true for text node, false for element and document fragment
    obj.is( 'textProxy' ); // true for text proxy object

    Parameters

    type : 'element' | 'rootElement' | 'text' | 'textProxy' | 'documentFragment'

    Returns

    Boolean
    Overrides: Node#is
  • isAfter( node ) → Boolean

    inherited

    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

    inherited

    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 Text instance to plain object and returns it.

    Returns

    Object

    Text instance converted to plain object.

    Overrides: Node#toJSON
  • _clearAttributes()

    protected inherited

    Removes all attributes from the node.

  • _clone() → Text

    protected

    Creates a copy of this text node and returns it. Created text node has same text data and attributes as original text node.

    Returns

    Text

    Text instance created using given plain object.

    Overrides: Node#_clone
  • _remove()

    protected inherited

    Removes this node from it's parent.

  • _removeAttribute( key ) → Boolean

    protected inherited

    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.

  • _setAttribute( key, value )

    protected inherited

    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.

  • _setAttributesTo( [ attrs ] )

    protected inherited

    Removes all attributes from the node and sets given attributes.

    Parameters

    [ attrs ] : Object

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

Static methods

  • fromJSON( json ) → Text

    static

    Creates a Text instance from given plain object (i.e. parsed JSON string).

    Parameters

    json : Object

    Plain object to be converted to Text.

    Returns

    Text

    Text instance created using given plain object.