# MergeFieldsEditing
class
The merge fields editing feature.
## Properties
### `availablePreviewModes: Array` _(readonly)_
All configured preview modes, available to be set as a value for [`previewMode`](#member-previewMode).
### `editor: Editor` _(readonly)_
The editor instance.
Note that most editors implement the [`ui`](module_core_editor_editor-Editor.md#member-ui) property. However, editors with an external UI (i.e. Bootstrap-based) or a headless editor may not have this property or throw an error when accessing it.
Because of above, to make plugins more universal, it is recommended to split features into:
* The "editing" part that uses the [`Editor`](module_core_editor_editor-Editor.md) class without `ui` property.
* The "UI" part that uses the [`Editor`](module_core_editor_editor-Editor.md) class and accesses `ui` property.
### `flattenedMergeFieldDefinitions: Array`
A flat list of all merge field definitions.
### `isEnabled: boolean` _(readonly)_
Flag indicating whether a plugin is enabled or disabled. A disabled plugin will not transform text.
Plugin can be simply disabled like that:
```typescript
// Disable the plugin so that no toolbars are visible.
editor.plugins.get( 'TextTransformation' ).isEnabled = false;
```
You can also use [`forceDisabled`](#function-forceDisabled) method.
### `previewMode: string` _(observable)_
The current preview mode for merge fields. Determines the merge field values displayed in the editor.
#### Static properties
### `isContextPlugin: false` _(readonly)_
### `pluginName: 'MergeFieldsEditing'` _(readonly)_
### `requires: readonly [ PluginConstructor & new ( context: Editor ) => ImageUtils, PluginConstructor & new ( context: Editor ) => ImageEditing ]` _(readonly)_
## Methods
### `constructor( editor )`
#### Parameters
* `editor: Editor`
### `afterInit() → void`
#### Returns
* `void`
### `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<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'getDefinition' | 'init' | 'editor' | 'afterInit' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'previewMode' | 'availablePreviewModes' | 'flattenedMergeFieldDefinitions' | '_mergeFieldRegExp' | 'isMergeField' | 'getDefaultValues' | 'getDataSetValues' | 'getLabel' | 'getMergeFieldDefaultValue' | 'getMergeFieldValue' | 'getMergeFieldType' | 'getMergeFieldHeight' | 'getMergeFieldWidth' | 'getDocumentMergeFieldsIds' | 'getMergeFieldsIds' | 'refreshMergeFields' | 'wrapInAffixes' | 'unwrapAffixes'>`
Observable properties that will be bound to other observable(s).
#### Returns
* `ObservableMultiBindChain`
The bind chain with the `to()` and `toMany()` methods.
### `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( 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.
### `clearForceDisabled( id ) → void` _(inherited)_
Clears forced disable previously set through [`forceDisabled`](#function-forceDisabled). See [`forceDisabled`](#function-forceDisabled).
#### Parameters
* `id: string`
Unique identifier, equal to the one passed in [`forceDisabled`](#function-forceDisabled) call.
#### Returns
* `void`
### `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: 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'getDefinition' | 'init' | 'editor' | 'afterInit' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'previewMode' | 'availablePreviewModes' | 'flattenedMergeFieldDefinitions' | '_mergeFieldRegExp' | 'isMergeField' | 'getDefaultValues' | 'getDataSetValues' | 'getLabel' | 'getMergeFieldDefaultValue' | 'getMergeFieldValue' | 'getMergeFieldType' | 'getMergeFieldHeight' | 'getMergeFieldWidth' | 'getDocumentMergeFieldsIds' | 'getMergeFieldsIds' | 'refreshMergeFields' | 'wrapInAffixes' | 'unwrapAffixes'`
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`
### `destroy() → void` _(inherited)_
Destroys the plugin.
**Note:** This method is optional. A plugin instance does not need to have it defined.
#### Returns
* `void`
### `fire( eventOrInfo, args ) → GetEventInfo[ '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).
### `forceDisabled( id ) → void` _(inherited)_
Disables the plugin.
Plugin may be disabled by multiple features or algorithms (at once). When disabling a plugin, unique id should be passed (e.g. feature name). The same identifier should be used when [enabling back](#function-clearForceDisabled) the plugin. The plugin becomes enabled only after all features [enabled it back](#function-clearForceDisabled).
Disabling and enabling a plugin:
```typescript
plugin.isEnabled; // -> true
plugin.forceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```
Plugin disabled by multiple features:
```typescript
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'OtherFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'OtherFeature' );
plugin.isEnabled; // -> true
```
Multiple disabling with the same identifier is redundant:
```typescript
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'MyFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```
**Note:** some plugins or algorithms may have more complex logic when it comes to enabling or disabling certain plugins, so the plugin might be still disabled after [`clearForceDisabled`](#function-clearForceDisabled) was used.
#### Parameters
* `id: string`
Unique identifier for disabling. Use the same id when [enabling back](#function-clearForceDisabled) the plugin.
#### Returns
* `void`
### `getDataSetValues( dataSetId, useDefaultValues ) → MergeFieldsValues`
Returns an object with merge fields values defined for given data set.
Custom merge fields (created by user, not defined in the config) will be returned as well, and their value will be set to `null`.
Values defined as functions are evaluated and their result is returned.
If the data set is not found, it throws an error.
#### Parameters
* `dataSetId: string`
* `useDefaultValues: boolean`
If set to `true`, merge field default value will be used for these merge fields, for which the data was not defined. If default value is not configured for given merge field, `null` will be still returned.
Defaults to `false`
#### Returns
* `MergeFieldsValues`
### `getDefaultValues() → MergeFieldsValues`
Returns an object with default merge fields values.
Custom merge fields (created by user, not defined in the config) will be returned as well, and their value will be set to `null`.
Values defined as functions are evaluated and their result is returned.
#### Returns
* `MergeFieldsValues`
### `getDefinition( id ) → MergeFieldDefinition | null`
Returns the merge field definition for the given id.
#### Parameters
* `id: string`
#### Returns
* `MergeFieldDefinition | null`
### `getDocumentMergeFieldsIds() → Array`
Returns ids of all merge fields that are present in the document.
#### Returns
* `Array`
### `getLabel( id ) → string | null`
Retrieves the label for the merge field with the given id.
If the merge field definition for given id was not found or a label was not specified, function returns `null`.
#### Parameters
* `id: string`
#### Returns
* `string | null`
### `getMergeFieldDefaultValue( id ) → string | null`
Returns the default value for the merge field with the given id.
If the merge field default value was specified as a callback, it will be executed and the result will be returned.
If the merge field definition for given id was not found, or a default value was not specified, `null` is returned.
#### Parameters
* `id: string`
#### Returns
* `string | null`
### `getMergeFieldHeight( id ) → number | null`
Returns the height of the merge field with the given id.
If the merge field is of type `block` or `image` and the height is not specified, the default height is returned.
If the merge field is of type `text`, `null` is returned.
#### Parameters
* `id: string`
#### Returns
* `number | null`
### `getMergeFieldType( idOrElement ) → MergeFieldType | null`
Returns the merge field type of the given element or id.
Possible values are: `text`, `block`, `image` or `null` if the element is not a merge field.
#### Parameters
* `idOrElement: string | ModelElement`
#### Returns
* `MergeFieldType | null`
### `getMergeFieldValue( id, dataSetId ) → string | null`
Returns the value specified for merge field with the given in given data set.
If the merge field value was specified as a callback, it will be executed and the result will be returned.
If the merge field definition for given id was not found, or the data set has no value for this merge field, `null` is returned.
#### Parameters
* `id: string`
* `dataSetId: string`
#### Returns
* `string | null`
### `getMergeFieldWidth( id ) → number | null`
Returns the width of the merge field with the given id.
If the merge field is of type `image` and the width is not specified, the default width is returned.
If the merge field is of type `text` or `block`, `null` is returned.
#### Parameters
* `id: string`
#### Returns
* `number | null`
### `getMergeFieldsIds() → Array`
Returns ids of all merge fields defined in the configuration and custom merge fields added by the user that exist in the document.
#### Returns
* `Array`
### `init() → void`
#### Returns
* `void`
### `isMergeField( element ) → boolean`
Check if the given model element is a merge field.
It is a merge field if:
* it is a `mergeField` or `mergeFieldBlock` element.
* it is an `imageBlock` or `imageInline` element with a `src` attribute that matches the merge field pattern.
#### Parameters
* `element: ModelElement`
#### 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`
### `refreshMergeFields() → void`
Triggers the reconversion for all merge field elements in the editor content.
It can be used for refreshing the values or default values defined through the callbacks.
#### 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: MergeFieldsEditing[ K ]`
The property's value.
#### Returns
* `void`
### `stopDelegating( event?, emitter? ) → void` _(inherited)_
Stops delegating events. It can be used at different levels:
* To stop delegating all events.
* To stop delegating a specific event to all emitters.
* To stop delegating a specific event to a specific emitter.
#### Parameters
* `event?: string`
The name of the event to stop delegating. If omitted, stops it all delegations.
* `emitter?: Emitter`
(requires `event`) The object to stop delegating a particular event to. If omitted, stops delegation of `event` to all emitters.
#### Returns
* `void`
### `stopListening( emitter?, event?, callback? ) → void` _(inherited)_
Stops listening for events. It can be used at different levels:
* To stop listening to a specific callback.
* To stop listening to a specific event.
* To stop listening to all events fired by a specific object.
* To stop listening to all events fired by all objects.
#### Parameters
* `emitter?: Emitter`
The object to stop listening to. If omitted, stops it for all objects.
* `event?: string`
(Requires the `emitter`) The name of the event to stop listening to. If omitted, stops it for all events from `emitter`.
* `callback?: Function`
(Requires the `event`) The function to be removed from the call list for the given `event`.
#### Returns
* `void`
### `unbind( unbindProperties ) → void` _(inherited)_
Removes the binding created with [`bind`](#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<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'getDefinition' | 'init' | 'editor' | 'afterInit' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'previewMode' | 'availablePreviewModes' | 'flattenedMergeFieldDefinitions' | '_mergeFieldRegExp' | 'isMergeField' | 'getDefaultValues' | 'getDataSetValues' | 'getLabel' | 'getMergeFieldDefaultValue' | 'getMergeFieldValue' | 'getMergeFieldType' | 'getMergeFieldHeight' | 'getMergeFieldWidth' | 'getDocumentMergeFieldsIds' | 'getMergeFieldsIds' | 'refreshMergeFields' | 'wrapInAffixes' | 'unwrapAffixes'>`
Observable properties to be unbound. All the bindings will be released if no properties are provided.
#### Returns
* `void`
## Events
### `change:isEnabled( eventInfo, name, value, oldValue )` _(inherited)_
Fired when the `isEnabled` property changed value.
#### Parameters
* `eventInfo: EventInfo`
An object containing information about the fired event.
* `name: string`
Name of the changed property (`isEnabled`).
* `value: boolean`
New value of the `isEnabled` property with given key or `null`, if operation should remove property.
* `oldValue: boolean`
Old value of the `isEnabled` property with given key or `null`, if property was not set before.
### `change:previewMode( eventInfo, name, value, oldValue )`
Fired when the `previewMode` property changed value.
#### Parameters
* `eventInfo: EventInfo`
An object containing information about the fired event.
* `name: string`
Name of the changed property (`previewMode`).
* `value: string`
New value of the `previewMode` property with given key or `null`, if operation should remove property.
* `oldValue: string`
Old value of the `previewMode` 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:isEnabled( eventInfo, name, value, oldValue )` _(inherited)_
Fired when the `isEnabled` property is going to be set but is not set yet (before the `change` event is fired).
#### Parameters
* `eventInfo: EventInfo`
An object containing information about the fired event.
* `name: string`
Name of the changed property (`isEnabled`).
* `value: boolean`
New value of the `isEnabled` property with given key or `null`, if operation should remove property.
* `oldValue: boolean`
Old value of the `isEnabled` property with given key or `null`, if property was not set before.
### `set:previewMode( eventInfo, name, value, oldValue )`
Fired when the `previewMode` 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 (`previewMode`).
* `value: string`
New value of the `previewMode` property with given key or `null`, if operation should remove property.
* `oldValue: string`
Old value of the `previewMode` 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)