DocumentCompare

class

DocumentCompare provides a set of tools that allows you to process editor document data by custom external logic, evaluate the differences between original and processed data, and apply them as granular changes or tracked suggestions.

Contrary to editor.setData(), this does not replace the whole editor data. Instead, atomic changes are evaluated and a small set of changes is applied to the document. This is especially useful when the editor also uses Track Changes, Revision History, and Real-Time Collaboration features.

Use process(), to run the whole pipeline in one call - it makes a document snapshot, processes the data, and applies granular changes:

await documentCompare.process( async snapshot => externalDataProcessing( snapshot.content ) );

// Or, to apply changes as suggestions:
await documentCompare.process( async snapshot => externalDataProcessing( snapshot.content ), { asSuggestions: true } );

Some integrations need to process the data in separate steps (e.g. backend processing workflows, or when changes are not applied immediately to the content). In this case, you can capture a snapshot first and apply the result later:

const snapshot = documentCompare.makeSnapshot();
const processed = await externalDataProcessing( snapshot.content );

// ...

const patch = documentCompare.computePatch( snapshot, processed, { asSuggestions: true } );
documentCompare.applyPatch( patch );

If the user should decide whether changes are accepted or rejected, compare the snapshot into separate changes instead, and apply the ones they keep:

const changes = documentCompare.computeChanges( snapshot, processed );

documentCompare.applyChange( changes[ 0 ] );

See also ProposedChanges plugin, a set of tools to display the proposed changes to the user.

The snapshot data is stamped with data-id attributes, and the comparison pairs the elements of the snapshot and the processed data by these ids. When the processing cannot retain the ids (for example, when the data goes through Markdown), capture the snapshot without them. The elements are then paired by their content instead:

const snapshot = documentCompare.makeSnapshot( { useDataIds: false } );
const processed = await externalDataProcessing( snapshot.content );

const patch = documentCompare.computePatch( snapshot, processed );
documentCompare.applyPatch( patch );

A document from outside the editor (for example, another version of the document) can be compared with the current document present in the editor. Capture the snapshot without the ids just before the comparison, so the documents are compared by content similarity:

const snapshot = documentCompare.makeSnapshot( { useDataIds: false } );
const patch = documentCompare.computePatch( snapshot, importedHtml, { asSuggestions: true } );
documentCompare.applyPatch( patch );

The recommended way to use DocumentCompare is to create a snapshot with data IDs, then process the snapshot content, and then use the snapshot to generate the changes using DocumentCompare methods. This approach will result in better performance and the best diff quality, as snapshot data IDs are used by the diff algorithm to pair the elements. Skip IDs only in cases where they cannot be used.

Properties

editor: Editor
readonlyinherited
module:ai/toolkit/documentcompare~DocumentCompare#editor
The editor instance.

Note that most editors implement the ui property. However, editors with an external UI (i.e. Bootstrap-based) or a headless editor may not have this property or throw an error when accessing it.

Because of above, to make plugins more universal, it is recommended to split features into:
- The "editing" part that uses the Editor class without ui property.
- The "UI" part that uses the Editor class and accesses ui property.
isEnabled: boolean
readonlyinheritedobservable
module:ai/toolkit/documentcompare~DocumentCompare#isEnabled
Flag indicating whether a plugin is enabled or disabled. A disabled plugin will not transform text.

Plugin can be simply disabled like that:
```
// Disable the plugin so that no toolbars are visible.
editor.plugins.get( 'TextTransformation' ).isEnabled = false;
```
Copy code
You can also use forceDisabled method.

Static properties

isContextPlugin: false
readonlyinheritedstatic
pluginName: 'DocumentCompare'
readonlystatic
requires: readonly [ PluginConstructor<Editor> & new ( context: Editor ) => DocumentDiffer, PluginConstructor<Editor> & new ( context: Editor ) => DocumentCompareUtils, PluginConstructor<Editor> & new ( context: Editor ) => SuggestionsConversion, PluginConstructor<Editor> & new ( context: Editor ) => AIEditorConfig ]
readonlystatic

Methods

