Home/CKEditor 5/API

TableUtils (table)

@ckeditor/ckeditor5-table/src/tableutils

class

See source

The table utilities plugin.

Filtering

Public
Inherited
Mixed
Protected
Private
Deprecated

Properties

editor : Editor

readonly inherited
The editor instance.

See source
Note that most editors implement the EditorWithUI interface in addition to the base Editor interface. However, editors with an external UI (i.e. Bootstrap-based) or a headless editor may not implement the EditorWithUI interface.

Because of above, to make plugins more universal, it is recommended to split features into:
- The "editing" part that only uses the Editor interface.
- The "UI" part that uses both the Editor interface and the EditorWithUI interface.
isEnabled : Boolean

readonly inherited observable
Flag indicating whether a plugin is enabled or disabled. A disabled plugin will not transform text.

See source
Plugin can be simply disabled like that:
```
// Disable the plugin so that no toolbars are visible.
editor.plugins.get( 'TextTransformation' ).isEnabled = false;
```
You can also use forceDisabled method.
_disableStack : Set.<String>

private inherited

Holds identifiers for forceDisabled mechanism.

See source

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.

See source
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.

See source
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.

See source
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.

See source

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
afterInit() → null | Promise

inherited

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

See source

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.

See source
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.
clearForceDisabled( id )

inherited

Clears forced disable previously set through forceDisabled. See forceDisabled.

See source

Parameters

id : String

Unique identifier, equal to the one passed in forceDisabled call.
createTable( writer, options = { [options.rows], [options.columns], [options.headingRows], [options.headingColumns] } ) → Element
Creates an empty table with a proper structure. The table needs to be inserted into the model, for example, by using the insertContent function.

See source
```
model.change( ( writer ) => {
	// Create a table of 2 rows and 7 columns:
	const table = tableUtils.createTable( writer, { rows: 2, columns: 7 } );

	// Insert a table to the model at the best position taking the current selection:
	model.insertContent( table );
}
```
Parameters

writer : Writer

The model writer.

options : Object

Properties

[ options.rows ] : Number

The number of rows to create.

Defaults to 2

[ options.columns ] : Number

The number of columns to create.

Defaults to 2

[ options.headingRows ] : Number

The number of heading rows.

Defaults to 0

[ options.headingColumns ] : Number

The number of heading columns.

Defaults to 0

Returns

Element

The created table element.
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.

See source
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:

See source
```
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.

See source

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.

See source

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).
forceDisabled( id )

inherited
Disables the plugin.

See source
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 the plugin. The plugin becomes enabled only after all features enabled it back.

Disabling and enabling a plugin:
```
plugin.isEnabled; // -> true
plugin.forceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```
Plugin disabled by multiple features:
```
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:
```
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 was used.

Parameters

id : String

Unique identifier for disabling. Use the same id when enabling back the plugin.

`getCellLocation( tableCell ) → Object`

Returns the table cell location as an object with table row and table column indexes.

See source

For instance, in the table below:

    0   1   2   3
  +---+---+---+---+
0 | a     | b | c |
  +       +   +---+
1 |       |   | d |
  +---+---+   +---+
2 | e     |   | f |
  +---+---+---+---+

the method will return:

const cellA = table.getNodeByPath( [ 0, 0 ] );
editor.plugins.get( 'TableUtils' ).getCellLocation( cellA );
// will return { row: 0, column: 0 }

const cellD = table.getNodeByPath( [ 1, 0 ] );
editor.plugins.get( 'TableUtils' ).getCellLocation( cellD );
// will return { row: 1, column: 3 }

Parameters

tableCell : Element

Returns

Object: Returns a {row, column} object.

getColumnIndexes( tableCells ) → Object
Returns an object with the first and last column index contained in the given tableCells.

See source
```
const selectedTableCells = getSelectedTableCells( editor.model.document.selection );

const { first, last } = getColumnIndexes( selectedTableCells );

