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

    Interface RunningHeaderFooter

    A rich, Word-like running header/footer definition (see GigaPdfDoc.setRunningHeaderFooter). The definition is the source of truth (stored in the editor-meta sidecar); the bake regenerates the visible /GPHF band from it.

    Zone selection per 1-based page: page 1 → firstPage when differentFirstPage (else default); otherwise, when differentOddEven, even pages → evenPage and odd pages → oddPage (each falling back to default when omitted); otherwise default everywhere.

    interface RunningHeaderFooter {
        default: HFZone;
        firstPage?: HFZone | null;
        evenPage?: HFZone | null;
        oddPage?: HFZone | null;
        differentFirstPage?: boolean;
        differentOddEven?: boolean;
        headerBand?: number;
        footerBand?: number;
    }
    Index

    Properties

    default firstPage? evenPage? oddPage? differentFirstPage? differentOddEven? headerBand? footerBand?

    Properties

    default: HFZone

    The zone every page not overridden by a more specific zone uses.

    firstPage?: HFZone | null

    First-page override (used when differentFirstPage).

    evenPage?: HFZone | null

    Even-page override (used when differentOddEven).

    oddPage?: HFZone | null

    Odd-page override (used when differentOddEven).

    differentFirstPage?: boolean

    Give page 1 its own firstPage zone (default false).

    differentOddEven?: boolean

    Give even/odd pages their own evenPage/oddPage zones (default false).

    headerBand?: number

    Header band height (distance from the top edge to the baseline), points (default 36).

    footerBand?: number

    Footer band height (distance from the bottom edge to the baseline), points (default 36).

    Settings

    Member Visibility

    On This Page

    Properties