SinglePageExporter

A single page exporter. Used by the PdfExport feature to export to single page. Content will be scaled in both directions to fit the page.

You do not need to use this class directly.

Extending exporter

class MySinglePageExporter extends SinglePageExporter {
    // type is required for exporter
    static get type() {
        return 'mysinglepageexporter';
    }

    get stylesheets() {
        const stylesheets = super.stylesheets;

        stylesheets.forEach(styleNodeOrLinkTag => doSmth(styleNodeOrLinkTag))

        return stylesheets;
    }
}

const grid = new Grid({
    features : {
        pdfExport : {
            // this export feature is configured with only one exporter
            exporters : [MySinglePageExporter]
        }
    }
});

// run export with the new exporter
grid.features.pdfExport.export({ exporter : 'mysinglepageexporter' });

Configs

11

Common

listenersEvents

Other

Set to true to center content horizontally on the page

keepPathNameExporterBase
rowReadyConditionExporterBase

Misc

localeClassLocalizable
localizableLocalizable

Properties

11

Class hierarchy

isSinglePageExporter: Boolean= truereadonly
Identifies an object as an instance of SinglePageExporter class, or subclass thereof.
isSinglePageExporter: Boolean= truereadonlystatic
Identifies an object as an instance of SinglePageExporter class, or subclass thereof.
isEventsEvents
isExporterExporter
isLocalizableLocalizable

Misc

localeHelperLocalizable
localeManagerLocalizable

Other

rowReadyConditionExporterBase
stylesheetsExporterBase

Functions

15

Misc

optionalLstaticLocalizable

Other

filterStylesExporterBase
LstaticLocalizable
onEvents
pageTplExporterBase
relayAllEvents
triggerEvents
unEvents

Events

3

Event handlers

3

Typedefs

1