DataController

Downcast dispatcher used by the get method. Downcast converters should be attached to it.

Data processor used specifically for HTML conversion.

Mapper used for the conversion. It has no permanent bindings, because these are created while getting data and are cleared directly after the data are converted. However, the mapper is defined as a class property, because it needs to be passed to the DowncastDispatcher as a conversion API.

Data model.

Data processor used during the conversion. Same instance as htmlProcessor by default. Can be replaced at run time to handle different format, e.g. XML or Markdown.

Styles processor used during the conversion.

Upcast dispatcher used by the set method. Upcast converters should be attached to it.

The view document used by the data controller.

The view downcast writer just for data conversion purposes, i.e. to modify the viewDocument.

Creates a data controller instance.

Parameters

model : Model

Data model.

stylesProcessor : StylesProcessor

The styles processor instance.

Adds the style processor normalization rules.

You can implement your own rules as well as use one of the available processor rules:

• background: addBackgroundStylesRules
• border: addBorderStylesRules
• margin: addMarginStylesRules
• padding: addPaddingStylesRules

Parameters

callback : ( stylesProcessor: StylesProcessor ) => void

Returns

void

Delegates selected events to another Emitter. For instance:

emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );

then eventX is delegated (fired by) emitterB and emitterC along with data:

emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );

and eventY is delegated (fired by) emitterC along with data:

emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );

Parameters

events : Array<string>

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain

Removes all event listeners set by the DataController.

Returns

void

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

Returns the model's data converted by downcast dispatchers attached to downcastDispatcher and formatted by the data processor.

A warning is logged when you try to retrieve data for a detached root, as most probably this is a mistake. A detached root should be treated like it is removed, and you should not save its data. Note, that the detached root data is always an empty string.

Parameters

options : object

Additional configuration for the retrieved data. DataController provides two optional properties: rootName and trim. Other properties of this object are specified by various editor features.

Properties

[ options.rootName ] : string

Root name. Default 'main'.

[ options.trim ] : 'none' | 'empty'

Whether returned data should be trimmed. This option is set to empty by default, which means whenever editor content is considered empty, an empty string will be returned. To turn off trimming completely use 'none'. In such cases the exact content will be returned (for example a <p>&nbsp;</p> for an empty editor).

options.[key: string] : unknown

Defaults to {}

Returns

string

Output data.

Fires

• get

Sets the initial input data parsed by the data processor and converted by the view-to-model converters. Initial data can be only set to a document whose version is equal 0.

Note This method is decorated which is used by e.g. collaborative editing plugin that syncs remote data on init.

When data is passed as a string, it is initialized on the default main root:

dataController.init( '<p>Foo</p>' ); // Initializes data on the `main` root only, as no other is specified.

To initialize data on a different root or multiple roots at once, an object containing rootName - data pairs should be passed:

dataController.init( '<p>Foo</p>' ); // Initializes data on the `main` root only, as no other is specified.

Parameters

data : string | Record<string, string>

Input data as a string or an object containing the rootName - data pairs to initialize data on multiple roots at once.

Returns

Promise<void>

Promise that is resolved after the data is set on the editor.

Fires

• init

Registers a callback function to be executed when an event is fired in a specific (emitter) object.

Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.

// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );

An event callback can stop the event and set the return value of the fire method.

Type parameters

TEvent : extends BaseEvent

The type describing the event. See BaseEvent.

Parameters

emitter : Emitter

The object that fires the event.

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void

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

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

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

Returns the data parsed by the data processor and then converted by upcast converters attached to the upcastDispatcher.

Parameters

data : string

Data to parse.

context : ModelSchemaContextDefinition

Base context in which the view will be converted to the model. See: convert.

Defaults to '$root'

Returns

ModelDocumentFragment

Parsed data.

Related:

• DataController#set

Registers a MatcherPattern on an htmlProcessor and a processor for view elements whose content should be treated as raw data and not processed during the conversion from DOM to view elements.

