Available only in PRO Edition

Overlay-Erweiterung

Die Overlay-Erweiterung bietet eine Sammlung von API-Methoden, die das Arbeiten mit Overlays im Gantt-Diagramm erleichtern. Für detailliertere Informationen über die Overlay-Erweiterung, lesen Sie den Artikel Benutzerdefinierte Elemente im Zeitachsenbereich.

Methoden

Hier sind die Methoden, die Sie mit dem gantt.ext.overlay-Objekt verwenden können:

addOverlay

• addOverlay (render, id): string | number - fügt dem Gantt-Diagramm ein neues Overlay hinzu und gibt dessen ID zurück.
  • render - (Function): HTMLElement - eine Render-Funktion, die einen Container mit benutzerdefiniertem Inhalt als Parameter nimmt.
    • container - (HTMLElement) - der Container des Overlays.
  • id? - (number | string) - optional, die ID des Overlays.

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

deleteOverlay

• deleteOverlay (id): boolean - entfernt ein Overlay mithilfe seiner ID.
  • id - (number | string) - die ID des Overlays.

gantt.ext.overlay.deleteOverlay(id);

getOverlaysIds

• getOverlaysIds (): Array<string> - ruft ein Array von IDs für alle dem Diagramm hinzugefügten Overlays ab.

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

refreshOverlay

• refreshOverlay (id): void - aktualisiert die Anzeige eines bestimmten Overlays.
  • id - (number | string) - die ID des Overlays.

gantt.ext.overlay.refreshOverlay(id);

showOverlay

• showOverlay (id): void - macht ein Overlay mithilfe seiner ID sichtbar.
  • id - (number | string) - die ID des Overlays.

gantt.ext.overlay.showOverlay(id);

hideOverlay

• hideOverlay (id): void - verbirgt ein Overlay mithilfe seiner ID.
  • id - (number | string) - die ID des Overlays.

gantt.ext.overlay.hideOverlay(id);

isOverlayVisible

• isOverlayVisible (id): boolean - überprüft, ob ein bestimmtes Overlay sichtbar ist. Gibt true zurück, wenn das Overlay derzeit sichtbar ist.
  • id - (number | string) - die ID des Overlays.

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

Zurück nach oben