pyqtgraph/pyqtgraph/exporters
Carlos Pascual 23a46b5fb9
Add "left" and "right" step Modes (#1360)
* Add "lstep" and "rstep" step Modes

stepMode is currently either True or False. If it is True,
it requires the user to make len(x) = len(y)+1. This is
inconvenient because it makes it difficult to change the
stepMode on a given curve (just as one would change, e.g.,
its color).

This commit extends the current situation by introducing
two more step modes: "lstep" and "rstep", which do not require
passing an extra x value. In turn, this modes associate each
y value to either the left or the right boundary of the step.

For example, the "rstep" mode is handy when plotting "life"
digital signals in which x,y data pairs are appended as they
are read.

This commit does not modify the behaviour in case of stepMode=True

* Replace step mode names: lstep,rstep -> left,right

* Improve docs for stepMode

Reword docstring and add it to PlotDataItem class too

* Document left and right stepModes as added in v 0.12.0

TODO: confirm the exact version number to use here

* Add comments stress the need for "is True"

Some conditional statements in the code regarding stepMode are
done with "is True". This is actually required since other
possible values such as "left" also evaluate as true but should
not be caught.

* Deprecate boolean API for stepMode

Introduce stepMode="mid" as a replacement of stepMode=True,
but keeping full backwards compatibility with the old API.
Adapt docs, examples and tests accordingly.

* Raise ValueError on unsupported stepMode values

* Rename "mid" step mode to "center"

* Remove "added in 0.12.0" note

See https://github.com/pyqtgraph/pyqtgraph/pull/1360#discussion_r502746919

* Add deprecation warning when stepMode=True

Issue a DeprecationWarning if stepMode=True is being passed to the
constructor or setData() of PlotDataItem or PlotCurveItem.

Note: warnings module is imported locally so that it is esier to
remove once this check is no longer needed.

* Fix wrong syntax in last commit

Fix usage of "default" kwarg in dict.get()
2020-10-13 08:52:07 -07:00
..
tests Add "left" and "right" step Modes (#1360) 2020-10-13 08:52:07 -07:00
__init__.py Squashed commit of the following: 2014-08-07 09:03:26 -04:00
CSVExporter.py Encode csv export header as unicode 2020-05-30 21:13:20 -07:00
Exporter.py Import from python2_3 for all uses of basestring, cmp, and xrange 2015-05-19 09:29:55 -04:00
HDF5Exporter.py HDF5Exporter handling of ragged curves with tests (#1072) 2019-11-12 09:01:49 -08:00
ImageExporter.py moved some functionality from method 'export' to new method (#390) 2020-06-01 11:05:39 -07:00
Matplotlib.py Handle axis SI prefix scaling in MatplotlibExporter (#1282) 2020-06-28 08:51:34 -07:00
PrintExporter.py Added Travis CI support 2014-03-30 02:51:32 -04:00
SVGExporter.py SVGExporter: Correct image pixelation. 2020-04-08 01:14:36 +02:00