Method insert_image

xlsxwriter/worksheet.py:1557–1592

Insert an image with its top-left corner in a worksheet cell. Args: row: The cell row (zero indexed). col: The cell column (zero indexed). source: Filename, BytesIO, or Image object. options: Position, scale, url and data

(
        self,
        row: int,
        col: int,
        source: Union[str, BytesIO, Image],
        options: Optional[Dict[str, Any]] = None,
    )

    @convert_cell_args
    def insert_image(
        self,
        row: int,
        col: int,
        source: Union[str, BytesIO, Image],
        options: Optional[Dict[str, Any]] = None,
    ) -> Literal[0, -1]:
        """
        Insert an image with its top-left corner in a worksheet cell.

        Args:
            row:      The cell row (zero indexed).
            col:      The cell column (zero indexed).
            source:   Filename, BytesIO, or Image object.
            options:  Position, scale, url and data stream of the image.

        Returns:
            0:  Success.
            -1: Row or column is out of worksheet bounds.

        """
        # Check insert (row, col) without storing.
        if self._check_dimensions(row, col, True, True):
            warn(f"Cannot insert image at ({row}, {col}).")
            return -1

        # Convert the source to an Image object.
        image = self._image_from_source(source, options)

        image._row = row
        image._col = col
        image._set_user_options(options)

        self.images.append(image)

        return 0

    @convert_cell_args
    def embed_image(