PdfExport

Format of the exported file, either pdf or png.

Name of the exported file.

Orientation. Options are portrait and landscape.

Export paper format. Available options are A1...A5, Legal, Letter.

Specifies which rows to export. all for complete set of rows, visible for only rows currently visible.

Set to true to align row top to the page top on every exported page. Only applied to multipage export.

Export server will navigate to this url first and then will change page content to whatever client sent. This option is useful with react dev server, which uses a strict CORS policy.

A config object to apply to the ExportDialog widget.

List of exporter classes to use in export feature

Type of the exporter to use. Should be one of the configured exporters

A message to be shown when Export feature is performing export.

A message to be shown when export is almost done.

URL of the print server.

An object containing the Fetch options to pass to the export server request. Use this to control if credentials are sent and other options, read more at MDN.

A template function used to generate a page footer. It is passed an object with ´currentPage´ and `totalPages´ properties.

let grid = new Grid({
     appendTo   : 'container',
     features : {
         pdfExport : {
             exportServer : 'http://localhost:8080/',
             footerTpl    : () => '<div class="demo-export-footer"><h3>© 2020 CoolCorp Inc</h3></div>'
         }
     }
});

A template function used to generate a page header. It is passed an object with ´currentPage´ and `totalPages´ properties.

let grid = new Grid({
    appendTo   : 'container',
    features : {
        pdfExport : {
            exportServer : 'http://localhost:8080/',
            headerTpl : ({ currentPage, totalPages }) => `
                <div class="demo-export-header">
                    <img src="coolcorp-logo.png"/>
                    <dl>
                        <dt>Date: ${DateHelper.format(new Date(), 'll LT')}</dt>
                        <dd>${totalPages ? `Page: ${currentPage + 1}/${totalPages}` : ''}</dd>
                    </dl>
                </div>`
         }
    }
});

When true links are converted to absolute by combining current window location (with replaced origin) with resource link. When false links are converted by combining new origin with resource link (for angular)

By default, subGrid width is changed to fit all exported columns. To keep certain subGrid size specify it in the following form:

keepRegionSizes : {
    locked : true
}

Defines if printed/exported page should contain @page style with paper size and orientation specified.

When true, page will attempt to download generated file.

False to open in the current tab, true - in a new tab

Set to true to show column headers on every page. This will also set alignRows to true. Only applies to MultiPageVertical exporter.

A function that determines when to capture the HTML for exported rows. When set to null (the default), the export happens immediately without waiting. The function receives the export configuration as a parameter. The rendering process works in chunks, using the same approach as the Grid component - displaying visible rows with an additional buffer.

Examples:

// simple timeout
new Grid({
    features : {
        pdfExport : {
            rowReadyCondition : async () => await new Promise(resolve => setTimeout(resolve, 100))
        }
    }
});

// waiting for a condition
new Grid({
    features : {
        pdfExport : {
            rowReadyCondition : async () => await promiseWithCondition
        }
    }
});

Set to true to receive binary file from the server instead of download link.

Set to false to not show Toast message on export error.

True to replace all linked CSS files URLs to absolute before passing HTML to the server. When passing a string the current origin of the CSS files URLS will be replaced by the passed origin.

For example: css files pointing to /app.css will be translated from current origin to {translateURLsToAbsolute}/app.css

Determines whether to stream exported pages directly to the export server using WebSocket connection to offload client application. false - use legacy mode which first collected all pages locally and then passed them in a single request true - stream pages directly to the server null (default) - ask export server for WebSocket support and use it if possible

Maximum time in ms to wait for the response over the websocket connection

When export is started from GUI (ExportDialog), export promise can be accessed via this property.

Returns the instantiated export dialog widget as configured by exportDialog

This yields true if an export/print operation is ongoing.

A function that determines when to capture the HTML for exported rows. When set to null (the default), the export happens immediately without waiting. The function receives the export configuration as a parameter. The rendering process works in chunks, using the same approach as the Grid component - displaying visible rows with an additional buffer.

Examples:

// simple timeout
new Grid({
    features : {
        pdfExport : {
            rowReadyCondition : async () => await new Promise(resolve => setTimeout(resolve, 100))
        }
    }
});

// waiting for a condition
new Grid({
    features : {
        pdfExport : {
            rowReadyCondition : async () => await promiseWithCondition
        }
    }
});

Determines whether to stream exported pages directly to the export server using WebSocket connection to offload client application. false - use legacy mode which first collected all pages locally and then passed them in a single request true - stream pages directly to the server null (default) - ask export server for WebSocket support and use it if possible

Maximum time in ms to wait for the response over the websocket connection

Starts the export process. Accepts a config object which overrides any default configs. NOTE. Component should not be interacted with when export is in progress

This method accepts all stylesheets (link and style tags) which are supposed to be put on the page. Use this hook method to filter or modify them.

new Grid({
    features: {
        pdfExport: {
            // filter out inline styles and bootstrap.css
            filterStyles: styles => styles.filter(item => !/(link|bootstrap.css)/.test(item))
        }
    }
});

Handles output of the receiveExportContent. Server response can be of two different types depending on sendAsBinary config:

• application/json In this case JSON response contains url of the file to download
• application/octet-stream In this case response contains stream of file binary data

If openAfterExport is true, this method will try to download content.

Sends request to the export server and returns Response instance. This promise can be cancelled by the user by clicking on the toast message. When the user clicks on the toast, abort method is called on the promise returned by this method. If you override this method you can implement abort method like in the snippet below to cancel the request.

class MyPdfExport extends PdfExport {
    receiveExportContent(pages, config) {
        let controller;

        const promise = new Promise(resolve => {
            controller = new AbortController();
            const signal = controller.signal;

            fetch(url, { signal })
                .then(response => resolve(response));
        });

        // This method will be called when user clicks on the toast message to cancel the request
        promise.abort = () => controller.abort();

        return promise;
    }
}

const grid = new Grid({ features: { myPdfExport : {...} } });

grid.features.myPdfExport.export().catch(e => {
    // In case of aborted request do nothing
    if (e.name !== 'AbortError') {
        // handle other exceptions
    }
});

Shows export dialog