pdfextract API
    Preparing search index...

    Interface ImageOccurrence

    One placement of an embedded appearance; repeated uses remain distinct even when their asset is shared.

    interface ImageOccurrence {
        bbox: Box;
        clipped: boolean;
        imageToPage: AffineTransform;
        occurrenceId: string;
        originalOrientation: ImageOrientation;
        overlaid: boolean;
        pageNumber: number;
    }
    Index
    bbox: Box

    Unclipped placement bounds in canonical page points.

    clipped: boolean

    Whether a clip cuts this placement. False when every clip in effect is an axis-aligned rectangle (including Form XObject bounds) containing the whole image, such as a page-wide clip; true for clips that cut into it and, conservatively, for non-rectangular, rotated and text clips. Standalone export still preserves the whole source image.

    imageToPage: AffineTransform

    Maps top-left source raster pixel edges into canonical page coordinates.

    occurrenceId: string

    Distinct document-scoped placement identifier.

    originalOrientation: ImageOrientation

    Orientation of the stored raster relative to this placement; exports correct it by default.

    overlaid: boolean

    Whether the page draws something visible above this placement within its area: text, vector graphics or another image, within the clip area (annotations too with the annotations option of getImages or the document). Text extents are estimated, so this errs towards true; invisible text such as an OCR layer does not count.

    pageNumber: number

    One-based page containing this placement.