MarkerOperation
Abstract base operation class.
Properties
-
affectedSelectable : ModelSelectable
readonlymodule:engine/model/operation/markeroperation~MarkerOperation#affectedSelectable
A selectable that will be affected by the operation after it is executed.
The exact returned parameter differs between operation types.
-
affectsData : boolean
readonlymodule:engine/model/operation/markeroperation~MarkerOperation#affectsData
Specifies whether the marker operation affects the data produced by the data pipeline (is persisted in the editor's data).
-
baseVersion : null | number
inheritedmodule:engine/model/operation/markeroperation~MarkerOperation#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. -
module:engine/model/operation/markeroperation~MarkerOperation#batch
Batch to which the operation is added or
null
if 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. -
isDocumentOperation : boolean
readonlyinheritedmodule:engine/model/operation/markeroperation~MarkerOperation#isDocumentOperation
Defines whether operation is executed on attached or detached items.
-
name : string
readonlymodule:engine/model/operation/markeroperation~MarkerOperation#name
Marker name.
-
newRange : null | ModelRange
readonlymodule:engine/model/operation/markeroperation~MarkerOperation#newRange
Marker range after the change.
-
oldRange : null | ModelRange
readonlymodule:engine/model/operation/markeroperation~MarkerOperation#oldRange
Marker range before the change.
-
type : 'marker'
readonlymodule:engine/model/operation/markeroperation~MarkerOperation#type
Operation type.
-
_markers : MarkerCollection
privatereadonlymodule:engine/model/operation/markeroperation~MarkerOperation#_markers
Marker collection on which change should be executed.
Static properties
-
className : string
readonlystaticmodule:engine/model/operation/markeroperation~MarkerOperation.className
Name of the operation class used for serialization.
Methods
-
constructor( name, oldRange, newRange, markers, affectsData, baseVersion )
module:engine/model/operation/markeroperation~MarkerOperation#constructor
Parameters
name : string
Marker name.
oldRange : null | ModelRange
Marker range before the change.
newRange : null | ModelRange
Marker range after the change.
markers : MarkerCollection
Marker collection on which change should be executed.
affectsData : boolean
Specifies whether the marker operation affects the data produced by the data pipeline (is persisted in the editor's data).
baseVersion : null | number
Document
version
on which operation can be applied ornull
if the operation operates on detached (non-document) tree.
-
clone() → MarkerOperation
module:engine/model/operation/markeroperation~MarkerOperation#clone
Creates and returns an operation that has the same parameters as this operation.
Returns
-
getReversed() → Operation
module:engine/model/operation/markeroperation~MarkerOperation#getReversed
-
toJSON() → unknown
module:engine/model/operation/markeroperation~MarkerOperation#toJSON
Custom toJSON method to solve child-parent circular dependencies.
Returns
unknown
Clone of this object with the operation property replaced with string.
-
_execute() → void
internalmodule:engine/model/operation/markeroperation~MarkerOperation#_execute
Executes the operation - modifications described by the operation properties will be applied to the model tree.
Returns
void
-
_validate() → void
internalinheritedmodule:engine/model/operation/markeroperation~MarkerOperation#_validate
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
-
fromJSON( json, document ) → MarkerOperation
staticmodule:engine/model/operation/markeroperation~MarkerOperation.fromJSON
Creates
MarkerOperation
object from deserialized object, i.e. from parsed JSON string.Parameters
json : any
Deserialized JSON object.
document : ModelDocument
Document on which this operation will be applied.
Returns