The raw data can be later accessed by the view element custom property "$rawContent".

Parameters

pattern : MatcherPattern

Pattern matching all view elements whose content should be treated as a raw data.

Returns

void

Sets the input data parsed by the data processor and converted by the view-to-model converters. This method can be used any time to replace existing editor data with the new one without clearing the document history.

This method also creates a batch with all the changes applied. If all you need is to parse data, use the parse method.

When data is passed as a string it is set on the default main root:

dataController.set( '<p>Foo</p>' ); // Sets data on the `main` root, as no other is specified.

To set data on a different root or multiple roots at once, an object containing rootName - data pairs should be passed:

dataController.set( '<p>Foo</p>' ); // Sets data on the `main` root, as no other is specified.

To set the data with a preserved undo stack and add the change to the undo stack, set { isUndoable: true } as a batchType option.

dataController.set( '<p>Foo</p>' ); // Sets data on the `main` root, as no other is specified.

Parameters

data : string | Record<string, string>

Input data as a string or an object containing the rootName - data pairs to set data on multiple roots at once.

options : object

Options for setting data.

Properties

[ options.batchType ] : BatchType

The batch type that will be used to create a batch for the changes applied by this method. By default, the batch will be set as not undoable and the undo stack will be cleared after the new data is applied (all undo steps will be removed). If the batch type isUndoable flag is be set to true, the undo stack will be preserved instead and not cleared when new data is applied.

options.[key: string] : unknown

Defaults to {}

Returns

void

Fires

• set

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

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

Returns the content of the given model's element or model document fragment converted by the downcast converters attached to the downcastDispatcher and formatted by the data processor.

Parameters

modelElementOrFragment : ModelElement | ModelDocumentFragment

The element whose content will be stringified.

options : Record<string, unknown>

Additional configuration passed to the conversion process.

Defaults to {}

Returns

string

Output data.

Returns the result of the given view element or view document fragment converted by the view-to-model converters, wrapped by ModelDocumentFragment.

When marker elements were converted during the conversion process, it will be set as a document fragment's static markers map.

Parameters

viewElementOrFragment : ViewElement | ViewDocumentFragment

The element or document fragment whose content will be converted.

context : ModelSchemaContextDefinition

Base context in which the view will be converted to the model. See: convert.

Defaults to '$root'

Returns

ModelDocumentFragment

Output document fragment.

Fires

• toModel

Returns the content of the given model element or model document fragment converted by the downcast converters attached to downcastDispatcher into a view document fragment.

Parameters

modelElementOrFragment : ModelElement | ModelDocumentFragment

Element or document fragment whose content will be converted.

options : Record<string, unknown>

Additional configuration that will be available through the options during the conversion process.

Defaults to {}

Returns

ViewDocumentFragment

Output view ModelDocumentFragment.

Fires

• toView

Checks whether all provided root names are actually existing editor roots.

Parameters

rootNames : Array<string>

Root names to check.

Returns

boolean

Whether all provided root names are existing editor roots.

Event fired after the get() method has been run.

The get event is fired by the decorated get method. See decorate for more information and samples.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : Parameters<DataController[ 'get' ]>

An event fired after the init() method was run. It can be listened to in order to adjust or modify the initialization flow. However, if the init event is stopped or prevented, the ready event should be fired manually.

The init event is fired by the decorated init method. See decorate for more information and samples.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : Parameters<DataController[ 'init' ]>

Event fired once the data initialization has finished.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

An event fired after set() method has been run.

The set event is fired by the decorated set method. See decorate for more information and samples.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : Parameters<DataController[ 'set' ]>

Event fired after the toModel() method has been run.

The toModel event is fired by the decorated toModel method. See decorate for more information and samples.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : Parameters<DataController[ 'toModel' ]>

Event fired after the toView() method has been run.

The toView event is fired by the decorated toView method. See decorate for more information and samples.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : Parameters<DataController[ 'toView' ]>