console.log( `Selected columns: ${ first } to ${ last }` );
```
Parameters

tableCells : Array.<Element>

Returns

Object

Returns an object with the first and last table column indexes.
getColumns( table ) → Number
Returns the number of columns for a given table.

See source
```
editor.plugins.get( 'TableUtils' ).getColumns( table );
```
Parameters

table : Element

The table to analyze.

Returns

Number
getRowIndexes( tableCells ) → Object
Returns an object with the first and last row index contained in the given tableCells.

See source
```
const selectedTableCells = getSelectedTableCells( editor.model.document.selection );

const { first, last } = getRowIndexes( selectedTableCells );

console.log( `Selected rows: ${ first } to ${ last }` );
```
Parameters

tableCells : Array.<Element>

Returns

Object

Returns an object with the first and last table row indexes.
getRows( table ) → Number
Returns the number of rows for a given table. Any other element present in the table model is omitted.

See source
```
editor.plugins.get( 'TableUtils' ).getRows( table );
```
Parameters

table : Element

The table to analyze.

Returns

Number
getSelectedTableCells( selection ) → Array.<Element>

Returns all model table cells that are fully selected (from the outside) within the provided model selection's ranges.

See source

To obtain the cells selected from the inside, use getTableCellsContainingSelection.

Parameters

selection : Selection

Returns

Array.<Element>
getSelectionAffectedTableCells( selection ) → Array.<Element>

Returns all model table cells that are either completely selected by selection ranges or host selection range start positions inside them.

See source

Combines getTableCellsContainingSelection and getSelectedTableCells.

Parameters

selection : Selection

Returns

Array.<Element>
getTableCellsContainingSelection( selection ) → Array.<Element>

Returns all model table cells that the provided model selection's ranges start inside.

See source

To obtain the cells selected from the outside, use getSelectedTableCells.

Parameters

selection : Selection

Returns

Array.<Element>
init() → null | Promise

inherited

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

See source

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

`insertColumns( table, options = { [options.at], [options.columns] } )`

Inserts columns into a table.

See source

editor.plugins.get( 'TableUtils' ).insertColumns( table, { at: 1, columns: 2 } );

Assuming the table on the left, the above code will transform it to the table on the right:

0   1   2   3                   0   1   2   3   4   5
+---+---+---+                   +---+---+---+---+---+
| a     | b |                   | a             | b |
+       +---+                   +               +---+
|       | c |                   |               | c |
+---+---+---+     will give:    +---+---+---+---+---+
| d | e | f |                   | d |   |   | e | f |
+---+   +---+                   +---+---+---+   +---+
| g |   | h |                   | g |   |   |   | h |
+---+---+---+                   +---+---+---+---+---+
| i         |                   | i                 |
+---+---+---+                   +---+---+---+---+---+
    ^---- insert here, `at` = 1, `columns` = 2

Parameters

table : Element

The table model element where the columns will be inserted.

options : Object

Properties

[ options.at ] : Number

The column index at which the columns will be inserted.

Defaults to 0

[ options.columns ] : Number

The number of columns to insert.

Defaults to 1

insertRows( table, options = { [options.at], [options.rows], [options.copyStructureFromAbove] } )
Inserts rows into a table.

See source
```
editor.plugins.get( 'TableUtils' ).insertRows( table, { at: 1, rows: 2 } );
```
Assuming the table on the left, the above code will transform it to the table on the right:
```
row index
  0 +---+---+---+       `at` = 1,      +---+---+---+ 0
    | a | b | c |       `rows` = 2,    | a | b | c |
  1 +   +---+---+   <-- insert here    +   +---+---+ 1
    |   | d | e |                      |   |   |   |
  2 +   +---+---+       will give:     +   +---+---+ 2
    |   | f | g |                      |   |   |   |
  3 +---+---+---+                      +   +---+---+ 3
                                       |   | d | e |
                                       +   +---+---+ 4
                                       +   + f | g |
                                       +---+---+---+ 5