constructor( editor )
inherited
Parameters
editor: Editor
afterInit() → void
Returns
void
applyChange( change, options ) → void
Applies a single document change the same way applyPatch applies a whole patch. See applyPatch.
Parameters
change: DocumentChange
The change to apply.
options: DocumentCompareApplyChangeOptions
How the change is applied.
Defaults to {}
Returns
void
applyPatch( patch ) → void
Applies a patch to the current state of the document.

As a result, all changes described by the patch are reflected in the document. Note that this converges with all changes that happened on the document after the snapshot used for the patch was made, including both local and remote edits (if real-time collaboration is enabled).

Note that the patch can only be applied to the same document as the snapshot, and only during the same editing session. Otherwise, the method throws documentcompare-channel-mismatch or documentcompare-session-mismatch.

The patch is first validated against a copy of the document before anything is committed. If any errors or conflict resolution problems surface during this dry-run, documentcompare-invalid-patch error is thrown, and the editor data is left intact.

The changes can be applied directly to the content or as tracked suggestions (requires Track changes plugin, otherwise documentcompare-no-track-changes is thrown). See also computePatch.
Parameters
patch: DocumentComparePatch
The patch to apply, as produced by computePatch.
Returns
void
bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, DocumentCompare[ K1 ], K2, DocumentCompare[ K2 ]>
inherited
module:ai/toolkit/documentcompare~DocumentCompare#bind:DUAL_BIND
Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
Type parameters
K1
K2
Parameters
bindProperty1: K1
Observable property that will be bound to other observable(s).
bindProperty2: K2
Observable property that will be bound to other observable(s).
Returns
ObservableDualBindChain<K1, DocumentCompare[ K1 ], K2, DocumentCompare[ K2 ]>
The bind chain with the to() and toMany() methods.
bind( bindProperties ) → ObservableMultiBindChain
inherited
module:ai/toolkit/documentcompare~DocumentCompare#bind:MANY_BIND
Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
Parameters
bindProperties: Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'init' | 'afterInit' | 'editor' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'process' | 'makeSnapshot' | 'computePatch' | 'applyPatch' | 'computeChanges' | 'applyChange'>
Observable properties that will be bound to other observable(s).
Returns
ObservableMultiBindChain
The bind chain with the to() and toMany() methods.
bind( bindProperty ) → ObservableSingleBindChain<K, DocumentCompare[ K ]>
inherited
module:ai/toolkit/documentcompare~DocumentCompare#bind:SINGLE_BIND
Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
Type parameters
K
Parameters
bindProperty: K
Observable property that will be bound to other observable(s).
Returns
ObservableSingleBindChain<K, DocumentCompare[ K ]>
The bind chain with the to() and toMany() methods.
clearForceDisabled( id ) → void
inherited
Clears forced disable previously set through forceDisabled. See forceDisabled.
Parameters
id: string
Unique identifier, equal to the one passed in forceDisabled call.
Returns
void
computeChanges( snapshot, data, options ) → Array<DocumentChange>
Compares the earlier captured snapshot and the given data. Returns a set of grouped document changes. Changes are grouped based on where in the document they sit - related changes made next to each other are put together into one group. Each group is one, atomic, reviewable unit, to be accepted or rejected independently of each other.

The document changes can be collected into a set of proposed changes and passed to createController to create a controller, which binds the changes with an editor instance and offers an API to operate on them. To provide an interface for managing the changes, create a proposed changes UI component and attach it to the controller.

You can also apply the accepted document changes directly, using applyChange.

The passed data is compared against the snapshot state. When a change is accepted, it is resolved against any changes that happened in the editor since the snapshot was taken. This allows you to process the data asynchronously, while retaining any edits that have happened in the editor in the meantime.

If you did not make the snapshot for processing purposes (for example, a case where you compare editor data to a different, already existing document), make the snapshot just before calling computeChanges().

