Image

Image Element - show an image in the window. Should be a GIF or a PNG only

Image(
    source = None,
    filename = None,
    data = None,
    background_color = None,
    size = (None, None),
    s = (None, None),
    pad = None,
    p = None,
    key = None,
    k = None,
    tooltip = None,
    subsample = None,
    zoom = None,
    right_click_menu = None,
    expand_x = False,
    expand_y = False,
    visible = True,
    enable_events = False,
    metadata = None
)

Parameter Descriptions

Name	Type	Default	Description
background_color		None	color of background
data	bytes or str or None	None	Raw or Base64 representation of the image to put on button. Choose either filename or data
enable_events	bool	False	Turns on the element specific events. For an Image element, the event is "image clicked"
expand_x	bool	False	If True the element will automatically expand in the X direction to fill available space
expand_y	bool	False	If True the element will automatically expand in the Y direction to fill available space
filename	str or None	None	image filename if there is a button image. GIFs and PNGs only.
k	str or int or tuple or object	None	Same as the Key. You can use either k or key. Which ever is set will be used.
key	str or int or tuple or object	None	Used with window.find_element and with return values to uniquely identify this element to uniquely identify this element
metadata	Any	None	User metadata that can be set to ANYTHING
p	(int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) or int	None	Same as pad parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, pad will be used
pad	(int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) or int	None	Amount of padding to put around element in pixels (left/right, top/bottom) or ((left, right), (top, bottom)) or an int. If an int, then it's converted into a tuple (int, int)
right_click_menu	List[List[ List[str] or str ]]	None	A list of lists of Menu items to show when this element is right clicked. See user docs for exact format.
s	(int, int) or (None, None) or int	(None, None)	Same as size parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, size will be used
size	(int, int)	(None, None)	(width, height) size of image in pixels
source	str or bytes or None	None	A filename or a base64 bytes. Will automatically detect the type and fill in filename or data for you.
subsample	int	None	amount to reduce the size of the image. Divides the size by this number. 2=1/2, 3=1/3, 4=1/4, etc
tooltip	str	None	text, that will appear when mouse hovers over the element
visible	bool	True	set visibility state of the element
zoom	int	None	amount to increase the size of the image.

Class Properties

key
metadata
visible
widget

key

Returns key for the element. This is a READONLY property. Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists)

key

Parameter Descriptions

Name	Type	Default	Description
RETURN	Any		The window's Key

metadata

Metadata is an Element property that you can use at any time to hold any value

metadata

Parameter Descriptions

Name	Type	Default	Description
RETURN	Any		the current metadata value

visible

Returns visibility state for the element. This is a READONLY property

visible

Parameter Descriptions

Name	Type	Default	Description
RETURN	bool		Visibility state for element

Returns tkinter widget for the element. This is a READONLY property. The implementation is that the Widget member variable is returned. This is a backward compatible addition

widget

Parameter Descriptions

Name	Type	Default	Description
RETURN	(tkinter.Widget)		The element's underlying tkinter widget

Class Methods

def bind
def block_focus
def expand
def get_next_focus
def get_previous_focus
def get_size
def grab_anywhere_exclude
def grab_anywhere_include
def hide_row
def remove_tooltip
def save_element_screenshot_to_disk
def set_cursor
def set_focus
def set_right_click_menu
def set_size
def set_tooltip
def set_vscroll_position
def unbind
def unhide_row
def update
def update_animation
def update_animation_no_buffering

bind

Used to add tkinter events to an Element. The tkinter specific data is in the Element's member variable user_bind_event

bind(
    bind_string,
    key_modifier,
    propagate = True
)

Parameter Descriptions

Name	Type	Default	Description
bind_string	str		The string tkinter expected in its bind function
key_modifier	str		Additional data to be added to the element's key when event is returned
propagate	bool	True	If True then tkinter will be told to propagate the event to the element

block_focus

Enable or disable the element from getting focus by using the keyboard. If the block parameter is True, then this element will not be given focus by using the keyboard to go from one element to another. You CAN click on the element and utilize it.

block_focus(
    block = True
)

Parameter Descriptions

Name	Type	Default	Description
block	bool	True	if True the element will not get focus via the keyboard

expand

Causes the Element to expand to fill available space in the X and Y directions. Can specify which or both directions

expand(
    expand_x = False,
    expand_y = False,
    expand_row = True
)

Parameter Descriptions

Name	Type	Default	Description
expand_row	bool	True	If True the row containing the element will also expand. Without this your element is "trapped" within the row
expand_x	bool	False	If True Element will expand in the Horizontal directions
expand_y	bool	False	If True Element will expand in the Vertical directions

get_next_focus

Gets the next element that should get focus after this element.

get_next_focus()

Parameter Descriptions

Name	Type	Default	Description
RETURN	Element		Element that will get focus after this one

get_previous_focus

Gets the element that should get focus previous to this element.

get_previous_focus()

Parameter Descriptions

Name	Type	Default	Description
RETURN	Element		Element that should get the focus before this one

get_size

Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method.

get_size()

Parameter Descriptions

Name	Type	Default	Description
RETURN	(int, int)		width and height of the element

grab_anywhere_exclude

