@combeenation/configurator-client
    Preparing search index...

    Interface Html2PdfOptions

    See Pupeteer docs for further details regarding the exposed options.

    Note:
    You can only use the options mentioned here even though the Pupeteer docs describe some more.
    Please let us know if you'd need other options as well.

    interface Html2PdfOptions {
        displayHeaderFooter?: boolean;
        footerTemplate?: string;
        format?: Html2PdfFormats;
        headerTemplate?: string;
        height?: string | number;
        landscape?: boolean;
        margin?: {
            bottom?: string | number;
            left?: string | number;
            right?: string | number;
            top?: string | number;
        };
        width?: string
        | number;
    }
    Index

    Properties

    displayHeaderFooter? footerTemplate? format? headerTemplate? height? landscape? margin? width?

    Properties

    displayHeaderFooter?: boolean
    footerTemplate?: string
    format?: Html2PdfFormats

    If set, takes priority over width or height options.
    If neither format, nor width or height are set, Html2PdfFormats.A4 is used as fallback.

    headerTemplate?: string
    height?: string | number

    Only takes effect if no format is set

    landscape?: boolean
    margin?: {
        bottom?: string | number;
        left?: string | number;
        right?: string | number;
        top?: string | number;
    }
    width?: string | number

    Only takes effect if no format is set

    Settings

    Member Visibility

    On This Page

    Properties