Annotations (comments/annotations)

@ckeditor/ckeditor5-comments/src/annotations/annotations

class

Stores and manages all annotations created for the entire Context or Editor.

It allows for adding and removing annotations.

It manages activating and deactivating annotations. Using those methods will result in setting activeAnnotation in the appropriate annotations UI plugins.

All active annotations are stored in activeAnnotations.

Annotations is linked with AnnotationsUIs, which listens to events fired by Annotations and propagates information to and from annotations UI plugins.

Filtering

Public
Inherited
Mixed
Protected
Private
Deprecated

Properties

activeAnnotations : Set.<Annotation>

observable

A set of currently active annotations.
collection : AnnotationCollection

readonly

A collection of all annotations. It should not be operated on directly.
context : Context | Editor

readonly inherited

The context instance.

Static properties

isContextPlugin : Boolean

readonly inherited static

A flag which defines if a plugin is allowed or not allowed to be used directly by a Context.
pluginName : String | undefined

readonly inherited static
An optional name of the plugin. If set, the plugin will be available in get by its name and its constructor. If not, then only by its constructor.
The name should reflect the constructor name.

To keep the plugin class definition tight, it is recommended to define this property as a static getter:
```
export default class ImageCaption {
	static get pluginName() {
		return 'ImageCaption';
	}
}
```
Note: The native Function.name property could not be used to keep the plugin name because it will be mangled during code minification.

Naming a plugin is necessary to enable removing it through the config.removePlugins option.
requires : Array.<Function> | undefined

readonly inherited static
An array of plugins required by this plugin.
To keep the plugin class definition tight it is recommended to define this property as a static getter:
```
import Image from './image.js';

export default class ImageCaption {
	static get requires() {
		return [ Image ];
	}
}
```

Methods

constructor( editor )

inherited

Creates a new plugin instance. This is the first step of the plugin initialization. See also init and afterInit.

A plugin is always instantiated after its dependencies and the init and afterInit methods are called in the same order.

Usually, you will want to put your plugin's initialization code in the init method. The constructor can be understood as "before init" and used in special cases, just like afterInit serves the special "after init" scenarios (e.g.the code which depends on other plugins, but which does not explicitly require them).

Parameters

editor : Editor
activate( annotation )
Activates the given annotation.
If annotations UI that handles the given annotation already has an active annotation, then it deactivates it and activates the provided one.

Parameters

annotation : Annotation

Fires
- _activateAnnotation
add( annotation )

Adds an annotation to the collection.

Parameters

annotation : Annotation
afterInit() → null | Promise

inherited

The third (and last) stage of the plugin initialization. See also constructor and init.

Note: This method is optional. A plugin instance does not need to have it defined.

Returns

null | Promise
bind( bindProperties ) → Object

mixed
Binds observable properties to other objects implementing the Observable interface.
Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Parameters

bindProperties : String

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

Returns

Object

The bind chain with the to() and toMany() methods.
createAnnotation( options = { options.view, options.target, options.type, [options.isVisible] } ) → Annotation
Creates an annotation.
```
const annotationView = annotations.createAnnotationView( editor.locale, innerView );

const annotation = annotations.createAnnotation( {
	view: annotationView,
	target: document.getElementById( 'target' ),
	type: 'comment'
} );
```
Parameters

options : Object

Properties

options.view : AnnotationView

The annotation view.

options.target : Rect | function | Element

The annotation target.

options.type : String | function

The annotation type.

[ options.isVisible ] : Boolean

The initial visibility of the annotation.

Returns

Annotation

An annotation.
createAnnotationView( locale, view ) → AnnotationView
Creates an annotation view wrapper for the annotation content.
```
const innerView = createCustomView();
const annotationView = annotations.createAnnotationView( editor.locale, innerView );
```
Parameters

locale : Locale

view : View

Returns

AnnotationView

An annotation view.
deactivateAll()
Deactivates all active annotations.
Fires
- _deactivateAllAnnotations
decorate( methodName )

mixed
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 {
	constructor() {
		this.decorate( 'method' );
	}

	method() {
		console.log( 'called!' );
	}
}

const foo = new Foo();
foo.on( 'method', ( evt ) => {
	evt.stop();
}, { priority: 'high' } );

