streamlit-nightly 1.36.1.dev20240626__py2.py3-none-any.whl → 1.36.1.dev20240627__py2.py3-none-any.whl

streamlit/elements/lib/built_in_chart_utils.py

@@ -45,7 +45,7 @@ if TYPE_CHECKING:
     import pandas as pd
 
     from streamlit.elements.arrow import Data
-    from streamlit.type_util import DataFrameCompatible
+    from streamlit.type_util import ChartStackType, DataFrameCompatible
 
 
 class PrepDataColumns(TypedDict):
@@ -123,6 +123,8 @@ def generate_chart(
     size_from_user: str | float | None = None,
     width: int | None = None,
     height: int | None = None,
+    # Bar charts only:
+    stack: bool | ChartStackType | None = None,
 ) -> tuple[alt.Chart, AddRowsMetadata]:
     """Function to use the chart's type, data columns and indices to figure out the chart's spec."""
     import altair as alt
@@ -166,21 +168,18 @@ def generate_chart(
 
     # At this point, x_column is only None if user did not provide one AND df is empty.
 
-    if chart_type == ChartType.HORIZONTAL_BAR:
-        # Handle horizontal bar chart - switches x and y data:
-        x_encoding = _get_x_encoding(
-            df, y_column, y_from_user, x_axis_label, chart_type
-        )
-        y_encoding = _get_y_encoding(
-            df, x_column, x_from_user, y_axis_label, chart_type
-        )
-    else:
-        x_encoding = _get_x_encoding(
-            df, x_column, x_from_user, x_axis_label, chart_type
-        )
-        y_encoding = _get_y_encoding(
-            df, y_column, y_from_user, y_axis_label, chart_type
-        )
+    # Get x and y encodings
+    x_encoding, y_encoding = _get_axis_encodings(
+        df,
+        chart_type,
+        x_column,
+        y_column,
+        x_from_user,
+        y_from_user,
+        x_axis_label,
+        y_axis_label,
+        stack,
+    )
 
     # Create a Chart with x and y encodings.
     chart = alt.Chart(
@@ -193,8 +192,21 @@ def generate_chart(
         y=y_encoding,
     )
 
+    # Offset encoding only works for Altair >= 5.0.0
+    is_altair_version_offset_compatible = not type_util.is_altair_version_less_than(
+        "5.0.0"
+    )
+    # Set up offset encoding (creates grouped/non-stacked bar charts, so only applicable when stack=False).
+    if (
+        is_altair_version_offset_compatible
+        and stack is False
+        and color_column is not None
+    ):
+        x_offset, y_offset = _get_offset_encoding(chart_type, color_column)
+        chart = chart.encode(xOffset=x_offset, yOffset=y_offset)
+
     # Set up opacity encoding.
-    opacity_enc = _get_opacity_encoding(chart_type, color_column)
+    opacity_enc = _get_opacity_encoding(chart_type, stack, color_column)
     if opacity_enc is not None:
         chart = chart.encode(opacity=opacity_enc)
 
@@ -484,7 +496,7 @@ def _maybe_convert_color_column_in_place(df: pd.DataFrame, color_column: str | N
         pass
     elif is_color_tuple_like(first_color_datum):
         # Tuples need to be converted to CSS-valid.
-        df[color_column] = df[color_column].map(to_css_color)
+        df.loc[:, color_column] = df[color_column].map(to_css_color)
     else:
         # Other kinds of colors columns (i.e. pure numbers or nominal strings) shouldn't
         # be converted since they are treated by Vega-Lite as sequential or categorical colors.
@@ -577,14 +589,38 @@ def _parse_y_columns(
     return y_column_list
 
 
+def _get_offset_encoding(
+    chart_type: ChartType,
+    color_column: str | None,
+) -> tuple[alt.XOffset, alt.YOffset]:
+    # Vega's Offset encoding channel is used to create grouped/non-stacked bar charts
+    import altair as alt
+
+    x_offset = alt.XOffset()
+    y_offset = alt.YOffset()
+
+    if chart_type is ChartType.VERTICAL_BAR:
+        x_offset = alt.XOffset(field=color_column)
+    elif chart_type is ChartType.HORIZONTAL_BAR:
+        y_offset = alt.YOffset(field=color_column)
+
+    return x_offset, y_offset
+
+
 def _get_opacity_encoding(
-    chart_type: ChartType, color_column: str | None
+    chart_type: ChartType,
+    stack: bool | ChartStackType | None,
+    color_column: str | None,
 ) -> alt.OpacityValue | None:
     import altair as alt
 
     if color_column and chart_type == ChartType.AREA:
         return alt.OpacityValue(0.7)
 
+    # Layered bar chart
+    if color_column and stack == "layered":
+        return alt.OpacityValue(0.7)
+
     return None
 
 
@@ -634,6 +670,42 @@ def _maybe_melt(
     return df, y_column, color_column
 
 
+def _get_axis_encodings(
+    df: pd.DataFrame,
+    chart_type: ChartType,
+    x_column: str | None,
+    y_column: str | None,
+    x_from_user: str | None,
+    y_from_user: str | Sequence[str] | None,
+    x_axis_label: str | None,
+    y_axis_label: str | None,
+    stack: bool | ChartStackType | None,
+) -> tuple[alt.X, alt.Y]:
+    stack_encoding: alt.X | alt.Y
+    if chart_type == ChartType.HORIZONTAL_BAR:
+        # Handle horizontal bar chart - switches x and y data:
+        x_encoding = _get_x_encoding(
+            df, y_column, y_from_user, x_axis_label, chart_type
+        )
+        y_encoding = _get_y_encoding(
+            df, x_column, x_from_user, y_axis_label, chart_type
+        )
+        stack_encoding = x_encoding
+    else:
+        x_encoding = _get_x_encoding(
+            df, x_column, x_from_user, x_axis_label, chart_type
+        )
+        y_encoding = _get_y_encoding(
+            df, y_column, y_from_user, y_axis_label, chart_type
+        )
+        stack_encoding = y_encoding
+
+    # Handle stacking - only relevant for bar charts
+    _update_encoding_with_stack(stack, stack_encoding)
+
+    return x_encoding, y_encoding
+
+
 def _get_x_encoding(
     df: pd.DataFrame,
     x_column: str | None,
@@ -730,6 +802,19 @@ def _get_y_encoding(
     )
 
 
+def _update_encoding_with_stack(
+    stack: bool | ChartStackType | None,
+    encoding: alt.X | alt.Y,
+) -> None:
+    if stack is None:
+        return None
+    # Our layered option maps to vega's stack=False option
+    elif stack == "layered":
+        stack = False
+
+    encoding["stack"] = stack
+
+
 def _get_color_encoding(
     df: pd.DataFrame,
     color_value: Color | None,

streamlit/elements/vega_charts.py

@@ -57,7 +57,7 @@ from streamlit.runtime.metrics_util import gather_metrics
 from streamlit.runtime.scriptrunner import get_script_run_ctx
 from streamlit.runtime.state import register_widget
 from streamlit.runtime.state.common import compute_widget_id
-from streamlit.type_util import Key, to_key
+from streamlit.type_util import ChartStackType, Key, to_key
 from streamlit.util import HASHLIB_KWARGS
 
 if TYPE_CHECKING:
@@ -957,6 +957,7 @@ class VegaChartsMixin:
         y_label: str | None = None,
         color: str | Color | list[Color] | None = None,
         horizontal: bool = False,
+        stack: bool | ChartStackType | None = None,
         width: int | None = None,
         height: int | None = None,
         use_container_width: bool = True,
@@ -1046,6 +1047,14 @@ class VegaChartsMixin:
             Streamlit swaps the x-axis and y-axis and the bars display
             horizontally.
 
+        stack : bool, "normalize", "center", "layered", or None
+            Whether to stack the bars. If this is ``None`` (default), uses Vega's
+            default. If this is ``True``, the bars are stacked on top of each other.
+            If this is ``False``, the bars are displayed side by side. If "normalize",
+            the bars are stacked and normalized to 100%. If "center", the bars are
+            stacked around a central axis. If "layered", the bars are stacked on top
+            of one another.
+
         width : int or None
             Desired width of the chart expressed in pixels. If ``width`` is
             ``None`` (default), Streamlit sets the width of the chart to fit
@@ -1139,6 +1148,20 @@ class VegaChartsMixin:
 
         """
 
+        # Offset encodings (used for non-stacked/grouped bar charts) are not supported in Altair < 5.0.0
+        if type_util.is_altair_version_less_than("5.0.0") and stack is False:
+            raise StreamlitAPIException(
+                "Streamlit does not support non-stacked (grouped) bar charts with Altair 4.x. Please upgrade to Version 5."
+            )
+
+        # Check that the stack parameter is valid, raise more informative error message if not
+        VALID_STACK_TYPES = (None, True, False, "normalize", "center", "layered")
+        if stack not in VALID_STACK_TYPES:
+            raise StreamlitAPIException(
+                f'Invalid value for stack parameter: {stack}. Stack must be one of True, False, "normalize", "center", "layered" or None. '
+                "See documentation for `st.bar_chart` [here](https://docs.streamlit.io/develop/api-reference/charts/st.bar_chart) for more information."
+            )
+
         bar_chart_type = (
             ChartType.HORIZONTAL_BAR if horizontal else ChartType.VERTICAL_BAR
         )
@@ -1154,6 +1177,7 @@ class VegaChartsMixin:
             size_from_user=None,
             width=width,
             height=height,
+            stack=stack,
         )
         return cast(
             "DeltaGenerator",

streamlit/type_util.py

@@ -142,6 +142,8 @@ LabelVisibility = Literal["visible", "hidden", "collapsed"]
 
 VegaLiteType = Literal["quantitative", "ordinal", "temporal", "nominal"]
 
+ChartStackType = Literal["normalize", "center", "layered"]
+
 
 class SupportsStr(Protocol):
     def __str__(self) -> str: ...

{streamlit_nightly-1.36.1.dev20240626.dist-info → streamlit_nightly-1.36.1.dev20240627.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: streamlit-nightly
-Version: 1.36.1.dev20240626
+Version: 1.36.1.dev20240627
 Summary: A faster way to build and share data apps
 Home-page: https://streamlit.io
 Author: Snowflake Inc

{streamlit_nightly-1.36.1.dev20240626.dist-info → streamlit_nightly-1.36.1.dev20240627.dist-info}/RECORD

@@ -31,7 +31,7 @@ streamlit/source_util.py,sha256=2KOVrEhBATVh9M_bnbg9OwWPORg1riCB63JzE7g8oK0,6145
 streamlit/string_util.py,sha256=x1ZuLlorPMNUpOZYMAN1VLdxViJwfPcXQ99PKRn0pyg,6347
 streamlit/temporary_directory.py,sha256=eBv5q0CR9GApa-itZBaGtqQKMl248H0HojEVKzkS9cc,1627
 streamlit/time_util.py,sha256=zPDirzZDAOPzGogHy-4wOalfBb7zCNCvFEfkZf03otc,2836
-streamlit/type_util.py,sha256=0sRlyamlv31HzIt0aaOccpd1U9dtB4ghaFoVgV4gKZc,48505
+streamlit/type_util.py,sha256=GEjqe0irGTExIm_eAalSAVwzIn3as04iZgF2jqPwgSk,48565
 streamlit/url_util.py,sha256=iU1lpZhzW4ZjhjBhSdw39OzixnThIsxhXpDP-ZIgUT8,3019
 streamlit/user_info.py,sha256=tvv__45d7cA6tNrGw1vHtWwc6QLtmXTM5xZoYeTs1cw,3383
 streamlit/util.py,sha256=0Phev7Lytvcy_eqIjpoGl2-7mOODwAwArY2zJpavEh8,6375
@@ -89,10 +89,10 @@ streamlit/elements/snow.py,sha256=WHqk8zmfOr5iD0R-wLlAdlIkDDbiaayguTVmA4e7V_Q,14
 streamlit/elements/spinner.py,sha256=ZMJlO-J77lpQZbRPvqJ80ur9u11dBUwJr6JgDct8TLY,2934
 streamlit/elements/text.py,sha256=-g2LYiJpP2OAdllpd7Df9rhTehIOEuiZN7-u1jwKEio,1856
 streamlit/elements/toast.py,sha256=aT_cIaQZOpG34pBGGyV7YaW0XBj1ircE5cXs2O7KzUU,4343
-streamlit/elements/vega_charts.py,sha256=MPRb2D8z1r0k61vLH-1GqNGIwTY2wqtkGwg5aNgQwA8,74285
+streamlit/elements/vega_charts.py,sha256=rt_eZBpUoNQDV4OcLeGz6fG2-0FlzEwtXfOy_i09HGE,75825
 streamlit/elements/write.py,sha256=9kpeYFx8huqQOPR_3me2vXjXbyWwipBNpMcwp1icnHI,21021
 streamlit/elements/lib/__init__.py,sha256=Vrf1yVMOcTyhUPnYvsfyeL96Vpd5z8KoSV5ZzTcTQgU,616
-streamlit/elements/lib/built_in_chart_utils.py,sha256=VStm5ps5G1OqllEXkCQxzSTUUC7IY199O9zHxVvITqc,32285
+streamlit/elements/lib/built_in_chart_utils.py,sha256=1Z4yHv-VnHKVsAlArlf3xa7vHrjnwrzxY5orQVPXJ7Y,34724
 streamlit/elements/lib/column_config_utils.py,sha256=-33zN3dALfvBdV0KAaLMpXNv7xwNrekCoG2r-pmr3B8,17379
 streamlit/elements/lib/column_types.py,sha256=anShsRYM3brr30bB7B-j3PBm3pJwD7dBpFz-7zwSfwY,51180
 streamlit/elements/lib/dialog.py,sha256=qaQjJNeaXanqCBtJ-rDv1vY2oCLRSiigdi7qKtYaldw,5732
@@ -529,9 +529,9 @@ streamlit/web/server/server_util.py,sha256=C3M971XFoEXTMufQLwHbZdtZOE30nWx-2WiXm
 streamlit/web/server/stats_request_handler.py,sha256=47nQHe4ETsO9QS9FAEUF8rZigU_k5eACJZw4-jc8U6c,3684
 streamlit/web/server/upload_file_request_handler.py,sha256=ftyKpARrUjOpRcFETIXuoTyOG_mo-ToOw5NI0y_W4lE,5003
 streamlit/web/server/websocket_headers.py,sha256=07SkWLcOxbyldl7UcBzrMKY9ZojypCQACiKoh5FcH7Y,1870
-streamlit_nightly-1.36.1.dev20240626.data/scripts/streamlit.cmd,sha256=ZEYM3vBJSp-k7vwSJ3ba5NzEk9-qHdSeLvGYAAe1mMw,676
-streamlit_nightly-1.36.1.dev20240626.dist-info/METADATA,sha256=d0CSSpOYbSy3pEs_wMZgyl_AG80I4NOFmoZz2A1Wvos,8531
-streamlit_nightly-1.36.1.dev20240626.dist-info/WHEEL,sha256=_4XEmVmaBFWtekSGrbfOGNjC2I5lUr0lZSRblBllIFA,109
-streamlit_nightly-1.36.1.dev20240626.dist-info/entry_points.txt,sha256=uNJ4DwGNXEhOK0USwSNanjkYyR-Bk7eYQbJFDrWyOgY,53
-streamlit_nightly-1.36.1.dev20240626.dist-info/top_level.txt,sha256=V3FhKbm7G2LnR0s4SytavrjIPNIhvcsAGXfYHAwtQzw,10
-streamlit_nightly-1.36.1.dev20240626.dist-info/RECORD,,
+streamlit_nightly-1.36.1.dev20240627.data/scripts/streamlit.cmd,sha256=ZEYM3vBJSp-k7vwSJ3ba5NzEk9-qHdSeLvGYAAe1mMw,676
+streamlit_nightly-1.36.1.dev20240627.dist-info/METADATA,sha256=HexX6Zm08shI4hezGym8T6l6roNgucozZZ2ayYn3fNM,8531
+streamlit_nightly-1.36.1.dev20240627.dist-info/WHEEL,sha256=_4XEmVmaBFWtekSGrbfOGNjC2I5lUr0lZSRblBllIFA,109
+streamlit_nightly-1.36.1.dev20240627.dist-info/entry_points.txt,sha256=uNJ4DwGNXEhOK0USwSNanjkYyR-Bk7eYQbJFDrWyOgY,53
+streamlit_nightly-1.36.1.dev20240627.dist-info/top_level.txt,sha256=V3FhKbm7G2LnR0s4SytavrjIPNIhvcsAGXfYHAwtQzw,10
+streamlit_nightly-1.36.1.dev20240627.dist-info/RECORD,,