Home/CKEditor 5/API

TableUtils (table)

@ckeditor/ckeditor5-table/src/tableutils

class

See source

The table utilities plugin.

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Properties

readonly inherited
editor : Editor
See source
The editor instance.

Note that most editors implement the 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 class without ui property.
- The "UI" part that uses the Editor class and accesses ui property.
inherited observable
isEnabled : boolean
See source
Flag indicating whether a plugin is enabled or disabled. A disabled plugin will not transform text.

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.

Static properties

readonly inherited static
isContextPlugin : false

See source
readonly static
pluginName : 'TableUtils'

See source
internal readonly static
isOfficialPlugin : true

See source
internal readonly inherited static
isPremiumPlugin : boolean

See source

Methods

inherited
constructor( editor )

See source

Parameters

editor : Editor
inherited
bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, TableUtils[ K1 ], K2, TableUtils[ K2 ]>
See source
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 );
```
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

DualBindChain<K1, TableUtils[ K1 ], K2, TableUtils[ K2 ]>

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperties ) → MultiBindChain
See source
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 : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'isEnabled' | 'init' | 'editor' | 'forceDisabled' | 'clearForceDisabled' | 'insertColumns' | 'getCellLocation' | 'createTable' | 'insertRows' | 'removeRows' | 'removeColumns' | 'splitCellVertically' | 'splitCellHorizontally' | 'getColumns' | 'getRows' | 'createTableWalker' | 'getSelectedTableCells' | 'getTableCellsContainingSelection' | 'getSelectionAffectedTableCells' | 'getRowIndexes' | 'getColumnIndexes' | 'isSelectionRectangular' | 'sortRanges'>

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

Returns

MultiBindChain

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperty ) → SingleBindChain<K, TableUtils[ K ]>
See source
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 );
```
Type parameters

K

Parameters

bindProperty : K

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

Returns

SingleBindChain<K, TableUtils[ K ]>

The bind chain with the to() and toMany() methods.
inherited
clearForceDisabled( id ) → void

See source
Clears forced disable previously set through forceDisabled. See forceDisabled.

Parameters

id : string

Unique identifier, equal to the one passed in forceDisabled call.

Returns

void
createTable( writer, options = { [options.columns], [options.headingColumns], [options.headingRows], [options.rows] } ) → Element
See source
Creates an empty table with a proper structure. The table needs to be inserted into the model, for example, by using the insertContent function.
```
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.columns ] : number

The number of columns to create. Default value is 2.

[ options.headingColumns ] : number

The number of heading columns. Default value is 0.

[ options.headingRows ] : number

The number of heading rows. Default value is 0.

[ options.rows ] : number

The number of rows to create. Default value is 2.

Returns

Element

The created table element.
inherited
decorate( methodName ) → void
See source
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 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 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 : 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'isEnabled' | 'init' | 'editor' | 'forceDisabled' | 'clearForceDisabled' | 'insertColumns' | 'getCellLocation' | 'createTable' | 'insertRows' | 'removeRows' | 'removeColumns' | 'splitCellVertically' | 'splitCellHorizontally' | 'getColumns' | 'getRows' | 'createTableWalker' | 'getSelectedTableCells' | 'getTableCellsContainingSelection' | 'getSelectionAffectedTableCells' | 'getRowIndexes' | 'getColumnIndexes' | 'isSelectionRectangular' | 'sortRanges'

Name of the method to decorate.

Returns

void
inherited
delegate( events ) → EmitterMixinDelegateChain
See source
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 : Array<string>

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain
inherited
destroy() → void

See source
Destroys the plugin.

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

Returns

void
inherited
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]

See source
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).
inherited
forceDisabled( id ) → void
See source
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 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.

Returns

void
getCellLocation( tableCell ) → object
See source
Returns the table cell location as an object with table row and table column indexes.

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 ) → IndexesObject
See source
Returns an object with the first and last column index contained in the given tableCells.
```
const selectedTableCells = getSelectedTableCells( editor.model.document.selection );

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

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

tableCells : Array<Element>

Returns

IndexesObject

Returns an object with the first and last table column indexes.
getColumns( table ) → number
See source
Returns the number of columns for a given table.
```
editor.plugins.get( 'TableUtils' ).getColumns( table );
```
Parameters

table : Element

The table to analyze.

Returns

