RevisionTracker

class

Creates and updates revisions based on changes of the editor content.

There are always at least two revisions available for the document: the initial revision and the current revision. If those revisions have not been created for the document yet, they are created when the editor data is loaded.

The initial revision contains the initial document data from when the document was loaded for the first time.

The current revision contains all the unsaved document changes, that is changes which have not been saved yet as a specific revision. The current revision is always available and it is always the "top" revision (most recent).

Properties

Methods

constructor( editor )

Parameters
editor : Editor
addRevisionData( revisionData ) → Revision

Creates a revision basing on given revision data and adds it to the revision tracker and revision repository.
Parameters
revisionData : RevisionData
Returns
Revision
afterInit() → Promise<void>

Returns
Promise<void>
bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, RevisionTracker[ K1 ], K2, RevisionTracker[ K2 ]>
inherited
module:revision-history/revisiontracker~RevisionTracker#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, RevisionTracker[ K1 ], K2, RevisionTracker[ K2 ]>
The bind chain with the to() and toMany() methods.
bind( bindProperties ) → ObservableMultiBindChain
inherited
module:revision-history/revisiontracker~RevisionTracker#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' | 'update' | 'init' | 'isEnabled' | 'licenseKey' | 'editor' | 'isReady' | 'forceDisabled' | 'clearForceDisabled' | 'afterInit' | 'adapter' | 'addRevisionData' | 'getRevisionDocumentData' | 'getRevisionRootsAttributes' | 'currentRevision' | 'repository' | '_revisionDataBuilder' | '_bufferedUpdates' | '_startingVersion' | '_isPendingUpdate' | 'saveRevision' | 'setSource' | 'sendBufferedUpdates' | 'buildRevisionData' | '_bufferUpdate' | 'setRevisionData' | '_createInitialRevision' | '_createCurrentRevision'>
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, RevisionTracker[ K ]>
inherited
module:revision-history/revisiontracker~RevisionTracker#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, RevisionTracker[ 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
decorate( methodName ) → void
inherited
module:revision-history/revisiontracker~RevisionTracker#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' | 'update' | 'init' | 'isEnabled' | 'licenseKey' | 'editor' | 'isReady' | 'forceDisabled' | 'clearForceDisabled' | 'afterInit' | 'adapter' | 'addRevisionData' | 'getRevisionDocumentData' | 'getRevisionRootsAttributes' | 'currentRevision' | 'repository' | '_revisionDataBuilder' | '_bufferedUpdates' | '_startingVersion' | '_isPendingUpdate' | 'saveRevision' | 'setSource' | 'sendBufferedUpdates' | 'buildRevisionData' | '_bufferUpdate' | 'setRevisionData' | '_createInitialRevision' | '_createCurrentRevision'
Name of the method to decorate.
Returns
void
delegate( events ) → EmitterMixinDelegateChain
inherited
module:revision-history/revisiontracker~RevisionTracker#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

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
module:revision-history/revisiontracker~RevisionTracker#fire
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

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
Plugin disabled by multiple features:
plugin.forceDisabled( 'MyFeature' ); plugin.forceDisabled( 'OtherFeature' ); plugin.clearForceDisabled( 'MyFeature' ); plugin.isEnabled; // -> false plugin.clearForceDisabled( 'OtherFeature' ); plugin.isEnabled; // -> true
Multiple disabling with the same identifier is redundant:
plugin.forceDisabled( 'MyFeature' ); plugin.forceDisabled( 'MyFeature' ); plugin.clearForceDisabled( 'MyFeature' ); plugin.isEnabled; // -> true
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
getRevisionDocumentData( revision ) → Promise<Record<string, string>>

Returns document data for given revision.
The document data is HTML or a different format, depending on the editor configuration.
This method returns a promise which resolves with an object, where keys are root names and values are these roots' data. Most editor setups use just one root, which has the default name main. In this case, the promise will resolve with an object similar to this:
{ main: "<p>Sample document data.</p>" }
If the adapter integration is used, this method will automatically load necessary Revision#diffData if it is missing.
Please note, that the data returned by this method uses marked fillers mode. This means that some   characters in the returned data may be wrapped with <span data-cke-filler="true"> </span>. Take this difference into consideration if you plan to compare revision data with the data returned by editor.getData().
See also getRevisionRootsAttributes.
Parameters
revision : Revision
Returns
Promise<Record<string, string>>
getRevisionRootsAttributes( revision ) → Promise<Record<string, Record<string, unknown>>>

