Расширение оверлей

информация

Эта функциональность доступна только в версии PRO.

Расширение оверлей содержит набор API-методов для упрощения работы с оверлеями. Подробнее об расширении оверлей можно узнать в статье Пользовательские элементы в области таймлайна.

Методы

Следующие методы доступны через объект gantt.ext.overlay:

addOverlay

• addOverlay (render, id): string | number - добавляет новый оверлей в диаграмму Gantt и возвращает его id
  • render - (Function): HTMLElement - функция рендера. Принимает на вход контейнер с произвольным содержимым
    • container - (HTMLElement) - контейнер оверлея
  • id? - (number | string) - необязательный, идентификатор оверлея

var overlay = gantt.ext.overlay.addOverlay(function(container){});

deleteOverlay

• deleteOverlay (id): boolean - удаляет оверлей по его id
  • id - (number | string) - идентификатор оверлей

gantt.ext.overlay.deleteOverlay(id);

getOverlaysIds

• getOverlaysIds (): Array<string> - возвращает массив идентификаторов оверлеев, добавленных на диаграмму

var ids = gantt.ext.overlay.getOverlaysIds();

refreshOverlay

• refreshOverlay (id): void - перерисовывает указанный оверлей.
  • id - (number | string) - идентификатор оверлея

gantt.ext.overlay.refreshOverlay(id);

showOverlay

• showOverlay (id): void - отображает оверлей по его идентификатору.
  • id - (number | string) - идентификатор оверлея

gantt.ext.overlay.showOverlay(id);

hideOverlay

• hideOverlay (id): void - скрывает оверлей по его идентификатору
  • id - (number | string) - идентификатор оверлея

gantt.ext.overlay.hideOverlay(id);

isOverlayVisible

• isOverlayVisible (id): boolean - проверяет видимость указанного оверлея. Возвращает true, если оверлей видим.
  • id - (number | string) - идентификатор оверлея

var isVisible = gantt.ext.overlay.isOverlayVisible(id);