Module PIL.ImageTk

Module Summary:

class BitmapImage:
    def __init__(self, image=None, **options)
Create a Tkinter-compatible bitmap image.
class PhotoImage:
    def __init__(self, image=None, size=None, **options)
Creates a Tkinter-compatible photo image.

Classes

The BitmapImage Class

BitmapImage()

Create a Tkinter-compatible bitmap image. This can be used everywhere Tkinter expects an image object.

Constructor:

BitmapImage(image=None, **options)

Create a Tkinter-compatible bitmap image.

The given image must have mode "1". Pixels having value 0 are treated as transparent. Options, if any, are passed on to Tkinter. The most commonly used option is foreground, which is used to specify the colour for the non-transparent parts. See the Tkinter documentation for information on how to specify colours.

Parameters:

image -- A PIL image.

Method Summary:

__str__()
Get the Tkinter bitmap image identifier.
height()
Get the height of the image.
width()
Get the width of the image.

__str__

__str__()

Get the Tkinter bitmap image identifier. This method is automatically called by Tkinter whenever a BitmapImage object is passed to a Tkinter method.

Returns:

A Tkinter bitmap image identifier (a string).

height

height()

Get the height of the image.

Returns:

The height, in pixels.

width

width()

Get the width of the image.

Returns:

The width, in pixels.

The PhotoImage Class

PhotoImage()

Creates a Tkinter-compatible photo image. This can be used everywhere Tkinter expects an image object. If the image is an RGBA image, pixels having alpha 0 are treated as transparent.

Constructor:

PhotoImage(image=None, size=None, **options)

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

Parameters:

image -- Either a PIL image, or a mode string. If a mode string is used, a size must also be given.

size -- If the first argument is a mode string, this defines the size of the image.

Keyword Parameters:

file -- A filename to load the image from (using Image.open(file)).

data -- An 8-bit string containing image data (as loaded from an image file).

Method Summary:

__str__()
Get the Tkinter photo image identifier.
height()
Get the height of the image.
paste(im, box=None)
Paste a PIL image into the photo image.
width()
Get the width of the image.

__str__

__str__()

Get the Tkinter photo image identifier. This method is automatically called by Tkinter whenever a PhotoImage object is passed to a Tkinter method.

Returns:

A Tkinter photo image identifier (a string).

height

height()

Get the height of the image.

Returns:

The height, in pixels.

paste

paste(im, box=None)

Paste a PIL image into the photo image. Note that this can be very slow if the photo image is displayed.

Parameters:

im -- A PIL image. The size must match the target region. If the mode does not match, the image is converted to the mode of the bitmap image.

box -- A 4-tuple defining the left, upper, right, and lower pixel coordinate. If None is given instead of a tuple, all of the image is assumed.

width

width()

Get the width of the image.

Returns:

The width, in pixels.