Returns roots attributes for given revision.
This method returns a promise which resolves with an object, where keys are root names and values are these roots' attributes. Most editor setups use just one root, which has the default name main. In this case, the promise will resolve with an object similar to this:
{ main: {} }
See also getRevisionDocumentData.
Parameters
revision : Revision
Returns
Promise<Record<string, Record<string, unknown>>>
init() → void

Returns
void
listenTo( emitter, event, callback, [ options ] ) → void
inherited

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' );
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
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
saveRevision( revisionData, version ) → Promise<Revision>

Creates and saves a new revision.
// Saves all the unsaved changes as a revision without a name. const myRevision = await revisionTracker.saveRevision(); // Saves all the unsaved changes as a revision named 'My revision'. const myRevision = await revisionTracker.saveRevision( { name: 'My revision' } ); // Saves a revision named 'My revision'. // It will include document data with all the changes up to document version `30`. // The revision will be on "top" of the closest revision with a lower document version. // The revision diff will include all the changes since the previous revision up to document version `30`. const myRevision = await revisionTracker.saveRevision( { name: 'My revision' }, 30 );
A new revision can be created in the middle of the revision history. In such case, already existing revisions will be appropriately updated.
Using this method, a revision without a name can be created even if the requireRevisionName configuration option is set to true.
Parameters
revisionData : RevisionData
Revision data to set on the created revision.

Defaults to {}
version : null | number
Document version on which the revision is saved. If not set, the revision will be saved for the current (most recent) document state.

Defaults to null
Returns
Promise<Revision>
Promise that resolves with the created revision after it is saved locally (the promise does not wait for the adapter update).
set( values ) → void
inherited

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' } ); }
Parameters
values : object
An object with name=>value pairs.
Returns
void
set( name, value ) → void
inherited

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 ); }
Type parameters
K
Parameters
name : K
The property's name.
value : RevisionTracker[ K ]
The property's value.
Returns
void
stopDelegating( [ event ], [ emitter ] ) → void
inherited

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

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

Removes the binding created with bind.
// Removes the binding for the 'a' property. A.unbind( 'a' ); // Removes bindings for all properties. A.unbind();
Parameters
unbindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'update' | 'init' | 'isEnabled' | 'licenseKey' | 'editor' | 'isReady' | 'forceDisabled' | 'clearForceDisabled' | 'afterInit' | 'adapter' | 'addRevisionData' | 'getRevisionDocumentData' | 'getRevisionRootsAttributes' | 'currentRevision' | 'repository' | '_revisionDataBuilder' | '_bufferedUpdates' | '_startingVersion' | '_isPendingUpdate' | 'saveRevision' | 'setSource' | 'sendBufferedUpdates' | 'buildRevisionData' | '_bufferUpdate' | 'setRevisionData' | '_createInitialRevision' | '_createCurrentRevision'>
Observable properties to be unbound. All the bindings will be released if no properties are provided.
Returns
void
update() → Promise<void>

Adds the new document changes to the current revision.
This method should be called before document data and revision data is saved (for example, in the autosave callback).
Returns
Promise<void>
Promise that is resolved after the revision is updated locally (the promise does not wait for the adapter update).
Events
change:_isPendingUpdate( eventInfo, name, value, oldValue )

Fired when the _isPendingUpdate property changed value.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (_isPendingUpdate).
value : boolean
New value of the _isPendingUpdate property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the _isPendingUpdate property with given key or null, if property was not set before.
change:isEnabled( eventInfo, name, value, oldValue )

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:isReady( eventInfo, name, value, oldValue )

Fired when the isReady property changed value.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (isReady).
value : boolean
New value of the isReady property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the isReady property with given key or null, if property was not set before.
change:{property}( eventInfo, name, value, oldValue )
inherited

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'
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:_isPendingUpdate( eventInfo, name, value, oldValue )

Fired when the _isPendingUpdate 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 (_isPendingUpdate).
value : boolean
New value of the _isPendingUpdate property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the _isPendingUpdate property with given key or null, if property was not set before.
set:isEnabled( eventInfo, name, value, oldValue )

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:isReady( eventInfo, name, value, oldValue )

