ComPDFKit Web SDK
    Preparing search index...

    Interface HeaderFooterOptions

    Header / footer / Bates: text at each position (a string, or with font, size and color '#rrggbb'); margin in pt (36 by default); pages are page numbers (all by default)

    interface HeaderFooterOptions {
        margins?: {
            bottom?: number;
            left?: number;
            right?: number;
            top?: number;
        };
        pages?: number[];
        texts: Partial<
            Record<
                HeaderFooterPosition,
                | string
                | { color?: string; fontName?: string; fontSize?: number; text: string },
            >,
        >;
    }
    Index
    margins?: { bottom?: number; left?: number; right?: number; top?: number }

    Margins in PDF points. Default 36 on each side.

    Type Declaration

    • Optionalbottom?: number

      Bottom margin.

    • Optionalleft?: number

      Left margin.

    • Optionalright?: number

      Right margin.

    • Optionaltop?: number

      Top margin.

    pages?: number[]

    Page numbers (1-based) to apply to; all pages by default.

    texts: Partial<
        Record<
            HeaderFooterPosition,
            | string
            | { color?: string; fontName?: string; fontSize?: number; text: string },
        >,
    >

    Text at each position: a string, or an object with the text and its font name, size and color ('#rrggbb').