Suggestion

• attributes : object

  observable

  module:track-changes/suggestion~Suggestion#attributes

  Custom suggestion attributes. See also setAttribute and removeAttribute.

• author : User

  module:track-changes/suggestion~Suggestion#author

  The author of the change marked by the suggestion.

• authoredAt : null | Date

  observable

  module:track-changes/suggestion~Suggestion#authoredAt

  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).

• commentThread : null | CommentThread

  observable

  module:track-changes/suggestion~Suggestion#commentThread

  Comment thread model for comments added to this suggestion.

• createdAt : null | Date

  module:track-changes/suggestion~Suggestion#createdAt

  Date when the suggestion was saved in the database.

• creator : User

  module:track-changes/suggestion~Suggestion#creator

  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 | SuggestionFormatData | SuggestionAttributeData

  module:track-changes/suggestion~Suggestion#data

  Additional suggestion data.

• hasComments : boolean

  readonly

  module:track-changes/suggestion~Suggestion#hasComments

  Informs whether suggestion has at least one comment.

• head : Suggestion

  readonly

  module:track-changes/suggestion~Suggestion#head

  The first (most-previous) suggestion in this suggestion chain.

• id : string

  readonly

  module:track-changes/suggestion~Suggestion#id

  Suggestion ID.

• isExternal : boolean

  module:track-changes/suggestion~Suggestion#isExternal

  The flag indicating whether the suggestion comes from an external source.

• isInContent : boolean

  readonly

  module:track-changes/suggestion~Suggestion#isInContent

  Informs whether the suggestion is still in the editor content.

  Returns true if there is at least one marker suggestion in the editor content.

• isMultiRange : boolean

  readonly

  module:track-changes/suggestion~Suggestion#isMultiRange

  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.

• next : null | Suggestion

  observable

  module:track-changes/suggestion~Suggestion#next

  Next suggestion in suggestions chain.

  Chained suggestions should be handled as one entity.

• previous : null | Suggestion

  observable

  module:track-changes/suggestion~Suggestion#previous

  Previous suggestion in suggestions chain.

  Chained suggestions should be handled as one entity.

• subType : null | string

  module:track-changes/suggestion~Suggestion#subType

  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

  module:track-changes/suggestion~Suggestion#type

  Suggestion type.

• constructor( model, options )

  module:track-changes/suggestion~Suggestion#constructor

  Parameters

  model : Model

  options : SuggestionOptions

• accept() → void

  module:track-changes/suggestion~Suggestion#accept

  Accepts the suggestion.

  Returns

  void

• addMarkerName( markerName ) → void

  module:track-changes/suggestion~Suggestion#addMarkerName

  Binds given marker name to this suggestion.

  Parameters

  markerName : string

  Returns

  void

• addRange( range ) → void

  module:track-changes/suggestion~Suggestion#addRange

  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 : ModelRange

  Returns

  void

• bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, Suggestion[ K1 ], K2, Suggestion[ K2 ]>

  inherited

  module:track-changes/suggestion~Suggestion#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, Suggestion[ K1 ], K2, Suggestion[ K2 ]>

  The bind chain with the to() and toMany() methods.

• bind( bindProperties ) → ObservableMultiBindChain

  inherited

  module:track-changes/suggestion~Suggestion#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<'type' | 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'data' | 'head' | 'attributes' | 'id' | 'removeAttribute' | 'setAttribute' | 'toJSON' | 'removeMarker' | 'next' | 'accept' | 'previous' | 'authoredAt' | 'author' | 'creator' | 'isExternal' | 'createdAt' | 'subType' | 'commentThread' | '_saved' | '_originalSuggestionId' | '_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

  ObservableMultiBindChain

  The bind chain with the to() and toMany() methods.

• bind( bindProperty ) → ObservableSingleBindChain<K, Suggestion[ K ]>

  inherited

  module:track-changes/suggestion~Suggestion#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, Suggestion[ K ]>

  The bind chain with the to() and toMany() methods.

• decorate( methodName ) → void

  inherited

  module:track-changes/suggestion~Suggestion#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 : 'type' | 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'data' | 'head' | 'attributes' | 'id' | 'removeAttribute' | 'setAttribute' | 'toJSON' | 'removeMarker' | 'next' | 'accept' | 'previous' | 'authoredAt' | 'author' | 'creator' | 'isExternal' | 'createdAt' | 'subType' | 'commentThread' | '_saved' | '_originalSuggestionId' | '_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

• delegate( events ) → EmitterMixinDelegateChain

  inherited

  module:track-changes/suggestion~Suggestion#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

• discard() → void

  module:track-changes/suggestion~Suggestion#discard

  Discards the suggestion.

  Returns

  void

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

  inherited

  module:track-changes/suggestion~Suggestion#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).

• getAllAdjacentSuggestions() → Array<Suggestion>

  module:track-changes/suggestion~Suggestion#getAllAdjacentSuggestions

  Returns all suggestions that are in this suggestion chain.

  Returns

  Array<Suggestion>

• getContainedElement() → null | ModelElement

  module:track-changes/suggestion~Suggestion#getContainedElement

  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 | ModelElement

