Available only in PRO Edition

Расширение Overlay

Расширение overlay предоставляет набор API методов, разработанных для упрощения работы с оверлеями в диаграмме Ганта. Для более подробной информации о расширении Overlay, ознакомьтесь со статьей Пользовательские элементы в области временной шкалы.

Методы

Вот методы, которые вы можете использовать с объектом gantt.ext.overlay:

addOverlay

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

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

deleteOverlay

• deleteOverlay (id): boolean - удаляет оверлей, используя его ID.
  • id - (number | string) - ID оверлея.

gantt.ext.overlay.deleteOverlay(id);

getOverlaysIds

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

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

refreshOverlay

• refreshOverlay (id): void - обновляет отображение конкретного оверлея.
  • id - (number | string) - ID оверлея.

gantt.ext.overlay.refreshOverlay(id);

showOverlay

• showOverlay (id): void - делает оверлей видимым, используя его ID.
  • id - (number | string) - ID оверлея.

gantt.ext.overlay.showOverlay(id);

hideOverlay

• hideOverlay (id): void - скрывает оверлей, используя его ID.
  • id - (number | string) - ID оверлея.

gantt.ext.overlay.hideOverlay(id);

isOverlayVisible

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

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

К началу