Skip to main content

beforeSubmenuOpen

Description​

Fires before the menu of the subheader is opened

Usage​

beforeSubmenuOpen: (
    id: string | number, 
    event: MouseEvent, 
    subHeaderId?: string
) => boolean | void;

Parameters​

The callback of the event takes the following parameters:

  • id - (required) the id of a swimlane
  • event - (required) a native HTML event object
  • subHeaderId - (optional) the id of a subheader of a swimlane

Returns​

Return false to block opening the subheader; otherwise, true

Example​

// initializing Diagram
const diagram = new dhx.Diagram("diagram_container", {
    type: "default"
});
// loading data
diagram.data.parse(data);

// attaching a handler to the event
diagram.events.on("beforeSubmenuOpen", (id, event, subheaderId) => {
    console.log(id, event, subheaderId);
    return true;
});

Change log: Added in v4.0

Related article: Event handling