```
Parameters

table : Element

The table model element where the rows will be inserted.

options : Object

Properties

[ options.at ] : Number

The row index at which the rows will be inserted.

Defaults to 0

[ options.rows ] : Number

The number of rows to insert.

Defaults to 1

[ options.copyStructureFromAbove ] : Boolean | undefined

The flag for copying row structure. Note that the row structure will not be copied if this option is not provided.
isSelectionRectangular( selectedTableCells ) → Boolean
Checks if the selection contains cells that do not exceed rectangular selection.

See source
In a table below:
```
┌───┬───┬───┬───┐
│ a │ b │ c │ d │
├───┴───┼───┤   │
│ e     │ f │   │
│       ├───┼───┤
│       │ g │ h │
└───────┴───┴───┘
```
Valid selections are these which create a solid rectangle (without gaps), such as:
- a, b (two horizontal cells)
- c, f (two vertical cells)
- a, b, e (cell "e" spans over four cells)
- c, d, f (cell d spans over a cell in the row below)
While an invalid selection would be:
- a, c (the unselected cell "b" creates a gap)
- f, g, h (cell "d" spans over a cell from the row of "f" cell - thus creates a gap)
Parameters

selectedTableCells : Array.<Element>

Returns

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

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

See source

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.

See source

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.

See source

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 {}

`removeColumns( table, options = { options.at, [options.columns] } )`

Removes columns from the given table.

See source

This method re-calculates the table geometry including the colspan attribute of table cells overlapping removed columns and table headings values.

editor.plugins.get( 'TableUtils' ).removeColumns( table, { at: 1, columns: 2 } );

Executing the above code in the context of the table on the left will transform its structure as presented on the right:

  0   1   2   3   4                       0   1   2
┌───────────────┬───┐                   ┌───────┬───┐
│ a             │ b │                   │ a     │ b │
│               ├───┤                   │       ├───┤
│               │ c │                   │       │ c │
├───┬───┬───┬───┼───┤     will give:    ├───┬───┼───┤
│ d │ e │ f │ g │ h │                   │ d │ g │ h │
├───┼───┼───┤   ├───┤                   ├───┤   ├───┤
│ i │ j │ k │   │ l │                   │ i │   │ l │
├───┴───┴───┴───┴───┤                   ├───┴───┴───┤
│ m                 │                   │ m         │
└───────────────────┘                   └───────────┘
      ^---- remove from here, `at` = 1, `columns` = 2

Parameters

table : Element

options : Object

Properties

options.at : Number

The row index at which the removing columns will start.

[ options.columns ] : Number

The number of columns to remove.

Defaults to 1

`removeRows( table, options = { options.at, [options.rows] } )`

Removes rows from the given table.

See source

This method re-calculates the table geometry including rowspan attribute of table cells overlapping removed rows and table headings values.

editor.plugins.get( 'TableUtils' ).removeRows( table, { at: 1, rows: 2 } );

Executing the above code in the context of the table on the left will transform its structure as presented on the right:

row index
    ┌───┬───┬───┐        `at` = 1        ┌───┬───┬───┐
  0 │ a │ b │ c │        `rows` = 2      │ a │ b │ c │ 0
    │   ├───┼───┤                        │   ├───┼───┤
  1 │   │ d │ e │  <-- remove from here  │   │ d │ g │ 1
    │   │   ├───┤        will give:      ├───┼───┼───┤
  2 │   │   │ f │                        │ h │ i │ j │ 2
    │   │   ├───┤                        └───┴───┴───┘
  3 │   │   │ g │
    ├───┼───┼───┤
  4 │ h │ i │ j │
    └───┴───┴───┘

Parameters

table : Element

options : Object

Properties

options.at : Number

The row index at which the removing rows will start.

[ options.rows ] : Number

The number of rows to remove.

Defaults to 1

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.

See source

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).
sortRanges( ranges ) → Array.<Range>

Returns array of sorted ranges.

See source

Parameters

ranges : Iterable.<Range>

Returns

Array.<Range>
splitCellHorizontally( tableCell, numberOfCells )
Divides a table cell horizontally into several ones.

See source
The cell will be visually split into more cells by updating rowspans of other cells in the row and inserting rows with a single cell below.

If in the table below cell "b" is split into 3 cells:
```
+---+---+---+
| a | b | c |
+---+---+---+
| d | e | f |
+---+---+---+
```
It will result in the table below:
```
+---+---+---+
| a | b | c |
+   +---+   +
|   |   |   |
+   +---+   +
|   |   |   |
+---+---+---+
| d | e | f |
+---+---+---+
```
So cells "a" and "b" will get their rowspan updated to 3 and 2 rows with a single cell will be added.

Splitting a cell that already has a rowspan attribute set will distribute the cell rowspan evenly and the remainder will be left to the original cell:
```
+---+---+---+
| a | b | c |
+   +---+---+
|   | d | e |
+   +---+---+
|   | f | g |
+   +---+---+
|   | h | i |
+---+---+---+
```
Splitting cell "a" with rowspan=4 into 3 cells will create 2 cells with a rowspan=1 and cell "a" will have rowspan=2:
```
+---+---+---+
| a | b | c |
+   +---+---+
|   | d | e |
+---+---+---+
|   | f | g |
+---+---+---+
|   | h | i |
+---+---+---+
```
Parameters

tableCell : Element

numberOfCells : Number

Defaults to 2
splitCellVertically( tableCell, numberOfCells )
Divides a table cell vertically into several ones.

See source
The cell will be visually split into more cells by updating colspans of other cells in a column and inserting cells (columns) after that cell.

In the table below, if cell "a" is split into 3 cells:
```
+---+---+---+
| a | b | c |
+---+---+---+
| d | e | f |
+---+---+---+
```
it will result in the table below:
```
+---+---+---+---+---+
| a |   |   | b | c |
+---+---+---+---+---+
| d         | e | f |
+---+---+---+---+---+
```
So cell "d" will get its colspan updated to 3 and 2 cells will be added (2 columns will be created).

Splitting a cell that already has a colspan attribute set will distribute the cell colspan evenly and the remainder will be left to the original cell:
```
+---+---+---+
| a         |
+---+---+---+
| b | c | d |
+---+---+---+
```
Splitting cell "a" with colspan=3 into 2 cells will create 1 cell with a colspan=a and cell "a" that will have colspan=2:
```
+---+---+---+
| a     |   |
+---+---+---+
| b | c | d |
+---+---+---+
```
Parameters

tableCell : Element

numberOfCells : Number

Defaults to 2
stopDelegating( [ event ], [ emitter ] )

mixed
Stops delegating events. It can be used at different levels:

See source
- 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:

See source
- 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.

See source
```
// 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.

