documentation updates
This commit is contained in:
parent
d800ab03aa
commit
9cb199d971
8
documentation/source/3dgraphics/glsurfaceplotitem.rst
Normal file
8
documentation/source/3dgraphics/glsurfaceplotitem.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
GLSurfacePlotItem
|
||||||
|
=================
|
||||||
|
|
||||||
|
.. autoclass:: pyqtgraph.opengl.GLSurfacePlotItem
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. automethod:: pyqtgraph.opengl.GLSurfacePlotItem.__init__
|
||||||
|
|
@ -16,9 +16,10 @@ Contents:
|
|||||||
glviewwidget
|
glviewwidget
|
||||||
|
|
||||||
glgriditem
|
glgriditem
|
||||||
glmeshitem
|
glsurfaceplotitem
|
||||||
glvolumeitem
|
glvolumeitem
|
||||||
glimageitem
|
glimageitem
|
||||||
|
glmeshitem
|
||||||
glaxisitem
|
glaxisitem
|
||||||
glgraphicsitem
|
glgraphicsitem
|
||||||
glscatterplotitem
|
glscatterplotitem
|
||||||
|
@ -5,5 +5,4 @@ MeshData
|
|||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. automethod:: pyqtgraph.opengl.MeshData.MeshData.__init__
|
.. automethod:: pyqtgraph.opengl.MeshData.MeshData.__init__
|
||||||
.. automethod:: pyqtgraph.opengl.MeshData.MeshData.__iter__
|
|
||||||
|
|
||||||
|
8
documentation/source/graphicsItems/fillbetweenitem.rst
Normal file
8
documentation/source/graphicsItems/fillbetweenitem.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
FillBetweenItem
|
||||||
|
===============
|
||||||
|
|
||||||
|
.. autoclass:: pyqtgraph.FillBetweenItem
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. automethod:: pyqtgraph.FillBetweenItem.__init__
|
||||||
|
|
@ -0,0 +1,8 @@
|
|||||||
|
GraphicsWidgetAnchor
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. autoclass:: pyqtgraph.GraphicsWidgetAnchor
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. automethod:: pyqtgraph.GraphicsWidgetAnchor.__init__
|
||||||
|
|
@ -23,6 +23,7 @@ Contents:
|
|||||||
axisitem
|
axisitem
|
||||||
textitem
|
textitem
|
||||||
arrowitem
|
arrowitem
|
||||||
|
fillbetweenitem
|
||||||
curvepoint
|
curvepoint
|
||||||
curvearrow
|
curvearrow
|
||||||
griditem
|
griditem
|
||||||
@ -38,4 +39,5 @@ Contents:
|
|||||||
graphicswidget
|
graphicswidget
|
||||||
graphicsitem
|
graphicsitem
|
||||||
uigraphicsitem
|
uigraphicsitem
|
||||||
|
graphicswidgetanchor
|
||||||
|
|
||||||
|
8
documentation/source/widgets/busycursor.rst
Normal file
8
documentation/source/widgets/busycursor.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
BusyCursor
|
||||||
|
==========
|
||||||
|
|
||||||
|
.. autoclass:: pyqtgraph.BusyCursor
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. automethod:: pyqtgraph.BusyCursor.__init__
|
||||||
|
|
8
documentation/source/widgets/combobox.rst
Normal file
8
documentation/source/widgets/combobox.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
ComboBox
|
||||||
|
========
|
||||||
|
|
||||||
|
.. autoclass:: pyqtgraph.ComboBox
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. automethod:: pyqtgraph.ComboBox.__init__
|
||||||
|
|
8
documentation/source/widgets/feedbackbutton.rst
Normal file
8
documentation/source/widgets/feedbackbutton.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
FeedbackButton
|
||||||
|
==============
|
||||||
|
|
||||||
|
.. autoclass:: pyqtgraph.FeedbackButton
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. automethod:: pyqtgraph.FeedbackButton.__init__
|
||||||
|
|
@ -30,4 +30,11 @@ Contents:
|
|||||||
joystickbutton
|
joystickbutton
|
||||||
multiplotwidget
|
multiplotwidget
|
||||||
verticallabel
|
verticallabel
|
||||||
|
remotegraphicsview
|
||||||
|
matplotlibwidget
|
||||||
|
feedbackbutton
|
||||||
|
combobox
|
||||||
|
layoutwidget
|
||||||
|
pathbutton
|
||||||
|
valuelabel
|
||||||
|
busycursor
|
||||||
|
8
documentation/source/widgets/layoutwidget.rst
Normal file
8
documentation/source/widgets/layoutwidget.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
LayoutWidget
|
||||||
|
============
|
||||||
|
|
||||||
|
.. autoclass:: pyqtgraph.LayoutWidget
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. automethod:: pyqtgraph.LayoutWidget.__init__
|
||||||
|
|
8
documentation/source/widgets/matplotlibwidget.rst
Normal file
8
documentation/source/widgets/matplotlibwidget.rst
Normal 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
8
documentation/source/widgets/pathbutton.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
PathButton
|
||||||
|
==========
|
||||||
|
|
||||||
|
.. autoclass:: pyqtgraph.PathButton
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. automethod:: pyqtgraph.PathButton.__init__
|
||||||
|
|
8
documentation/source/widgets/remotegraphicsview.rst
Normal file
8
documentation/source/widgets/remotegraphicsview.rst
Normal 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
8
documentation/source/widgets/valuelabel.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
ValueLabel
|
||||||
|
==========
|
||||||
|
|
||||||
|
.. autoclass:: pyqtgraph.ValueLabel
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. automethod:: pyqtgraph.ValueLabel.__init__
|
||||||
|
|
@ -9,22 +9,25 @@ class ValueLabel(QtGui.QLabel):
|
|||||||
"""
|
"""
|
||||||
QLabel specifically for displaying numerical values.
|
QLabel specifically for displaying numerical values.
|
||||||
Extends QLabel adding some extra functionality:
|
Extends QLabel adding some extra functionality:
|
||||||
|
|
||||||
- displaying units with si prefix
|
- displaying units with si prefix
|
||||||
- built-in exponential averaging
|
- built-in exponential averaging
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, parent=None, suffix='', siPrefix=False, averageTime=0, formatStr=None):
|
def __init__(self, parent=None, suffix='', siPrefix=False, averageTime=0, formatStr=None):
|
||||||
"""
|
"""
|
||||||
Arguments:
|
============ ==================================================================================
|
||||||
*suffix* (str or None) The suffix to place after the value
|
Arguments
|
||||||
*siPrefix* (bool) Whether to add an SI prefix to the units and display a scaled value
|
suffix (str or None) The suffix to place after the value
|
||||||
*averageTime* (float) The length of time in seconds to average values. If this 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
|
is 0, then no averaging is performed. As this value increases
|
||||||
the display value will appear to change more slowly and smoothly.
|
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
|
formatStr (str) Optionally, provide a format string to use when displaying text. The text
|
||||||
be generated by calling formatStr.format(value=, avgValue=, suffix=)
|
will be generated by calling formatStr.format(value=, avgValue=, suffix=)
|
||||||
(see Python documentation on str.format)
|
(see Python documentation on str.format)
|
||||||
This option is not compatible with siPrefix
|
This option is not compatible with siPrefix
|
||||||
|
============ ==================================================================================
|
||||||
"""
|
"""
|
||||||
QtGui.QLabel.__init__(self, parent)
|
QtGui.QLabel.__init__(self, parent)
|
||||||
self.values = []
|
self.values = []
|
||||||
|
Loading…
Reference in New Issue
Block a user