# Suggestion
class
Represents a singular suggestion that is tracked by track changes plugin.
`Suggestion` instances are created and handled by [track changes plugin](module_track-changes_trackchanges-TrackChanges.md).
## Properties
### `aiSource: AIOperationSource | null` _(readonly)_
AI source identifier when the suggestion was produced by an AI feature, otherwise `null`.
### `attributes: object` _(observable)_
Custom suggestion attributes. See also [`setAttribute`](#function-setAttribute) and [`removeAttribute`](#function-removeAttribute).
### `author: User`
The author of the change marked by the suggestion.
### `authoredAt: Date | null` _(observable)_
Date when the change marked by the suggestion was made.
Usually the same as [`createdAt`](#member-createdAt) but may be different in some cases (e.g. when suggestion was added from an external source).
### `createdAt: Date | null`
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: SuggestionFormatData | SuggestionAttributeData | null`
Additional suggestion data.
### `head: Suggestion` _(readonly)_
The first (most-previous) suggestion in this suggestion chain.
### `id: string` _(readonly)_
Suggestion ID.
### `isExternal: boolean` _(readonly)_
The flag indicating whether the suggestion comes from an external source.
### `isInContent: boolean` _(readonly)_
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)_
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: Suggestion | null` _(observable)_
Next suggestion in suggestions chain.
Chained suggestions should be handled as one entity.
### `previous: Suggestion | null` _(observable)_
Previous suggestion in suggestions chain.
Chained suggestions should be handled as one entity.
### `subType: string | null`
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: ModelRange`
#### Returns
* `void`
### `bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain` _(inherited)_
Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.
Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) 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:
```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```typescript
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`](module_utils_observablemixin-Observable.md#function-unbind).
You can also "rename" the property in the binding by specifying the new name in the `to()` chain:
```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```typescript
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:
```typescript
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:
```typescript
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:
```typescript
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
* `ObservableDualBindChain`
The bind chain with the `to()` and `toMany()` methods.
### `bind( bindProperties ) → ObservableMultiBindChain` _(inherited)_
Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.
Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) 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:
```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```typescript
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`](module_utils_observablemixin-Observable.md#function-unbind).
You can also "rename" the property in the binding by specifying the new name in the `to()` chain:
```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```typescript
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:
```typescript
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:
```typescript
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:
```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
#### 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' | 'createdAt' | 'isExternal' | 'aiSource' | '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` _(inherited)_
Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.
Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) 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:
```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```typescript
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`](module_utils_observablemixin-Observable.md#function-unbind).
You can also "rename" the property in the binding by specifying the new name in the `to()` chain:
```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```typescript
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:
```typescript
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:
```typescript
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:
```typescript
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
* `ObservableSingleBindChain`
The bind chain with the `to()` and `toMany()` methods.
### `decorate( methodName ) → void` _(inherited)_
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](../framework/deep-dive/observables.md#decorating-object-methods) 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](module_utils_eventinfo-EventInfo.md#member-stop):
```typescript
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](module_utils_priorities-PriorityString.md) 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:
```typescript
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:
```typescript
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' | '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' | 'createdAt' | 'isExternal' | 'aiSource' | '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)_
Delegates selected events to another [`Emitter`](module_utils_emittermixin-Emitter.md). For instance:
```typescript
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
then `eventX` is delegated (fired by) `emitterB` and `emitterC` along with `data`:
```typescript
emitterA.fire( 'eventX', data );
```
and `eventY` is delegated (fired by) `emitterC` along with `data`:
```typescript
emitterA.fire( 'eventY', data );
```
#### Parameters
* `events: Array`
Event names that will be delegated to another emitter.
#### Returns
* `EmitterMixinDelegateChain`
### `discard() → void`
Discards the suggestion.
#### Returns
* `void`
### `fire( eventOrInfo, args ) → GetEventInfo[ 'return' ]` _(inherited)_
Fires an event, executing all callbacks registered for it.
The first parameter passed to callbacks is an [`EventInfo`](module_utils_eventinfo-EventInfo.md) object, followed by the optional `args` provided in the `fire()` method call.
#### Type parameters
* `TEvent: extends BaseEvent`
The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).
#### Parameters
* `eventOrInfo: GetNameOrEventInfo`
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[ 'return' ]`
By default the method returns `undefined`. However, the return value can be changed by listeners through modification of the [`evt.return`](module_utils_eventinfo-EventInfo.md#member-return)'s property (the event info is the first param of every callback).
### `getAllAdjacentSuggestions() → Array`
Returns all suggestions that are in this suggestion chain.
#### Returns
* `Array`
### `getContainedElement() → ModelElement | null`
Returns the model element contained in the suggestion.
A [model element](module_engine_model_element-ModelElement.md) 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
* `ModelElement | null`
### `getFirstMarker() → Marker | null`
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
* `Marker | null`
### `getFirstRange() → ModelRange | null`
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
* `ModelRange | null`
### `getItems() → Array`
Returns all [model items](module_engine_model_item-ModelItem.md) that are in this suggestion.
#### Returns
* `Array`
### `getMarkerNames() → Array`
Returns all names of markers belonging to this suggestion.
#### Returns
* `Array`
### `getMarkers() → Array`
Returns all markers belonging to this suggestion.
#### Returns
* `Array`
### `getRanges() → Array`
Returns all ranges of all markers belonging to this suggestion.
#### Returns
* `Array`
### `isIntersectingWithRange( range ) → boolean`
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)_
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.
```typescript
// 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](module_utils_eventinfo-EventInfo.md#member-stop) and set the [return value](module_utils_eventinfo-EventInfo.md#member-return) of the [`fire`](#function-fire) method.
#### Type parameters
* `TEvent: extends BaseEvent`
The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).
#### Parameters
* `emitter: Emitter`
The object that fires the event.
* `event: TEvent[ 'name' ]`
The name of the event.
* `callback: GetCallback`
The function to be called on event.
* `options?: GetCallbackOptions`
Additional options.
#### Returns
* `void`
### `off( event, callback ) → void` _(inherited)_
Stops executing the callback on the given event. Shorthand for [`this.stopListening( this, event, callback )`](#function-stopListening:BASE_STOP).
#### 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 )`](#function-listenTo:BASE_EMITTER) (it makes the emitter listen on itself).
#### Type parameters
* `TEvent: extends BaseEvent`
The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).
#### Parameters
* `event: TEvent[ 'name' ]`
The name of the event.
* `callback: GetCallback`
The function to be called on event.
* `options?: GetCallbackOptions`
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`](#function-on) followed by [`off`](#function-off) in the callback.
#### Type parameters
* `TEvent: extends BaseEvent`
The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).
#### Parameters
* `event: TEvent[ 'name' ]`
The name of the event.
* `callback: GetCallback`
The function to be called on event.
* `options?: GetCallbackOptions`
Additional options.
#### Returns
* `void`
### `removeAttribute( name ) → void`
Removes suggestion attribute.
See also [`setAttribute`](#function-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`
### `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:
```typescript
public declare myProp1: number;
public declare myProp2: string;
constructor() {
this.set( {
'myProp1: 2,
'myProp2: 'foo'
} );
}
```
#### Parameters
* `values: object & 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:
```typescript
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.
```typescript
suggestion.setAttribute( 'isImportant', true );
```
You can group multiple values in an object, using dot notation:
```typescript
suggestion.setAttribute( 'customData.type', 'image' );
suggestion.setAttribute( 'customData.src', 'foo.jpg' );
```
Attributes set on the suggestion can be accessed through `attribute` property:
```typescript
const isImportant = suggestion.attributes.isImportant;
const type = suggestion.attributes.customData.type;
```
You can also observe `attributes` property or bind other properties to it:
```typescript
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`
### `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`
### `toJSON() → SuggestionJSON`
#### Returns
* `SuggestionJSON`
### `unbind( unbindProperties ) → void` _(inherited)_
Removes the binding created with [`bind`](#function-bind:SINGLE_BIND).
```typescript
// Removes the binding for the 'a' property.
A.unbind( 'a' );
// Removes bindings for all properties.
A.unbind();
```
#### 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' | 'createdAt' | 'isExternal' | 'aiSource' | '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)_
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: Date | null`
New value of the `authoredAt` property with given key or `null`, if operation should remove property.
* `oldValue: Date | null`
Old value of the `authoredAt` 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: Suggestion | null`
New value of the `next` property with given key or `null`, if operation should remove property.
* `oldValue: Suggestion | null`
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: Suggestion | null`
New value of the `previous` property with given key or `null`, if operation should remove property.
* `oldValue: Suggestion | null`
Old value of the `previous` 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.
```typescript
observable.set( 'prop', 1 );
observable.on>( '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: Date | null`
New value of the `authoredAt` property with given key or `null`, if operation should remove property.
* `oldValue: Date | null`
Old value of the `authoredAt` 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: Suggestion | null`
New value of the `next` property with given key or `null`, if operation should remove property.
* `oldValue: Suggestion | null`
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: Suggestion | null`
New value of the `previous` property with given key or `null`, if operation should remove property.
* `oldValue: Suggestion | null`
Old value of the `previous` 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](module_utils_eventinfo-EventInfo.md#member-return).
```typescript
observable.set( 'prop', 1 );
observable.on>( '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>( '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.
---
Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)