If the processed data for an inline root contains block content, no change is returned for that root and a documentcompare-unsupported-inline-root-content warning is logged.
Parameters
snapshot: DocumentCompareSnapshot
The captured before-state to compare against.
data: string | Record<string, string>
The processed data. For multi-root editor, pass an object keyed by root name.
options: DocumentCompareComputeChangesOptions
How the comparison is computed.
Defaults to {}
Returns
Array<DocumentChange>
The changes bringing the document from the snapshot to the processed state, in document order.
computePatch( snapshot, data, options ) → DocumentComparePatch
Computes a document patch - a set of granular differences between the earlier captured snapshot and the given data. You can apply the patch using applyPatch. All changes from the patch are applied at once.

Use options to set whether the patch should be calculated and applied as tracked changes or as direct changes to the document.

The passed data is compared against the snapshot state. Later, when a patch is applied, the differences are resolved against any changes that happened in the editor since the snapshot was taken. This allows you to process the data asynchronously, while retaining all edits that have happened in the editor in the meantime.

If you did not make the snapshot for processing purposes (for example, a case where you compare editor data to a different, already existing document), make the snapshot just before calling computePatch().

Throws documentcompare-unsupported-inline-root-content if the processed data for an inline root contains block content.
Parameters
snapshot: DocumentCompareSnapshot
The captured before-state to diff against.
data: string | Record<string, string>
The new data. For multi-root editor, pass an object keyed by root name.
options: DocumentCompareComputePatchOptions
How the comparison is computed.
Defaults to {}
Returns
DocumentComparePatch
The patch bringing the document from the snapshot to the processed state.
decorate( methodName ) → void
inherited
module:ai/toolkit/documentcompare~DocumentCompare#decorate
Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.

Read more in the dedicated guide covering the topic of decorating methods with some additional examples.

Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.

For example, to cancel the method execution the event can be stopped:
```
class Foo extends ObservableMixin() {
	constructor() {
		super();
		this.decorate( 'method' );
	}

	method() {
		console.log( 'called!' );
	}
}

const foo = new Foo();
foo.on( 'method', ( evt ) => {
	evt.stop();
}, { priority: 'high' } );

foo.method(); // Nothing is logged.
```
Copy code
Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

It is also possible to change the returned value:
```
foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'
```
Copy code
Finally, it is possible to access and modify the arguments the method is called with:
```
method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'
```
Copy code
Parameters
methodName: 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'init' | 'afterInit' | 'editor' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'process' | 'makeSnapshot' | 'computePatch' | 'applyPatch' | 'computeChanges' | 'applyChange'
Name of the method to decorate.
Returns
void
delegate( events ) → EmitterMixinDelegateChain
inherited
module:ai/toolkit/documentcompare~DocumentCompare#delegate
Delegates selected events to another Emitter. For instance:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
Copy code
then eventX is delegated (fired by) emitterB and emitterC along with data:
```
emitterA.fire( 'eventX', data );
```
Copy code
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.fire( 'eventY', data );
```
Copy code
Parameters
events: Array<string>
Event names that will be delegated to another emitter.
Returns
EmitterMixinDelegateChain
destroy() → void
inherited
Destroys the plugin.

Note: This method is optional. A plugin instance does not need to have it defined.
Returns
void
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]
inherited
Fires an event, executing all callbacks registered for it.

The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.
Type parameters
TEvent: extends BaseEvent
The type describing the event. See BaseEvent.
Parameters
eventOrInfo: GetNameOrEventInfo<TEvent>
The name of the event or EventInfo object if event is delegated.
args: TEvent[ 'args' ]
Additional arguments to be passed to the callbacks.
Returns
GetEventInfo<TEvent>[ 'return' ]
By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).
forceDisabled( id ) → void
inherited
module:ai/toolkit/documentcompare~DocumentCompare#forceDisabled
Disables the plugin.

Plugin may be disabled by multiple features or algorithms (at once). When disabling a plugin, unique id should be passed (e.g. feature name). The same identifier should be used when enabling back the plugin. The plugin becomes enabled only after all features enabled it back.

Disabling and enabling a plugin:
```
plugin.isEnabled; // -> true
plugin.forceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```
Copy code
Plugin disabled by multiple features:
```
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'OtherFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'OtherFeature' );
plugin.isEnabled; // -> true
```
Copy code
Multiple disabling with the same identifier is redundant:
```
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'MyFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```
Copy code
Note: some plugins or algorithms may have more complex logic when it comes to enabling or disabling certain plugins, so the plugin might be still disabled after clearForceDisabled was used.
Parameters
id: string
Unique identifier for disabling. Use the same id when enabling back the plugin.
Returns
void
init() → void
Returns
void
listenTo( emitter, event, callback, options? ) → void
inherited
module:ai/toolkit/documentcompare~DocumentCompare#listenTo:BASE_EMITTER
Registers a callback function to be executed when an event is fired in a specific (emitter) object.

Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.
```
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
```
Copy code
An event callback can stop the event and set the return value of the fire method.
Type parameters
TEvent: extends BaseEvent
The type describing the event. See BaseEvent.
Parameters
emitter: Emitter
The object that fires the event.
event: TEvent[ 'name' ]
The name of the event.
callback: GetCallback<TEvent>
The function to be called on event.
options?: GetCallbackOptions<TEvent>
Additional options.
Returns
void
makeSnapshot( options ) → DocumentCompareSnapshot
Captures the current document state as a DocumentCompareSnapshot.

