Class PhotoImage

Lib/tkinter/__init__.py:4404–4664

Widget which can display images in PGM, PPM, GIF, PNG format.

class PhotoImage(Image):
    """Widget which can display images in PGM, PPM, GIF, PNG format."""

    def __init__(self, name=None, cnf={}, master=None, **kw):
        """Create an image with NAME.

        Valid option names: data, format, file, gamma, height, palette,
        width."""
        Image.__init__(self, 'photo', name, cnf, master, **kw)

    def blank(self):
        """Display a transparent image."""
        self.tk.call(self.name, 'blank')

    def cget(self, option):
        """Return the value of OPTION."""
        return self.tk.call(self.name, 'cget', '-' + option)
    # XXX config

    def __getitem__(self, key):
        return self.tk.call(self.name, 'cget', '-' + key)

    def copy(self, *, from_coords=None, zoom=None, subsample=None):
        """Return a new PhotoImage with the same image as this widget.

        The FROM_COORDS option specifies a rectangular sub-region of the
        source image to be copied. It must be a tuple or a list of 1 to 4
        integers (x1, y1, x2, y2).  (x1, y1) and (x2, y2) specify diagonally
        opposite corners of the rectangle.  If x2 and y2 are not specified,
        the default value is the bottom-right corner of the source image.
        The pixels copied will include the left and top edges of the
        specified rectangle but not the bottom or right edges.  If the
        FROM_COORDS option is not given, the default is the whole source
        image.

        If SUBSAMPLE or ZOOM are specified, the image is transformed as in
        the subsample() or zoom() methods.  The value must be a single
        integer or a pair of integers.
        """
        destImage = PhotoImage(master=self.tk)
        destImage.copy_replace(self, from_coords=from_coords,
                               zoom=zoom, subsample=subsample)
        return destImage

    def zoom(self, x, y='', *, from_coords=None):
        """Return a new PhotoImage with the same image as this widget
        but zoom it with a factor of X in the X direction and Y in the Y
        direction.  If Y is not given, the default value is the same as X.

        The FROM_COORDS option specifies a rectangular sub-region of the
        source image to be copied, as in the copy() method.
        """
        if y=='': y=x
        return self.copy(zoom=(x, y), from_coords=from_coords)

    def subsample(self, x, y='', *, from_coords=None):
        """Return a new PhotoImage based on the same image as this widget
        but use only every Xth or Yth pixel.  If Y is not given, the