Fired when the isReady 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 (isReady).
value : boolean
New value of the isReady property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the isReady property with given key or null, if property was not set before.
set:{property}( eventInfo, name, value, oldValue )
inherited

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.
Was this page helpful?
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.
GitHub Support Contact Us
© 2003 - 2025 CKSource. All rights reserved.
Hierarchy
Plugin
RevisionTracker
currentRevision
editor
repository
isContextPlugin
pluginName
requires
constructor
addRevisionData
afterInit
bind: DUAL_BIND
bind: MANY_BIND
bind: SINGLE_BIND
clearForceDisabled
decorate
delegate
destroy
fire
forceDisabled
getRevisionDocumentData
getRevisionRootsAttributes
init
listenTo: BASE_EMITTER
off
on
once
saveRevision
set: OBJECT
set: KEY_VALUE
stopDelegating
stopListening: BASE_STOP
unbind
update
change:_isPendingUpdate
change:isEnabled
change:isReady
change:{property}
set:_isPendingUpdate
set:isEnabled
set:isReady
set:{property}

RevisionTracker

Properties

currentRevision : null | Revision

editor : Editorreadonlyinherited

repository : RevisionsRepository

Static properties

isContextPlugin : falsereadonlyinheritedstatic

pluginName : 'RevisionTracker'readonlystatic

requires : readonly tuplereadonlystatic

Methods

constructor( editor )

Parameters

addRevisionData( revisionData ) → Revision

Parameters

Returns

afterInit() → Promise<void>

Returns

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

Type parameters

Parameters

Returns

bind( bindProperties ) → ObservableMultiBindChaininherited

Parameters

Returns

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

Type parameters

Parameters

Returns

clearForceDisabled( id ) → voidinherited

Parameters

Returns

decorate( methodName ) → voidinherited

Parameters

Returns

delegate( events ) → EmitterMixinDelegateChaininherited

Parameters

Returns

destroy() → void

Returns

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

Type parameters

Parameters

Returns

forceDisabled( id ) → voidinherited

Parameters

Returns

getRevisionDocumentData( revision ) → Promise<Record<string, string>>

Parameters

Returns

getRevisionRootsAttributes( revision ) → Promise<Record<string, Record<string, unknown>>>

Parameters

Returns

init() → void

Returns

listenTo( emitter, event, callback, [ options ] ) → voidinherited

Type parameters

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

saveRevision( revisionData, version ) → Promise<Revision>

Parameters

Returns

set( values ) → voidinherited

Parameters

Returns

set( name, value ) → voidinherited

Type parameters

Parameters

Returns

stopDelegating( [ event ], [ emitter ] ) → voidinherited

`currentRevision : null | Revision`

`editor : Editor`
readonlyinherited

`repository : RevisionsRepository`

`isContextPlugin : false`
readonlyinheritedstatic

`pluginName : 'RevisionTracker'`
readonlystatic

`requires : readonly tuple`
readonlystatic

`constructor( editor )`

`addRevisionData( revisionData ) → Revision`

`afterInit() → Promise<void>`

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

`bind( bindProperties ) → ObservableMultiBindChain`
inherited

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

`clearForceDisabled( id ) → void`
inherited

`decorate( methodName ) → void`
inherited

`delegate( events ) → EmitterMixinDelegateChain`
inherited

`destroy() → void`

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

`forceDisabled( id ) → void`
inherited

`getRevisionDocumentData( revision ) → Promise<Record<string, string>>`

`getRevisionRootsAttributes( revision ) → Promise<Record<string, Record<string, unknown>>>`

`init() → void`

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

`off( event, callback ) → void`
inherited

`on( event, callback, [ options ] ) → void`
inherited

`once( event, callback, [ options ] ) → void`
inherited

`saveRevision( revisionData, version ) → Promise<Revision>`

`set( values ) → void`
inherited

`set( name, value ) → void`
inherited

`stopDelegating( [ event ], [ emitter ] ) → void`
inherited

`stopListening( [ emitter ], [ event ], [ callback ] ) → void`
inherited

`unbind( unbindProperties ) → void`
inherited

`update() → Promise<void>`

`change:_isPendingUpdate( eventInfo, name, value, oldValue )`

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

`change:isReady( eventInfo, name, value, oldValue )`

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

`set:_isPendingUpdate( eventInfo, name, value, oldValue )`

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

`set:isReady( eventInfo, name, value, oldValue )`

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