See source

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.

See source

Parameters

event : String

The name of the event.

callback : function

The function to stop being called.
createTableWalker( table, [ options ] = { [options.row], [options.startRow], [options.endRow], [options.column], [options.startColumn], [options.endColumn], [options.includeAllSlots] } )

protected

Creates an instance of the table walker.

See source

The table walker iterates internally by traversing the table from row index = 0 and column index = 0. It walks row by row and column by column in order to output values defined in the options. By default it will output only the locations that are occupied by a cell. To include also spanned rows and columns, pass the includeAllSlots option.

Parameters

table : Element

A table over which the walker iterates.

[ options ] : Object

An object with configuration.

Properties

[ options.row ] : Number

A row index for which this iterator will output cells. Can't be used together with startRow and endRow.

[ options.startRow ] : Number

A row index from which this iterator should start. Can't be used together with row.

Defaults to 0

[ options.endRow ] : Number

A row index at which this iterator should end. Can't be used together with row.

[ options.column ] : Number

A column index for which this iterator will output cells. Can't be used together with startColumn and endColumn.

[ options.startColumn ] : Number

A column index from which this iterator should start. Can't be used together with column.

Defaults to 0

[ options.endColumn ] : Number

A column index at which this iterator should end. Can't be used together with column.

[ options.includeAllSlots ] : Boolean

