DetachOperation (engine/model/operation)
@ckeditor/ckeditor5-engine/src/model/operation/detachoperation
Operation to permanently remove node from detached root. Note this operation is only a local operation and won't be send to the other clients.
Filtering
Properties
-
readonly
affectedSelectable : Selectable
module:engine/model/operation/detachoperation~DetachOperation#affectedSelectable
A selectable that will be affected by the operation after it is executed.
The exact returned parameter differs between operation types.
-
inherited
baseVersion : null | number
module:engine/model/operation/detachoperation~DetachOperation#baseVersion
version
on which operation can be applied. If you try to apply operation with different base version than the document version the model-document-applyOperation-wrong-version error is thrown. -
Batch to which the operation is added or
null
if the operation is not added to any batch yet. -
clone : never
module:engine/model/operation/detachoperation~DetachOperation#clone
-
getReversed : never
module:engine/model/operation/detachoperation~DetachOperation#getReversed
-
howMany : number
module:engine/model/operation/detachoperation~DetachOperation#howMany
Offset size of moved range.
-
readonly inherited
isDocumentOperation : boolean
module:engine/model/operation/detachoperation~DetachOperation#isDocumentOperation
Defines whether operation is executed on attached or detached items.
-
sourcePosition : Position
module:engine/model/operation/detachoperation~DetachOperation#sourcePosition
Position before the first model item to detach.
-
Operation type.
Static properties
-
readonly static
className : string
module:engine/model/operation/detachoperation~DetachOperation.className
Name of the operation class used for serialization.
Methods
-
constructor( sourcePosition, howMany )
module:engine/model/operation/detachoperation~DetachOperation#constructor
Creates an insert operation.
Parameters
sourcePosition : Position
Position before the first model item to move.
howMany : number
Offset size of moved range. Moved range will start from
sourcePosition
and end atsourcePosition
with offset shifted byhowMany
.
-
toJSON() → unknown
module:engine/model/operation/detachoperation~DetachOperation#toJSON
Custom toJSON method to solve child-parent circular dependencies.
Returns
unknown
Clone of this object with the operation property replaced with string.
-
Executes the operation - modifications described by the operation properties will be applied to the model tree.
Returns
void
-
Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws an error if operation is not valid.
Returns
void
Static methods
-
inherited static
fromJSON( json, document ) → Operation
module:engine/model/operation/detachoperation~DetachOperation.fromJSON
Creates
Operation
object from deserialized object, i.e. from parsed JSON string.Parameters
json : any
Deserialized JSON object.
document : Document
Returns
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.