PdfExport

Feature

Generates PDF/PNG files from the Scheduler component.

When your server is up and running, it listens to requests. The Export feature sends a request to the specified URL with the HTML fragments. The server generates a PDF (or PNG) file and returns a download link (or binary, depending on sendAsBinary config). Then the Export feature opens the link in a new tab and the file is automatically downloaded by your browser. This is configurable, see openAfterExport config.

The exportServer URL must be configured. The URL can be localhost if you start the server locally, or your remote server address.

Usage

const scheduler = new Scheduler({
    features : {
        pdfExport : {
            exportServer : 'http://localhost:8080' // Required
        }
    }
})

// Opens popup allowing to customize export settings
scheduler.features.pdfExport.showExportDialog();

// Simple export
scheduler.features.pdfExport.export({
    // Required, set list of column ids to export
    columns : scheduler.columns.map(c => c.id)
}).then(result => {
    // Response instance and response content in JSON
    let { response, responseJSON } = result;
});

Appends configs related to exporting time axis: scheduleRange, rangeStart, rangeEnd

Loading resources

If you face a problem with loading resources when exporting, the cause might be that the application and the export server are hosted on different servers. This is due to Cross-Origin Resource Sharing (CORS). There are 2 options how to handle this:

• Allow cross-origin requests from the server where your export is hosted to the server where your application is hosted;
• Copy all resources keeping the folder hierarchy from the server where your application is hosted to the server where your export is hosted and setup paths using translateURLsToAbsolute config and configure the export server to give access to the path:

const scheduler = new Scheduler({
    features : {
        pdfExport : {
            exportServer : 'http://localhost:8080',
            // '/resources' is hardcoded in WebServer implementation
            translateURLsToAbsolute : 'http://localhost:8080/resources'
        }
    }
})

// Following path would be served by this address: http://localhost:8080/resources/
node ./src/server.js -h 8080 -r web/application/styles

where web/application/styles is a physical root location of the copied resources, for example:

This feature is disabled by default. For info on enabling it, see GridFeatures.

Useful configs and functions

See also

• Print - Print using browser print dialog
• PdfExport - Grid base class
• SchedulerExportDialog - Export dialog