Home/CKEditor 5/API

Suggestion (track-changes)

@ckeditor/ckeditor5-track-changes/src/suggestion

class

Represents a singular suggestion that is tracked by track changes plugin.

Suggestion instances are created and handled by track changes plugin.

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Properties

observable
attributes : object

Custom suggestion attributes. See also setAttribute and removeAttribute.
author : User

The author of the change marked by the suggestion.
observable
authoredAt : null | Date

Date when the change marked by the suggestion was made.

Usually the same as createdAt but may be different in some cases (e.g. when suggestion was added from an external source).
observable
commentThread : null | CommentThread

Comment thread model for comments added to this suggestion.
createdAt : null | Date

Date when the suggestion was saved in the database.
creator : User

The user which saved the suggestion data in the database.

Usually the same as author but may be different in some cases (e.g. when suggestion was added from an external source).
data : null | FormatData | AttributeData

Additional suggestion data.
readonly
hasComments : boolean

Informs whether suggestion has at least one comment.
readonly
head : Suggestion

The first (most-previous) suggestion in this suggestion chain.
readonly
id : string

Suggestion ID.
isExternal : boolean

The flag indicating whether the suggestion comes from an external source.
readonly
isInContent : boolean

Informs whether the suggestion is still in the editor content.

Returns true if there is at least one marker suggestion in the editor content.
readonly
isMultiRange : boolean

Informs whether the suggestion is a multi-range suggestion or a single-range suggestion.

This is evaluated basing on the marker name belonging to this suggestion. Even if only one marker belongs to the suggestion at a given time it can still be a multi range suggestion.
observable
next : null | Suggestion

Next suggestion in suggestions chain.

Chained suggestions should be handled as one entity.
observable
previous : null | Suggestion

Previous suggestion in suggestions chain.

Chained suggestions should be handled as one entity.
subType : null | string
Suggestion sub-type.

This is an additional identifier for suggestions. Two suggestions of the same type may have different sub-types to differentiate suggestions behavior and handle interactions between suggestions.

Sub-type is used for:
- suggestions joining (only suggestions with the same sub-type can be joined),
- suggestions custom callbacks (fired when adding, deleting and joining suggestions).
type : SuggestionType

Suggestion type.

Methods

constructor( model, options )

Parameters

model : Model

options : SuggestionOptions
accept() → void

Accepts the suggestion.

Returns

void
addMarkerName( markerName ) → void

Binds given marker name to this suggestion.

Parameters

markerName : string

Returns

void
addRange( range ) → void

Adds a new range to this suggestion. It is assumed that the suggestion is a multi-range suggestion.

A marker name is generated from this suggestion's properties and a marker with that name is created and set to a given range.

Parameters

range : Range

Returns

void
inherited
bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, Suggestion[ K1 ], K2, Suggestion[ K2 ]>
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' );
```
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
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' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
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 );
```
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
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 );
```
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

DualBindChain<K1, Suggestion[ K1 ], K2, Suggestion[ K2 ]>

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperties ) → MultiBindChain
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' );
```
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
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' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
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 );
```
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
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 );
```
Parameters

bindProperties : Array<'type' | 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'data' | 'head' | 'attributes' | 'id' | 'removeAttribute' | 'setAttribute' | 'toJSON' | 'removeMarker' | 'next' | 'accept' | 'previous' | 'authoredAt' | 'author' | 'creator' | 'isExternal' | 'createdAt' | 'subType' | 'commentThread' | '_saved' | '_isDataLoaded' | '_onAccept' | '_onDiscard' | 'hasComments' | 'isMultiRange' | 'isInContent' | 'addMarkerName' | 'getMarkerNames' | 'getMarkers' | 'getFirstMarker' | 'removeMarkers' | 'addRange' | 'isIntersectingWithRange' | 'getRanges' | 'getItems' | 'getFirstRange' | 'getContainedElement' | 'discard' | 'getAllAdjacentSuggestions'>

Observable properties that will be bound to other observable(s).

Returns

