Commit 9cb199d9 authored by Luke Campagnola's avatar Luke Campagnola
Browse files

documentation updates

parent d800ab03
GLSurfacePlotItem
=================
.. autoclass:: pyqtgraph.opengl.GLSurfacePlotItem
:members:
.. automethod:: pyqtgraph.opengl.GLSurfacePlotItem.__init__
......@@ -16,9 +16,10 @@ Contents:
glviewwidget
glgriditem
glmeshitem
glsurfaceplotitem
glvolumeitem
glimageitem
glmeshitem
glaxisitem
glgraphicsitem
glscatterplotitem
......
......@@ -5,5 +5,4 @@ MeshData
:members:
.. automethod:: pyqtgraph.opengl.MeshData.MeshData.__init__
.. automethod:: pyqtgraph.opengl.MeshData.MeshData.__iter__
FillBetweenItem
===============
.. autoclass:: pyqtgraph.FillBetweenItem
:members:
.. automethod:: pyqtgraph.FillBetweenItem.__init__
GraphicsWidgetAnchor
====================
.. autoclass:: pyqtgraph.GraphicsWidgetAnchor
:members:
.. automethod:: pyqtgraph.GraphicsWidgetAnchor.__init__
......@@ -23,6 +23,7 @@ Contents:
axisitem
textitem
arrowitem
fillbetweenitem
curvepoint
curvearrow
griditem
......@@ -38,4 +39,5 @@ Contents:
graphicswidget
graphicsitem
uigraphicsitem
graphicswidgetanchor
BusyCursor
==========
.. autoclass:: pyqtgraph.BusyCursor
:members:
.. automethod:: pyqtgraph.BusyCursor.__init__
ComboBox
========
.. autoclass:: pyqtgraph.ComboBox
:members:
.. automethod:: pyqtgraph.ComboBox.__init__
FeedbackButton
==============
.. autoclass:: pyqtgraph.FeedbackButton
:members:
.. automethod:: pyqtgraph.FeedbackButton.__init__
......@@ -30,4 +30,11 @@ Contents:
joystickbutton
multiplotwidget
verticallabel
remotegraphicsview
matplotlibwidget
feedbackbutton
combobox
layoutwidget
pathbutton
valuelabel
busycursor
LayoutWidget
============
.. autoclass:: pyqtgraph.LayoutWidget
:members:
.. automethod:: pyqtgraph.LayoutWidget.__init__
MatplotlibWidget
================
.. autoclass:: pyqtgraph.widgets.MatplotlibWidget.MatplotlibWidget
:members:
.. automethod:: pyqtgraph.widgets.MatplotlibWidget.MatplotlibWidget.__init__
PathButton
==========
.. autoclass:: pyqtgraph.PathButton
:members:
.. automethod:: pyqtgraph.PathButton.__init__
RemoteGraphicsView
==================
.. autoclass:: pyqtgraph.widgets.RemoteGraphicsView.RemoteGraphicsView
:members:
.. automethod:: pyqtgraph.widgets.RemoteGraphicsView.RemoteGraphicsView.__init__
ValueLabel
==========
.. autoclass:: pyqtgraph.ValueLabel
:members:
.. automethod:: pyqtgraph.ValueLabel.__init__
......@@ -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)
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment