Zum Hauptinhalt springen

exportToExcel

Description​

Exportiert Daten aus dem Gantt-Diagramm in eine Excel-Datei

exportToExcel: (export?: any) => void

Parameters​

  • export - (optional) object - optionale Einstellungen für den Export (siehe Details)

Example​

gantt.exportToExcel({
    name:"document.xlsx", 
    columns:[
        { id:"text",  header:"Titel", width:150 },
        { id:"start_date",  header:"Startdatum", width:250, type:"date" }
    ],
    server:"https://myapp.com/myexport/gantt",
    callback: function(res){
        alert(res.url);
    },
    visual:true,
    cellColors:true,
    date_format: "dddd d, mmmm yyyy"
});

Details​

Hinweis

Diese Methode ist Teil der export Erweiterung, daher stellen Sie sicher, dass das export_api Plugin aktiviert ist. Weitere Details finden Sie im Artikel Export/Import for Excel, Export to iCal.

Hinweis

Für Gantt-Versionen vor 8.0 binden Sie das Script https://export.dhtmlx.com/gantt/api.js auf Ihrer Seite ein, um den Online-Exportdienst zu aktivieren, z.B.:

<script src="codebase/dhtmlxgantt.js"></script>
<script src="https://export.dhtmlx.com/gantt/api.js"></script>

Die Methode exportToExcel() akzeptiert ein Objekt mit mehreren optionalen Eigenschaften:

  • name - (string) legt den Dateinamen der Ausgabedatei fest, inklusive der Endung '.xlsx'
  • columns - (array) definiert die Spalten für das generierte Excel-Blatt. Jedes Spaltenobjekt kann enthalten:
    • 'id' - (string,number) die Eigenschaft des Events, die der Spalte zugeordnet wird
    • 'header' - (string) der Spaltenkopftext
    • 'width' - (number) die Spaltenbreite in Pixeln
    • 'type' - (string) der Datentyp der Spalte
  • server - (string) die URL des API-Endpunkts für die Exportanfrage. Nützlich bei Verwendung eines lokal installierten Exportdienstes. Standard ist https://export.dhtmlx.com/gantt
  • callback - (function) eine Funktion, die die URL der generierten XLSX-Datei erhält. Der Callback erhält ein JSON-Objekt mit der Eigenschaft url
  • visual - (boolean) fügt das Zeitachsen-Diagramm in die exportierte Excel-Datei ein; Standard ist false. Details siehe wie man Aufgabenfarben hinzufügt
  • cellColors - (boolean) wenn true, erhalten Zellen in der exportierten Datei Farben entsprechend der timeline_cell_class Vorlage, es werden color und background-color Eigenschaften exportiert
  • data - (object) spezifiziert eine benutzerdefinierte Datenquelle, die im ausgegebenen Gantt-Diagramm angezeigt werden soll
  • date_format - (string) definiert das Datumsformat, das im exportierten Excel-Dokument verwendet wird. Folgende Formatcodes werden unterstützt:
<style>
    table.my_table {
        width: 70%;
        padding: 0 20px;
      
    }
    table.my_table tr td {
        text-align: left;
        vertical-align: middle;
        width: 35%;
        border-bottom: 1px solid grey;
    }
    table.my_table td.version_info {
        text-align: left;
        font-weight: bold;
    }
</style>
FormatcodeAusgabe
d9
dd09
dddMo
ddddMontag
mm01
mmmJan
mmmmJanuar
mmmmmJ
yy12
yyyy2021
mm/dd/yyyy01/09/2021
m/d/y1/9/21
ddd, mmm dMo, Jan 9
mm/dd/yyyy h:mm AM/PM01/09/2021 6:20 PM
dd/mm/yyyy hh:mm:ss09/01/2012 16:20:00

Standard-Datumsparameter​

Das Export-Modul erwartet, dass die Spalten start_date und end_date vom Typ Date sind und die Spalte duration vom Typ number.

Wenn Sie benutzerdefinierte Templates verwenden, sollten Sie entweder Werte des erwarteten Typs zurückgeben oder eine andere Eigenschaft im name-Feld der Spaltenkonfiguration angeben. Zum Beispiel:


gantt.config.columns = [
    ...
    {name: "start_date", align: "center", width: 100, resize: true, 
        editor: start_dateEditor},
    {name: "end_date", align: "center", width: 100, resize: true, 
        editor: end_dateEditor},
    {name: "duration_formatted", /*!*/
        align: "center", width: 40, resize: true, 
        editor: durationEditor, 
        template: function(task){ /*!*/
            return formatter.format(task.duration_formatted); /*!*/
        }
    },
    ...
];

Andernfalls werden die Gantt-Daten nicht korrekt exportiert. Siehe das zugehörige Beispiel.