foo.method(); // Nothing is logged.
```
Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

It is also possible to change the returned value:
```
foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'
```
Finally, it is possible to access and modify the arguments the method is called with:
```
method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'
```
Parameters

methodName : String

Name of the method to decorate.
delegate( events ) → EmitterMixinDelegateChain

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

events : String

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain
destroy() → null | Promise

inherited

Destroys the plugin.

Note: This method is optional. A plugin instance does not need to have it defined.

Returns

null | Promise
fire( eventOrInfo, [ args ] ) → *

mixed

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.

Parameters

eventOrInfo : String | EventInfo

The name of the event or EventInfo object if event is delegated.

[ args ] : *

Additional arguments to be passed to the callbacks.

Returns

*

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).
getByInnerView( innerView ) → Annotation

Returns the annotation that "contains" the given annotation view's inner view.

Parameters

innerView : View

Returns

Annotation
init() → null | Promise

inherited

The second stage (after plugin constructor) of the plugin initialization. Unlike the plugin constructor this method can be asynchronous.

A plugin's init() method is called after its dependencies are initialized, so in the same order as the constructors of these plugins.

Note: This method is optional. A plugin instance does not need to have it defined.

Returns

null | Promise
listenTo( emitter, event, callback, [ options ] = { [options.priority] } )

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

Parameters

emitter : Emitter

The object that fires the event.

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
off( event, callback )

mixed

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.
on( event, callback, [ options ] = { [options.priority] } )

mixed

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

Parameters

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
once( event, callback, [ options ] = { [options.priority] } )

mixed

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.

Parameters

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
refreshPositioning()

Refreshes the positioning of all visible annotations and sorts them topmost and leftmost.
refreshVisibility()

Refreshes the visibility of annotations based on the visibility of their annotation targets.

This method should be called when one or more annotations' targets changed their visibility, for example when one of the editors was shown or hidden.

This method recalculates all annotations' isVisible property.
remove( annotation )

Removes the given annotation from the collection.

Parameters

annotation : Annotation
set( name, [ value ] )

mixed

Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

It accepts also 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.

Parameters

name : String | Object

The property's name or object with name=>value pairs.

[ value ] : *

The property's value (if name was passed in the first parameter).
stopDelegating( [ event ], [ emitter ] )

mixed
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.
stopListening( [ emitter ], [ event ], [ callback ] )

mixed
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.
unbind( [ unbindProperties ] )

mixed
Removes the binding created with bind.
```
// Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
```
Parameters

[ unbindProperties ] : String

Observable properties to be unbound. All the bindings will be released if no properties are provided.
_addEventListener( event, callback, [ options ] = { [options.priority] } )

protected mixed

Adds callback to emitter for given event.

Parameters

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
_removeEventListener( event, callback )

protected mixed

Removes callback from emitter for given event.

Parameters

event : String

The name of the event.

callback : function

The function to stop being called.

Events

_activateAnnotation( eventInfo )

An internal event that fires when the annotation should be activated.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.
_deactivateAllAnnotations( eventInfo )

An internal event that fires when all annotations should be deactivated.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.
change:activeAnnotations( eventInfo, name, value, oldValue )

Fired when the activeAnnotations property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : String

Name of the changed property (activeAnnotations).

value : Set.<Annotation>

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

oldValue : Set.<Annotation>

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

mixed
Fired when a property changed value.
```
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 : *

The new property value.

oldValue : *

The previous property value.
set:{property}( eventInfo, name, value, oldValue )

