ComPDFKit Web SDK
    Preparing search index...

    Interface SortOptions

    Context passed to the functions of a notes panel sort strategy.

    interface SortOptions {
        documentViewerKey: number;
        getDisplayAuthor?: (author: string) => string;
        pageLabels: readonly string[];
        t(key: string): string;
    }
    Index
    • Translates a key into the current UI language.

      Parameters

      • key: string

        Translation key.

      Returns string

      The translated text.

    documentViewerKey: number

    Key of the document viewer whose notes are listed (1 for the main viewer).

    getDisplayAuthor?: (author: string) => string

    Returns the name shown for an annotation author.

    Type Declaration

      • (author: string): string
      • Parameters

        • author: string

          The author stored on the annotation.

        Returns string

        The display name.

    pageLabels: readonly string[]

    Page labels of the document, indexed by page number minus one.