Skip to content

Commit 80a1ba0

Browse files
committed
fixing docs
1 parent d35d4a7 commit 80a1ba0

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

circuitpython_uplot/ulogging.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ def __init__(
5555
:param int|None line_color: line color. Defaults to None
5656
:param np.array|list ticksx: X axis ticks values
5757
:param np.array|list ticksy: Y axis ticks values
58-
:param bool tick_pos: indicates ticks position. True for below the axes. Defaults to ``False``
58+
:param bool tick_pos: indicates ticks position. True for below the axes.
59+
Defaults to ``False``
5960
:param bool fill: enable the filling of the plot. Defaults to ``False``
6061
6162
"""

docs/quick_start.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,12 @@ could vary. This allows us to have more than 1 plot at the same time in the scre
3232
Every one of them with different characteristics or graphs.
3333

3434
Options available are:
35+
* width: width of the plot area
36+
* height: height of the plot area
3537
* backround_color: Allows to change the background color. The default is black.
3638
* box_color: Allows to change the box color. Default is white.
39+
* padding: allows the user to give the plot area a pad. This is helpful if you are planning to include text and legends in the axes.
40+
* scale: scale of the plot.
3741

3842
We tell the microcontroller to display our plot:
3943

@@ -375,6 +379,15 @@ Logging
375379
This is a similar to Cartesian but designed to allow the user to use it as a data logger.
376380
The user needs to setup manually the range and tick values in order for this graph to work proeprly
377381

382+
There are some parameters that you can customize:
383+
384+
* rangex and rangey: you need specify the ranges of your graph. This allows you to move your graph according to your needs. This parameters only accept lists
385+
* ticksx and ticksy: Specific ticks for the X and Y axes
386+
* line_color: you can specify the color in HEX
387+
* tick_pos: Allows to show the ticks below the axes.
388+
* fill: genrates lines under each point, to fill the area under the points
389+
390+
378391
.. code-block:: python
379392
380393
plot = Uplot(0, 0, display.width, display.height)

0 commit comments

Comments
 (0)