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

Overlay Extension

заметка

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

Расширение overlay предоставляет набор 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.
    • id - (number | string) - идентификатор оверлея
gantt.ext.overlay.showOverlay(id);

hideOverlay​

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

isOverlayVisible​

  • isOverlayVisible (id): boolean - определяет, видим ли указанный оверлей. Возвращает true, если оверлей видим.
    • id - (number | string) - идентификатор оверлея
var isVisible = gantt.ext.overlay.isOverlayVisible(id);