ASCEE/pyqtgraph
5
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

documentation updates

Browse Source
This commit is contained in:
Luke Campagnola 2012-11-28 23:34:05 -05:00
parent d800ab03aa
commit 9cb199d971
16 changed files with 116 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
documentation/source/3dgraphics/glsurfaceplotitem.rst Normal file
View File

@ -0,0 +1,8 @@
GLSurfacePlotItem
=================
.. autoclass:: pyqtgraph.opengl.GLSurfacePlotItem
:members:
.. automethod:: pyqtgraph.opengl.GLSurfacePlotItem.__init__

3
documentation/source/3dgraphics/index.rst
View File

@ -16,9 +16,10 @@ Contents:
glviewwidget
glgriditem
glmeshitem
glsurfaceplotitem
glvolumeitem
glimageitem
glmeshitem
glaxisitem
glgraphicsitem
glscatterplotitem

1
documentation/source/3dgraphics/meshdata.rst
View File

@ -5,5 +5,4 @@ MeshData
:members:
.. automethod:: pyqtgraph.opengl.MeshData.MeshData.__init__
.. automethod:: pyqtgraph.opengl.MeshData.MeshData.__iter__

8
documentation/source/graphicsItems/fillbetweenitem.rst Normal file
View File

@ -0,0 +1,8 @@
FillBetweenItem
===============
.. autoclass:: pyqtgraph.FillBetweenItem
:members:
.. automethod:: pyqtgraph.FillBetweenItem.__init__

8
documentation/source/graphicsItems/graphicswidgetanchor.rst Normal file
View File

@ -0,0 +1,8 @@
GraphicsWidgetAnchor
====================
.. autoclass:: pyqtgraph.GraphicsWidgetAnchor
:members:
.. automethod:: pyqtgraph.GraphicsWidgetAnchor.__init__

2
documentation/source/graphicsItems/index.rst
View File

@ -23,6 +23,7 @@ Contents:
axisitem
textitem
arrowitem
fillbetweenitem
curvepoint
curvearrow
griditem
@ -38,4 +39,5 @@ Contents:
graphicswidget
graphicsitem
uigraphicsitem
graphicswidgetanchor

8
documentation/source/widgets/busycursor.rst Normal file
View File

@ -0,0 +1,8 @@
BusyCursor
==========
.. autoclass:: pyqtgraph.BusyCursor
:members:
.. automethod:: pyqtgraph.BusyCursor.__init__

8
documentation/source/widgets/combobox.rst Normal file
View File

@ -0,0 +1,8 @@
ComboBox
========
.. autoclass:: pyqtgraph.ComboBox
:members:
.. automethod:: pyqtgraph.ComboBox.__init__

8
documentation/source/widgets/feedbackbutton.rst Normal file
View File

@ -0,0 +1,8 @@
FeedbackButton
==============
.. autoclass:: pyqtgraph.FeedbackButton
:members:
.. automethod:: pyqtgraph.FeedbackButton.__init__

9
documentation/source/widgets/index.rst
View File

@ -30,4 +30,11 @@ Contents:
joystickbutton
multiplotwidget
verticallabel
remotegraphicsview
matplotlibwidget
feedbackbutton
combobox
layoutwidget
pathbutton
valuelabel
busycursor

8
documentation/source/widgets/layoutwidget.rst Normal file
View File

@ -0,0 +1,8 @@
LayoutWidget
============
.. autoclass:: pyqtgraph.LayoutWidget
:members:
.. automethod:: pyqtgraph.LayoutWidget.__init__

8
documentation/source/widgets/matplotlibwidget.rst Normal file
View File

@ -0,0 +1,8 @@
MatplotlibWidget
================
.. autoclass:: pyqtgraph.widgets.MatplotlibWidget.MatplotlibWidget
:members:
.. automethod:: pyqtgraph.widgets.MatplotlibWidget.MatplotlibWidget.__init__

8
documentation/source/widgets/pathbutton.rst Normal file
View File

@ -0,0 +1,8 @@
PathButton
==========
.. autoclass:: pyqtgraph.PathButton
:members:
.. automethod:: pyqtgraph.PathButton.__init__

8
documentation/source/widgets/remotegraphicsview.rst Normal file
View File

@ -0,0 +1,8 @@
RemoteGraphicsView
==================
.. autoclass:: pyqtgraph.widgets.RemoteGraphicsView.RemoteGraphicsView
:members:
.. automethod:: pyqtgraph.widgets.RemoteGraphicsView.RemoteGraphicsView.__init__

8
documentation/source/widgets/valuelabel.rst Normal file
View File

@ -0,0 +1,8 @@
ValueLabel
==========
.. autoclass:: pyqtgraph.ValueLabel
:members:
.. automethod:: pyqtgraph.ValueLabel.__init__

29
widgets/ValueLabel.py
View File

@ -9,22 +9,25 @@ class ValueLabel(QtGui.QLabel):
"""
QLabel specifically for displaying numerical values.
Extends QLabel adding some extra functionality:
- displaying units with si prefix
- built-in exponential averaging
- displaying units with si prefix
- built-in exponential averaging
"""
def __init__(self, parent=None, suffix='', siPrefix=False, averageTime=0, formatStr=None):
"""
Arguments:
*suffix* (str or None) The suffix to place after the value
*siPrefix* (bool) Whether to add an SI prefix to the units and display a scaled value
*averageTime* (float) The length of time in seconds to average values. If this value
is 0, then no averaging is performed. As this value increases
the display value will appear to change more slowly and smoothly.
*formatStr* (str) Optionally, provide a format string to use when displaying text. The text will
be generated by calling formatStr.format(value=, avgValue=, suffix=)
(see Python documentation on str.format)
This option is not compatible with siPrefix
============ ==================================================================================
Arguments
suffix (str or None) The suffix to place after the value
siPrefix (bool) Whether to add an SI prefix to the units and display a scaled value
averageTime (float) The length of time in seconds to average values. If this value
is 0, then no averaging is performed. As this value increases
the display value will appear to change more slowly and smoothly.
formatStr (str) Optionally, provide a format string to use when displaying text. The text
will be generated by calling formatStr.format(value=, avgValue=, suffix=)
(see Python documentation on str.format)
This option is not compatible with siPrefix
============ ==================================================================================
"""
QtGui.QLabel.__init__(self, parent)
self.values = []
@ -67,4 +70,4 @@ class ValueLabel(QtGui.QLabel):
return pg.siFormat(avg, suffix=self.suffix)
else:
return self.formatStr.format(value=val, avgValue=avg, suffix=self.suffix)