ExcelExporter
Feature
A feature that allows exporting Scheduler data to Excel or CSV without involving the server. It uses TableExporter class as data provider, 3rd party provider to generate XLS files, and Microsoft XML specification.
import WriteExcelFileProvider from '../../lib/Grid/feature/experimental/xlsproviders/WriteExcelFileProvider.js';
new Scheduler({
features : {
excelExporter : {
xlsProvider : WriteExcelFileProvider
}
}
});
Here is an example of how to add the feature:
const scheduler = new Scheduler({
features : {
excelExporter : {
// Choose the date format for date fields
dateFormat : 'YYYY-MM-DD HH:mm',
exporterConfig : {
// Choose the Resource fields to include in the exported file
columns : [{ text : 'Staff', field : 'name' }],
// Choose the Event fields to include in the exported file
eventColumns : [
{ text : 'Task', field : 'name' },
{ text : 'Starts', field : 'startDate', width : 140 },
{ text : 'Ends', field : 'endDate', width : 140 }
]
}
}
}
});
And how to call it:
scheduler.features.excelExporter.export({
filename : 'Export',
exporterConfig : {
columns : [{ text : 'Staff', field : 'name' }]
}
})
This feature is disabled by default.
This class requires a 3rd party library to export to XLSX
No results
Configs
Configs are options you supply in a configuration object when creating an instance of this class-
Exporter class. Must subclass ScheduleTableExporter
-
Configuration object for exporter class.
Properties
Properties are getters/setters or publicly accessible variables on this class-
Identifies an object as an instance of ExcelExporter class, or subclass thereof.
-
Identifies an object as an instance of ExcelExporter class, or subclass thereof.
id: excelExporter