ComPDFKit Web SDK
    Preparing search index...

    Interface CustomHeaderOptions

    Options of UI.NotesPanel.setCustomHeader.

    interface CustomHeaderOptions {
        overwriteDefaultHeader?: boolean;
        render(notes: unknown[]): HTMLElement;
    }
    Index
    • Builds the custom header.

      Parameters

      • notes: unknown[]

        The annotations listed in the panel (after filtering).

      Returns HTMLElement

      The element to show.

    overwriteDefaultHeader?: boolean

    When true, the element replaces the panel's title bar; otherwise it is placed before the title bar.