Print

Allows printing Scheduler contents using browser print dialog.

This feature is based on PdfExport with only difference that instead of sending request to a backend it renders content to an IFrame element and requests print dialog for it. For more details about preparing HTML for printing, please refer to the PdfExport docs.

Usage

const scheduler = new Scheduler({
    features : {
        print : true
    }
})

// Opens popup allowing to customize print settings
scheduler.features.print.showPrintDialog();

// Simple print
scheduler.features.print.print({
    columns : scheduler.columns.map(c => c.id)
});

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

Configs

40

Common

disabledInstancePlugin
listenersEvents

Export file config

fileFormatPdfExport
fileNamePdfExport
orientationPdfExport
paperFormatPdfExport
rangeEndPdfExport
rangeStartPdfExport
rowsRangePdfExport
scheduleRangePdfExport

Misc

clientInstancePlugin
localeClassLocalizable
localizableLocalizable

Other

alignRowsPdfExport
clientURLPdfExport
exportDialogPdfExport
exportersPdfExport
exporterTypePdfExport
exportMaskPdfExport
exportServerPdfExport
fetchOptionsPdfExport
footerTplPdfExport
headerTplPdfExport
keepPathNamePdfExport
lockPaperSizePdfExport
openInNewTabPdfExport
repeatHeaderPdfExport
sendAsBinaryPdfExport

Properties

24

Common

disabledInstancePlugin

Class hierarchy

isPrint: Boolean= truereadonly
Identifies an object as an instance of Print class, or subclass thereof.
isPrint: Boolean= truereadonlystatic
Identifies an object as an instance of Print class, or subclass thereof.
isPrintMixin: Boolean= truereadonlyPrintMixin
Identifies an object as an instance of PrintMixin class, or subclass thereof.
isPrintMixin: Boolean= truereadonlystaticPrintMixin
Identifies an object as an instance of PrintMixin class, or subclass thereof.
isEventsEvents
isInstancePluginInstancePlugin
isLocalizableLocalizable
isPdfExportPdfExport

Lifecycle

configBase

Misc

clientInstancePlugin
localeHelperLocalizable
localeManagerLocalizable

Other

exportDialogPdfExport
isExportingPdfExport

Functions

36

Other

This method is called when IFrame is loaded with all the HTML/CSS and is about to be printed. Use it to take control over the page contents.

ParameterTypeDescription
iframeHTMLIFrameElement
exportPdfExport
filterStylesPdfExport
LstaticLocalizable
onEvents
relayAllEvents
triggerEvents
unEvents

Print

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

ParameterTypeDescription
configPrintConfig
Returns: Promise -

Promise which resolves when printing is done. Optionally it might return an object with an error key in it.

Shows the print dialog

Returns: Promise

Configuration

applyDefaultsstaticBase

Events

Lifecycle

destroystaticBase

Misc

doDisableInstancePlugin
initClassstaticBase
isOfTypeNamestaticBase
mixinstaticBase
optionalLstaticLocalizable

Events

8
catchAllEvents
destroyEvents
disableInstancePlugin
enableInstancePlugin
exportStepPdfExport
pdfExportPdfExport

Event handlers

8
onDestroyEvents
onDisableInstancePlugin
onEnableInstancePlugin
onExportStepPdfExport
onPdfExportPdfExport

Typedefs

1