Module fpdf.image_datastructures

Classes

class ImageCache (images: Dict[str, dict] = <factory>, icc_profiles: Dict[bytes, int] = <factory>, image_filter: str = 'AUTO')

ImageCache(images: Dict[str, dict] = , icc_profiles: Dict[bytes, int] = , image_filter: str = 'AUTO')

Expand source code Browse git

@dataclass
class ImageCache:
    # Map image identifiers to dicts describing the raster images
    images: Dict[str, dict] = field(default_factory=dict)
    # Map icc profiles (bytes) to their index (number)
    icc_profiles: Dict[bytes, int] = field(default_factory=dict)
    # Must be one of SUPPORTED_IMAGE_FILTERS values
    image_filter: str = "AUTO"

    def reset_usages(self):
        for img in self.images.values():
            img["usages"] = 0

Class variables

var icc_profiles : Dict[bytes, int]

var image_filter : str

var images : Dict[str, dict]

Methods

def reset_usages(self)

Expand source code Browse git

def reset_usages(self):
    for img in self.images.values():
        img["usages"] = 0

class ImageInfo (*args, **kwargs)

Information about an image used in the PDF document (base class). We subclass this to distinguish between raster and vector images.

Expand source code Browse git

class ImageInfo(dict):
    """Information about an image used in the PDF document (base class).
    We subclass this to distinguish between raster and vector images."""

    @property
    def width(self):
        "Intrinsic image width"
        return self["w"]

    @property
    def height(self):
        "Intrinsic image height"
        return self["h"]

    @property
    def rendered_width(self):
        "Only available if the image has been placed on the document"
        return self["rendered_width"]

    @property
    def rendered_height(self):
        "Only available if the image has been placed on the document"
        return self["rendered_height"]

    def __str__(self):
        d = {k: ("..." if k in ("data", "smask") else v) for k, v in self.items()}
        return f"self.__class__.__name__({d})"

    def scale_inside_box(self, x, y, w, h):
        """
        Make an image fit within a bounding box, maintaining its proportions.
        In the reduced dimension it will be centered within the available space.
        """
        ratio = self.width / self.height
        if h * ratio < w:
            new_w = h * ratio
            new_h = h
            x += (w - new_w) / 2
        else:  # => too wide, limiting width:
            new_h = w / ratio
            new_w = w
            y += (h - new_h) / 2
        return x, y, new_w, new_h

    @staticmethod
    def x_by_align(x, w, pdf, keep_aspect_ratio):
        if keep_aspect_ratio:
            raise ValueError(
                "FPDF.image(): 'keep_aspect_ratio' cannot be used with an enum value provided to `x`"
            )
        x = Align.coerce(x)
        if x == Align.C:
            return (pdf.w - w) / 2
        if x == Align.R:
            return pdf.w - w - pdf.r_margin
        if x == Align.L:
            return pdf.l_margin
        raise ValueError(f"Unsupported 'x' value passed to .image(): {x}")

Ancestors

• builtins.dict

Subclasses

• RasterImageInfo
• VectorImageInfo

Static methods

def x_by_align(x, w, pdf, keep_aspect_ratio)

Expand source code Browse git

@staticmethod
def x_by_align(x, w, pdf, keep_aspect_ratio):
    if keep_aspect_ratio:
        raise ValueError(
            "FPDF.image(): 'keep_aspect_ratio' cannot be used with an enum value provided to `x`"
        )
    x = Align.coerce(x)
    if x == Align.C:
        return (pdf.w - w) / 2
    if x == Align.R:
        return pdf.w - w - pdf.r_margin
    if x == Align.L:
        return pdf.l_margin
    raise ValueError(f"Unsupported 'x' value passed to .image(): {x}")

Instance variables

var height

Intrinsic image height

Expand source code Browse git

@property
def height(self):
    "Intrinsic image height"
    return self["h"]

var rendered_height

Only available if the image has been placed on the document

Expand source code Browse git

@property
def rendered_height(self):
    "Only available if the image has been placed on the document"
    return self["rendered_height"]

var rendered_width

Only available if the image has been placed on the document

Expand source code Browse git

@property
def rendered_width(self):
    "Only available if the image has been placed on the document"
    return self["rendered_width"]

var width

Intrinsic image width

Expand source code Browse git

@property
def width(self):
    "Intrinsic image width"
    return self["w"]

Methods

def scale_inside_box(self, x, y, w, h)

Make an image fit within a bounding box, maintaining its proportions. In the reduced dimension it will be centered within the available space.

Expand source code Browse git

def scale_inside_box(self, x, y, w, h):
    """
    Make an image fit within a bounding box, maintaining its proportions.
    In the reduced dimension it will be centered within the available space.
    """
    ratio = self.width / self.height
    if h * ratio < w:
        new_w = h * ratio
        new_h = h
        x += (w - new_w) / 2
    else:  # => too wide, limiting width:
        new_h = w / ratio
        new_w = w
        y += (h - new_h) / 2
    return x, y, new_w, new_h

class RasterImageInfo (*args, **kwargs)

Information about a raster image used in the PDF document

Expand source code Browse git

class RasterImageInfo(ImageInfo):
    "Information about a raster image used in the PDF document"

    def size_in_document_units(self, w, h, scale=1):
        if w == 0 and h == 0:  # Put image at 72 dpi
            w = self["w"] / scale
            h = self["h"] / scale
        elif w == 0:
            w = h * self["w"] / self["h"]
        elif h == 0:
            h = w * self["h"] / self["w"]
        return w, h

Ancestors

• ImageInfo
• builtins.dict

Methods

def size_in_document_units(self, w, h, scale=1)

Expand source code Browse git

def size_in_document_units(self, w, h, scale=1):
    if w == 0 and h == 0:  # Put image at 72 dpi
        w = self["w"] / scale
        h = self["h"] / scale
    elif w == 0:
        w = h * self["w"] / self["h"]
    elif h == 0:
        h = w * self["h"] / self["w"]
    return w, h

Inherited members

• ImageInfo:
  • height
  • rendered_height
  • rendered_width
  • scale_inside_box
  • width

class VectorImageInfo (*args, **kwargs)

Information about a vector image used in the PDF document

Expand source code Browse git

class VectorImageInfo(ImageInfo):
    "Information about a vector image used in the PDF document"
    # pass

Ancestors

• ImageInfo
• builtins.dict

Inherited members

• ImageInfo:
  • height
  • rendered_height
  • rendered_width
  • scale_inside_box
  • width