number
getRowIndexes( tableCells ) → IndexesObject
See source
Returns an object with the first and last row index contained in the given tableCells.
```
const selectedTableCells = getSelectedTableCells( editor.model.document.selection );

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

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

tableCells : Array<Element>

Returns

IndexesObject

Returns an object with the first and last table row indexes.
getRows( table ) → number
See source
Returns the number of rows for a given table. Any other element present in the table model is omitted.
```
editor.plugins.get( 'TableUtils' ).getRows( table );
```
Parameters

table : Element

The table to analyze.

Returns

number
getSelectedTableCells( selection ) → Array<Element>

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

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

Parameters

selection : Selection | DocumentSelection

Returns

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

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

Combines getTableCellsContainingSelection and getSelectedTableCells.

Parameters

selection : Selection | DocumentSelection

Returns

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

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

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

Parameters

selection : Selection | DocumentSelection

Returns

Array<Element>
init() → void

See source

Returns

void
insertColumns( table, options = { [options.at], [options.columns] } ) → void
See source
Inserts columns into a table.
```
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. Default value is 0.

[ options.columns ] : number

The number of columns to insert. Default value is 1.

Defaults to {}

Returns

void
insertRows( table, options = { [options.at], [options.copyStructureFromAbove], [options.rows] } ) → void
See source
Inserts rows into a table.
```
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. Default value is 0.

[ options.copyStructureFromAbove ] : boolean

The flag for copying row structure. Note that the row structure will not be copied if this option is not provided.

[ options.rows ] : number

The number of rows to insert. Default value is 1.

Defaults to {}

Returns

void
isSelectionRectangular( selectedTableCells ) → boolean
See source
Checks if the selection contains cells that do not exceed rectangular selection.

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
inherited
listenTo( emitter, event, callback, [ options ] ) → void
See source
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
inherited
off( event, callback ) → void

See source
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
inherited
on( event, callback, [ options ] ) → void

See source
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
inherited
once( event, callback, [ options ] ) → void

See source
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
removeColumns( table, options = { options.at, [options.columns] } ) → void
See source
Removes columns from the given table.

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.

Returns

void
removeRows( table, options = { options.at, [options.rows] } ) → void
See source
Removes rows from the given table.

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. Default value is 1.

Returns

void
inherited
set( values ) → void
See source
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:
```
public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}
```
Parameters

values : object

An object with name=>value pairs.

Returns

void
inherited
set( name, value ) → void
See source
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:
```
public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}
```
Type parameters

K

Parameters

name : K

The property's name.

value : TableUtils[ K ]

The property's value.

Returns

void
sortRanges( ranges ) → Array<Range>

See source
Returns array of sorted ranges.

Parameters

ranges : Iterable<Range>

Returns

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

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

Returns

void
splitCellVertically( tableCell, numberOfCells ) → void

See source
Divides a table cell vertically into several ones.

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

Returns

void
inherited
stopDelegating( [ event ], [ emitter ] ) → void
See source
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
inherited
stopListening( [ emitter ], [ event ], [ callback ] ) → void
See source
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
inherited
unbind( unbindProperties ) → void
See source
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 : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'isEnabled' | 'init' | 'editor' | 'forceDisabled' | 'clearForceDisabled' | 'insertColumns' | 'getCellLocation' | 'createTable' | 'insertRows' | 'removeRows' | 'removeColumns' | 'splitCellVertically' | 'splitCellHorizontally' | 'getColumns' | 'getRows' | 'createTableWalker' | 'getSelectedTableCells' | 'getTableCellsContainingSelection' | 'getSelectionAffectedTableCells' | 'getRowIndexes' | 'getColumnIndexes' | 'isSelectionRectangular' | 'sortRanges'>

Observable properties to be unbound. All the bindings will be released if no properties are provided.

Returns

void
internal
createTableWalker( table, options ) → TableWalker

See source
Creates an instance of the table walker.

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 : TableWalkerOptions

An object with configuration.

Defaults to {}

Returns

TableWalker
private
_areCellInTheSameTableSection( tableCells ) → boolean

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

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
private
_areIndexesInSameSection( __namedParameters, headingSectionSize ) → boolean

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

Parameters

__namedParameters : IndexesObject

headingSectionSize : number

Returns

boolean
private
_getFirstLastIndexesObject( indexes ) → IndexesObject

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

Parameters

indexes : Array<number>

Returns

IndexesObject

Events

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

See source
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.
inherited
change:{property}( eventInfo, name, value, oldValue )
See source
Fired when a property changed value.
```
observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( '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.
inherited
set:isEnabled( eventInfo, name, value, oldValue )

See source
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.
inherited
set:{property}( eventInfo, name, value, oldValue )
See source
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<ObservableSetEvent<number>>( '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<ObservableChangeEvent<number>>( '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.

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

With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.

TableUtils (table)

Filtering

Properties

readonly inherited editor : Editormodule:table/tableutils~TableUtils#editor

inherited observable isEnabled : booleanmodule:table/tableutils~TableUtils#isEnabled

Static properties

readonly inherited static isContextPlugin : falsemodule:table/tableutils~TableUtils.isContextPlugin

readonly static pluginName : 'TableUtils'module:table/tableutils~TableUtils.pluginName

internal readonly static isOfficialPlugin : truemodule:table/tableutils~TableUtils.isOfficialPlugin

internal readonly inherited static isPremiumPlugin : booleanmodule:table/tableutils~TableUtils.isPremiumPlugin

Methods

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

Parameters

inherited bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, TableUtils[ K1 ], K2, TableUtils[ K2 ]>module:table/tableutils~TableUtils#bind:DUAL_BIND

Type parameters

Parameters

Returns

inherited bind( bindProperties ) → MultiBindChainmodule:table/tableutils~TableUtils#bind:MANY_BIND

Parameters

Returns

inherited bind( bindProperty ) → SingleBindChain<K, TableUtils[ K ]>module:table/tableutils~TableUtils#bind:SINGLE_BIND

Type parameters

Parameters

Returns

inherited clearForceDisabled( id ) → voidmodule:table/tableutils~TableUtils#clearForceDisabled

Parameters

Returns

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

Parameters

Returns

inherited decorate( methodName ) → voidmodule:table/tableutils~TableUtils#decorate

Parameters

Returns

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

Parameters

Returns

inherited destroy() → voidmodule:table/tableutils~TableUtils#destroy

Returns

inherited fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]module:table/tableutils~TableUtils#fire

Type parameters

Parameters

Returns

inherited forceDisabled( id ) → voidmodule:table/tableutils~TableUtils#forceDisabled

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

getRowIndexes( tableCells ) → IndexesObjectmodule: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() → voidmodule:table/tableutils~TableUtils#init

Returns

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

readonly inherited
`editor : Editor`

inherited observable
`isEnabled : boolean`

readonly inherited static
`isContextPlugin : false`

readonly static
`pluginName : 'TableUtils'`

internal readonly static
`isOfficialPlugin : true`

internal readonly inherited static
`isPremiumPlugin : boolean`

inherited
`constructor( editor )`

inherited
`bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, TableUtils[ K1 ], K2, TableUtils[ K2 ]>`

inherited
`bind( bindProperties ) → MultiBindChain`

inherited
`bind( bindProperty ) → SingleBindChain<K, TableUtils[ K ]>`

inherited
`clearForceDisabled( id ) → void`

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

inherited
`decorate( methodName ) → void`

inherited
`delegate( events ) → EmitterMixinDelegateChain`

inherited
`destroy() → void`

inherited
`fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]`

inherited
`forceDisabled( id ) → void`

`getCellLocation( tableCell ) → object`

`getColumnIndexes( tableCells ) → IndexesObject`

`getColumns( table ) → number`

`getRowIndexes( tableCells ) → IndexesObject`

`getRows( table ) → number`

`getSelectedTableCells( selection ) → Array<Element>`

`getSelectionAffectedTableCells( selection ) → Array<Element>`

`getTableCellsContainingSelection( selection ) → Array<Element>`

`init() → void`

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

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

`isSelectionRectangular( selectedTableCells ) → boolean`

inherited
`listenTo( emitter, event, callback, [ options ] ) → void`

inherited
`off( event, callback ) → void`

inherited
`on( event, callback, [ options ] ) → void`

inherited
`once( event, callback, [ options ] ) → void`

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

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

inherited
`set( values ) → void`

inherited
`set( name, value ) → void`

`sortRanges( ranges ) → Array<Range>`

`splitCellHorizontally( tableCell, numberOfCells ) → void`

`splitCellVertically( tableCell, numberOfCells ) → void`

inherited
`stopDelegating( [ event ], [ emitter ] ) → void`

inherited
`stopListening( [ emitter ], [ event ], [ callback ] ) → void`

inherited
`unbind( unbindProperties ) → void`

internal
`createTableWalker( table, options ) → TableWalker`

private
`_areCellInTheSameTableSection( tableCells ) → boolean`

private
`_areIndexesInSameSection( __namedParameters, headingSectionSize ) → boolean`

private
`_getFirstLastIndexesObject( indexes ) → IndexesObject`

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

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

inherited
`set:isEnabled( eventInfo, name, value, oldValue )`

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