• getFirstMarker() → null | Marker

  module:track-changes/suggestion~Suggestion#getFirstMarker

  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 | ModelRange

  module:track-changes/suggestion~Suggestion#getFirstRange

  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 | ModelRange

• getItems() → Array<ModelItem>

  module:track-changes/suggestion~Suggestion#getItems

  Returns all model items that are in this suggestion.

  Returns

  Array<ModelItem>

• getMarkerNames() → Array<string>

  module:track-changes/suggestion~Suggestion#getMarkerNames

  Returns all names of markers belonging to this suggestion.

  Returns

  Array<string>

• getMarkers() → Array<Marker>

  module:track-changes/suggestion~Suggestion#getMarkers

  Returns all markers belonging to this suggestion.

  Returns

  Array<Marker>

• getRanges() → Array<ModelRange>

  module:track-changes/suggestion~Suggestion#getRanges

  Returns all ranges of all markers belonging to this suggestion.

  Returns

  Array<ModelRange>

• isIntersectingWithRange( range ) → boolean

  module:track-changes/suggestion~Suggestion#isIntersectingWithRange

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

  Parameters

  range : ModelRange

  Returns

  boolean

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

  inherited

  module:track-changes/suggestion~Suggestion#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

• off( event, callback ) → void

  inherited

  module:track-changes/suggestion~Suggestion#off

  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

  module:track-changes/suggestion~Suggestion#on

  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

  module:track-changes/suggestion~Suggestion#once

  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

  module:track-changes/suggestion~Suggestion#removeAttribute

  Removes suggestion attribute.

  See also setAttribute

  Parameters

  name : string

  Returns

  void

• removeMarker( markerName ) → void

  module:track-changes/suggestion~Suggestion#removeMarker

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

  Parameters

  markerName : string

  Returns

  void

• removeMarkers() → void

  module:track-changes/suggestion~Suggestion#removeMarkers

  Removes all markers from the suggestion and the editor content.

  Returns

  void

• set( values ) → void

  inherited

  module:track-changes/suggestion~Suggestion#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

  An object with name=>value pairs.

  Returns

  void

• set( name, value ) → void

  inherited

  module:track-changes/suggestion~Suggestion#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 : Suggestion[ K ]

  The property's value.

  Returns

  void

• setAttribute( name, value ) → void

  module:track-changes/suggestion~Suggestion#setAttribute

  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 );
  

  Copy code

  You can group multiple values in an object, using dot notation:

  suggestion.setAttribute( 'customData.type', 'image' );
  suggestion.setAttribute( 'customData.src', 'foo.jpg' );
  

  Copy code

  Attributes set on the suggestion can be accessed through attribute property:

  const isImportant = suggestion.attributes.isImportant;
  const type = suggestion.attributes.customData.type;
  

  Copy code

  You can also observe attributes property or bind other properties to it:

  myObj.bind( 'customData' ).to( suggestion, 'attributes', attributes => attributes.customData );
  

  Copy code

  Whenever setAttribute() or removeAttribute() is called, attributes property is re-set and observables are refreshed.

  Parameters

  name : string

  value : unknown

  Returns

  void

• stopDelegating( [ event ], [ emitter ] ) → void

  inherited

  module:track-changes/suggestion~Suggestion#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:track-changes/suggestion~Suggestion#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

• toJSON() → SuggestionJSON

  module:track-changes/suggestion~Suggestion#toJSON

  Returns

  SuggestionJSON

• unbind( unbindProperties ) → void

  inherited

  module:track-changes/suggestion~Suggestion#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<'type' | 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'data' | 'head' | 'attributes' | 'id' | 'removeAttribute' | 'setAttribute' | 'toJSON' | 'removeMarker' | 'next' | 'accept' | 'previous' | 'authoredAt' | 'author' | 'creator' | 'isExternal' | 'createdAt' | 'subType' | 'commentThread' | '_saved' | '_originalSuggestionId' | '_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

• getMultiRangeId() → string

  static

  module:track-changes/suggestion~Suggestion.getMultiRangeId

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

  Returns

  string

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

  module:track-changes/suggestion~Suggestion#event:change:_saved

  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] } )

  module:track-changes/suggestion~Suggestion#event:change:attributes

  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 )

  module:track-changes/suggestion~Suggestion#event:change:authoredAt

  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 )

  module:track-changes/suggestion~Suggestion#event:change:commentThread

  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 )

  module:track-changes/suggestion~Suggestion#event:change:next

  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 )

  module:track-changes/suggestion~Suggestion#event:change:previous

  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.

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

  inherited

  module:track-changes/suggestion~Suggestion#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:_saved( eventInfo, name, value, oldValue )

  module:track-changes/suggestion~Suggestion#event:set:_saved

  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] } )

  module:track-changes/suggestion~Suggestion#event:set:attributes

  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 )

  module:track-changes/suggestion~Suggestion#event:set:authoredAt

  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 )

  module:track-changes/suggestion~Suggestion#event:set:commentThread

  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 )

  module:track-changes/suggestion~Suggestion#event:set:next

  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 )

  module:track-changes/suggestion~Suggestion#event:set:previous

  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.

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

  inherited

  module:track-changes/suggestion~Suggestion#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'
  

  Copy code

  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.