Also return values for spanned cells.

Defaults to false

Defaults to {}
_areCellInTheSameTableSection( tableCells ) → Boolean

private

Checks if the selection does not mix a header (column or row) with other cells.

See source

For instance, in the table below valid selections consist of cells with the same letter only. So, a-a (same heading row and column) or d-d (body cells) are valid while c-d or a-b are not.

header columns ↓ ↓ ┌───┬───┬───┬───┐ │ a │ a │ b │ b │ ← header row ├───┼───┼───┼───┤ │ c │ c │ d │ d │ ├───┼───┼───┼───┤ │ c │ c │ d │ d │ └───┴───┴───┴───┘

Parameters

tableCells : Array.<Element>

Returns

Boolean
_areIndexesInSameSection( params = { params.first, params.last }, headingSectionSize )

private

Unified check if table rows/columns indexes are in the same heading/body section.

See source

Parameters

params : Object

Properties

params.first : Number

params.last : Number

headingSectionSize : Number
_getFirstLastIndexesObject( indexes ) → Object

private

Helper method to get an object with first and last indexes from an unsorted array of indexes.

See source

Parameters

indexes : Array.<Number>

Returns

Object

Events

change:isEnabled( eventInfo, name, value, oldValue )

inherited

Fired when the isEnabled property changed value.

See source

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:{property}( eventInfo, name, value, oldValue )

mixed
Fired when a property changed value.

