nipanel.enum_selectbox

Author: Mike Prosser

examples/all_types/all_types_panel.py

@@ -1,5 +1,7 @@
 """A Streamlit visualization panel for the all_types.py example script."""
 
+from enum import Enum
+
 import streamlit as st
 from define_types import all_types_with_values
 
@@ -11,10 +13,25 @@
 
 panel = nipanel.get_panel_accessor()
 for name in all_types_with_values.keys():
-    col1, col2 = st.columns([0.4, 0.6])
+    st.markdown("---")
+
+    default_value = all_types_with_values[name]
+    col1, col2, col3 = st.columns([0.2, 0.2, 0.6])
 
     with col1:
         st.write(name)
 
     with col2:
+        if isinstance(all_types_with_values[name], Enum):
+            nipanel.enum_selectbox(panel, label=name, value=default_value, key=name)
+        elif isinstance(all_types_with_values[name], bool):
+            st.checkbox(label=name, value=default_value, key=name)
+        elif isinstance(all_types_with_values[name], int):
+            st.number_input(label=name, value=default_value, key=name)
+        elif isinstance(all_types_with_values[name], float):
+            st.number_input(label=name, value=default_value, key=name, format="%.2f")
+        elif isinstance(all_types_with_values[name], str):
+            st.text_input(label=name, value=default_value, key=name)
+
+    with col3:
         st.write(panel.get_value(name))

examples/all_types/define_types.py

@@ -38,16 +38,19 @@ class MyStrEnum(str, enum.Enum):
     "float": 13.12,
     "int": 42,
     "str": "sample string",
+    # supported enum and flag types
+    "intflags": MyIntFlags.VALUE1 | MyIntFlags.VALUE4,
+    "intenum": MyIntEnum.VALUE20,
+    "strenum": MyStrEnum.VALUE3,
+    # NI types
+    "nitypes_Scalar": Scalar(42, "m"),
+    "nitypes_AnalogWaveform": AnalogWaveform.from_array_1d(np.array([1.0, 2.0, 3.0])),
     # supported collection types
     "bool_collection": [True, False, True],
     "bytes_collection": [b"one", b"two", b"three"],
     "float_collection": [1.1, 2.2, 3.3],
     "int_collection": [1, 2, 3],
     "str_collection": ["one", "two", "three"],
-    # supported enum and flag types
-    "intflags": MyIntFlags.VALUE1 | MyIntFlags.VALUE4,
-    "intenum": MyIntEnum.VALUE20,
-    "strenum": MyStrEnum.VALUE3,
     "intflags_collection": [MyIntFlags.VALUE1, MyIntFlags.VALUE2, MyIntFlags.VALUE4],
     "intenum_collection": [MyIntEnum.VALUE10, MyIntEnum.VALUE20, MyIntEnum.VALUE30],
     "strenum_collection": [MyStrEnum.VALUE1, MyStrEnum.VALUE2, MyStrEnum.VALUE3],
@@ -56,9 +59,6 @@ class MyStrEnum(str, enum.Enum):
     "tuple": (4, 5, 6),
     "set": {7, 8, 9},
     "frozenset": frozenset([10, 11, 12]),
-    # NI types
-    "nitypes_Scalar": Scalar(42, "m"),
-    "nitypes_AnalogWaveform": AnalogWaveform.from_array_1d(np.array([1.0, 2.0, 3.0])),
     # supported 2D collections
     "list_list_float": [[1.0, 2.0], [3.0, 4.0]],
     "tuple_tuple_float": ((1.0, 2.0), (3.0, 4.0)),

examples/simple_graph/simple_graph.py

@@ -21,17 +21,14 @@
 
     # Generate and update the sine wave data periodically
     while True:
-        # not-found values need to be performant
-        not_found = panel.get_value("no_such_value", "Hello, World!")
-
-        amplitude_enum = panel.get_value("amplitude_enum", AmplitudeEnum.SMALL)
+        amplitude = panel.get_value("amplitude", AmplitudeEnum.SMALL)
         base_frequency = panel.get_value("base_frequency", 1.0)
 
         # Slowly vary the total frequency for a more dynamic visualization
         frequency = base_frequency + 0.5 * math.sin(time.time() / 5.0)
 
         time_points = np.linspace(0, num_points, num_points)
