| Function signature[source] | |
|---|---|
st.metric(label, value, delta=None, delta_color="normal", help=None, label_visibility="visible") | |
| Parameters | |
label (str) | The header or title for the metric. The label can optionally contain GitHub-flavored Markdown of the following types: Bold, Italics, Strikethroughs, Inline Code, and Links. Unsupported Markdown elements are unwrapped so only their children (text contents) render. Display unsupported elements as literal characters by backslash-escaping them. E.g., "1\. Not an ordered list". See the body parameter of st.markdown for additional, supported Markdown directives. |
value (int, float, str, or None) | Value of the metric. None is rendered as a long dash. |
delta (int, float, str, or None) | Indicator of how the metric changed, rendered with an arrow below the metric. If delta is negative (int/float) or starts with a minus sign (str), the arrow points down and the text is red; else the arrow points up and the text is green. If None (default), no delta indicator is shown. |
delta_color ("normal", "inverse", or "off") | If "normal" (default), the delta indicator is shown as described above. If "inverse", it is red when positive and green when negative. This is useful when a negative change is considered good, e.g. if cost decreased. If "off", delta is shown in gray regardless of its value. |
help (str) | An optional tooltip that gets displayed next to the metric label. |
label_visibility ("visible", "hidden", or "collapsed") | The visibility of the label. If "hidden", the label doesn't show but there is still empty space for it (equivalent to label=""). If "collapsed", both the label and the space are removed. Default is "visible". |
Example
import streamlit as st st.metric(label="Temperature", value="70 °F", delta="1.2 °F")st.metric looks especially nice in combination with st.columns:
import streamlit as st col1, col2, col3 = st.columns(3) col1.metric("Temperature", "70 °F", "1.2 °F") col2.metric("Wind", "9 mph", "-8%") col3.metric("Humidity", "86%", "4%")The delta indicator color can also be inverted or turned off:
import streamlit as st st.metric(label="Gas price", value=4, delta=-0.5, delta_color="inverse") st.metric( label="Active developers", value=123, delta=123, delta_color="off" )
Still have questions?
Our forums are full of helpful information and Streamlit experts.