See source
```
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).

See source
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.

TableUtils (table)

Filtering

Properties

editor : Editormodule:table/tableutils~TableUtils#editor

isEnabled : Booleanmodule:table/tableutils~TableUtils#isEnabled

_disableStack : Set.<String>module:table/tableutils~TableUtils#_disableStack

Static properties

isContextPlugin : Booleanmodule:table/tableutils~TableUtils.isContextPlugin

pluginName : String | undefinedmodule:table/tableutils~TableUtils.pluginName

requires : Array.<Function> | undefinedmodule:table/tableutils~TableUtils.requires

Methods

constructor( editor )module:table/tableutils~TableUtils#constructor

Parameters

afterInit() → null | Promisemodule:table/tableutils~TableUtils#afterInit

Returns

bind( bindProperties ) → Objectmodule:table/tableutils~TableUtils#bind

Parameters

Returns

clearForceDisabled( id )module:table/tableutils~TableUtils#clearForceDisabled

Parameters

createTable( writer, options = { [options.rows], [options.columns], [options.headingRows], [options.headingColumns] } ) → Elementmodule:table/tableutils~TableUtils#createTable

Parameters

Returns

decorate( methodName )module:table/tableutils~TableUtils#decorate

Parameters

delegate( events ) → EmitterMixinDelegateChainmodule:table/tableutils~TableUtils#delegate

Parameters

Returns

destroy() → null | Promisemodule:table/tableutils~TableUtils#destroy

Returns

fire( eventOrInfo, [ args ] ) → *module:table/tableutils~TableUtils#fire

Parameters

Returns

forceDisabled( id )module:table/tableutils~TableUtils#forceDisabled

Parameters

getCellLocation( tableCell ) → Objectmodule:table/tableutils~TableUtils#getCellLocation

Parameters

Returns

getColumnIndexes( tableCells ) → Objectmodule:table/tableutils~TableUtils#getColumnIndexes

Parameters

Returns

getColumns( table ) → Numbermodule:table/tableutils~TableUtils#getColumns

Parameters

Returns

getRowIndexes( tableCells ) → Objectmodule:table/tableutils~TableUtils#getRowIndexes

Parameters

Returns

getRows( table ) → Numbermodule:table/tableutils~TableUtils#getRows

Parameters

Returns

getSelectedTableCells( selection ) → Array.<Element>module:table/tableutils~TableUtils#getSelectedTableCells

Parameters

Returns

getSelectionAffectedTableCells( selection ) → Array.<Element>module:table/tableutils~TableUtils#getSelectionAffectedTableCells

Parameters

Returns

getTableCellsContainingSelection( selection ) → Array.<Element>module:table/tableutils~TableUtils#getTableCellsContainingSelection

Parameters

Returns

init() → null | Promisemodule:table/tableutils~TableUtils#init

Returns

insertColumns( table, options = { [options.at], [options.columns] } )module:table/tableutils~TableUtils#insertColumns

Parameters

insertRows( table, options = { [options.at], [options.rows], [options.copyStructureFromAbove] } )module:table/tableutils~TableUtils#insertRows

Parameters

isSelectionRectangular( selectedTableCells ) → Booleanmodule:table/tableutils~TableUtils#isSelectionRectangular

Parameters

Returns

listenTo( emitter, event, callback, [ options ] = { [options.priority] } )module:table/tableutils~TableUtils#listenTo

Parameters

off( event, callback )module:table/tableutils~TableUtils#off

Parameters

on( event, callback, [ options ] = { [options.priority] } )module:table/tableutils~TableUtils#on

Parameters

once( event, callback, [ options ] = { [options.priority] } )module:table/tableutils~TableUtils#once

Parameters

removeColumns( table, options = { options.at, [options.columns] } )module:table/tableutils~TableUtils#removeColumns

Parameters

removeRows( table, options = { options.at, [options.rows] } )module:table/tableutils~TableUtils#removeRows

Parameters

`editor : Editor`

`isEnabled : Boolean`

`_disableStack : Set.<String>`

`isContextPlugin : Boolean`

`pluginName : String | undefined`

`requires : Array.<Function> | undefined`

`constructor( editor )`

`afterInit() → null | Promise`

`bind( bindProperties ) → Object`

`clearForceDisabled( id )`

`createTable( writer, options = { [options.rows], [options.columns], [options.headingRows], [options.headingColumns] } ) → Element`

`decorate( methodName )`

`delegate( events ) → EmitterMixinDelegateChain`

`destroy() → null | Promise`

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

`forceDisabled( id )`

`getCellLocation( tableCell ) → Object`

`getColumnIndexes( tableCells ) → Object`

`getColumns( table ) → Number`

`getRowIndexes( tableCells ) → Object`

`getRows( table ) → Number`

`getSelectedTableCells( selection ) → Array.<Element>`

`getSelectionAffectedTableCells( selection ) → Array.<Element>`

`getTableCellsContainingSelection( selection ) → Array.<Element>`

`init() → null | Promise`

`insertColumns( table, options = { [options.at], [options.columns] } )`

`insertRows( table, options = { [options.at], [options.rows], [options.copyStructureFromAbove] } )`

`isSelectionRectangular( selectedTableCells ) → Boolean`

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

`off( event, callback )`

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

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

`removeColumns( table, options = { options.at, [options.columns] } )`

`removeRows( table, options = { options.at, [options.rows] } )`

`set( name, [ value ] )`

`sortRanges( ranges ) → Array.<Range>`

`splitCellHorizontally( tableCell, numberOfCells )`

`splitCellVertically( tableCell, numberOfCells )`

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

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

`unbind( [ unbindProperties ] )`

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

`_removeEventListener( event, callback )`

`createTableWalker( table, [ options ] = { [options.row], [options.startRow], [options.endRow], [options.column], [options.startColumn], [options.endColumn], [options.includeAllSlots] } )`

`_areCellInTheSameTableSection( tableCells ) → Boolean`

`_areIndexesInSameSection( params = { params.first, params.last }, headingSectionSize )`

`_getFirstLastIndexesObject( indexes ) → Object`

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

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

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