Excludes this element from being used by the grab_anywhere feature Handy for elements like a Graph element when dragging is enabled. You want the Graph element to get the drag events instead of the window dragging.

grab_anywhere_exclude()

grab_anywhere_include

Includes this element in the grab_anywhere feature This will allow you to make a Multline element drag a window for example

grab_anywhere_include()

hide_row

Hide the entire row an Element is located on. Use this if you must have all space removed when you are hiding an element, including the row container

hide_row()

Removes a previiously created tooltip for an element

remove_tooltip()

save_element_screenshot_to_disk

Saves an image of the PySimpleGUI window provided into the filename provided

save_element_screenshot_to_disk(
    filename = None
)

Parameter Descriptions

Name	Type	Default	Description
RETURN	(PIL.ImageGrab or None)		A PIL ImageGrab object that can be saved or manipulated

set_cursor

Sets the cursor for the current Element. "Cursor" is used in 2 different ways in this call. For the parameter "cursor" it's actually the mouse pointer. If you do not want any mouse pointer, then use the string "none" For the parameter "cursor_color" it's the color of the beam used when typing into an input element

set_cursor(
    cursor = None,
    cursor_color = None
)

Parameter Descriptions

Name	Type	Default	Description
cursor	str	None	The tkinter cursor name
cursor_color	str	None	color to set the "cursor" to

set_focus

Sets the current focus to be on this element

set_focus(
    force = False
)

Parameter Descriptions

Name	Type	Default	Description
force	bool	False	if True will call focus_force otherwise calls focus_set

set_right_click_menu

Sets a right click menu for an element. If a menu is already set for the element, it will call the tkinter destroy method to remove it

set_right_click_menu(
    menu = None
)

Parameter Descriptions

Name	Type	Default	Description
menu	List[List[ List[str] or str ]]	None	A list of lists of Menu items to show when this element is right clicked. See user docs for exact format.

set_size

Changes the size of an element to a specific size. It's possible to specify None for one of sizes so that only 1 of the element's dimensions are changed.

set_size(
    size = (None, None)
)

Parameter Descriptions

Name	Type	Default	Description
size	(int, int)	(None, None)	The size in characters, rows typically. In some cases they are pixels

Called by application to change the tooltip text for an Element. Normally invoked using the Element Object such as: window.Element('key').SetToolTip('New tip').

set_tooltip(
    tooltip_text
)

Parameter Descriptions

Name	Type	Default	Description
tooltip_text	str or None		the text to show in tooltip. If None then no tip will be shown

set_vscroll_position

Attempts to set the vertical scroll postition for an element's Widget

set_vscroll_position(
    percent_from_top
)

Parameter Descriptions

Name	Type	Default	Description
percent_from_top	float		From 0 to 1.0, the percentage from the top to move scrollbar to

unbind

Removes a previously bound tkinter event from an Element.

unbind(
    bind_string
)

Parameter Descriptions

Name	Type	Default	Description
bind_string	str		The string tkinter expected in its bind function

unhide_row

Unhides (makes visible again) the row container that the Element is located on. Note that it will re-appear at the bottom of the window / container, most likely.

unhide_row()

update

Changes some of the settings for the Image Element. Must call Window.Read or Window.Finalize prior. To clear an image that's been displayed, call with NONE of the options set. A blank update call will delete the previously shown image.

Changes will not be visible in your window until you call window.read or window.refresh.

If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper" function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there when made visible.

update(
    source = None,
    filename = None,
    data = None,
    size = (None, None),
    subsample = None,
    zoom = None,
    visible = None
)

Parameter Descriptions

Name	Type	Default	Description
data	str or tkPhotoImage	None	Base64 encoded string OR a tk.PhotoImage object
filename	str	None	filename to the new image to display.
size	Tuple[int,int]	(None, None)	(width, height) size of image in pixels
source	str or bytes or None	None	A filename or a base64 bytes. Will automatically detect the type and fill in filename or data for you.
subsample	int	None	amount to reduce the size of the image. Divides the size by this number. 2=1/2, 3=1/3, 4=1/4, etc
visible	bool	None	control visibility of element
zoom	int	None	amount to increase the size of the image

update_animation

Show an Animated GIF. Call the function as often as you like. The function will determine when to show the next frame and will automatically advance to the next frame at the right time. NOTE - does NOT perform a sleep call to delay

update_animation(
    source,
    time_between_frames = 0
)

Parameter Descriptions

Name	Type	Default	Description
source	str or bytes or None		Filename or Base64 encoded string containing Animated GIF
time_between_frames	int	0	Number of milliseconds to wait between showing frames
RETURN	True or False or None		True if worked OK, False if out of frames, None is window was closed

update_animation_no_buffering

Show an Animated GIF. Call the function as often as you like. The function will determine when to show the next frame and will automatically advance to the next frame at the right time. NOTE - does NOT perform a sleep call to delay

update_animation_no_buffering(
    source,
    time_between_frames = 0
)

Parameter Descriptions

Name	Type	Default	Description
source	str or bytes		Filename or Base64 encoded string containing Animated GIF
time_between_frames	int	0	Number of milliseconds to wait between showing frames
RETURN	True or False or None		True if worked OK, False if out of frames, None is window was closed