st_pyplot.py

# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2024)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import textwrap

import matplotlib.pyplot as plt
import numpy as np
import seaborn as sns
from matplotlib import pyplot

import streamlit as st

np.random.seed(0)


st.write("Normal figure:")
data = np.random.normal(1, 1, size=100)
fig, ax = plt.subplots()
ax.hist(data, bins=20)
st.pyplot(fig)

st.write("Resized figure:")
# Resize plot. It is now 4 times smaller than the default value.
fig.set_size_inches(6.4 / 4, 4.8 / 4)
st.pyplot(fig)

st.write("Resized figure with `use_container_width=True`:")
st.pyplot(fig, use_container_width=True)

st.write("Resized figure with `use_container_width=False`:")
st.pyplot(fig, use_container_width=False)

st.write("Advanced Seaborn figure:")
# Generate data
data_points = 100
xData: "np.typing.NDArray[np.float64]" = (np.random.randn(data_points, 1) * 30) + 30
yData: "np.typing.NDArray[np.float64]" = np.random.randn(data_points, 1) * 30
data: "np.typing.NDArray[np.float64]" = np.random.randn(data_points, 2)

# Generate plot
fig, ax = plt.subplots(figsize=(4.5, 4.5))
sns.set_context(rc={"font.size": 10})
p = sns.regplot(x=xData, y=yData, data=data, ci=None, ax=ax, color="grey")

p.set_title("An Extremely and Really Really Long Long Long Title", fontweight="bold")
p.set_xlabel("Very long long x label")
p.set_ylabel("Very long long y label")

p.set_ylim(-30, 30)
plot_text = textwrap.dedent(
    """
    some_var_1 = 'Some label 1'
    some_var_2 = 'Some label 2'
"""
)

txt = ax.text(0.90, 0.10, plot_text, transform=ax.transAxes)
sns.despine()

st.pyplot(fig)

st.write("Advanced Seaborn figure using kwargs (low dpi):")

kwargs = {
    "dpi": 50,  # We use a low dpi to show a stark difference to the figure above.
    "bbox_extra_artists": (txt,),
    "bbox_inches": "tight",
    "format": "png",  # Required for some Matplotlib backends.
}

# We need to set clear_figure=True, otherwise the global object
# test below would not work.
st.pyplot(fig, clear_figure=True, **kwargs)

st.write("Figure using deprecated global object:")
plot = pyplot.plot(data)
st.pyplot()
pyplot.clf()

fig, ax = plt.subplots()
st.pyplot(fig)