adding bar_color_change

Author: jposada202020

circuitpython_uplot/ubar.py

@@ -88,6 +88,7 @@ def __init__(
         self._new_max = int(plot.transform(0, y_max, y_max, 0, y_max))
 
         if color_palette is not None:
+            self._palette_defined = True
             if projection:
                 color_count = 2
             else:
@@ -97,6 +98,7 @@ def __init__(
                 self._color_palette[i] = selected_color
             self._color_index = 0
         else:
+            self._palette_defined = False
             self._color_palette = plot._plot_palette
             self._color_index = plot._index_colorused
             self._color_palette[self._color_index] = color
@@ -261,6 +263,40 @@ def update_values(self, values: list = None):
             element.height = height
             element.y = y
 
+    def update_colors(self, colors: list = None):
+        """
+        Update Colors of the bars
+
+        :param list colors: list of colors to be asigned. list lenght must coincide with
+         the numbers of bars in your plot
+
+        """
+        if colors is None:
+            raise ValueError("You must provide a list of colors")
+        if len(colors) != len(self._bars):
+            raise ValueError("You must provide the same number of colors as bars")
+        if self._palette_defined:
+            for i in range(len(self._bars)):
+                self._color_palette[i] = colors[i]
+        else:
+            for i in range(len(self._bars)):
+                self._color_palette[i + 4] = colors[i]
+
+    def update_bar_color(self, bar_number: int, color: int = 0xFFFFFF):
+        """
+        Update the color of a single bar
+
+        :param int bar_number: bar index. Bar number starts with :const`0`
+        :param int color: new bar color. Defaults to :const:`0xFFFFFF`. White
+
+        """
+        if bar_number > len(self._bars):
+            raise ValueError("Bar number must be a valid bar index")
+        if self._palette_defined:
+            self._color_palette[bar_number] = color
+        else:
+            self._color_palette[bar_number + 4] = color
+
 
 def color_fader(source_color=None, brightness=1.0, gamma=1.0):
     """

docs/examples.rst

@@ -102,6 +102,15 @@ Bar Plot example showing how to update values for a filled bars bar plot
     :caption: examples/uplot_ubar_updating_values.py
     :lines: 5-
 
+Bar plot updating bar colors Example
+-------------------------------------
+
+Bar Plot example showing how to update colors for a filled bars bar plot
+
+.. literalinclude:: ../examples/uplot_ubar_color_changing.py
+    :caption: examples/uplot_ubar_color_changing.py
+    :lines: 5-
+
 
 Ubar 3D Example
 ----------------

docs/quick_start.rst

@@ -344,8 +344,8 @@ appearance
     ubar(plot, a, b, color=0xFF1000, fill=True, bar_space=30, xstart=70, projection=True)
 
 
-For filled unprojected bar you can update their values. This is useful for data logging.
-the max_value argument will allow you to set the maximum value of the graph. The plot will scale
+For filled unprojected bars you can update their values. This is useful for data logging.
+The max_value argument will allow you to set the maximum value of the graph. The plot will scale
 according to this max value, and bar plot will update their values accordingly
 
 .. code-block:: python
@@ -362,13 +362,30 @@ according to this max value, and bar plot will update their values accordingly
     b = [3, 5, 1, 7]
     my_ubar = ubar(plot, a, b, color=0xFF1000, fill=True, color_palette=[0xFF1000, 0x00FF00, 0xFFFF00, 0x123456], max_value=10)
 
-
 Then you can update the values of the bar plot:
 
 .. code-block:: python
 
     my_ubar.update_values([1, 2, 3, 4])
 
+
+Also for Filled unprojected bars you can change all bars color at once. The following
+code will change all the bar's color to red
+
+.. code-block:: python
+
+    my_ubar.update_colors(0xFF0000, 0xFF0000, 0xFF0000, 0xFF0000)
+
+If you prefer, you can change the color of a single bar using the following code:
+
+.. code-block:: python
+
+    my_ubar.update_bar_color(0, 0x0000FF)
+
+This will change the first bar to Blue.
+
+
+
 ===============
 Fillbetween
 ===============

examples/uplot_ubar_color_changing.py

@@ -0,0 +1,56 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023 Jose D. Montoya
+#
+# SPDX-License-Identifier: MIT
+
+import board
+from circuitpython_uplot.uplot import Uplot, color
+from circuitpython_uplot.ubar import ubar
+import time
+
+# Setting up the display
+display = board.DISPLAY
+
+# Configuring display dimensions
+DISPLAY_WIDTH = 480
+DISPLAY_HEIGHT = 320
+
+# Defining the plot
+plot = Uplot(
+    0,
+    0,
+    DISPLAY_WIDTH,
+    DISPLAY_HEIGHT,
+    background_color=color.BLACK,
+    padding=10,
+    box_color=color.WHITE,
+)
+
+display.show(plot)
+
+# Dummy data to plot
+some_values = [55, 20, 25, 30, 35, 10]
+a = ["a", "b", "c", "d", "e", "f"]
+
+# Showing the plot
+display.show(plot)
+
+# Creating the bar
+my_ubar = ubar(
+    plot,
+    a,
+    some_values,
+    0xFF1000,
+    True,
+    projection=False,
+    max_value=50,
+)
+time.sleep(2)
+# Changing all the bars to Yellow
+my_ubar.update_colors(
+    [color.YELLOW, color.YELLOW, color.YELLOW, color.YELLOW, color.YELLOW, color.YELLOW]
+)
+
+time.sleep(2)
+
+# Changing the 3 bar to Purple
+my_ubar.update_bar_color(2, color.PURPLE)

requirements.txt

@@ -1,4 +1,3 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2023 Jose D. Montoya
 #
 # SPDX-License-Identifier: MIT