`image`¶

A control that can display an image.

Image format

Note that if the content is provided as a buffer of bytes, it can be converted to an image content if and only if you have installed the python-magic Python package (as well as python-magic-bin if your platform is Windows).

You can indicate a function to be called when the user clicks on the image.

Properties¶

Name	Type	Default	Description
`content`^(★)	dynamic(url \| path \| file \| ReadableBuffer)		The image source. If a buffer is provided (string, array of bytes...), and in order to prevent the bandwidth to be consumed too much, the way the image data is transferred depends on the the data_url_max_size parameter of the application configuration (which is set to 50kB by default): If the size of the buffer is smaller than this setting, then the raw content is generated as a data URL, encoded using base64 (i.e. `"data:<mimetype>;base64,<data>"`). If the size of the buffer is greater than this setting, then it is transferred through a temporary file.
`label`	dynamic(str)		The label for this image.
`on_action`	str		The name of a function that is triggered when the user clicks on the image. All the parameters of that function are optional: state (`State`): the state instance. id (optional[str]): the identifier of the button. action (optional[str]): the name of the action that provoked the change.
`width`	str\|int\|float	"300px"	The width, in CSS units, of this element.
`height`	str\|int\|float		The height, in CSS units, of this element.
`active`	dynamic(bool)	True	Indicates if this component is active. An inactive component allows no user interaction.
`id`	str		The identifier that will be assigned to the rendered HTML component.
`properties`	dict[str, Any]		Bound to a dictionary that contains additional properties for this element.
`class_name`	dynamic(str)		List of CSS class names that will be associated with the generated HTML Element. This class names will be added to the default `taipy-<element_type>`.
`hover_text`	dynamic(str)		Information that is displayed when the user hovers over this element.

^(★)content is the default property for this visual element.

Usage¶

Default behavior¶

Shows an image specified as a local file path or as raw content.

Page content

Markdown

<|{content}|image|>

HTML

<taipy:image>{content}</taipy:image>

Call a function on click¶

A specific label can be shown over the image. The function name provided as on_action is called when the image is clicked (same as button).