-        sine_values = amplitude_enum.value * np.sin(frequency * time_points)
+        sine_values = amplitude.value * np.sin(frequency * time_points)
 
         panel.set_value("frequency", frequency)
         panel.set_value("time_points", time_points.tolist())

examples/simple_graph/simple_graph_panel.py

@@ -12,25 +12,16 @@
 col1, col2, col3, col4, col5, col6 = st.columns(6)
 
 panel = nipanel.get_panel_accessor()
+frequency = panel.get_value("frequency", 0.0)
+time_points = panel.get_value("time_points", [0.0])
+sine_values = panel.get_value("sine_values", [0.0])
 
 with col1:
-    amplitude_tuple = st.selectbox(
-        "Amplitude",
-        options=[(e.name, e.value) for e in AmplitudeEnum],
-        format_func=lambda x: x[0],
-        index=0,
-    )
-    amplitude_enum = AmplitudeEnum[amplitude_tuple[0]]
-    panel.set_value("amplitude_enum", amplitude_enum)
+    nipanel.enum_selectbox(panel, label="Amplitude", value=AmplitudeEnum.MEDIUM, key="amplitude")
 with col2:
-    base_frequency = st.number_input("Base Frequency", value=1.0, step=0.1, key="base_frequency")
-
+    st.number_input("Base Frequency", value=1.0, step=0.5, key="base_frequency")
 with col3:
-    frequency = panel.get_value("frequency", 0.0)
     st.metric("Frequency", f"{frequency:.2f} Hz")
-
-time_points = panel.get_value("time_points", [0.0])
-sine_values = panel.get_value("sine_values", [0.0])
 with col4:
     st.metric("Min Value", f"{min(sine_values):.3f}")
 with col5:

src/nipanel/__init__.py

@@ -3,12 +3,14 @@
 from importlib.metadata import version
 
 from nipanel._panel import Panel
+from nipanel._streamlit_components import enum_selectbox
 from nipanel._streamlit_panel import StreamlitPanel
 from nipanel._streamlit_panel_initializer import create_panel, get_panel_accessor
 from nipanel._streamlit_panel_value_accessor import StreamlitPanelValueAccessor
 
 __all__ = [
     "create_panel",
+    "enum_selectbox",
     "get_panel_accessor",
     "Panel",
     "StreamlitPanel",

src/nipanel/_streamlit_components.py

@@ -0,0 +1,49 @@
+"""Streamlit UI components for NI Panel."""
+
+from enum import Enum
+from typing import TypeVar
+
+import streamlit as st
+
+from nipanel._panel_value_accessor import PanelValueAccessor
+
+T = TypeVar("T", bound=Enum)
+
+
+def enum_selectbox(panel: PanelValueAccessor, label: str, value: T, key: str) -> T:
+    """Create a selectbox for an Enum.
+
+    The selectbox will display the names of all the enum values, and when a value is selected,
+    that value will be stored in the panel under the specified key.
+
+    Args:
+        panel: The panel
+        label: Label to display for the selectbox
+        value: The default enum value to select (also determines the specific enum type)
+        key: Key to use for storing the enum value in the panel
+
+    Returns:
+        The selected enum value of the same specific enum subclass as the input value
+    """
+    enum_class = type(value)
+    if not issubclass(enum_class, Enum):
+        raise TypeError(f"Expected an Enum type, got {type(value)}")
+
+    options = [(e.name, e.value) for e in enum_class]
+
+    default_index = 0
+    if value is not None:
+        for i, (name, _) in enumerate(options):
+            if name == value.name:
+                default_index = i
+                break
+
+    box_tuple = st.selectbox(
+        label,
+        options=options,
+        format_func=lambda x: x[0],
+        index=default_index,
+    )
+    enum_value = enum_class[box_tuple[0]]
+    panel.set_value(key, enum_value)
+    return enum_value