adding tick format option and example

Author: jposada202020

circuitpython_uplot/plot.py

@@ -109,6 +109,7 @@ def __init__(
 
         self._cartesianfirst = True
         self._loggingfirst = True
+        self._scatterfirst = True
 
         self._showtext = False
 
@@ -127,7 +128,7 @@ def __init__(
 
         self._index_colorused = 4
 
-        self._plotbitmap = displayio.Bitmap(width, height, 20)
+        self._plotbitmap = displayio.Bitmap(width, height, 10)
 
         if show_box:
             self._drawbox()
@@ -323,7 +324,10 @@ def _draw_ticks(self, x: int, y: int) -> None:
             )
             if self._showtext:
                 self.show_text(
-                    "{:.2f}".format(ticksxnorm[i]), tick, self._newymin, (0.5, 0.0)
+                    "{:.{}f}".format(ticksxnorm[i], self._decimal_points),
+                    tick,
+                    self._newymin,
+                    (0.5, 0.0),
                 )
         for i, tick in enumerate(ticksyrenorm):
             draw_line(
@@ -336,7 +340,10 @@ def _draw_ticks(self, x: int, y: int) -> None:
             )
             if self._showtext:
                 self.show_text(
-                    "{:.2f}".format(ticksynorm[i]), self._newxmin, tick, (1.0, 0.5)
+                    "{:.{}f}".format(ticksynorm[i], self._decimal_points),
+                    self._newxmin,
+                    tick,
+                    (1.0, 0.5),
                 )
         for tick in subticksxrenorm:
             draw_line(
@@ -369,26 +376,34 @@ def tick_params(
         tickcolor: int = 0xFFFFFF,
         tickgrid: bool = False,
         showtext: bool = False,
+        decimal_points: int = 0,
     ) -> None:
         """
         Function to set ticks parameters
 
+        :param bool show_ticks: Show ticks. Defaults to `True`
         :param int tickx_height: X axes tick height in pixels. Defaults to 8
         :param int ticky_height: Y axes tick height in pixels. Defaults to 8
         :param int tickcolor: tick color in hex. Defaults to white. ``0xFFFFFF``
         :param bool tickgrid: defines if the grid is to be shown. Defaults to `False`
         :param bool showtext: Show Axes text. Defaults to `False`
+        :param int decimal_points: Number of decimal points to show. Defaults to 0
 
         :return: None
 
         """
+        if showtext and self.padding < 20:
+            raise ValueError(
+                "Please select a padding that allows to show the tick text"
+            )
 
         self._showticks = show_ticks
         self._tickheightx = tickx_height
         self._tickheighty = ticky_height
         self._plot_palette[2] = tickcolor
         self._tickgrid = tickgrid
         self._showtext = showtext
+        self._decimal_points = decimal_points
         if self._showtext:
             from adafruit_display_text import bitmap_label
 
@@ -460,6 +475,7 @@ def show_text(
         :param Tuple anchorpoint: Display_text anchor point. Defaults to (0.5, 0.0)
         :return: None
         """
+
         if self._showtext:
             text_toplot = self.bitmap_label.Label(terminalio.FONT, text=text, x=x, y=y)
             text_toplot.anchor_point = anchorpoint

circuitpython_uplot/scatter.py

@@ -74,9 +74,13 @@ def __init__(
         else:
             self._pointer = pointer
 
+
         self._radius = radius
         self._pointer_color = pointer_color
 
+        if isinstance(self._radius, list) and self._pointer != "circle":
+            raise ValueError(f"Pointer paramater is {self._pointer}. Variable Radius are not accepted")
+
         if rangex is None:
             xmin = np.min(x) - nudge_factor * (abs(np.max(x) - np.min(x)) / 10)
             xmax = np.max(x) + nudge_factor * (abs(np.max(x) - np.min(x)) / 10)
@@ -105,8 +109,12 @@ def __init__(
 
         self._draw_pointer(plot)
 
-        if plot._showticks:
-            plot._draw_ticks(x, y)
+        if plot._scatterfirst:
+            if plot._showticks:
+                plot._draw_ticks(x, y)
+
+                plot._scatterfirst = False
+                plot._showticks = False
 
     def _draw_pointer(self, plot: Plot) -> None:
         """

docs/quick_start.rst

@@ -123,6 +123,8 @@ the following parameters:
    :param int ticky_height: ticky_height in pixels
    :param int tickcolor: tickcolor in Hex format
    :param bool tickgrid: displays the tickgrid. Defaults to `False`
+   :param bool showtext: displays the tick text. Defaults to `False`
+   :param int decimal_points: number of decimal points to show. Defaults to `0` 
 
 .. code-block:: python
 
@@ -136,6 +138,20 @@ Gridlines are normally ``OFF``. If you want visible gridlines then use:
     plot.tick_params(tickgrid=True)
 
 
+If you want to show the axes text. You can use:
+
+.. code-block:: python
+
+    plot.tick_params(showtext=True)
+
+If you want to show some decimal places in the text. use:
+
+.. code-block:: python
+
+    plot.tick_params(decimal_points=2)
+
+
+
 Colors
 ===============
 You can choose some colors directly from the library. This can be done by importing the color class:

docs/scatter_using_different_datasets.jpg

@@ -0,0 +1,57 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023 Jose D. Montoya
+#
+# SPDX-License-Identifier: MIT
+
+from random import choice
+import board
+from ulab import numpy as np
+from circuitpython_uplot.plot import Plot
+from circuitpython_uplot.scatter import Scatter
+
+
+# Setting up the display
+display = board.DISPLAY
+
+# Adding the plot area
+plot = Plot(0, 0, display.width, display.height, padding=25)
+plot.tick_params(
+    tickx_height=12,
+    ticky_height=12,
+    tickcolor=0x939597,
+    tickgrid=True,
+    showtext=True,
+    decimal_points=0,
+)
+
+display.show(plot)
+
+a = np.linspace(4, 200, 50)
+z = [4, 5, 6, 7, 8]
+radi = [choice(z) for _ in a]
+b = [choice(a) for _ in a]
+Scatter(
+    plot, a, b, rangex=[0, 210], rangey=[0, 210], radius=radi, pointer_color=0xF456F3
+)
+a = np.linspace(50, 170, 50)
+radi = [choice(z) for _ in a]
+b = [choice(a) for _ in a]
+Scatter(
+    plot, a, b, rangex=[0, 210], rangey=[0, 210], radius=radi, pointer_color=0x00FF00
+)
+a = np.linspace(50, 100, 25)
+z = [
+    4,
+    5,
+    6,
+]
+radi = [choice(z) for _ in a]
+b = [int(choice(a) / 1.2) for _ in a]
+Scatter(
+    plot,
+    a,
+    b,
+    rangex=[0, 210],
+    rangey=[0, 210],
+    pointer="triangle",
+    pointer_color=0x00FFFF,
+)