added bar color palette argument

Author: jposada202020

.pylintrc

@@ -385,7 +385,7 @@ max-public-methods=20
 max-returns=6
 
 # Maximum number of statements in function / method body
-max-statements=50
+max-statements=60
 
 # Minimum number of public methods for a class (see R0903).
 min-public-methods=1

circuitpython_uplot/ubar.py

@@ -19,6 +19,7 @@
 except ImportError:
     pass
 import math
+from displayio import Palette
 from bitmaptools import draw_line
 from vectorio import Rectangle, Polygon
 
@@ -43,6 +44,7 @@ def __init__(
         bar_space=16,
         xstart=50,
         projection=False,
+        color_palette=None,
     ) -> None:
         """
         :param Uplot plot: Plot object for the scatter to be drawn
@@ -51,8 +53,11 @@ def __init__(
         :param int color: boxes color. Defaults to const:``0xFFFFFF``
         :param bool fill: boxes fill attribute. Defaults to `False`
         :param int bar_space: space in pixels between the bars
-        :param int xstart: start point in the x axis for the bar to start. Default to :const:`50`
+        :param int xstart: start point in the x axis for the bar to start. Defaults to :const:`50`
         :param bool projection: creates projection of the bars given them depth.
+        :param list color_palette: list of colors to be used for the bars. Defaults to None.
+         Be aware that you need to include the same number if colors as your data.
+         This functionality will only work with filled bars.
 
         """
         y = [i * plot.scale for i in y]
@@ -66,7 +71,19 @@ def __init__(
         self._new_min = int(plot.transform(0, max(y), max(y), 0, 0))
         self._new_max = int(plot.transform(0, max(y), max(y), 0, max(y)))
 
-        plot._plot_palette[plot._index_colorused] = color
+        if color_palette is not None:
+            if projection:
+                color_count = 2
+            else:
+                color_count = 1
+            self._color_palette = Palette(len(color_palette) * color_count)
+            for i, selected_color in enumerate(color_palette):
+                self._color_palette[i] = selected_color
+            self._color_index = 0
+        else:
+            self._color_palette = plot._plot_palette
+            self._color_index = plot._index_colorused
+            self._color_palette[self._color_index] = color
 
         if plot._index_colorused >= 14:
             plot._index_colorused = 0
@@ -75,12 +92,12 @@ def __init__(
             for i, _ in enumerate(x):
                 plot.append(
                     Rectangle(
-                        pixel_shader=plot._plot_palette,
+                        pixel_shader=self._color_palette,
                         width=self._graphx,
                         height=self._graphy * y[i],
                         x=xstart + (i * self._graphx),
                         y=int(plot._newymin - self._graphy * y[i] / plot.scale),
-                        color_index=plot._index_colorused,
+                        color_index=self._color_index,
                     )
                 )
                 if projection:
@@ -93,16 +110,16 @@ def __init__(
                         (self._graphx - rx, 0 + ry),
                         (0 - rx, 0 + ry),
                     ]
-                    plot._plot_palette[plot._index_colorused + 6] = color_fader(
-                        plot._plot_palette[plot._index_colorused], 0.7, 1
-                    )
+                    self._color_palette[
+                        self._color_index + len(color_palette)
+                    ] = color_fader(self._color_palette[self._color_index], 0.7, 1)
                     plot.append(
                         Polygon(
-                            pixel_shader=plot._plot_palette,
+                            pixel_shader=self._color_palette,
                             points=points,
                             x=xstart + (i * self._graphx),
                             y=plot._newymin - self._graphy * y[i],
-                            color_index=plot._index_colorused + 6,
+                            color_index=self._color_index + len(color_palette),
                         )
                     )
                     points = [
@@ -113,11 +130,11 @@ def __init__(
                     ]
                     plot.append(
                         Polygon(
-                            pixel_shader=plot._plot_palette,
+                            pixel_shader=self._color_palette,
                             points=points,
                             x=xstart + (i * self._graphx),
                             y=plot._newymin - self._graphy * y[i],
-                            color_index=plot._index_colorused + 6,
+                            color_index=self._color_index + len(color_palette),
                         )
                     )
 
@@ -128,6 +145,7 @@ def __init__(
                 )
                 xstart = xstart + self._bar_space
                 plot._index_colorused = plot._index_colorused + 1
+                self._color_index = self._color_index + 1
         else:
             for i, _ in enumerate(x):
                 self._draw_rectangle(

docs/bar_palette.jpg

@@ -82,6 +82,17 @@ Bar plot example showing how to use the scale
 .. image:: ../docs/bar_scale.jpg
 
 
+Ubar Color Palette Example
+----------------------------
+
+Bar plot example showing how to pass a user color Palette
+
+.. literalinclude:: ../examples/uplot_ubar_colorpalette.py
+    :caption: examples/uplot_ubar_colorpalette.py
+    :lines: 5-
+.. image:: ../docs/bar_palette.jpg
+
+
 Ubar 3D Example
 ----------------
 

docs/examples.rst

@@ -306,6 +306,26 @@ You can select the color or and if the bars are filled
     ubar(plot, a, b, 0xFF1000, True)
 
 
+You can also select the bar spacing and the xstart position:
+
+.. code-block:: python
+
+    ubar(plot, a, b, 0xFF1000, fill=True, bar_space=30, xstart=70)
+
+For bar filled graphs you can pass a color_palette list. This will allow you to select the color of each bar
+This will not work for shell bars sadly.
+
+.. code-block:: python
+
+    import board
+    from circuitpython_uplot.uplot import Uplot
+    from circuitpython_uplot.ubar import ubar
+
+    display = board.DISPLAY
+    plot = Uplot(0, 0, display.width, display.height)
+    ubar(plot, a, b, fill=True, bar_space=30, xstart=70, color_palette=[0xFF1000, 0x00FF00, 0x0000FF, 0x00FFFF])
+
+
 with the projection argument you can show the bars with projection. This will give them a 3D
 appearance
 

docs/quick_start.rst

@@ -0,0 +1,42 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023 Jose D. Montoya, DJDevon
+#
+# SPDX-License-Identifier: MIT
+
+import board
+from circuitpython_uplot.uplot import Uplot, color
+from circuitpython_uplot.ubar import ubar
+
+# 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.BLACK,
+)
+
+# Dummy data to plot
+activities_latest_heart_value = [55, 20, 25, 30, 35, 10]
+a = ["a", "b", "c", "d", "e", "f"]
+
+# Creating the Bar Plot
+ubar(
+    plot,
+    a,
+    activities_latest_heart_value,
+    0xFF1000,
+    True,
+    color_palette=[0xFF1000, 0x00FF00, 0x0000FF, 0xFFFF00, 0x00FFFF, 0x123456],
+)
+
+# Showing the plot
+display.show(plot)