pdfextract API
    Preparing search index...

    Interface GetImagesOptions

    Inventory selection. Images are enumerated without retaining all decoded rasters.

    interface GetImagesOptions {
        annotations?: boolean;
        minHeight?: number;
        minWidth?: number;
        onProgress?: (event: ProgressEvent) => void;
        pages?: readonly number[];
        signal?: AbortSignal;
    }

    Hierarchy (View Summary)

    Index
    annotations?: boolean

    Count annotation appearances in ImageOccurrence.overlaid, as extractImage does with its annotations option. Defaults to the document's annotations option (false).

    minHeight?: number

    Positive minimum height in pixels, measured like minWidth. Omitted means no height filter.

    minWidth?: number

    Positive minimum width in pixels; smaller images are left out and counted in ImageList.ignoredCount. Measured as exported by default, so quarter-turn placements count with width and height swapped. Omitted means no width filter.

    onProgress?: (event: ProgressEvent) => void

    Called during work. Keep callbacks lightweight and avoid throwing.

    pages?: readonly number[]

    One-based pages whose image occurrences are included; omitted means all pages.

    signal?: AbortSignal

    Aborts queued work promptly; a synchronous engine decode already running may finish before cleanup.