@qrcommunication/gigapdf-lib — SDK API reference - v0.110.3
    Preparing search index...

    Interface HeaderFooterSpec

    A running header/footer to bake onto an existing PDF (see GigaPdfDoc.setHeader / GigaPdfDoc.setFooter). text may contain the tokens {{page}} (1-based page number) and {{pages}} (total page count), substituted per page. Text is drawn in standard Helvetica inside the top (header) / bottom (footer) margin band.

    interface HeaderFooterSpec {
        text: string;
        align?: HeaderFooterAlign;
        fontSize?: number;
        color?: [number, number, number];
        pageRange?: [number, number] | null;
        showOnFirstPage?: boolean;
        bandHeight?: number;
    }
    Index

    Properties

    text align? fontSize? color? pageRange? showOnFirstPage? bandHeight?

    Properties

    text

    text: string

    Template text, with {{page}} / {{pages}} tokens.

    align?: HeaderFooterAlign

    Horizontal alignment (default "left").

    fontSize?: number

    Font size in points (default 10).

    color?: [number, number, number]

    RGB fill colour, 0..1 per channel (default black [0,0,0]).

    pageRange?: [number, number] | null

    Inclusive 1-based page range [first, last]; omit for every page.

    showOnFirstPage?: boolean

    Draw on the first page of the range too (default true).

    bandHeight?: number

    Band height from the page edge, in points (default 36).

    Settings

    Member Visibility

    On This Page

    Properties