Перейти к основному содержимому

attachEvent

Description​

Подключает обработчик к внутреннему событию dhtmlxGantt

attachEvent: <T extends keyof GanttEventCallback>(event: T, handler: GanttEventCallback[T], settings?: HandlerSettings) => string

Parameters​

  • name - (required) string - имя события, регистронезависимое
  • handler - (required) function - функция-обработчик
  • settings - (optional) HandlerSettings - необязательный параметр, объект с настройками для обработчика события

Returns​

  • event_id - (string) - идентификатор подключенного обработчика события

Example​

gantt.attachEvent("onTaskClick", function(id, e) {
    alert("Вы только что кликнули по элементу с id="+id);
});

Details​

К одному событию можно подключить несколько обработчиков, и все они будут выполнены. Если какой-либо обработчик возвращает false, соответствующая операция будет отменена. Обработчики выполняются в том порядке, в котором они были подключены.

Свойства объекта settings​

Объект settings может включать следующие свойства:

  • id? - (string | number) - идентификатор обработчика события. Это позволяет легко отключить конкретный обработчик от события:
gantt.attachEvent("onTaskClick", function(){
    console.log("task click");
}, {id: "my-click"}); /*!*/
... //позже:
gantt.detachEvent("my-click");
  • once? - (boolean) - указывает, должно ли событие сработать только один раз. Установите это в true, чтобы отловить только первое срабатывание события, например:
gantt.attachEvent("onTaskClick", function(){
    console.log("capture next task click");
    return true;
}, {once: true}); /*!*/
  • thisObject? - (any) - задаёт контекст this для слушателя события.
gantt.attachEvent("onTaskClick", function(){
    // ...
    return true;
}, {thisObject: this}); /*!*/