diff --git a/documentation/source/3dgraphics/glsurfaceplotitem.rst b/documentation/source/3dgraphics/glsurfaceplotitem.rst new file mode 100644 index 00000000..b6f4881e --- /dev/null +++ b/documentation/source/3dgraphics/glsurfaceplotitem.rst @@ -0,0 +1,8 @@ +GLSurfacePlotItem +================= + +.. autoclass:: pyqtgraph.opengl.GLSurfacePlotItem + :members: + + .. automethod:: pyqtgraph.opengl.GLSurfacePlotItem.__init__ + diff --git a/documentation/source/3dgraphics/index.rst b/documentation/source/3dgraphics/index.rst index d569db09..255f550b 100644 --- a/documentation/source/3dgraphics/index.rst +++ b/documentation/source/3dgraphics/index.rst @@ -16,9 +16,10 @@ Contents: glviewwidget glgriditem - glmeshitem + glsurfaceplotitem glvolumeitem glimageitem + glmeshitem glaxisitem glgraphicsitem glscatterplotitem diff --git a/documentation/source/3dgraphics/meshdata.rst b/documentation/source/3dgraphics/meshdata.rst index 3e08b92e..3a79a2bb 100644 --- a/documentation/source/3dgraphics/meshdata.rst +++ b/documentation/source/3dgraphics/meshdata.rst @@ -5,5 +5,4 @@ MeshData :members: .. automethod:: pyqtgraph.opengl.MeshData.MeshData.__init__ - .. automethod:: pyqtgraph.opengl.MeshData.MeshData.__iter__ diff --git a/documentation/source/graphicsItems/fillbetweenitem.rst b/documentation/source/graphicsItems/fillbetweenitem.rst new file mode 100644 index 00000000..680f29cc --- /dev/null +++ b/documentation/source/graphicsItems/fillbetweenitem.rst @@ -0,0 +1,8 @@ +FillBetweenItem +=============== + +.. autoclass:: pyqtgraph.FillBetweenItem + :members: + + .. automethod:: pyqtgraph.FillBetweenItem.__init__ + diff --git a/documentation/source/graphicsItems/graphicswidgetanchor.rst b/documentation/source/graphicsItems/graphicswidgetanchor.rst new file mode 100644 index 00000000..e0f9d6a7 --- /dev/null +++ b/documentation/source/graphicsItems/graphicswidgetanchor.rst @@ -0,0 +1,8 @@ +GraphicsWidgetAnchor +==================== + +.. autoclass:: pyqtgraph.GraphicsWidgetAnchor + :members: + + .. automethod:: pyqtgraph.GraphicsWidgetAnchor.__init__ + diff --git a/documentation/source/graphicsItems/index.rst b/documentation/source/graphicsItems/index.rst index d618fb83..70786d20 100644 --- a/documentation/source/graphicsItems/index.rst +++ b/documentation/source/graphicsItems/index.rst @@ -23,6 +23,7 @@ Contents: axisitem textitem arrowitem + fillbetweenitem curvepoint curvearrow griditem @@ -38,4 +39,5 @@ Contents: graphicswidget graphicsitem uigraphicsitem + graphicswidgetanchor diff --git a/documentation/source/widgets/busycursor.rst b/documentation/source/widgets/busycursor.rst new file mode 100644 index 00000000..32e1977d --- /dev/null +++ b/documentation/source/widgets/busycursor.rst @@ -0,0 +1,8 @@ +BusyCursor +========== + +.. autoclass:: pyqtgraph.BusyCursor + :members: + + .. automethod:: pyqtgraph.BusyCursor.__init__ + diff --git a/documentation/source/widgets/combobox.rst b/documentation/source/widgets/combobox.rst new file mode 100644 index 00000000..9fbfd828 --- /dev/null +++ b/documentation/source/widgets/combobox.rst @@ -0,0 +1,8 @@ +ComboBox +======== + +.. autoclass:: pyqtgraph.ComboBox + :members: + + .. automethod:: pyqtgraph.ComboBox.__init__ + diff --git a/documentation/source/widgets/feedbackbutton.rst b/documentation/source/widgets/feedbackbutton.rst new file mode 100644 index 00000000..67102603 --- /dev/null +++ b/documentation/source/widgets/feedbackbutton.rst @@ -0,0 +1,8 @@ +FeedbackButton +============== + +.. autoclass:: pyqtgraph.FeedbackButton + :members: + + .. automethod:: pyqtgraph.FeedbackButton.__init__ + diff --git a/documentation/source/widgets/index.rst b/documentation/source/widgets/index.rst index bfcf34ee..913557b7 100644 --- a/documentation/source/widgets/index.rst +++ b/documentation/source/widgets/index.rst @@ -30,4 +30,11 @@ Contents: joystickbutton multiplotwidget verticallabel - + remotegraphicsview + matplotlibwidget + feedbackbutton + combobox + layoutwidget + pathbutton + valuelabel + busycursor diff --git a/documentation/source/widgets/layoutwidget.rst b/documentation/source/widgets/layoutwidget.rst new file mode 100644 index 00000000..98090a6a --- /dev/null +++ b/documentation/source/widgets/layoutwidget.rst @@ -0,0 +1,8 @@ +LayoutWidget +============ + +.. autoclass:: pyqtgraph.LayoutWidget + :members: + + .. automethod:: pyqtgraph.LayoutWidget.__init__ + diff --git a/documentation/source/widgets/matplotlibwidget.rst b/documentation/source/widgets/matplotlibwidget.rst new file mode 100644 index 00000000..1823495d --- /dev/null +++ b/documentation/source/widgets/matplotlibwidget.rst @@ -0,0 +1,8 @@ +MatplotlibWidget +================ + +.. autoclass:: pyqtgraph.widgets.MatplotlibWidget.MatplotlibWidget + :members: + + .. automethod:: pyqtgraph.widgets.MatplotlibWidget.MatplotlibWidget.__init__ + diff --git a/documentation/source/widgets/pathbutton.rst b/documentation/source/widgets/pathbutton.rst new file mode 100644 index 00000000..13298f47 --- /dev/null +++ b/documentation/source/widgets/pathbutton.rst @@ -0,0 +1,8 @@ +PathButton +========== + +.. autoclass:: pyqtgraph.PathButton + :members: + + .. automethod:: pyqtgraph.PathButton.__init__ + diff --git a/documentation/source/widgets/remotegraphicsview.rst b/documentation/source/widgets/remotegraphicsview.rst new file mode 100644 index 00000000..c6c48c25 --- /dev/null +++ b/documentation/source/widgets/remotegraphicsview.rst @@ -0,0 +1,8 @@ +RemoteGraphicsView +================== + +.. autoclass:: pyqtgraph.widgets.RemoteGraphicsView.RemoteGraphicsView + :members: + + .. automethod:: pyqtgraph.widgets.RemoteGraphicsView.RemoteGraphicsView.__init__ + diff --git a/documentation/source/widgets/valuelabel.rst b/documentation/source/widgets/valuelabel.rst new file mode 100644 index 00000000..f87a6b14 --- /dev/null +++ b/documentation/source/widgets/valuelabel.rst @@ -0,0 +1,8 @@ +ValueLabel +========== + +.. autoclass:: pyqtgraph.ValueLabel + :members: + + .. automethod:: pyqtgraph.ValueLabel.__init__ + diff --git a/widgets/ValueLabel.py b/widgets/ValueLabel.py index e32e6b14..7f6fa84b 100644 --- a/widgets/ValueLabel.py +++ b/widgets/ValueLabel.py @@ -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 +