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

    Interface CollectionConfig

    Configuration for a PDF portfolio / embedded-file collection — what GigaPdfDoc.setCollection writes into the catalog /Collection (ISO 32000-1 §7.11.6, §12.3.5). Marks the document as a portfolio and configures its presentation.

    interface CollectionConfig {
        view?: CollectionView;
        schema?: CollectionField[];
        sort?: { field: string; ascending?: boolean } | null;
        defaultFile?: string | null;
        items?: CollectionItem[];
    }
    Index

    Properties

    view? schema? sort? defaultFile? items?

    Properties

    view?: CollectionView

    /View — the initial navigator. Defaults to "details".

    schema?: CollectionField[]

    /Schema — the columns, in declaration order. May be empty/omitted.

    sort?: { field: string; ascending?: boolean } | null

    /Sort — the column to sort on and direction. Omit/null to leave unset.

    defaultFile?: string | null

    /D — the embedded-file name initially selected. Omit/null to leave unset.

    items?: CollectionItem[]

    Per-file /CI metadata populating the schema columns.

    Settings

    Member Visibility

    On This Page

    Properties