The snapshot contains all data and metadata necessary to process the document and then be able to calculate differences between the original and the processed data.

Importantly, snapshot.content holds data for each root (excluding $graveyard), serialized to HTML. By default, the data is stamped with data-id attributes, assigned to structural elements of the data. During processing, make sure that these data-ids are retained. They are used to identify which elements were kept, which were removed, and which are new.

If the processing cannot retain them, capture the snapshot without the ids (options.useDataIds: false). When data IDs are skipped, the original and processed data is compared only by the content similarity.

The content of an inline root is wrapped in a single, artificial <p data-id="..."> element. This wrapper always gets a data-id, even when the snapshot is captured with options.useDataIds: false. Process only the content inside the wrapper.

See also DocumentCompareSnapshot.
Parameters
options: DocumentCompareSnapshotOptions
How the snapshot is captured.
Defaults to {}
Returns
DocumentCompareSnapshot
The captured snapshot.
off( event, callback ) → void
inherited
Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).
Parameters
event: string
The name of the event.
callback: Function
The function to stop being called.
Returns
void
on( event, callback, options? ) → void
inherited
Registers a callback function to be executed when an event is fired.

Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).
Type parameters
TEvent: extends BaseEvent
The type descibing the event. See BaseEvent.
Parameters
event: TEvent[ 'name' ]
The name of the event.
callback: GetCallback<TEvent>
The function to be called on event.
options?: GetCallbackOptions<TEvent>
Additional options.
Returns
void
once( event, callback, options? ) → void
inherited
Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.
Type parameters
TEvent: extends BaseEvent
The type descibing the event. See BaseEvent.
Parameters
event: TEvent[ 'name' ]
The name of the event.
callback: GetCallback<TEvent>
The function to be called on event.
options?: GetCallbackOptions<TEvent>
Additional options.
Returns
void
process( callback, options ) → Promise<boolean>
Runs the whole processing pipeline in one call: snapshots the document, hands the snapshot to callback for external processing (e.g. an AI service), then diffs returned data and applies granular changes to the document.

This is a "shortcut" for using makeSnapshot, computePatch, and applyPatch.

If diffing or applying fails, the underlying error is rethrown and can be further handled, unless options.overwriteOnError is set, in which case the current document is instead fully replaced with the processed data, the same way as if editor.setData() was used. In this case, changes that happened to the document after the snapshot was taken will be overwritten. See overwriteOnError for the side effects of the replacement.

Errors thrown or rejected by callback are always rethrown, regardless of options.overwriteOnError.

The snapshot is captured with data IDs stamped on the document content, unless options.useDataIds is false. See useDataIds.
Parameters
callback: ( snapshot: DocumentCompareSnapshot ) => Promise<string | Record<string, string>>
Receives the captured snapshot and returns the processed data. For multi-root editor, return an object keyed by root name. Otherwise, return a string with the data of the main root.
options: DocumentCompareProcessOptions
Additional processing options.
Defaults to {}
Returns
Promise<boolean>
true when the process finished successfully and changes were applied granularly, false when the full-replacement fallback was used.
set( values ) → void
inherited
module:ai/toolkit/documentcompare~DocumentCompare#set:OBJECT
Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.

