Report an issue
Class

TableUtils (table)

@ckeditor/ckeditor5-table/src/tableutils

class

The table utilities plugin.

Filtering

Properties

  • editor : Editor

    readonly inherited

    The editor instance.

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

    Because of above, to make plugins more universal, it is recommended to split features into:

Static properties

  • pluginName : String | undefined

    readonly inherited static

    Optional name of the plugin. If set, the plugin will be available in get by its name and its constructor. If not, then only by its constructor.

    The name should reflect the constructor name.

    To keep a plugin class definition tight it's recommended to define this property as a static getter:

    export default class ImageCaption {
        static get pluginName() {
            return 'ImageCaption';
        }
    }

    Note: The native Function.name property could not be used to keep the plugin name because it will be mangled during code minification.

    Naming a plugin is necessary to enable removing it through the config.removePlugins option.

  • requires : Array.<Function> | undefined

    readonly inherited static

    An array of plugins required by this plugin.

    To keep a plugin class definition tight it's 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 a plugin initialization. See also init and afterInit.

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

    Usually, you'll 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 servers for the special "after init" scenarios (e.g. code which depends on other plugins, but which doesn't explicitly require them).

    Parameters

    editor : Editor
  • afterInit() → null | Promise

    inherited

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

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

    Returns

    null | Promise
  • bind( bindProperties ) → Object

    mixed

    Binds observable properties to another objects implementing Observable interface (like Model).

    Once bound, the observable will immediately share the current state of properties of the observable it is bound to and react to the changes to these properties in the future.

    Note: To release the binding use unbind.

    Using bind().to() chain:

    A.bind( 'a' ).to( B );
    A.bind( 'a' ).to( B, 'b' );
    A.bind( 'a', 'b' ).to( B, 'c', 'd' );
    A.bind( 'a' ).to( B, 'b', C, 'd', ( b, d ) => b + d );

    It is also possible to bind to the same property in a observables collection using bind().toMany() chain:

    A.bind( 'a' ).toMany( [ B, C, D ], 'x', ( a, b, c ) => a + b + c );
    A.bind( 'a' ).toMany( [ B, C, D ], 'x', ( ...x ) => x.every( x => x ) );

    Parameters

    bindProperties : String

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

    Returns

    Object

    The bind chain with the to() and toMany() methods.

  • createTable( position, rows, columns ) → Element

    Creates an empty table at a given position.

    Parameters

    position : Position

    The position where the table will be inserted.

    rows : Number

    The number of rows to create.

    columns : Number

    The number of columns to create.

    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.

    This is a very simplified method decoration. Itself it doesn't change the behavior of a method (expect adding the event), but it allows to modify it later on by listening to the method's event.

    For example, in order to cancel the method execution one can stop the event:

    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: we used a high priority listener here to execute this callback before the one which calls the original method (which used the default priority).

    It's also possible to change the return value:

    foo.on( 'method', ( evt ) => {
        evt.return = 'Foo!';
    } );
    
    foo.method(); // -> 'Foo'

    Finally, it's possible to access and modify the parameters:

    method( a, b ) {
        console.log( `${ a }, ${ b }`  );
    }
    
    // ...
    
    foo.on( 'method', ( evt, args ) => {
        args[ 0 ] = 3;
    
        console.log( args[ 1 ] ); // -> 2
    }, { priority: 'high' } );
    
    foo.method( 1, 2 ); // -> '3, 2'

    Parameters

    methodName : String

    Name of the method to decorate.

  • delegate( events ) → EmitterMixinDelegateChain

    mixed

    Delegates selected events to another Emitter. For instance:

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

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

    emitterA.fire( 'eventX', data );

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

    emitterA.fire( 'eventY', data );

    Parameters

    events : String

    Event names that will be delegated to another emitter.

    Returns

    EmitterMixinDelegateChain
  • destroy() → null | Promise

    inherited

    Destroys the plugin.

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

    Returns

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

    mixed

    Fires an event, executing all callbacks registered for it.

    The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

    Parameters

    eventOrInfo : String | EventInfo

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

    [ args ] : *

    Additional arguments to be passed to the callbacks.

    Returns

    *

    By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).

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

    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.

  • getColumns( table ) → Number

    Returns the number of columns for a given table.

    editor.plugins.get( 'TableUtils' ).getColumns( table );

    Parameters

    table : Element

    The table to analyze.

    Returns

    Number
  • init() → null | Promise

    inherited

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

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

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

    Returns

    null | Promise
  • insertColumns( table, options = { [options.at], [options.columns] } )

    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

    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] } )

    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

    Row index at which the rows will be inserted.

    Defaults to 0

    [ options.rows ] : Number

    The number of rows to insert.

    Defaults to 1

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

    mixed

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

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

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

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

    Parameters

    emitter : Emitter

    The object that fires the event.

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

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

    Defaults to 'normal'

    Defaults to {}

  • off( event, callback )

    mixed

    Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to stop being called.

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

    mixed

    Registers a callback function to be executed when an event is fired.

    Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

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

    Defaults to 'normal'

    Defaults to {}

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

    mixed

    Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

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

    Defaults to 'normal'

    Defaults to {}

  • set( name, [ value ] )

    mixed

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

    It accepts also a single object literal containing key/value pairs with properties to be set.

    This method throws the observable-set-cannot-override error if the observable instance already have 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).

  • splitCellHorizontally( tableCell, numberOfCells )

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

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

    • To stop delegating all events.
    • To stop delegating a specific event to all emitters.
    • To stop delegating a specific event to a specific emitter.

    Parameters

    [ event ] : String

    The name of the event to stop delegating. If omitted, stops it all delegations.

    [ emitter ] : Emitter

    (requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.

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

    mixed

    Stops listening for events. It can be used at different levels:

    • To stop listening to a specific callback.
    • To stop listening to a specific event.
    • To stop listening to all events fired by a specific object.
    • To stop listening to all events fired by all objects.

    Parameters

    [ emitter ] : Emitter

    The object to stop listening to. If omitted, stops it for all objects.

    [ event ] : String

    (Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

    [ callback ] : function

    (Requires the event) The function to be removed from the call list for the given event.

  • unbind( [ unbindProperties ] )

    mixed

    Removes the binding created with bind.

    A.unbind( 'a' );
    A.unbind();

    Parameters

    [ unbindProperties ] : String

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

Events

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

    mixed

    Fired when a property changed value.

    observable.set( 'prop', 1 );
    
    observable.on( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
        console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
    } );
    
    observable.prop = 2; // -> 'prop has changed from 1 to 2'

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    The property name.

    value : *

    The new property value.

    oldValue : *

    The previous property value.

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

    mixed

    Fired when a property value is going to be set but is not set yet (before the change event is fired).

    You can control the final value of the property by using the event's return property.

    observable.set( 'prop', 1 );
    
    observable.on( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
        console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
        console.log( `Current property value is ${ observable[ propertyName ] }` );
    
        // Let's override the value.
        evt.return = 3;
    } );
    
    observable.on( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
        console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
    } );
    
    observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
                         // -> 'Current property value is 1'
                         // -> 'Value has changed from 1 to 3'

    Note: 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.