Overlay-Erweiterung

Info

Diese Funktionalität ist nur in der PRO-Edition verfügbar.

Die overlay-Erweiterung enthält eine Reihe von API-Methoden, um die Arbeit mit Overlays zu vereinfachen. Details zur Overlay-Erweiterung finden Sie im Artikel Benutzerdefinierte Elemente im Timeline-Bereich.

Methoden

Die folgenden Methoden sind über das Objekt gantt.ext.overlay verfügbar:

addOverlay

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

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

deleteOverlay

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

gantt.ext.overlay.deleteOverlay(id);

getOverlaysIds

• getOverlaysIds (): Array<string> - gibt ein Array mit den IDs der dem Diagramm hinzugefügten Overlays zurück

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

refreshOverlay

• refreshOverlay (id): void - zeichnet das angegebene Overlay neu.
  • id - (number | string) - die ID des Overlays

gantt.ext.overlay.refreshOverlay(id);

showOverlay

• showOverlay (id): void - zeigt ein Overlay anhand seiner ID an.
  • id - (number | string) - die ID des Overlays

gantt.ext.overlay.showOverlay(id);

hideOverlay

• hideOverlay (id): void - versteckt ein Overlay anhand seiner ID
  • id - (number | string) - die ID des Overlays

gantt.ext.overlay.hideOverlay(id);

isOverlayVisible

• isOverlayVisible (id): boolean - prüft die Sichtbarkeit des angegebenen Overlays. Gibt true zurück, wenn das Overlay sichtbar ist.
  • id - (number | string) - die ID des Overlays

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