Function signature[source] | |
---|---|
st.image(image, caption=None, width=None, use_column_width=None, clamp=False, channels="RGB", output_format="auto", *, use_container_width=False) | |
Parameters | |
image (numpy.ndarray, BytesIO, str, Path, or list of these) | The image to display. This can be one of the following:
|
caption (str or list of str) | Image caption(s). If this is None (default), no caption is displayed. If image is a list of multiple images, caption must be a list of captions (one caption for each image) or None. |
width (int or None) | Image width. If this is None (default), Streamlit will use the image's native width, up to the width of the parent container. When using an SVG image without a default width, you should declare width or use use_container_width=True. |
use_column_width ("auto", "always", "never", or bool) |
delete
use_column_width is deprecated and will be removed in a future release. Please use the use_container_width parameter instead. If "auto", set the image's width to its natural size, but do not exceed the width of the column. If "always" or True, set the image's width to the column width. If "never" or False, set the image's width to its natural size. Note: if set, use_column_width takes precedence over the width parameter. |
clamp (bool) | Whether to clamp image pixel values to a valid range (0-255 per channel). This is only used for byte array images; the parameter is ignored for image URLs and files. If this is False (default) and an image has an out-of-range value, a RuntimeError will be raised. |
channels ("RGB" or "BGR") | The color format when image is an nd.array. This is ignored for other image types. If this is "RGB" (default), image[:, :, 0] is the red channel, image[:, :, 1] is the green channel, and image[:, :, 2] is the blue channel. For images coming from libraries like OpenCV, you should set this to "BGR" instead. |
output_format ("JPEG", "PNG", or "auto") | The output format to use when transferring the image data. If this is "auto" (default), Streamlit identifies the compression type based on the type and format of the image. Photos should use the "JPEG" format for lossy compression while diagrams should use the "PNG" format for lossless compression. |
use_container_width (bool) | Whether to override width with the width of the parent container. If use_container_width is False (default), Streamlit sets the image's width according to width. If use_container_width is True, Streamlit sets the width of the image to match the width of the parent container. |
Example
import streamlit as st st.image("sunrise.jpg", caption="Sunrise by the mountains")
Still have questions?
Our forums are full of helpful information and Streamlit experts.