It accepts a single object literal containing key/value pairs with properties to be set.

This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

In TypeScript, those properties should be declared in class using declare keyword. In example:
```
public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}
```
Copy code
Parameters
values: object & object
An object with name=>value pairs.
Returns
void
set( name, value ) → void
inherited
module:ai/toolkit/documentcompare~DocumentCompare#set:KEY_VALUE
Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

In TypeScript, those properties should be declared in class using declare keyword. In example:
```
public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}
```
Copy code
Type parameters
K
Parameters
name: K
The property's name.
value: DocumentCompare[ K ]
The property's value.
Returns
void
stopDelegating( event?, emitter? ) → void
inherited
module:ai/toolkit/documentcompare~DocumentCompare#stopDelegating
Stops delegating events. It can be used at different levels:
- To stop delegating all events.
- To stop delegating a specific event to all emitters.
- To stop delegating a specific event to a specific emitter.
Parameters
event?: string
The name of the event to stop delegating. If omitted, stops it all delegations.
emitter?: Emitter
(requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.
Returns
void
stopListening( emitter?, event?, callback? ) → void
inherited
module:ai/toolkit/documentcompare~DocumentCompare#stopListening:BASE_STOP
Stops listening for events. It can be used at different levels:
- To stop listening to a specific callback.
- To stop listening to a specific event.
- To stop listening to all events fired by a specific object.
- To stop listening to all events fired by all objects.
Parameters
emitter?: Emitter
The object to stop listening to. If omitted, stops it for all objects.
event?: string
(Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.
callback?: Function
(Requires the event) The function to be removed from the call list for the given event.
Returns
void
unbind( unbindProperties ) → void
inherited
module:ai/toolkit/documentcompare~DocumentCompare#unbind
Removes the binding created with bind.
```
// Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
```
Copy code
Parameters
unbindProperties: Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'init' | 'afterInit' | 'editor' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'process' | 'makeSnapshot' | 'computePatch' | 'applyPatch' | 'computeChanges' | 'applyChange'>
Observable properties to be unbound. All the bindings will be released if no properties are provided.
Returns
void

Events

change:isEnabled( eventInfo, name, value, oldValue )
inherited
Fired when the isEnabled property changed value.
Parameters
eventInfo: EventInfo
An object containing information about the fired event.
name: string
Name of the changed property (isEnabled).
value: boolean
New value of the isEnabled property with given key or null, if operation should remove property.
oldValue: boolean
Old value of the isEnabled property with given key or null, if property was not set before.
change:{property}( eventInfo, name, value, oldValue )
inherited
module:ai/toolkit/documentcompare~DocumentCompare#event:change:{property}
Fired when a property changed value.
```
observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'prop has changed from 1 to 2'
```
Copy code
Parameters
eventInfo: EventInfo
An object containing information about the fired event.
name: string
The property name.
value: TValue
The new property value.
oldValue: TValue
The previous property value.
set:isEnabled( eventInfo, name, value, oldValue )
inherited
Fired when the isEnabled property is going to be set but is not set yet (before the change event is fired).
Parameters
eventInfo: EventInfo
An object containing information about the fired event.
name: string
Name of the changed property (isEnabled).
value: boolean
New value of the isEnabled property with given key or null, if operation should remove property.
oldValue: boolean
Old value of the isEnabled property with given key or null, if property was not set before.

`set:{property}( eventInfo, name, value, oldValue )`
inherited

module:ai/toolkit/documentcompare~DocumentCompare#event:set:{property}

Fired when a property value is going to be set but is not set yet (before the change event is fired).

You can control the final value of the property by using the event's return property.

observable.set( 'prop', 1 );

observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
	console.log( `Current property value is ${ observable[ propertyName ] }` );

	// Let's override the value.
	evt.return = 3;
} );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
					 // -> 'Current property value is 1'
					 // -> 'Value has changed from 1 to 3'

Note: The event is fired even when the new value is the same as the old value.

Parameters