MultiBindChain

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperty ) → SingleBindChain<K, Suggestion[ K ]>
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' );
```
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
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' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
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 );
```
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
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 );
```
Type parameters

K

Parameters

bindProperty : K

Observable property that will be bound to other observable(s).

Returns

SingleBindChain<K, Suggestion[ K ]>

The bind chain with the to() and toMany() methods.
inherited
decorate( methodName ) → void
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.
```
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'
```
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'
```
Parameters

methodName : 'type' | 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'data' | 'head' | 'attributes' | 'id' | 'removeAttribute' | 'setAttribute' | 'toJSON' | 'removeMarker' | 'next' | 'accept' | 'previous' | 'authoredAt' | 'author' | 'creator' | 'isExternal' | 'createdAt' | 'subType' | 'commentThread' | '_saved' | '_isDataLoaded' | '_onAccept' | '_onDiscard' | 'hasComments' | 'isMultiRange' | 'isInContent' | 'addMarkerName' | 'getMarkerNames' | 'getMarkers' | 'getFirstMarker' | 'removeMarkers' | 'addRange' | 'isIntersectingWithRange' | 'getRanges' | 'getItems' | 'getFirstRange' | 'getContainedElement' | 'discard' | 'getAllAdjacentSuggestions'

Name of the method to decorate.

Returns

