# TableUtils
class
The table utilities plugin.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L37)
## Properties
### `editor: Editor` _(readonly)_
The editor instance.
Note that most editors implement the [`ui`](module_core_editor_editor-Editor.md#member-ui) property. However, editors with an external UI (i.e. Bootstrap-based) or a headless editor may not have this property or throw an error when accessing it.
Because of above, to make plugins more universal, it is recommended to split features into:
* The "editing" part that uses the [`Editor`](module_core_editor_editor-Editor.md) class without `ui` property.
* The "UI" part that uses the [`Editor`](module_core_editor_editor-Editor.md) class and accesses `ui` property.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L33)
### `isEnabled: boolean` _(readonly)_
Flag indicating whether a plugin is enabled or disabled. A disabled plugin will not transform text.
Plugin can be simply disabled like that:
```typescript
// Disable the plugin so that no toolbars are visible.
editor.plugins.get( 'TextTransformation' ).isEnabled = false;
```
You can also use [`forceDisabled`](#function-forceDisabled) method.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L51)
#### Static properties
### `isContextPlugin: false` _(readonly)_
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L144)
### `pluginName: 'TableUtils'` _(readonly)_
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L41)
### `isOfficialPlugin: true` _(internal)_
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L48)
### `isPremiumPlugin: boolean` _(internal)_
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L160)
## Methods
### `constructor( editor )` _(inherited)_
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L61)
#### Parameters
* `editor: Editor`
### `bind( bindProperties ) → ObservableMultiBindChain` _(inherited)_
Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.
Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) guide covering the topic of property bindings with some additional examples.
Consider two objects: a `button` and an associated `command` (both `Observable`).
A simple property binding could be as follows:
```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```typescript
button.bind( 'isEnabled' ).to( command );
```
which works in the following way:
* `button.isEnabled` **instantly equals** `command.isEnabled`,
* whenever `command.isEnabled` changes, `button.isEnabled` will immediately reflect its value.
**Note**: To release the binding, use [`unbind`](module_utils_observablemixin-Observable.md#function-unbind).
You can also "rename" the property in the binding by specifying the new name in the `to()` chain:
```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```typescript
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
The binding can include more than one observable, combining multiple data sources in a custom callback:
```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Using a custom callback allows processing the value before passing it to the target property:
```typescript
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
It is also possible to bind to the same property in an array of observables. To bind a `button` to multiple commands (also `Observables`) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1074)
#### Parameters
* `bindProperties: Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'init' | 'editor' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'insertColumns' | 'getCellLocation' | 'createTable' | 'insertRows' | 'removeRows' | 'removeColumns' | 'splitCellVertically' | 'splitCellHorizontally' | 'getColumns' | 'getRows' | 'createTableWalker' | 'getSelectedTableCells' | 'setFooterRowsCount' | 'setHeadingRowsCount' | 'setHeadingColumnsCount' | 'getTableCellsContainingSelection' | 'getSelectionAffectedTableCells' | 'getRowIndexes' | 'getColumnIndexes' | 'isSelectionRectangular' | 'sortRanges'>`
Observable properties that will be bound to other observable(s).
#### Returns
* `ObservableMultiBindChain`
The bind chain with the `to()` and `toMany()` methods.
### `bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain` _(inherited)_
Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.
Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) guide covering the topic of property bindings with some additional examples.
Consider two objects: a `button` and an associated `command` (both `Observable`).
A simple property binding could be as follows:
```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```typescript
button.bind( 'isEnabled' ).to( command );
```
which works in the following way:
* `button.isEnabled` **instantly equals** `command.isEnabled`,
* whenever `command.isEnabled` changes, `button.isEnabled` will immediately reflect its value.
**Note**: To release the binding, use [`unbind`](module_utils_observablemixin-Observable.md#function-unbind).
You can also "rename" the property in the binding by specifying the new name in the `to()` chain:
```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```typescript
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
The binding can include more than one observable, combining multiple data sources in a custom callback:
```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Using a custom callback allows processing the value before passing it to the target property:
```typescript
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
It is also possible to bind to the same property in an array of observables. To bind a `button` to multiple commands (also `Observables`) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L996)
#### Type parameters
* * `K1`
* `K2`
#### Parameters
* `bindProperty1: K1`
Observable property that will be bound to other observable(s).
* `bindProperty2: K2`
Observable property that will be bound to other observable(s).
#### Returns
* `ObservableDualBindChain`
The bind chain with the `to()` and `toMany()` methods.
### `bind( bindProperty ) → ObservableSingleBindChain` _(inherited)_
Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.
Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) guide covering the topic of property bindings with some additional examples.
Consider two objects: a `button` and an associated `command` (both `Observable`).
A simple property binding could be as follows:
```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```typescript
button.bind( 'isEnabled' ).to( command );
```
which works in the following way:
* `button.isEnabled` **instantly equals** `command.isEnabled`,
* whenever `command.isEnabled` changes, `button.isEnabled` will immediately reflect its value.
**Note**: To release the binding, use [`unbind`](module_utils_observablemixin-Observable.md#function-unbind).
You can also "rename" the property in the binding by specifying the new name in the `to()` chain:
```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```typescript
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
The binding can include more than one observable, combining multiple data sources in a custom callback:
```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Using a custom callback allows processing the value before passing it to the target property:
```typescript
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
It is also possible to bind to the same property in an array of observables. To bind a `button` to multiple commands (also `Observables`) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L918)
#### Type parameters
* `K`
#### Parameters
* `bindProperty: K`
Observable property that will be bound to other observable(s).
#### Returns
* `ObservableSingleBindChain`
The bind chain with the `to()` and `toMany()` methods.
### `clearForceDisabled( id ) → void` _(inherited)_
Clears forced disable previously set through [`forceDisabled`](#function-forceDisabled). See [`forceDisabled`](#function-forceDisabled).
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L125)
#### Parameters
* `id: string`
Unique identifier, equal to the one passed in [`forceDisabled`](#function-forceDisabled) call.
#### Returns
* `void`
### `createTable( writer, options = { options.columns?, options.footerRows?, options.headingColumns?, options.headingRows?, options.rows? } ) → ModelElement`
Creates an empty table with a proper structure. The table needs to be inserted into the model, for example, by using the [`insertContent`](module_engine_model_model-Model.md#function-insertContent) function.
```typescript
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 );
}
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L129)
#### Parameters
* `writer: ModelWriter`
The model writer.
* `options: object`
Properties
* `options.columns?: number`
The number of columns to create. Default value is 2.
* `options.footerRows?: number`
The number of footer rows. Default value is 0.
* `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
* `ModelElement`
The created table element.
### `decorate( methodName ) → void` _(inherited)_
Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.
Read more in the [dedicated](../framework/deep-dive/observables.md#decorating-object-methods) guide covering the topic of decorating methods with some additional examples.
Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.
For example, to cancel the method execution the event can be [stopped](module_utils_eventinfo-EventInfo.md#member-stop):
```typescript
class Foo extends ObservableMixin() {
constructor() {
super();
this.decorate( 'method' );
}
method() {
console.log( 'called!' );
}
}
const foo = new Foo();
foo.on( 'method', ( evt ) => {
evt.stop();
}, { priority: 'high' } );
foo.method(); // Nothing is logged.
```
**Note**: The high [priority](module_utils_priorities-PriorityString.md) listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).
It is also possible to change the returned value:
```typescript
foo.on( 'method', ( evt ) => {
evt.return = 'Foo!';
} );
foo.method(); // -> 'Foo'
```
Finally, it is possible to access and modify the arguments the method is called with:
```typescript
method( a, b ) {
console.log( `${ a }, ${ b }` );
}
// ...
foo.on( 'method', ( evt, args ) => {
args[ 0 ] = 3;
console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );
foo.method( 1, 2 ); // -> '3, 2'
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1159)
#### Parameters
* `methodName: 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'init' | 'editor' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'insertColumns' | 'getCellLocation' | 'createTable' | 'insertRows' | 'removeRows' | 'removeColumns' | 'splitCellVertically' | 'splitCellHorizontally' | 'getColumns' | 'getRows' | 'createTableWalker' | 'getSelectedTableCells' | 'setFooterRowsCount' | 'setHeadingRowsCount' | 'setHeadingColumnsCount' | 'getTableCellsContainingSelection' | 'getSelectionAffectedTableCells' | 'getRowIndexes' | 'getColumnIndexes' | 'isSelectionRectangular' | 'sortRanges'`
Name of the method to decorate.
#### Returns
* `void`
### `delegate( events ) → EmitterMixinDelegateChain` _(inherited)_
Delegates selected events to another [`Emitter`](module_utils_emittermixin-Emitter.md). For instance:
```typescript
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
then `eventX` is delegated (fired by) `emitterB` and `emitterC` along with `data`:
```typescript
emitterA.fire( 'eventX', data );
```
and `eventY` is delegated (fired by) `emitterC` along with `data`:
```typescript
emitterA.fire( 'eventY', data );
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L539)
#### Parameters
* `events: Array`
Event names that will be delegated to another emitter.
#### Returns
* `EmitterMixinDelegateChain`
### `destroy() → void` _(inherited)_
Destroys the plugin.
**Note:** This method is optional. A plugin instance does not need to have it defined.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L137)
#### Returns
* `void`
### `fire( eventOrInfo, args ) → GetEventInfo[ 'return' ]` _(inherited)_
Fires an event, executing all callbacks registered for it.
The first parameter passed to callbacks is an [`EventInfo`](module_utils_eventinfo-EventInfo.md) object, followed by the optional `args` provided in the `fire()` method call.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L512)
#### Type parameters
* `TEvent: extends BaseEvent`
The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).
#### Parameters
* `eventOrInfo: GetNameOrEventInfo`
The name of the event or `EventInfo` object if event is delegated.
* `args: TEvent[ 'args' ]`
Additional arguments to be passed to the callbacks.
#### Returns
* `GetEventInfo[ 'return' ]`
By default the method returns `undefined`. However, the return value can be changed by listeners through modification of the [`evt.return`](module_utils_eventinfo-EventInfo.md#member-return)'s property (the event info is the first param of every callback).
### `forceDisabled( id ) → void` _(inherited)_
Disables the plugin.
Plugin may be disabled by multiple features or algorithms (at once). When disabling a plugin, unique id should be passed (e.g. feature name). The same identifier should be used when [enabling back](#function-clearForceDisabled) the plugin. The plugin becomes enabled only after all features [enabled it back](#function-clearForceDisabled).
Disabling and enabling a plugin:
```typescript
plugin.isEnabled; // -> true
plugin.forceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```
Plugin disabled by multiple features:
```typescript
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'OtherFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'OtherFeature' );
plugin.isEnabled; // -> true
```
Multiple disabling with the same identifier is redundant:
```typescript
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'MyFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```
**Note:** some plugins or algorithms may have more complex logic when it comes to enabling or disabling certain plugins, so the plugin might be still disabled after [`clearForceDisabled`](#function-clearForceDisabled) was used.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L111)
#### Parameters
* `id: string`
Unique identifier for disabling. Use the same id when [enabling back](#function-clearForceDisabled) the plugin.
#### Returns
* `void`
### `getCellLocation( tableCell ) → object`
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:
```typescript
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 }
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L88)
#### Parameters
* `tableCell: ModelElement`
#### Returns
* `object`
Returns a `{row, column}` object.
### `getColumnIndexes( tableCells ) → TableIndexesObject`
Returns an object with the `first` and `last` column index contained in the given `tableCells`.
```typescript
const selectedTableCells = getSelectedTableCells( editor.model.document.selection );
const { first, last } = getColumnIndexes( selectedTableCells );
console.log( `Selected columns: ${ first } to ${ last }` );
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L1315)
#### Parameters
* `tableCells: Array`
#### Returns
* `TableIndexesObject`
Returns an object with the `first` and `last` table column indexes.
### `getColumns( table ) → number`
Returns the number of columns for a given table.
```typescript
editor.plugins.get( 'TableUtils' ).getColumns( table );
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L948)
#### Parameters
* `table: ModelElement`
The table to analyze.
#### Returns
* `number`
### `getRowIndexes( tableCells ) → TableIndexesObject`
Returns an object with the `first` and `last` row index contained in the given `tableCells`.
```typescript
const selectedTableCells = getSelectedTableCells( editor.model.document.selection );
const { first, last } = getRowIndexes( selectedTableCells );
console.log( `Selected rows: ${ first } to ${ last }` );
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L1296)
#### Parameters
* `tableCells: Array`
#### Returns
* `TableIndexesObject`
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.
```typescript
editor.plugins.get( 'TableUtils' ).getRows( table );
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L973)
#### Parameters
* `table: ModelElement`
The table to analyze.
#### Returns
* `number`
### `getSelectedTableCells( selection ) → Array`
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`](#function-getTableCellsContainingSelection).
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L1002)
#### Parameters
* `selection: ModelSelection | ModelDocumentSelection`
#### Returns
* `Array`
### `getSelectionAffectedTableCells( selection ) → Array`
Returns all model table cells that are either completely selected by selection ranges or host selection range [start positions](module_engine_model_range-ModelRange.md#member-start) inside them.
Combines [`getTableCellsContainingSelection`](#function-getTableCellsContainingSelection) and [`getSelectedTableCells`](#function-getSelectedTableCells).
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L1273)
#### Parameters
* `selection: ModelSelection | ModelDocumentSelection`
#### Returns
* `Array`
### `getTableCellsContainingSelection( selection ) → Array`
Returns all model table cells that the provided model selection's ranges [`start`](module_engine_model_range-ModelRange.md#member-start) inside.
To obtain the cells selected from the outside, use [`getSelectedTableCells`](#function-getSelectedTableCells).
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L1251)
#### Parameters
* `selection: ModelSelection | ModelDocumentSelection`
#### Returns
* `Array`
### `init() → void`
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L55)
#### Returns
* `void`
### `insertColumns( table, options = { options.at?, options.columns? } ) → void`
Inserts columns into a table.
```typescript
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
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L343)
#### Parameters
* `table: ModelElement`
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`
Inserts rows into a table.
```typescript
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
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L189)
#### Parameters
* `table: ModelElement`
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`
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)
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L1349)
#### Parameters
* `selectedTableCells: Array`
#### Returns
* `boolean`
### `listenTo( emitter, event, callback, options? ) → void` _(inherited)_
Registers a callback function to be executed when an event is fired in a specific (emitter) object.
Events can be grouped in namespaces using `:`. When namespaced event is fired, it additionally fires all callbacks for that namespace.
```typescript
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );
// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
```
An event callback can [stop the event](module_utils_eventinfo-EventInfo.md#member-stop) and set the [return value](module_utils_eventinfo-EventInfo.md#member-return) of the [`fire`](#function-fire) method.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L475)
#### Type parameters
* `TEvent: extends BaseEvent`
The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).
#### Parameters
* `emitter: Emitter`
The object that fires the event.
* `event: TEvent[ 'name' ]`
The name of the event.
* `callback: GetCallback`
The function to be called on event.
* `options?: GetCallbackOptions`
Additional options.
#### Returns
* `void`
### `off( event, callback ) → void` _(inherited)_
Stops executing the callback on the given event. Shorthand for [`this.stopListening( this, event, callback )`](#function-stopListening:BASE_STOP).
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L444)
#### Parameters
* `event: string`
The name of the event.
* `callback: Function`
The function to stop being called.
#### Returns
* `void`
### `on( event, callback, options? ) → void` _(inherited)_
Registers a callback function to be executed when an event is fired.
Shorthand for [`this.listenTo( this, event, callback, options )`](#function-listenTo:BASE_EMITTER) (it makes the emitter listen on itself).
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L416)
#### Type parameters
* `TEvent: extends BaseEvent`
The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).
#### Parameters
* `event: TEvent[ 'name' ]`
The name of the event.
* `callback: GetCallback`
The function to be called on event.
* `options?: GetCallbackOptions`
Additional options.
#### Returns
* `void`
### `once( event, callback, options? ) → void` _(inherited)_
Registers a callback function to be executed on the next time the event is fired only. This is similar to calling [`on`](#function-on) followed by [`off`](#function-off) in the callback.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L431)
#### Type parameters
* `TEvent: extends BaseEvent`
The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).
#### Parameters
* `event: TEvent[ 'name' ]`
The name of the event.
* `callback: GetCallback`
The function to be called on event.
* `options?: GetCallbackOptions`
Additional options.
#### Returns
* `void`
### `removeColumns( table, options = { options.at, options.columns? } ) → void`
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.
```typescript
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
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L576)
#### Parameters
* `table: ModelElement`
* `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`
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.
```typescript
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 │ └───┴───┴───┘
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L469)
#### Parameters
* `table: ModelElement`
* `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`
### `set( values ) → void` _(inherited)_
Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.
It accepts a single object literal containing key/value pairs with properties to be set.
This method throws the `observable-set-cannot-override` error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that `foo.set( 'bar', 1 )` may be slightly slower than `foo.bar = 1`.
In TypeScript, those properties should be declared in class using `declare` keyword. In example:
```typescript
public declare myProp1: number;
public declare myProp2: string;
constructor() {
this.set( {
'myProp1: 2,
'myProp2: 'foo'
} );
}
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L843)
#### Parameters
* `values: object & object`
An object with `name=>value` pairs.
#### Returns
* `void`
### `set( name, value ) → void` _(inherited)_
Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.
This method throws the `observable-set-cannot-override` error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that `foo.set( 'bar', 1 )` may be slightly slower than `foo.bar = 1`.
In TypeScript, those properties should be declared in class using `declare` keyword. In example:
```typescript
public declare myProp: number;
constructor() {
this.set( 'myProp', 2 );
}
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L815)
#### Type parameters
* `K`
#### Parameters
* `name: K`
The property's name.
* `value: TableUtils[ K ]`
The property's value.
#### Returns
* `void`
### `setHeadingColumnsCount( writer, table, headingColumns, options ) → void`
Sets the number of heading columns for the given `table`.
If number of heading columns is greater than the number of columns in the table, it will be truncated to the number of columns.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L1167)
#### Parameters
* `writer: ModelWriter`
The model writer to use.
* `table: ModelElement`
The table model element.
* `headingColumns: number`
The number of heading columns to set.
* `options: UpdateTableHeadingsOptions`
Additional options.
Defaults to `{}`
#### Returns
* `void`
### `setHeadingRowsCount( writer, table, headingRows, options ) → void`
Sets the number of heading rows for the given `table`.
If number of heading rows is greater than the number of rows in the table, it will be truncated to the number of rows.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L1065)
#### Parameters
* `writer: ModelWriter`
The model writer.
* `table: ModelElement`
The table model element.
* `headingRows: number`
The number of heading rows to set.
* `options: UpdateTableHeadingsOptions`
Additional options.
Defaults to `{}`
#### Returns
* `void`
### `sortRanges( ranges ) → Array`
Returns array of sorted ranges.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L1393)
#### Parameters
* `ranges: Iterable`
#### Returns
* `Array`
### `splitCellHorizontally( tableCell, numberOfCells ) → void`
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 | +---+---+---+
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L815)
#### Parameters
* `tableCell: ModelElement`
* `numberOfCells: number`
Defaults to `2`
#### Returns
* `void`
### `splitCellVertically( tableCell, numberOfCells ) → void`
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 | +---+---+---+
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L682)
#### Parameters
* `tableCell: ModelElement`
* `numberOfCells: number`
Defaults to `2`
#### Returns
* `void`
### `stopDelegating( event?, emitter? ) → void` _(inherited)_
Stops delegating events. It can be used at different levels:
* To stop delegating all events.
* To stop delegating a specific event to all emitters.
* To stop delegating a specific event to a specific emitter.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L552)
#### Parameters
* `event?: string`
The name of the event to stop delegating. If omitted, stops it all delegations.
* `emitter?: Emitter`
(requires `event`) The object to stop delegating a particular event to. If omitted, stops delegation of `event` to all emitters.
#### Returns
* `void`
### `stopListening( emitter?, event?, callback? ) → void` _(inherited)_
Stops listening for events. It can be used at different levels:
* To stop listening to a specific callback.
* To stop listening to a specific event.
* To stop listening to all events fired by a specific object.
* To stop listening to all events fired by all objects.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L497)
#### Parameters
* `emitter?: Emitter`
The object to stop listening to. If omitted, stops it for all objects.
* `event?: string`
(Requires the `emitter`) The name of the event to stop listening to. If omitted, stops it for all events from `emitter`.
* `callback?: Function`
(Requires the `event`) The function to be removed from the call list for the given `event`.
#### Returns
* `void`
### `unbind( unbindProperties ) → void` _(inherited)_
Removes the binding created with [`bind`](#function-bind:SINGLE_BIND).
```typescript
// Removes the binding for the 'a' property.
A.unbind( 'a' );
// Removes bindings for all properties.
A.unbind();
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1090)
#### Parameters
* `unbindProperties: Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'init' | 'editor' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'insertColumns' | 'getCellLocation' | 'createTable' | 'insertRows' | 'removeRows' | 'removeColumns' | 'splitCellVertically' | 'splitCellHorizontally' | 'getColumns' | 'getRows' | 'createTableWalker' | 'getSelectedTableCells' | 'setFooterRowsCount' | 'setHeadingRowsCount' | 'setHeadingColumnsCount' | 'getTableCellsContainingSelection' | 'getSelectionAffectedTableCells' | 'getRowIndexes' | 'getColumnIndexes' | 'isSelectionRectangular' | 'sortRanges'>`
Observable properties to be unbound. All the bindings will be released if no properties are provided.
#### Returns
* `void`
### `createTableWalker( table, options ) → TableWalker` _(internal)_
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.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L991)
#### Parameters
* `table: ModelElement`
A table over which the walker iterates.
* `options: TableWalkerOptions`
An object with configuration.
Defaults to `{}`
#### Returns
* `TableWalker`
### `_areCellInTheSameTableSection( tableCells ) → boolean` _(private)_
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 │ └───┴───┴───┴───┘
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L1425)
#### Parameters
* `tableCells: Array`
#### Returns
* `boolean`
### `_areIndexesInSameHeadingSection( __namedParameters, headingSectionSize ) → boolean` _(private)_
Unified check if table rows/columns indexes are in the same heading/body section.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L1451)
#### Parameters
* `__namedParameters: TableIndexesObject`
* `headingSectionSize: number`
#### Returns
* `boolean`
### `_getFirstLastIndexesObject( indexes ) → TableIndexesObject` _(private)_
Helper method to get an object with `first` and `last` indexes from an unsorted array of indexes.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tableutils.ts#L1400)
#### Parameters
* `indexes: Array`
#### Returns
* `TableIndexesObject`
## Events
### `change:isEnabled( eventInfo, name, value, oldValue )` _(inherited)_
Fired when the `isEnabled` property changed value.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L51)
#### 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 )` _(inherited)_
Fired when a property changed value.
```typescript
observable.set( 'prop', 1 );
observable.on>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );
observable.prop = 2; // -> 'prop has changed from 1 to 2'
```
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1190)
#### Parameters
* `eventInfo: EventInfo`
An object containing information about the fired event.
* `name: string`
The property name.
* `value: TValue`
The new property value.
* `oldValue: TValue`
The previous property value.
### `set:isEnabled( eventInfo, name, value, oldValue )` _(inherited)_
Fired when the `isEnabled` property is going to be set but is not set yet (before the `change` event is fired).
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L51)
#### Parameters
* `eventInfo: EventInfo`
An object containing information about the fired event.
* `name: string`
Name of the changed property (`isEnabled`).
* `value: boolean`
New value of the `isEnabled` property with given key or `null`, if operation should remove property.
* `oldValue: boolean`
Old value of the `isEnabled` property with given key or `null`, if property was not set before.
### `set:{property}( eventInfo, name, value, oldValue )` _(inherited)_
Fired when a property value is going to be set but is not set yet (before the `change` event is fired).
You can control the final value of the property by using the [event's `return` property](module_utils_eventinfo-EventInfo.md#member-return).
```typescript
observable.set( 'prop', 1 );
observable.on>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
console.log( `Current property value is ${ observable[ propertyName ] }` );
// Let's override the value.
evt.return = 3;
} );
observable.on>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );
observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
// -> 'Current property value is 1'
// -> 'Value has changed from 1 to 3'
```
**Note:** The event is fired even when the new value is the same as the old value.
[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1228)
#### Parameters
* `eventInfo: EventInfo`
An object containing information about the fired event.
* `name: string`
The property name.
* `value: TValue`
The new property value.
* `oldValue: TValue`
The previous property value.
---
Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)