eventInfo: EventInfo: An object containing information about the fired event.
name: string: The property name.
value: TValue: The new property value.
oldValue: TValue: The previous property value.

DocumentCompare

Properties

editor: Editorreadonlyinherited

isEnabled: booleanreadonlyinheritedEye iconobservable

Static properties

isContextPlugin: falsereadonlyinheritedstatic

pluginName: 'DocumentCompare'readonlystatic

Methods

constructor( editor )inherited

Parameters

afterInit() → void

Returns

applyChange( change, options ) → void

Parameters

Returns

applyPatch( patch ) → void

Parameters

Returns

bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, DocumentCompare[ K1 ], K2, DocumentCompare[ K2 ]>inherited

Type parameters

Parameters

Returns

bind( bindProperties ) → ObservableMultiBindChaininherited

Parameters

Returns

bind( bindProperty ) → ObservableSingleBindChain<K, DocumentCompare[ K ]>inherited

Type parameters

Parameters

Returns

clearForceDisabled( id ) → voidinherited

Parameters

Returns

computeChanges( snapshot, data, options ) → Array<DocumentChange>

Parameters

Returns

computePatch( snapshot, data, options ) → DocumentComparePatch

Parameters

Returns

decorate( methodName ) → voidinherited

Parameters

Returns

delegate( events ) → EmitterMixinDelegateChaininherited

Parameters

Returns

destroy() → voidinherited

Returns

fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]inherited

Type parameters

Parameters

Returns

forceDisabled( id ) → voidinherited

Parameters

Returns

init() → void

Returns

listenTo( emitter, event, callback, options? ) → voidinherited

Type parameters

Parameters

Returns

makeSnapshot( options ) → DocumentCompareSnapshot

Parameters

Returns

off( event, callback ) → voidinherited

Parameters

Returns

on( event, callback, options? ) → voidinherited

Type parameters

Parameters

Returns

once( event, callback, options? ) → voidinherited

Type parameters

Parameters

Returns

process( callback, options ) → Promise<boolean>

Parameters

Returns

set( values ) → voidinherited

Parameters

Returns

set( name, value ) → voidinherited

`editor: Editor`
readonlyinherited

`isEnabled: boolean`
readonlyinheritedobservable

`isContextPlugin: false`
readonlyinheritedstatic

`pluginName: 'DocumentCompare'`
readonlystatic

`constructor( editor )`
inherited

`afterInit() → void`

`applyChange( change, options ) → void`

`applyPatch( patch ) → void`

`bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, DocumentCompare[ K1 ], K2, DocumentCompare[ K2 ]>`
inherited

`bind( bindProperties ) → ObservableMultiBindChain`
inherited

`bind( bindProperty ) → ObservableSingleBindChain<K, DocumentCompare[ K ]>`
inherited

`clearForceDisabled( id ) → void`
inherited

`computeChanges( snapshot, data, options ) → Array<DocumentChange>`

`computePatch( snapshot, data, options ) → DocumentComparePatch`

`decorate( methodName ) → void`
inherited

`delegate( events ) → EmitterMixinDelegateChain`
inherited

`destroy() → void`
inherited

`fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]`
inherited

`forceDisabled( id ) → void`
inherited

`init() → void`

`listenTo( emitter, event, callback, options? ) → void`
inherited

`makeSnapshot( options ) → DocumentCompareSnapshot`

`off( event, callback ) → void`
inherited

`on( event, callback, options? ) → void`
inherited

`once( event, callback, options? ) → void`
inherited

`process( callback, options ) → Promise<boolean>`

`set( values ) → void`
inherited

`set( name, value ) → void`
inherited

`stopDelegating( event?, emitter? ) → void`
inherited

`stopListening( emitter?, event?, callback? ) → void`
inherited

`unbind( unbindProperties ) → void`
inherited

`change:isEnabled( eventInfo, name, value, oldValue )`
inherited

`change:{property}( eventInfo, name, value, oldValue )`
inherited

`set:isEnabled( eventInfo, name, value, oldValue )`
inherited

`set:{property}( eventInfo, name, value, oldValue )`
inherited