Skip to main content

Event handling

Attaching event listeners​

The user can add any user-defined handler to any of the available events. To do this, the user can use the layout.events.on() method with the following parameters:

evNamename of the event
evHandleruser-defined event handler
layout.events.on("beforeHide", function(id){
    console.log("The id of a cell", id);
});

Several handlers can be attached to one and the same event, and all of them will be executed.

note

The names of the events are case-insensitive.

Related sample: Layout. Events

Detaching event listeners​

There is a simple way of removing an event handler via the layout.events.detach() method:

layout.events.on("beforeHide", function(id){
    console.log("The id of a cell", id);
});

layout.events.detach("beforeHide");

Calling events​

To call events, use layout.events.fire():

layout.events.fire("beforeHide",args);
// where args is an array of arguments

List of supported events​

You can find the full list of Layout events in the API Reference.