ImageTk Module

The ImageTk module contains support to create and modify TkinterBitmapImage and PhotoImage objects from PIL images.

For examples, see the demo programs in the Scripts directory.

  • class PIL.ImageTk.BitmapImage(image=None, **kw)[source]
  • A Tkinter-compatible bitmap image. This can be used everywhere Tkinterexpects an image object.

The given image must have mode “1”. Pixels having value 0 are treated astransparent. Options, if any, are passed on to Tkinter. The most commonlyused option is foreground, which is used to specify the color for thenon-transparent parts. See the Tkinter documentation for information onhow to specify colours.

Parameters:image – A PIL image.

  • height()[source]
  • Get the height of the image.

Returns:The height, in pixels.

  • width()[source]
  • Get the width of the image.

Returns:The width, in pixels.

  • class PIL.ImageTk.PhotoImage(image=None, size=None, **kw)[source]
  • A Tkinter-compatible photo image. This can be usedeverywhere Tkinter expects an image object. If the image is an RGBAimage, pixels having alpha 0 are treated as transparent.

The constructor takes either a PIL image, or a mode and a size.Alternatively, you can use the file or data options to initializethe photo image object.

Parameters:

  • image – Either a PIL image, or a mode string. If a mode string isused, a size must also be given.
  • size – If the first argument is a mode string, this defines the sizeof the image.
  • file – A filename to load the image from (usingImage.open(file)).
  • data – An 8-bit string containing image data (as loaded from animage file).
  • height()[source]
  • Get the height of the image.

Returns:The height, in pixels.

  • paste(im, box=None)[source]
  • Paste a PIL image into the photo image. Note that this canbe very slow if the photo image is displayed.

Parameters:

  1. - **im** A PIL image. The size must match the target region. If themode does not match, the image is converted to the mode ofthe bitmap image.
  2. - **box** A 4-tuple defining the left, upper, right, and lower pixelcoordinate. See [Coordinate System]($db9e32d428fb149e.md#coordinate-system). If None is giveninstead of a tuple, all of the image is assumed.
  • width()[source]
  • Get the width of the image.

Returns:The width, in pixels.