engine/model/position

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

Classes

• Positionmodule:engine/model/position~Position

  Represents a position in the model tree.

  See source

Type Definitions

• PositionRelationmodule:engine/model/position~PositionRelation

  A flag indicating whether this position is 'before' or 'after' or 'same' as given position. If positions are in different roots 'different' flag is returned.

  See source

• PositionStickinessmodule:engine/model/position~PositionStickiness

  Represents how position is "sticking" with neighbour nodes. Used to define how position should be transformed (moved) in edge cases. Possible values: 'toNone', 'toNext', 'toPrevious'.

  See source

Functions

• getNodeAfterPosition( position, positionParent, textNode ) → Node | nullmodule:engine/model/position.getNodeAfterPosition

  static

  Returns the node after the given position.

  See source

  This is a helper function optimized to reuse the position parent instance and the calculation of the text node at the specific position for performance reasons.

  Normally, you should use Position#nodeAfter. If you start hitting performance issues with Position#parent and/or Position#textNode check if your algorithm does not access those properties multiple times (which can happen directly or indirectly via other position properties).

  See https://github.com/ckeditor/ckeditor5/issues/6579 and https://github.com/ckeditor/ckeditor5/issues/6582.

  See also:

  • getTextNodeAtPosition
  • getNodeBeforePosition

  Parameters

  position : Position

  positionParent : Element | DocumentFragment

  The parent of the given position.

  textNode : Text | null

  Text node at the given position.

  Returns

  Node | null

• getNodeBeforePosition( position, positionParent, textNode ) → Node | nullmodule:engine/model/position.getNodeBeforePosition

  static

  Returns the node before the given position.

  See source

  Refer to getNodeBeforePosition for documentation on when to use this util method.

  See also:

  • getTextNodeAtPosition
  • getNodeAfterPosition

  Parameters

  position : Position

  positionParent : Element | DocumentFragment

  The parent of the given position.

  textNode : Text | null

  Text node at the given position.

  Returns

  Node | null

• getTextNodeAtPosition( position, positionParent ) → Text | nullmodule:engine/model/position.getTextNodeAtPosition

  static

  Returns a text node at the given position.

  See source

  This is a helper function optimized to reuse the position parent instance for performance reasons.

  Normally, you should use Position#textNode. If you start hitting performance issues with Position#parent check if your algorithm does not access it multiple times (which can happen directly or indirectly via other position properties).

  See https://github.com/ckeditor/ckeditor5/issues/6579.

  See also:

  • getNodeAfterPosition
  • getNodeBeforePosition

  Parameters

  position : Position

  positionParent : Element | DocumentFragment

  The parent of the given position.

  Returns

  Text | null