PDF Web SDK Documentation

Comprehensive Guide for Developers: UI & SDK Integration, Configuration, and API Reference

PDF Web SDK
    Preparing search index...

    Interface IStructuredContentOptions

    Options of a structured content export.

    interface IStructuredContentOptions {
        include?: readonly PdfContentKind[];
        onProgress?: (completedPages: number, totalPages: number) => void;
        pages?: readonly number[];
        signal?: AbortSignal;
    }

    Hierarchy (View Summary)

    Index

    Properties

    include? onProgress? pages? signal?

    Properties

    include?: readonly PdfContentKind[]

    Content kinds to include; DEFAULT_CONTENT_KINDS when omitted. Unknown kinds are ignored; a list with no known kind throws RangeError.

    onProgress?: (completedPages: number, totalPages: number) => void

    Called after each processed page.

    pages?: readonly number[]

    0-based page indexes; all pages when omitted. An empty list or an invalid index throws RangeError.

    signal?: AbortSignal

    Checked before each page; once aborted, the call rejects with signal.reason (an AbortError DOMException by default).

    Settings

    Member Visibility

    On This Page

    Properties