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.
Properties
-
affectedSelectable : ModelSelectablereadonlymodule:engine/model/operation/detachoperation~DetachOperation#affectedSelectableA selectable that will be affected by the operation after it is executed.
The exact returned parameter differs between operation types.
-
baseVersion : null | numberinheritedmodule:engine/model/operation/detachoperation~DetachOperation#baseVersionversionon 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. -
module:engine/model/operation/detachoperation~DetachOperation#batchBatch to which the operation is added or
nullif the operation is not added to any batch yet.Note, that a non-document operation has this property always set to
null, and is never added to any batch. -
clone : nevermodule:engine/model/operation/detachoperation~DetachOperation#cloneCreates and returns an operation that has the same parameters as this operation.
-
getReversed : nevermodule:engine/model/operation/detachoperation~DetachOperation#getReversedCreates and returns a reverse operation. Reverse operation when executed right after the original operation will bring back tree model state to the point before the original operation execution. In other words, it reverses changes done by the original operation.
Keep in mind that tree model state may change since executing the original operation, so reverse operation will be "outdated". In that case you will need to transform it by all operations that were executed after the original operation.
-
howMany : numbermodule:engine/model/operation/detachoperation~DetachOperation#howManyOffset size of moved range.
-
isDocumentOperation : booleanreadonlyinheritedmodule:engine/model/operation/detachoperation~DetachOperation#isDocumentOperationDefines whether operation is executed on attached or detached items.
-
module:engine/model/operation/detachoperation~DetachOperation#sourcePositionPosition before the first model item to detach.
-
type : 'detach'readonlymodule:engine/model/operation/detachoperation~DetachOperation#typeOperation type.
Static properties
-
className : stringreadonlystaticmodule:engine/model/operation/detachoperation~DetachOperation.classNameName of the operation class used for serialization.
Methods
-
constructor( sourcePosition, howMany )module:engine/model/operation/detachoperation~DetachOperation#constructorCreates an insert operation.
Parameters
sourcePosition : ModelPositionPosition before the first model item to move.
howMany : numberOffset size of moved range. Moved range will start from
sourcePositionand end atsourcePositionwith offset shifted byhowMany.
-
toJSON() → unknownmodule:engine/model/operation/detachoperation~DetachOperation#toJSONCustom toJSON method to solve child-parent circular dependencies.
Returns
unknownClone of this object with the operation property replaced with string.
-
_execute() → voidinternalmodule:engine/model/operation/detachoperation~DetachOperation#_executeExecutes the operation - modifications described by the operation properties will be applied to the model tree.
Returns
void
-
_validate() → voidinternalmodule:engine/model/operation/detachoperation~DetachOperation#_validateChecks 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
-
module:engine/model/operation/detachoperation~DetachOperation.fromJSONCreates
Operationobject from deserialized object, i.e. from parsed JSON string.Parameters
json : anyDeserialized JSON object.
document : ModelDocumentDocument on which this operation will be applied.
Returns