exportToExcel

Description

Exportiert Daten aus dem Gantt-Diagramm in ein Excel-Dokument

exportToExcel: (export?: any) => void

Parameters

• export - object - optional, ein Objekt mit Export-Einstellungen (siehe Details)

Example

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

Details

Hinweis

Diese Methode ist in der export-Erweiterung definiert, daher müssen Sie das export_api Plugin aktivieren. Lesen Sie die Details im Artikel.

Hinweis

Falls Sie eine Gantt-Version verwenden, die älter als 8.0 ist, müssen Sie die https://export.dhtmlx.com/gantt/api.js in Ihre Seite einbinden, um den Online-Export-Service zu aktivieren, z.B.:

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

Die exportToExcel()-Methode nimmt als Parameter ein Objekt mit mehreren Eigenschaften (alle Eigenschaften sind optional):

• name - (string) legt den Namen der Ausgabedatei mit der Erweiterung '.xlsx' fest
• columns - (array) ermöglicht die Konfiguration der Spalten des ausgabe Excel-Blatts. Die Eigenschaften der Spaltenobjekte sind:
  • 'id' - (string,number) eine Eigenschaft des Ereignisses, die der Spalte zugeordnet wird
  • 'header' - (string) der Spaltenheader
  • 'width' - (number) die Spaltenbreite in Pixeln
  • 'type' - (string) der Spaltentyp
• server - (string) legt den API-Endpunkt für die Anfrage fest. Kann mit der lokalen Installation des Export-Services verwendet werden. Standardwert ist https://export.dhtmlx.com/gantt
• callback - (function) Wenn Sie eine URL zum Herunterladen einer generierten XLSX-Datei erhalten möchten, kann die callback-Eigenschaft verwendet werden. Sie erhält ein JSON-Objekt mit der Eigenschaft url
• visual - (boolean) fügt dem exportierten Excel-Dokument das Timeline-Diagramm hinzu; standardmäßig false. Lesen Sie wie man Task-Farben zur exportierten Datei hinzufügt zum exportierten Dokument
• cellColors - (boolean) wenn auf true gesetzt, erhalten die Zellen des exportierten Dokuments die Farben, die durch die Vorlage festgelegt sind; die Eigenschaften color und background-color werden exportiert
• data - (object) legt eine benutzerdefinierte Datenquelle fest, die im exportierten Gantt-Diagramm dargestellt wird
• date_format - (string) legt das Datumsformat fest, in dem das Datum im exportierten Excel-Dokument angezeigt wird. Folgende Formatcodes können verwendet werden:

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;
}

Format codeOutput:

Format code	Output
d	9
dd	09
ddd	Mon
dddd	Monday
mm	01
mmm	Jan
mmmm	January
mmmmm	J
yy	12
yyyy	2021
mm/dd/yyyy	01/09/2021
m/d/y	1/9/21
ddd, mmm d	Mon, Jan 9
mm/dd/yyyy h:mm AM/PM	01/09/2021 6:20 PM
dd/mm/yyyy hh:mm:ss	09/01/2012 16:20:00

Default date parameters

• Das Export-Modul erwartet, dass die Spalten start_date und end_date den Typ Date haben und die Spalte duration den Typ number hat.

Im Falle der Anwendung custom templates ist es notwendig, entweder einen Wert des erwarteten Typs zurückzugeben oder einen anderen Wert in der name-Eigenschaft der Spaltenkonfiguration zu definieren. 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: (task) => { 
            return formatter.format(task.duration_formatted); 
        }
    },
    ...
];

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

Related API

• exportToMSProject
• exportToPrimaveraP6
• exportToICal
• exportToPDF
• exportToPNG
• exportToJSON
• importFromExcel
• importFromPrimaveraP6
• importFromMSProject

Related Guides

• Export/Import for Excel, Export to iCal