Overlay-Erweiterung

Info

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

Die overlay-Erweiterung stellt eine Sammlung von API-Methoden bereit, die die Arbeit mit Overlays vereinfachen. Ausführlichere Informationen finden Sie im Artikel Custom Elements in Timeline Area.

Methoden

Die folgenden Methoden sind über das Objekt gantt.ext.overlay zugänglich:

addOverlay

• addOverlay (render, id): string | number - fügt dem Gantt-Diagramm ein neues Overlay hinzu und gibt dessen ID zurück
  • render - (Function): HTMLElement - die Funktion, die für das Rendering verantwortlich ist. Sie erhält einen Container mit benutzerdefiniertem Inhalt als Parameter
    • container - (HTMLElement) - der Container für das Overlay
  • id? - (number | string) - optional, gibt die ID des Overlays an

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 - macht ein Overlay anhand seiner ID sichtbar.
  • id - (number | string) - die ID des Overlays

gantt.ext.overlay.showOverlay(id);

hideOverlay

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

gantt.ext.overlay.hideOverlay(id);

isOverlayVisible

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

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