Skip to main content

update-column

Description​

Fires when updating column data

Usage​

"update-column": ({
    id: string | number,
    column?: object,
    replace?: boolean,
    skipProvider?: boolean
}) => void;

Parameters​

The callback of the update-column event can take an object with the following parameter:

  • id - (required) the ID of the column to be updated

  • column - (optional) the new data object of the column. The full list of the column parameters can be found here

  • replace - (optional) enables/disables fully data replacing

    note

    If you set the replace parameter to true, the old data will be fully replaced by the new ones. Otherwise, the method will update only the values you passed.

  • skipProvider - (optional) enables/disables preventing the request from being sent to the server

info

For handling the inner events you can use the Event Bus methods

Example​

// create Kanban
const board = new kanban.Kanban("#root", {
    columns,
    cards
});
// subscribe on the "update-column" event
board.api.on("update-column", (obj) => {
    console.log(obj);
});

Change log:

  • The id and column parameters were added in v1.1
  • The replace parameter was added in v1.3