message

calls a message box of the specified type

string | number message(object | string | number config);

config

object | string | number

either an object with the message box's configuration or the text to show

string | number

the ID of the message box

let box = gantt.message({ 
    type:"warning", 
    text:"Are you sure you want to do it?"
});
 
// or
box = gantt.message("This is the message");

Details

The configuration object uses the following properties:

id? - (number | string) - optional, the ID of the popup message
text - (number | string) - the content of the popup message
type? - (string) - optional, the class name of the popup message
expire? - (number) - optional, the time period until the popup message disappears. -1 means, it won't hide by itself

The message property can be a function, but can also be used as a configuration object for the popup message. It has the following properties:

position - (string) - the position of the popup message. Possible values are: "top", "bottom", "left", "right"

gantt.message.position = "left";

keyboard - (boolean) - specifies if Gantt should block keyboard events. true by default.

gantt.message.keyboard = false;

hide (id): any - a function that hides the popup message. Uses id as a parameter:
- id - (number | string) - the ID of the popup message

gantt.message.hide("popupId");

For additional details about supported configuration options of a message box, see the Popup Messages and Modal Boxes article.