mixed
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( '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 : *

The new property value.

oldValue : *

The previous property value.

Every day, we work hard to keep our documentation complete. Have you spotted an outdated information? Is something missing? Please report it via our issue tracker.

Annotations (comments/annotations)

Filtering

Properties

activeAnnotations : Set.<Annotation>module:comments/annotations/annotations~Annotations#activeAnnotations

collection : AnnotationCollectionmodule:comments/annotations/annotations~Annotations#collection

context : Context | Editormodule:comments/annotations/annotations~Annotations#context

Static properties

isContextPlugin : Booleanmodule:comments/annotations/annotations~Annotations.isContextPlugin

pluginName : String | undefinedmodule:comments/annotations/annotations~Annotations.pluginName

requires : Array.<Function> | undefinedmodule:comments/annotations/annotations~Annotations.requires

Methods

constructor( editor )module:comments/annotations/annotations~Annotations#constructor

Parameters

activate( annotation )module:comments/annotations/annotations~Annotations#activate

Parameters

Fires

add( annotation )module:comments/annotations/annotations~Annotations#add

Parameters

afterInit() → null | Promisemodule:comments/annotations/annotations~Annotations#afterInit

Returns

bind( bindProperties ) → Objectmodule:comments/annotations/annotations~Annotations#bind

Parameters

Returns

createAnnotation( options = { options.view, options.target, options.type, [options.isVisible] } ) → Annotationmodule:comments/annotations/annotations~Annotations#createAnnotation

Parameters

Returns

createAnnotationView( locale, view ) → AnnotationViewmodule:comments/annotations/annotations~Annotations#createAnnotationView

Parameters

Returns

deactivateAll()module:comments/annotations/annotations~Annotations#deactivateAll

Fires

decorate( methodName )module:comments/annotations/annotations~Annotations#decorate

Parameters

delegate( events ) → EmitterMixinDelegateChainmodule:comments/annotations/annotations~Annotations#delegate

Parameters

Returns

destroy() → null | Promisemodule:comments/annotations/annotations~Annotations#destroy

Returns

fire( eventOrInfo, [ args ] ) → *module:comments/annotations/annotations~Annotations#fire

Parameters

Returns

getByInnerView( innerView ) → Annotationmodule:comments/annotations/annotations~Annotations#getByInnerView

Parameters

Returns

init() → null | Promisemodule:comments/annotations/annotations~Annotations#init

Returns

listenTo( emitter, event, callback, [ options ] = { [options.priority] } )module:comments/annotations/annotations~Annotations#listenTo

Parameters

off( event, callback )module:comments/annotations/annotations~Annotations#off

Parameters

on( event, callback, [ options ] = { [options.priority] } )module:comments/annotations/annotations~Annotations#on

Parameters

once( event, callback, [ options ] = { [options.priority] } )module:comments/annotations/annotations~Annotations#once

Parameters

refreshPositioning()module:comments/annotations/annotations~Annotations#refreshPositioning

refreshVisibility()module:comments/annotations/annotations~Annotations#refreshVisibility

remove( annotation )module:comments/annotations/annotations~Annotations#remove

Parameters

set( name, [ value ] )module:comments/annotations/annotations~Annotations#set

Parameters

stopDelegating( [ event ], [ emitter ] )module:comments/annotations/annotations~Annotations#stopDelegating

Parameters

stopListening( [ emitter ], [ event ], [ callback ] )module:comments/annotations/annotations~Annotations#stopListening

Parameters

unbind( [ unbindProperties ] )module:comments/annotations/annotations~Annotations#unbind

Parameters

_addEventListener( event, callback, [ options ] = { [options.priority] } )module:comments/annotations/annotations~Annotations#_addEventListener

Parameters

_removeEventListener( event, callback )module:comments/annotations/annotations~Annotations#_removeEventListener

Parameters

Events

_activateAnnotation( eventInfo )module:comments/annotations/annotations~Annotations#event:_activateAnnotation

Parameters

_deactivateAllAnnotations( eventInfo )module:comments/annotations/annotations~Annotations#event:_deactivateAllAnnotations

Parameters

change:activeAnnotations( eventInfo, name, value, oldValue )module:comments/annotations/annotations~Annotations#event:change:activeAnnotations

Parameters

change:{property}( eventInfo, name, value, oldValue )module:comments/annotations/annotations~Annotations#event:change:{property}

Parameters

set:{property}( eventInfo, name, value, oldValue )module:comments/annotations/annotations~Annotations#event:set:{property}

`activeAnnotations : Set.<Annotation>`

`collection : AnnotationCollection`

`context : Context | Editor`

`isContextPlugin : Boolean`

`pluginName : String | undefined`

`requires : Array.<Function> | undefined`

`constructor( editor )`

`activate( annotation )`

`add( annotation )`

`afterInit() → null | Promise`

`bind( bindProperties ) → Object`

`createAnnotation( options = { options.view, options.target, options.type, [options.isVisible] } ) → Annotation`

`createAnnotationView( locale, view ) → AnnotationView`

`deactivateAll()`

`decorate( methodName )`

`delegate( events ) → EmitterMixinDelegateChain`

`destroy() → null | Promise`

`fire( eventOrInfo, [ args ] ) → *`

`getByInnerView( innerView ) → Annotation`

`init() → null | Promise`

`listenTo( emitter, event, callback, [ options ] = { [options.priority] } )`

`off( event, callback )`

`on( event, callback, [ options ] = { [options.priority] } )`

`once( event, callback, [ options ] = { [options.priority] } )`

`refreshPositioning()`

`refreshVisibility()`

`remove( annotation )`

`set( name, [ value ] )`

`stopDelegating( [ event ], [ emitter ] )`

`stopListening( [ emitter ], [ event ], [ callback ] )`

`unbind( [ unbindProperties ] )`

`_addEventListener( event, callback, [ options ] = { [options.priority] } )`

`_removeEventListener( event, callback )`

`_activateAnnotation( eventInfo )`

`_deactivateAllAnnotations( eventInfo )`

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

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

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