void
inherited
delegate( events ) → EmitterMixinDelegateChain
Delegates selected events to another Emitter. For instance:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
then eventX is delegated (fired by) emitterB and emitterC along with data:
```
emitterA.fire( 'eventX', data );
```
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.fire( 'eventY', data );
```
Parameters

events : Array<string>

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain
discard() → void

Discards the suggestion.

Returns

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

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).
getAllAdjacentSuggestions() → Array<Suggestion>

Returns all suggestions that are in this suggestion chain.

Returns

Array<Suggestion>
getContainedElement() → null | Element

Returns the model element contained in the suggestion.

A model element is considered as contained if there is exactly one range in the suggestion, and that range contains exactly one element.

Returns null if there is no contained element.

Returns

null | Element
getFirstMarker() → null | Marker

Returns the first marker belonging to this suggestion, i.e the first marker that was added to this suggestion and not removed yet.

This method is useful if you know that the suggestion has only one marker and want to process it.

Returns

null | Marker
getFirstRange() → null | Range

Returns the first range belonging to this suggestion, i.e. the range of the first marker that was added to this suggestion and not removed yet.

This method is useful if you know that the suggestion has only one marker and want to process its range.

Returns

null | Range
getItems() → Array<Item>

Returns all model items that are in this suggestion.

Returns

Array<Item>
getMarkerNames() → Array<string>

Returns all names of markers belonging to this suggestion.

Returns

Array<string>
getMarkers() → Array<Marker>

Returns all markers belonging to this suggestion.

Returns

Array<Marker>
getRanges() → Array<Range>

Returns all ranges of all markers belonging to this suggestion.

Returns

Array<Range>
isIntersectingWithRange( range ) → boolean

Checks if given range is intersecting with any of the ranges of markers belonging to this suggestion.

Parameters

range : Range

Returns

boolean
inherited
listenTo( emitter, event, callback, [ options ] ) → void
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
inherited
off( event, callback ) → void

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
inherited
on( event, callback, [ options ] ) → void

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
inherited
once( event, callback, [ options ] ) → void

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
removeAttribute( name ) → void

Removes suggestion attribute.

See also setAttribute

Parameters

name : string

Returns

void
removeMarker( markerName ) → void

Removes marker with the given name from the suggestion and the editor content.

Parameters

markerName : string

Returns

void
removeMarkers() → void

Removes all markers from the suggestion and the editor content.

Returns

void
inherited
set( values ) → void
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
inherited
set( name, value ) → void
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 : Suggestion[ K ]

The property's value.

Returns

void
setAttribute( name, value ) → void
Adds suggestion attribute.

Suggestion attributes are custom data that can be set and used by features built around suggestions. Use it to store your feature data with other suggestion data.
```
suggestion.setAttribute( 'isImportant', true );
```
You can group multiple values in an object, using dot notation:
```
suggestion.setAttribute( 'customData.type', 'image' );
suggestion.setAttribute( 'customData.src', 'foo.jpg' );
```
Attributes set on the suggestion can be accessed through attribute property:
```
const isImportant = suggestion.attributes.isImportant;
const type = suggestion.attributes.customData.type;
```
You can also observe attributes property or bind other properties to it:
```
myObj.bind( 'customData' ).to( suggestion, 'attributes', attributes => attributes.customData );
```
Whenever setAttribute() or removeAttribute() is called, attributes property is re-set and observables are refreshed.

Parameters

name : string

value : unknown

Returns

void
inherited
stopDelegating( [ event ], [ emitter ] ) → void
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
inherited
stopListening( [ emitter ], [ event ], [ callback ] ) → void
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
toJSON() → SuggestionJSON

Returns

SuggestionJSON
inherited
unbind( unbindProperties ) → void
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<'type' | 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'data' | 'head' | 'attributes' | 'id' | 'removeAttribute' | 'setAttribute' | 'toJSON' | 'removeMarker' | 'next' | 'accept' | 'previous' | 'authoredAt' | 'author' | 'creator' | 'isExternal' | 'createdAt' | 'subType' | 'commentThread' | '_saved' | '_isDataLoaded' | '_onAccept' | '_onDiscard' | 'hasComments' | 'isMultiRange' | 'isInContent' | 'addMarkerName' | 'getMarkerNames' | 'getMarkers' | 'getFirstMarker' | 'removeMarkers' | 'addRange' | 'isIntersectingWithRange' | 'getRanges' | 'getItems' | 'getFirstRange' | 'getContainedElement' | 'discard' | 'getAllAdjacentSuggestions'>

Observable properties to be unbound. All the bindings will be released if no properties are provided.

Returns

void

Static methods

static
getMultiRangeId() → string

Returns a random string that can be used as additional identifier for the marker name for suggestions that are multi range.

Returns

string

Events

change:_saved( eventInfo, name, value, oldValue )

Fired when the _saved property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (_saved).

value : boolean

New value of the _saved property with given key or null, if operation should remove property.

oldValue : boolean

Old value of the _saved property with given key or null, if property was not set before.
change:attributes( eventInfo, name, value = { value[k: string] }, oldValue = { oldValue[k: string] } )

Fired when the attributes property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (attributes).

value : object

New value of the attributes property with given key or null, if operation should remove property.

Properties

value[k: string] : unknown

oldValue : object

Old value of the attributes property with given key or null, if property was not set before.

Properties

oldValue[k: string] : unknown
change:authoredAt( eventInfo, name, value, oldValue )

Fired when the authoredAt property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (authoredAt).

value : null | Date

New value of the authoredAt property with given key or null, if operation should remove property.

oldValue : null | Date

Old value of the authoredAt property with given key or null, if property was not set before.
change:commentThread( eventInfo, name, value, oldValue )

Fired when the commentThread property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (commentThread).

value : null | CommentThread

New value of the commentThread property with given key or null, if operation should remove property.

oldValue : null | CommentThread

Old value of the commentThread property with given key or null, if property was not set before.
change:next( eventInfo, name, value, oldValue )

Fired when the next property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (next).

value : null | Suggestion

New value of the next property with given key or null, if operation should remove property.

oldValue : null | Suggestion

Old value of the next property with given key or null, if property was not set before.
change:previous( eventInfo, name, value, oldValue )

Fired when the previous property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (previous).

value : null | Suggestion

New value of the previous property with given key or null, if operation should remove property.

oldValue : null | Suggestion

Old value of the previous property with given key or null, if property was not set before.
inherited
change:{property}( eventInfo, name, value, oldValue )
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:_saved( eventInfo, name, value, oldValue )

Fired when the _saved 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 (_saved).

value : boolean

New value of the _saved property with given key or null, if operation should remove property.

oldValue : boolean

Old value of the _saved property with given key or null, if property was not set before.
set:attributes( eventInfo, name, value = { value[k: string] }, oldValue = { oldValue[k: string] } )

Fired when the attributes 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 (attributes).

value : object

New value of the attributes property with given key or null, if operation should remove property.

Properties

value[k: string] : unknown

oldValue : object

Old value of the attributes property with given key or null, if property was not set before.

Properties

oldValue[k: string] : unknown
set:authoredAt( eventInfo, name, value, oldValue )

Fired when the authoredAt 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 (authoredAt).

value : null | Date

New value of the authoredAt property with given key or null, if operation should remove property.

oldValue : null | Date

Old value of the authoredAt property with given key or null, if property was not set before.
set:commentThread( eventInfo, name, value, oldValue )

Fired when the commentThread 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 (commentThread).

value : null | CommentThread

New value of the commentThread property with given key or null, if operation should remove property.

oldValue : null | CommentThread

Old value of the commentThread property with given key or null, if property was not set before.
set:next( eventInfo, name, value, oldValue )

Fired when the next 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 (next).

value : null | Suggestion

New value of the next property with given key or null, if operation should remove property.

oldValue : null | Suggestion

Old value of the next property with given key or null, if property was not set before.
set:previous( eventInfo, name, value, oldValue )

Fired when the previous 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 (previous).

value : null | Suggestion

New value of the previous property with given key or null, if operation should remove property.

oldValue : null | Suggestion

Old value of the previous property with given key or null, if property was not set before.
inherited
set:{property}( eventInfo, name, value, oldValue )
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.

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.

With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.

Suggestion (track-changes)

Filtering

Properties

observable attributes : objectmodule:track-changes/suggestion~Suggestion#attributes

author : Usermodule:track-changes/suggestion~Suggestion#author

observable authoredAt : null | Datemodule:track-changes/suggestion~Suggestion#authoredAt

observable commentThread : null | CommentThreadmodule:track-changes/suggestion~Suggestion#commentThread

createdAt : null | Datemodule:track-changes/suggestion~Suggestion#createdAt

creator : Usermodule:track-changes/suggestion~Suggestion#creator

data : null | FormatData | AttributeDatamodule:track-changes/suggestion~Suggestion#data

readonly hasComments : booleanmodule:track-changes/suggestion~Suggestion#hasComments

readonly head : Suggestionmodule:track-changes/suggestion~Suggestion#head

readonly id : stringmodule:track-changes/suggestion~Suggestion#id

isExternal : booleanmodule:track-changes/suggestion~Suggestion#isExternal

readonly isInContent : booleanmodule:track-changes/suggestion~Suggestion#isInContent

readonly isMultiRange : booleanmodule:track-changes/suggestion~Suggestion#isMultiRange

observable next : null | Suggestionmodule:track-changes/suggestion~Suggestion#next

observable previous : null | Suggestionmodule:track-changes/suggestion~Suggestion#previous

subType : null | stringmodule:track-changes/suggestion~Suggestion#subType

type : SuggestionTypemodule:track-changes/suggestion~Suggestion#type

Methods

constructor( model, options )module:track-changes/suggestion~Suggestion#constructor

Parameters

accept() → voidmodule:track-changes/suggestion~Suggestion#accept

Returns

addMarkerName( markerName ) → voidmodule:track-changes/suggestion~Suggestion#addMarkerName

Parameters

Returns

addRange( range ) → voidmodule:track-changes/suggestion~Suggestion#addRange

Parameters

Returns

inherited bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, Suggestion[ K1 ], K2, Suggestion[ K2 ]>module:track-changes/suggestion~Suggestion#bind:DUAL_BIND

Type parameters

Parameters

Returns

inherited bind( bindProperties ) → MultiBindChainmodule:track-changes/suggestion~Suggestion#bind:MANY_BIND

Parameters

Returns

inherited bind( bindProperty ) → SingleBindChain<K, Suggestion[ K ]>module:track-changes/suggestion~Suggestion#bind:SINGLE_BIND

Type parameters

Parameters

Returns

inherited decorate( methodName ) → voidmodule:track-changes/suggestion~Suggestion#decorate

Parameters

Returns

inherited delegate( events ) → EmitterMixinDelegateChainmodule:track-changes/suggestion~Suggestion#delegate

Parameters

Returns

discard() → voidmodule:track-changes/suggestion~Suggestion#discard

Returns

inherited fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]module:track-changes/suggestion~Suggestion#fire

Type parameters

Parameters

Returns

getAllAdjacentSuggestions() → Array<Suggestion>module:track-changes/suggestion~Suggestion#getAllAdjacentSuggestions

Returns

getContainedElement() → null | Elementmodule:track-changes/suggestion~Suggestion#getContainedElement

Returns

getFirstMarker() → null | Markermodule:track-changes/suggestion~Suggestion#getFirstMarker

Returns

getFirstRange() → null | Rangemodule:track-changes/suggestion~Suggestion#getFirstRange

Returns

getItems() → Array<Item>module:track-changes/suggestion~Suggestion#getItems

Returns

getMarkerNames() → Array<string>module:track-changes/suggestion~Suggestion#getMarkerNames

Returns

getMarkers() → Array<Marker>module:track-changes/suggestion~Suggestion#getMarkers

Returns

getRanges() → Array<Range>module:track-changes/suggestion~Suggestion#getRanges

Returns

isIntersectingWithRange( range ) → booleanmodule:track-changes/suggestion~Suggestion#isIntersectingWithRange

Parameters

Returns

inherited listenTo( emitter, event, callback, [ options ] ) → voidmodule:track-changes/suggestion~Suggestion#listenTo:BASE_EMITTER

Type parameters

Parameters

Returns

inherited off( event, callback ) → voidmodule:track-changes/suggestion~Suggestion#off

Parameters

Returns

observable
`attributes : object`

`author : User`

observable
`authoredAt : null | Date`

observable
`commentThread : null | CommentThread`

`createdAt : null | Date`

`creator : User`

`data : null | FormatData | AttributeData`

readonly
`hasComments : boolean`

readonly
`head : Suggestion`

readonly
`id : string`

`isExternal : boolean`

readonly
`isInContent : boolean`

readonly
`isMultiRange : boolean`

observable
`next : null | Suggestion`

observable
`previous : null | Suggestion`

`subType : null | string`

`type : SuggestionType`

`constructor( model, options )`

`accept() → void`

`addMarkerName( markerName ) → void`

`addRange( range ) → void`

inherited
`bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, Suggestion[ K1 ], K2, Suggestion[ K2 ]>`

inherited
`bind( bindProperties ) → MultiBindChain`

inherited
`bind( bindProperty ) → SingleBindChain<K, Suggestion[ K ]>`

inherited
`decorate( methodName ) → void`

inherited
`delegate( events ) → EmitterMixinDelegateChain`

`discard() → void`

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

`getAllAdjacentSuggestions() → Array<Suggestion>`

`getContainedElement() → null | Element`

`getFirstMarker() → null | Marker`

`getFirstRange() → null | Range`

`getItems() → Array<Item>`

`getMarkerNames() → Array<string>`

`getMarkers() → Array<Marker>`

`getRanges() → Array<Range>`

`isIntersectingWithRange( range ) → boolean`

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

inherited
`off( event, callback ) → void`

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

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

`removeAttribute( name ) → void`

`removeMarker( markerName ) → void`

`removeMarkers() → void`

inherited
`set( values ) → void`

inherited
`set( name, value ) → void`

`setAttribute( name, value ) → void`

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

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

`toJSON() → SuggestionJSON`

inherited
`unbind( unbindProperties ) → void`

static
`getMultiRangeId() → string`

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

`change:attributes( eventInfo, name, value = { value[k: string] }, oldValue = { oldValue[k: string] } )`

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

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

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

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

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

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

`set:attributes( eventInfo, name, value = { value[k: string] }, oldValue = { oldValue[k: string] } )`

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

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

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

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

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