engine/model/position
@ckeditor/ckeditor5-engine/src/model/position
Filtering
Classes
-
Positionmodule:engine/model/position~Position
Type Definitions
-
PositionOffsetmodule:engine/model/position~PositionOffset -
PositionRelationmodule:engine/model/position~PositionRelation -
PositionStickinessmodule:engine/model/position~PositionStickiness
Functions
-
getNodeAfterPosition( position, positionParent, textNode ) → Node | nullmodule:engine/model/position~getNodeAfterPositionReturns the node after the given position.
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 withPosition#parentand/orPosition#textNodecheck 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:
Parameters
position : PositionPosition to check.
positionParent : Element | DocumentFragmentThe parent of the given position.
textNode : null | TextText node at the given position.
Returns
Node | null
-
getNodeBeforePosition( position, positionParent, textNode ) → Node | nullmodule:engine/model/position~getNodeBeforePositionReturns the node before the given position.
Refer to
getNodeBeforePositionfor documentation on when to use this util method.See also:
Parameters
position : PositionPosition to check.
positionParent : Element | DocumentFragmentThe parent of the given position.
textNode : null | TextText node at the given position.
Returns
Node | null
-
getTextNodeAtPosition( position, positionParent ) → Text | nullmodule:engine/model/position~getTextNodeAtPositionReturns a text node at the given position.
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 withPosition#parentcheck 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:
Parameters
position : PositionpositionParent : Element | DocumentFragmentThe parent of the given position.
Returns
Text | null
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.