TimelineKit API
    Preparing search index...

    Interface CalendarPdfExportOptions

    interface CalendarPdfExportOptions {
        footer?: string | ((pageNumber: number, totalPages: number) => string);
        header?: string | ((pageNumber: number, totalPages: number) => string);
        includeSidebar?: boolean;
        margin?: { bottom: number; left: number; right: number; top: number };
        orientation?: "portrait" | "landscape";
        pageSize?: "A4" | "A3" | "Letter" | "Legal";
        quality?: number;
        scale?: number;
    }
    Index

    Properties

    footer? header? includeSidebar? margin? orientation? pageSize? quality? scale?

    Properties

    footer?: string | ((pageNumber: number, totalPages: number) => string)

    Footer text on each page.

    header?: string | ((pageNumber: number, totalPages: number) => string)

    Header text on each page.

    includeSidebar?: boolean

    Whether to include the sidebar. Default: false.

    margin?: { bottom: number; left: number; right: number; top: number }

    Page margins in mm. Default: 10mm on all sides.

    orientation?: "portrait" | "landscape"

    Page orientation. Default: 'landscape'.

    pageSize?: "A4" | "A3" | "Letter" | "Legal"

    Page format. Default: 'A4'.

    quality?: number

    Image quality (0-1). Default: 0.92.

    scale?: number

    Pixel scale factor for the captured image. Default: 2.

    Settings

    Member Visibility

    On This Page

    Properties