diff --git a/.gitignore b/.gitignore
index b8e7af7387928a99edeba6ee825328439381a410..bd9cbb44be65a607c8bcc0052fc15911185d42c4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,3 +5,5 @@ build
MANIFEST
deb_build
dist
+.idea
+rtr.cvs
diff --git a/doc/source/functions.rst b/doc/source/functions.rst
index 556c5be04dfc4a1488b69be0d6ecb3b3ac183baa..ef11a4c1004743a94beb95f3cdcdabea78bb2c0d 100644
--- a/doc/source/functions.rst
+++ b/doc/source/functions.rst
@@ -1,4 +1,4 @@
-Pyqtgraph's Helper Functions
+PyQtGraph's Helper Functions
============================
Simple Data Display Functions
diff --git a/doc/source/images/plottingClasses.png b/doc/source/images/plottingClasses.png
index 7c8325a5bbe0809aa3b40ac3a8f76972b4d802a9..3f968f509c57cd8f8e42cf5e214893c13ffc9515 100644
Binary files a/doc/source/images/plottingClasses.png and b/doc/source/images/plottingClasses.png differ
diff --git a/doc/source/images/plottingClasses.svg b/doc/source/images/plottingClasses.svg
index 393d16d7bfacc4aadb2a2bf5ce0b0c303856854c..9d9cd902997c6e36843cff161067a5c823dd4f1e 100644
--- a/doc/source/images/plottingClasses.svg
+++ b/doc/source/images/plottingClasses.svg
@@ -13,7 +13,7 @@
height="268.51233"
id="svg2"
version="1.1"
- inkscape:version="0.48.1 r9760"
+ inkscape:version="0.48.4 r9939"
sodipodi:docname="plottingClasses.svg"
inkscape:export-filename="/home/luke/work/manis_lab/code/pyqtgraph/documentation/source/images/plottingClasses.png"
inkscape:export-xdpi="124.99"
@@ -50,12 +50,12 @@
inkscape:cx="383.64946"
inkscape:cy="21.059243"
inkscape:document-units="px"
- inkscape:current-layer="g3978"
+ inkscape:current-layer="g3891"
showgrid="false"
- inkscape:window-width="1400"
+ inkscape:window-width="1918"
inkscape:window-height="1030"
- inkscape:window-x="-3"
- inkscape:window-y="-3"
+ inkscape:window-x="1"
+ inkscape:window-y="0"
inkscape:window-maximized="1"
fit-margin-top="0"
fit-margin-left="0"
@@ -69,7 +69,7 @@
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
- <dc:title></dc:title>
+ <dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
@@ -345,7 +345,7 @@
id="tspan3897"
x="124.24876"
y="376.57013"
- style="font-size:18px">GraphicsLayoutItem(GraphicsItem)</tspan></text>
+ style="font-size:18px">GraphicsLayout(GraphicsItem)</tspan></text>
</g>
<g
transform="translate(17.172593,259.49748)"
diff --git a/doc/source/plotting.rst b/doc/source/plotting.rst
index ee9ed6dc0283638a6815f6b561cfabdd14c858a7..209569570cff19e06b1772709ebb9b094d4876dd 100644
--- a/doc/source/plotting.rst
+++ b/doc/source/plotting.rst
@@ -3,12 +3,12 @@ Plotting in pyqtgraph
There are a few basic ways to plot data in pyqtgraph:
-================================================================ ==================================================
-:func:`pyqtgraph.plot` Create a new plot window showing your data
-:func:`PlotWidget.plot() <pyqtgraph.PlotWidget.plot>` Add a new set of data to an existing plot widget
-:func:`PlotItem.plot() <pyqtgraph.PlotItem.plot>` Add a new set of data to an existing plot widget
-:func:`GraphicsWindow.addPlot() <pyqtgraph.GraphicsWindow.plot>` Add a new plot to a grid of plots
-================================================================ ==================================================
+=================================================================== ==================================================
+:func:`pyqtgraph.plot` Create a new plot window showing your data
+:func:`PlotWidget.plot() <pyqtgraph.PlotWidget.plot>` Add a new set of data to an existing plot widget
+:func:`PlotItem.plot() <pyqtgraph.PlotItem.plot>` Add a new set of data to an existing plot widget
+:func:`GraphicsLayout.addPlot() <pyqtgraph.GraphicsLayout.addPlot>` Add a new plot to a grid of plots
+=================================================================== ==================================================
All of these will accept the same basic arguments which control how the plot data is interpreted and displayed:
@@ -31,17 +31,17 @@ Organization of Plotting Classes
There are several classes invloved in displaying plot data. Most of these classes are instantiated automatically, but it is useful to understand how they are organized and relate to each other. Pyqtgraph is based heavily on Qt's GraphicsView framework--if you are not already familiar with this, it's worth reading about (but not essential). Most importantly: 1) Qt GUIs are composed of QWidgets, 2) A special widget called QGraphicsView is used for displaying complex graphics, and 3) QGraphicsItems define the objects that are displayed within a QGraphicsView.
* Data Classes (all subclasses of QGraphicsItem)
- * PlotCurveItem - Displays a plot line given x,y data
- * ScatterPlotItem - Displays points given x,y data
- * :class:`PlotDataItem <pyqtgraph.graphicsItems.PlotDataItem.PlotDataItem>` - Combines PlotCurveItem and ScatterPlotItem. The plotting functions discussed above create objects of this type.
+ * :class:`PlotCurveItem <pyqtgraph.PlotCurveItem>` - Displays a plot line given x,y data
+ * :class:`ScatterPlotItem <pyqtgraph.ScatterPlotItem>` - Displays points given x,y data
+ * :class:`PlotDataItem <pyqtgraph.PlotDataItem>` - Combines PlotCurveItem and ScatterPlotItem. The plotting functions discussed above create objects of this type.
* Container Classes (subclasses of QGraphicsItem; contain other QGraphicsItem objects and must be viewed from within a GraphicsView)
- * PlotItem - Contains a ViewBox for displaying data as well as AxisItems and labels for displaying the axes and title. This is a QGraphicsItem subclass and thus may only be used from within a GraphicsView
- * GraphicsLayoutItem - QGraphicsItem subclass which displays a grid of items. This is used to display multiple PlotItems together.
- * ViewBox - A QGraphicsItem subclass for displaying data. The user may scale/pan the contents of a ViewBox using the mouse. Typically all PlotData/PlotCurve/ScatterPlotItems are displayed from within a ViewBox.
- * AxisItem - Displays axis values, ticks, and labels. Most commonly used with PlotItem.
+ * :class:`PlotItem <pyqtgraph.PlotItem>` - Contains a ViewBox for displaying data as well as AxisItems and labels for displaying the axes and title. This is a QGraphicsItem subclass and thus may only be used from within a GraphicsView
+ * :class:`GraphicsLayout <pyqtgraph.GraphicsLayout>` - QGraphicsItem subclass which displays a grid of items. This is used to display multiple PlotItems together.
+ * :class:`ViewBox <pyqtgraph.ViewBox>` - A QGraphicsItem subclass for displaying data. The user may scale/pan the contents of a ViewBox using the mouse. Typically all PlotData/PlotCurve/ScatterPlotItems are displayed from within a ViewBox.
+ * :class:`AxisItem <pyqtgraph.AxisItem>` - Displays axis values, ticks, and labels. Most commonly used with PlotItem.
* Container Classes (subclasses of QWidget; may be embedded in PyQt GUIs)
- * PlotWidget - A subclass of GraphicsView with a single PlotItem displayed. Most of the methods provided by PlotItem are also available through PlotWidget.
- * GraphicsLayoutWidget - QWidget subclass displaying a single GraphicsLayoutItem. Most of the methods provided by GraphicsLayoutItem are also available through GraphicsLayoutWidget.
+ * :class:`PlotWidget <pyqtgraph.PlotWidget>` - A subclass of GraphicsView with a single PlotItem displayed. Most of the methods provided by PlotItem are also available through PlotWidget.
+ * :class:`GraphicsLayoutWidget <pyqtgraph.GraphicsLayoutWidget>` - QWidget subclass displaying a single GraphicsLayoutItem. Most of the methods provided by GraphicsLayoutItem are also available through GraphicsLayoutWidget.
.. image:: images/plottingClasses.png
diff --git a/doc/source/widgets/index.rst b/doc/source/widgets/index.rst
index 7e6973a27d4d92cefaef5d70ddb385aa614abe3a..9cfbc0c47192754955dedaf33dfd1c4f028f1169 100644
--- a/doc/source/widgets/index.rst
+++ b/doc/source/widgets/index.rst
@@ -1,9 +1,9 @@
.. _api_widgets:
-Pyqtgraph's Widgets
+PyQtGraph's Widgets
===================
-Pyqtgraph provides several QWidget subclasses which are useful for building user interfaces. These widgets can generally be used in any Qt application and provide functionality that is frequently useful in science and engineering applications.
+PyQtGraph provides several QWidget subclasses which are useful for building user interfaces. These widgets can generally be used in any Qt application and provide functionality that is frequently useful in science and engineering applications.
Contents:
@@ -17,10 +17,10 @@ Contents:
gradientwidget
histogramlutwidget
parametertree
+ consolewidget
colormapwidget
scatterplotwidget
graphicsview
- rawimagewidget
datatreewidget
tablewidget
treewidget
diff --git a/pyqtgraph/canvas/CanvasItem.py b/pyqtgraph/canvas/CanvasItem.py
index a808765c7ae23cd2aaf49472a37632b554b51ad3..b6ecbb396b53cad80256d04c4fc7fa6cc6ca1aa0 100644
--- a/pyqtgraph/canvas/CanvasItem.py
+++ b/pyqtgraph/canvas/CanvasItem.py
@@ -431,9 +431,12 @@ class CanvasItem(QtCore.QObject):
def selectionChanged(self, sel, multi):
"""
Inform the item that its selection state has changed.
- Arguments:
- sel: bool, whether the item is currently selected
- multi: bool, whether there are multiple items currently selected
+ ============== =========================================================
+ **Arguments:**
+ sel (bool) whether the item is currently selected
+ multi (bool) whether there are multiple items currently
+ selected
+ ============== =========================================================
"""
self.selectedAlone = sel and not multi
self.showSelectBox()
diff --git a/pyqtgraph/colormap.py b/pyqtgraph/colormap.py
index cb1e882e13f29f0bd7160c961ab2d7b8aca7bfb8..38c120970424d665cb46d924455b71a9f825daca 100644
--- a/pyqtgraph/colormap.py
+++ b/pyqtgraph/colormap.py
@@ -52,17 +52,17 @@ class ColorMap(object):
def __init__(self, pos, color, mode=None):
"""
- ========= ==============================================================
- Arguments
- pos Array of positions where each color is defined
- color Array of RGBA colors.
- Integer data types are interpreted as 0-255; float data types
- are interpreted as 0.0-1.0
- mode Array of color modes (ColorMap.RGB, HSV_POS, or HSV_NEG)
- indicating the color space that should be used when
- interpolating between stops. Note that the last mode value is
- ignored. By default, the mode is entirely RGB.
- ========= ==============================================================
+ =============== ==============================================================
+ **Arguments:**
+ pos Array of positions where each color is defined
+ color Array of RGBA colors.
+ Integer data types are interpreted as 0-255; float data types
+ are interpreted as 0.0-1.0
+ mode Array of color modes (ColorMap.RGB, HSV_POS, or HSV_NEG)
+ indicating the color space that should be used when
+ interpolating between stops. Note that the last mode value is
+ ignored. By default, the mode is entirely RGB.
+ =============== ==============================================================
"""
self.pos = pos
self.color = color
@@ -193,16 +193,16 @@ class ColorMap(object):
"""
Return an RGB(A) lookup table (ndarray).
- ============= ============================================================================
- **Arguments**
- start The starting value in the lookup table (default=0.0)
- stop The final value in the lookup table (default=1.0)
- nPts The number of points in the returned lookup table.
- alpha True, False, or None - Specifies whether or not alpha values are included
- in the table. If alpha is None, it will be automatically determined.
- mode Determines return type: 'byte' (0-255), 'float' (0.0-1.0), or 'qcolor'.
- See :func:`map() <pyqtgraph.ColorMap.map>`.
- ============= ============================================================================
+ =============== =============================================================================
+ **Arguments:**
+ start The starting value in the lookup table (default=0.0)
+ stop The final value in the lookup table (default=1.0)
+ nPts The number of points in the returned lookup table.
+ alpha True, False, or None - Specifies whether or not alpha values are included
+ in the table. If alpha is None, it will be automatically determined.
+ mode Determines return type: 'byte' (0-255), 'float' (0.0-1.0), or 'qcolor'.
+ See :func:`map() <pyqtgraph.ColorMap.map>`.
+ =============== =============================================================================
"""
if isinstance(mode, basestring):
mode = self.enumMap[mode.lower()]
diff --git a/pyqtgraph/console/Console.py b/pyqtgraph/console/Console.py
index 0cbd2c3ed78ce1e37f34397208996de182cd502d..6d77c4cfcd6718448b2db1861c5f6564ed3814bf 100644
--- a/pyqtgraph/console/Console.py
+++ b/pyqtgraph/console/Console.py
@@ -31,16 +31,16 @@ class ConsoleWidget(QtGui.QWidget):
def __init__(self, parent=None, namespace=None, historyFile=None, text=None, editor=None):
"""
- ============ ============================================================================
- Arguments:
- namespace dictionary containing the initial variables present in the default namespace
- historyFile optional file for storing command history
- text initial text to display in the console window
- editor optional string for invoking code editor (called when stack trace entries are
- double-clicked). May contain {fileName} and {lineNum} format keys. Example::
+ ============== ============================================================================
+ **Arguments:**
+ namespace dictionary containing the initial variables present in the default namespace
+ historyFile optional file for storing command history
+ text initial text to display in the console window
+ editor optional string for invoking code editor (called when stack trace entries are
+ double-clicked). May contain {fileName} and {lineNum} format keys. Example::
- editorCommand --loadfile {fileName} --gotoline {lineNum}
- ============ =============================================================================
+ editorCommand --loadfile {fileName} --gotoline {lineNum}
+ ============== =============================================================================
"""
QtGui.QWidget.__init__(self, parent)
if namespace is None:
diff --git a/pyqtgraph/debug.py b/pyqtgraph/debug.py
index 685780d444b98fd6125eb3d70902183eb778ec46..6b01c3398e5392c312ad4f32c2ab6f528924c9d9 100644
--- a/pyqtgraph/debug.py
+++ b/pyqtgraph/debug.py
@@ -828,7 +828,8 @@ def typeStr(obj):
def searchRefs(obj, *args):
"""Pseudo-interactive function for tracing references backward.
- Arguments:
+ **Arguments:**
+
obj: The initial object from which to start searching
args: A set of string or int arguments.
each integer selects one of obj's referrers to be the new 'obj'
@@ -840,7 +841,8 @@ def searchRefs(obj, *args):
ro: return obj
rr: return list of obj's referrers
- Examples:
+ Examples::
+
searchRefs(obj, 't') ## Print types of all objects referring to obj
searchRefs(obj, 't', 0, 't') ## ..then select the first referrer and print the types of its referrers
searchRefs(obj, 't', 0, 't', 'l') ## ..also print lengths of the last set of referrers
diff --git a/pyqtgraph/dockarea/DockArea.py b/pyqtgraph/dockarea/DockArea.py
index 5c367f0be4d35de78a49998bfce9fc849275d89d..a75d881d49db903e1453f2d92c15480aa50e3bca 100644
--- a/pyqtgraph/dockarea/DockArea.py
+++ b/pyqtgraph/dockarea/DockArea.py
@@ -36,16 +36,16 @@ class DockArea(Container, QtGui.QWidget, DockDrop):
def addDock(self, dock=None, position='bottom', relativeTo=None, **kwds):
"""Adds a dock to this area.
- =========== =================================================================
- Arguments:
- dock The new Dock object to add. If None, then a new Dock will be
- created.
- position 'bottom', 'top', 'left', 'right', 'above', or 'below'
- relativeTo If relativeTo is None, then the new Dock is added to fill an
- entire edge of the window. If relativeTo is another Dock, then
- the new Dock is placed adjacent to it (or in a tabbed
- configuration for 'above' and 'below').
- =========== =================================================================
+ ============== =================================================================
+ **Arguments:**
+ dock The new Dock object to add. If None, then a new Dock will be
+ created.
+ position 'bottom', 'top', 'left', 'right', 'above', or 'below'
+ relativeTo If relativeTo is None, then the new Dock is added to fill an
+ entire edge of the window. If relativeTo is another Dock, then
+ the new Dock is placed adjacent to it (or in a tabbed
+ configuration for 'above' and 'below').
+ ============== =================================================================
All extra keyword arguments are passed to Dock.__init__() if *dock* is
None.
diff --git a/pyqtgraph/flowchart/Node.py b/pyqtgraph/flowchart/Node.py
index b6ed1e0fb27b7fd9bb22992ccee83b9d2554b0fb..6ae87765a948b4d49874e837805fc8868ced8790 100644
--- a/pyqtgraph/flowchart/Node.py
+++ b/pyqtgraph/flowchart/Node.py
@@ -37,7 +37,7 @@ class Node(QtCore.QObject):
def __init__(self, name, terminals=None, allowAddInput=False, allowAddOutput=False, allowRemove=True):
"""
============== ============================================================
- Arguments
+ **Arguments:**
name The name of this specific node instance. It can be any
string, but must be unique within a flowchart. Usually,
we simply let the flowchart decide on a name when calling
diff --git a/pyqtgraph/flowchart/NodeLibrary.py b/pyqtgraph/flowchart/NodeLibrary.py
index a30ffb2a51362240e7a0d623d6172c07ea2e016d..8e04e97ddee4ee916a27a6ffe2f85084d2dc1dce 100644
--- a/pyqtgraph/flowchart/NodeLibrary.py
+++ b/pyqtgraph/flowchart/NodeLibrary.py
@@ -26,12 +26,14 @@ class NodeLibrary:
Register a new node type. If the type's name is already in use,
an exception will be raised (unless override=True).
- Arguments:
+ ============== =========================================================
+ **Arguments:**
- nodeClass - a subclass of Node (must have typ.nodeName)
- paths - list of tuples specifying the location(s) this
- type will appear in the library tree.
- override - if True, overwrite any class having the same name
+ nodeClass a subclass of Node (must have typ.nodeName)
+ paths list of tuples specifying the location(s) this
+ type will appear in the library tree.
+ override if True, overwrite any class having the same name
+ ============== =========================================================
"""
if not isNodeClass(nodeClass):
raise Exception("Object %s is not a Node subclass" % str(nodeClass))
diff --git a/pyqtgraph/functions.py b/pyqtgraph/functions.py
index db22f8a31d066ef31d4e17b8b332f5bc353057d0..427fb01dbb259b577191a6d124a3cb896f26385f 100644
--- a/pyqtgraph/functions.py
+++ b/pyqtgraph/functions.py
@@ -388,7 +388,7 @@ def affineSlice(data, shape, origin, vectors, axes, order=1, returnCoords=False,
For a graphical interface to this function, see :func:`ROI.getArrayRegion <pyqtgraph.ROI.getArrayRegion>`
============== ====================================================================================================
- Arguments:
+ **Arguments:**
*data* (ndarray) the original dataset
*shape* the shape of the slice to take (Note the return value may have more dimensions than len(shape))
*origin* the location in the original dataset that will become the origin of the sliced data.
@@ -751,36 +751,36 @@ def makeARGB(data, lut=None, levels=None, scale=None, useRGBA=False):
Both stages are optional.
- ============ ==================================================================================
- Arguments:
- data numpy array of int/float types. If
- levels List [min, max]; optionally rescale data before converting through the
- lookup table. The data is rescaled such that min->0 and max->*scale*::
-
- rescaled = (clip(data, min, max) - min) * (*scale* / (max - min))
-
- It is also possible to use a 2D (N,2) array of values for levels. In this case,
- it is assumed that each pair of min,max values in the levels array should be
- applied to a different subset of the input data (for example, the input data may
- already have RGB values and the levels are used to independently scale each
- channel). The use of this feature requires that levels.shape[0] == data.shape[-1].
- scale The maximum value to which data will be rescaled before being passed through the
- lookup table (or returned if there is no lookup table). By default this will
- be set to the length of the lookup table, or 256 is no lookup table is provided.
- For OpenGL color specifications (as in GLColor4f) use scale=1.0
- lut Optional lookup table (array with dtype=ubyte).
- Values in data will be converted to color by indexing directly from lut.
- The output data shape will be input.shape + lut.shape[1:].
-
- Note: the output of makeARGB will have the same dtype as the lookup table, so
- for conversion to QImage, the dtype must be ubyte.
-
- Lookup tables can be built using GradientWidget.
- useRGBA If True, the data is returned in RGBA order (useful for building OpenGL textures).
- The default is False, which returns in ARGB order for use with QImage
- (Note that 'ARGB' is a term used by the Qt documentation; the _actual_ order
- is BGRA).
- ============ ==================================================================================
+ ============== ==================================================================================
+ **Arguments:**
+ data numpy array of int/float types. If
+ levels List [min, max]; optionally rescale data before converting through the
+ lookup table. The data is rescaled such that min->0 and max->*scale*::
+
+ rescaled = (clip(data, min, max) - min) * (*scale* / (max - min))
+
+ It is also possible to use a 2D (N,2) array of values for levels. In this case,
+ it is assumed that each pair of min,max values in the levels array should be
+ applied to a different subset of the input data (for example, the input data may
+ already have RGB values and the levels are used to independently scale each
+ channel). The use of this feature requires that levels.shape[0] == data.shape[-1].
+ scale The maximum value to which data will be rescaled before being passed through the
+ lookup table (or returned if there is no lookup table). By default this will
+ be set to the length of the lookup table, or 256 is no lookup table is provided.
+ For OpenGL color specifications (as in GLColor4f) use scale=1.0
+ lut Optional lookup table (array with dtype=ubyte).
+ Values in data will be converted to color by indexing directly from lut.
+ The output data shape will be input.shape + lut.shape[1:].
+
+ Note: the output of makeARGB will have the same dtype as the lookup table, so
+ for conversion to QImage, the dtype must be ubyte.
+
+ Lookup tables can be built using GradientWidget.
+ useRGBA If True, the data is returned in RGBA order (useful for building OpenGL textures).
+ The default is False, which returns in ARGB order for use with QImage
+ (Note that 'ARGB' is a term used by the Qt documentation; the _actual_ order
+ is BGRA).
+ ============== ==================================================================================
"""
profile = debug.Profiler()
@@ -887,23 +887,23 @@ def makeQImage(imgData, alpha=None, copy=True, transpose=True):
pointing to the array which shares its data to prevent python
freeing that memory while the image is in use.
- =========== ===================================================================
- Arguments:
- imgData Array of data to convert. Must have shape (width, height, 3 or 4)
- and dtype=ubyte. The order of values in the 3rd axis must be
- (b, g, r, a).
- alpha If True, the QImage returned will have format ARGB32. If False,
- the format will be RGB32. By default, _alpha_ is True if
- array.shape[2] == 4.
- copy If True, the data is copied before converting to QImage.
- If False, the new QImage points directly to the data in the array.
- Note that the array must be contiguous for this to work
- (see numpy.ascontiguousarray).
- transpose If True (the default), the array x/y axes are transposed before
- creating the image. Note that Qt expects the axes to be in
- (height, width) order whereas pyqtgraph usually prefers the
- opposite.
- =========== ===================================================================
+ ============== ===================================================================
+ **Arguments:**
+ imgData Array of data to convert. Must have shape (width, height, 3 or 4)
+ and dtype=ubyte. The order of values in the 3rd axis must be
+ (b, g, r, a).
+ alpha If True, the QImage returned will have format ARGB32. If False,
+ the format will be RGB32. By default, _alpha_ is True if
+ array.shape[2] == 4.
+ copy If True, the data is copied before converting to QImage.
+ If False, the new QImage points directly to the data in the array.
+ Note that the array must be contiguous for this to work
+ (see numpy.ascontiguousarray).
+ transpose If True (the default), the array x/y axes are transposed before
+ creating the image. Note that Qt expects the axes to be in
+ (height, width) order whereas pyqtgraph usually prefers the
+ opposite.
+ ============== ===================================================================
"""
## create QImage from buffer
profile = debug.Profiler()
@@ -1286,19 +1286,19 @@ def isocurve(data, level, connected=False, extendToEdge=False, path=False):
"""
Generate isocurve from 2D data using marching squares algorithm.
- ============= =========================================================
- Arguments
- data 2D numpy array of scalar values
- level The level at which to generate an isosurface
- connected If False, return a single long list of point pairs
- If True, return multiple long lists of connected point
- locations. (This is slower but better for drawing
- continuous lines)
- extendToEdge If True, extend the curves to reach the exact edges of
- the data.
- path if True, return a QPainterPath rather than a list of
- vertex coordinates. This forces connected=True.
- ============= =========================================================
+ ============== =========================================================
+ **Arguments:**
+ data 2D numpy array of scalar values
+ level The level at which to generate an isosurface
+ connected If False, return a single long list of point pairs
+ If True, return multiple long lists of connected point
+ locations. (This is slower but better for drawing
+ continuous lines)
+ extendToEdge If True, extend the curves to reach the exact edges of
+ the data.
+ path if True, return a QPainterPath rather than a list of
+ vertex coordinates. This forces connected=True.
+ ============== =========================================================
This function is SLOW; plenty of room for optimization here.
"""
diff --git a/pyqtgraph/graphicsItems/ArrowItem.py b/pyqtgraph/graphicsItems/ArrowItem.py
index c98ba1279c334a769c49b84aefd662e05180b06f..77e6195f28b58a13889eac2c3bf0fd5e40b11c93 100644
--- a/pyqtgraph/graphicsItems/ArrowItem.py
+++ b/pyqtgraph/graphicsItems/ArrowItem.py
@@ -47,27 +47,27 @@ class ArrowItem(QtGui.QGraphicsPathItem):
Changes the appearance of the arrow.
All arguments are optional:
- ================= =================================================
- Keyword Arguments
- angle Orientation of the arrow in degrees. Default is
- 0; arrow pointing to the left.
- headLen Length of the arrow head, from tip to base.
- default=20
- headWidth Width of the arrow head at its base.
- tipAngle Angle of the tip of the arrow in degrees. Smaller
- values make a 'sharper' arrow. If tipAngle is
- specified, ot overrides headWidth. default=25
- baseAngle Angle of the base of the arrow head. Default is
- 0, which means that the base of the arrow head
- is perpendicular to the arrow tail.
- tailLen Length of the arrow tail, measured from the base
- of the arrow head to the end of the tail. If
- this value is None, no tail will be drawn.
- default=None
- tailWidth Width of the tail. default=3
- pen The pen used to draw the outline of the arrow.
- brush The brush used to fill the arrow.
- ================= =================================================
+ ====================== =================================================
+ **Keyword Arguments:**
+ angle Orientation of the arrow in degrees. Default is
+ 0; arrow pointing to the left.
+ headLen Length of the arrow head, from tip to base.
+ default=20
+ headWidth Width of the arrow head at its base.
+ tipAngle Angle of the tip of the arrow in degrees. Smaller
+ values make a 'sharper' arrow. If tipAngle is
+ specified, ot overrides headWidth. default=25
+ baseAngle Angle of the base of the arrow head. Default is
+ 0, which means that the base of the arrow head
+ is perpendicular to the arrow tail.
+ tailLen Length of the arrow tail, measured from the base
+ of the arrow head to the end of the tail. If
+ this value is None, no tail will be drawn.
+ default=None
+ tailWidth Width of the tail. default=3
+ pen The pen used to draw the outline of the arrow.
+ brush The brush used to fill the arrow.
+ ====================== =================================================
"""
self.opts.update(opts)
diff --git a/pyqtgraph/graphicsItems/AxisItem.py b/pyqtgraph/graphicsItems/AxisItem.py
index 69ad695c60c1ad414eed2f9702f572c7354995cf..409ec46f0f986796163aaa0ac8057fde9c2c49c9 100644
--- a/pyqtgraph/graphicsItems/AxisItem.py
+++ b/pyqtgraph/graphicsItems/AxisItem.py
@@ -156,17 +156,17 @@ class AxisItem(GraphicsWidget):
def setLabel(self, text=None, units=None, unitPrefix=None, **args):
"""Set the text displayed adjacent to the axis.
- ============= =============================================================
- Arguments
- text The text (excluding units) to display on the label for this
- axis.
- units The units for this axis. Units should generally be given
- without any scaling prefix (eg, 'V' instead of 'mV'). The
- scaling prefix will be automatically prepended based on the
- range of data displayed.
- \**args All extra keyword arguments become CSS style options for
- the <span> tag which will surround the axis label and units.
- ============= =============================================================
+ ============== =============================================================
+ **Arguments:**
+ text The text (excluding units) to display on the label for this
+ axis.
+ units The units for this axis. Units should generally be given
+ without any scaling prefix (eg, 'V' instead of 'mV'). The
+ scaling prefix will be automatically prepended based on the
+ range of data displayed.
+ \**args All extra keyword arguments become CSS style options for
+ the <span> tag which will surround the axis label and units.
+ ============== =============================================================
The final text generated for the label will look like::
diff --git a/pyqtgraph/graphicsItems/GradientEditorItem.py b/pyqtgraph/graphicsItems/GradientEditorItem.py
index f5158a741c39a2231ff16d3ac3d55b8348e3bbce..e16370f566ea2a5c2f91a63230c30a837ecad36b 100644
--- a/pyqtgraph/graphicsItems/GradientEditorItem.py
+++ b/pyqtgraph/graphicsItems/GradientEditorItem.py
@@ -35,14 +35,14 @@ class TickSliderItem(GraphicsWidget):
def __init__(self, orientation='bottom', allowAdd=True, **kargs):
"""
- ============= =================================================================================
- **Arguments**
- orientation Set the orientation of the gradient. Options are: 'left', 'right'
- 'top', and 'bottom'.
- allowAdd Specifies whether ticks can be added to the item by the user.
- tickPen Default is white. Specifies the color of the outline of the ticks.
- Can be any of the valid arguments for :func:`mkPen <pyqtgraph.mkPen>`
- ============= =================================================================================
+ ============== =================================================================================
+ **Arguments:**
+ orientation Set the orientation of the gradient. Options are: 'left', 'right'
+ 'top', and 'bottom'.
+ allowAdd Specifies whether ticks can be added to the item by the user.
+ tickPen Default is white. Specifies the color of the outline of the ticks.
+ Can be any of the valid arguments for :func:`mkPen <pyqtgraph.mkPen>`
+ ============== =================================================================================
"""
## public
GraphicsWidget.__init__(self)
@@ -103,13 +103,13 @@ class TickSliderItem(GraphicsWidget):
## public
"""Set the orientation of the TickSliderItem.
- ============= ===================================================================
- **Arguments**
- orientation Options are: 'left', 'right', 'top', 'bottom'
- The orientation option specifies which side of the slider the
- ticks are on, as well as whether the slider is vertical ('right'
- and 'left') or horizontal ('top' and 'bottom').
- ============= ===================================================================
+ ============== ===================================================================
+ **Arguments:**
+ orientation Options are: 'left', 'right', 'top', 'bottom'
+ The orientation option specifies which side of the slider the
+ ticks are on, as well as whether the slider is vertical ('right'
+ and 'left') or horizontal ('top' and 'bottom').
+ ============== ===================================================================
"""
self.orientation = orientation
self.setMaxDim()
@@ -136,13 +136,13 @@ class TickSliderItem(GraphicsWidget):
"""
Add a tick to the item.
- ============= ==================================================================
- **Arguments**
- x Position where tick should be added.
- color Color of added tick. If color is not specified, the color will be
- white.
- movable Specifies whether the tick is movable with the mouse.
- ============= ==================================================================
+ ============== ==================================================================
+ **Arguments:**
+ x Position where tick should be added.
+ color Color of added tick. If color is not specified, the color will be
+ white.
+ movable Specifies whether the tick is movable with the mouse.
+ ============== ==================================================================
"""
if color is None:
@@ -265,14 +265,14 @@ class TickSliderItem(GraphicsWidget):
def setTickColor(self, tick, color):
"""Set the color of the specified tick.
- ============= ==================================================================
- **Arguments**
- tick Can be either an integer corresponding to the index of the tick
- or a Tick object. Ex: if you had a slider with 3 ticks and you
- wanted to change the middle tick, the index would be 1.
- color The color to make the tick. Can be any argument that is valid for
- :func:`mkBrush <pyqtgraph.mkBrush>`
- ============= ==================================================================
+ ============== ==================================================================
+ **Arguments:**
+ tick Can be either an integer corresponding to the index of the tick
+ or a Tick object. Ex: if you had a slider with 3 ticks and you
+ wanted to change the middle tick, the index would be 1.
+ color The color to make the tick. Can be any argument that is valid for
+ :func:`mkBrush <pyqtgraph.mkBrush>`
+ ============== ==================================================================
"""
tick = self.getTick(tick)
tick.color = color
@@ -284,14 +284,14 @@ class TickSliderItem(GraphicsWidget):
"""
Set the position (along the slider) of the tick.
- ============= ==================================================================
- **Arguments**
- tick Can be either an integer corresponding to the index of the tick
- or a Tick object. Ex: if you had a slider with 3 ticks and you
- wanted to change the middle tick, the index would be 1.
- val The desired position of the tick. If val is < 0, position will be
- set to 0. If val is > 1, position will be set to 1.
- ============= ==================================================================
+ ============== ==================================================================
+ **Arguments:**
+ tick Can be either an integer corresponding to the index of the tick
+ or a Tick object. Ex: if you had a slider with 3 ticks and you
+ wanted to change the middle tick, the index would be 1.
+ val The desired position of the tick. If val is < 0, position will be
+ set to 0. If val is > 1, position will be set to 1.
+ ============== ==================================================================
"""
tick = self.getTick(tick)
val = min(max(0.0, val), 1.0)
@@ -305,12 +305,12 @@ class TickSliderItem(GraphicsWidget):
## public
"""Return the value (from 0.0 to 1.0) of the specified tick.
- ============= ==================================================================
- **Arguments**
- tick Can be either an integer corresponding to the index of the tick
- or a Tick object. Ex: if you had a slider with 3 ticks and you
- wanted the value of the middle tick, the index would be 1.
- ============= ==================================================================
+ ============== ==================================================================
+ **Arguments:**
+ tick Can be either an integer corresponding to the index of the tick
+ or a Tick object. Ex: if you had a slider with 3 ticks and you
+ wanted the value of the middle tick, the index would be 1.
+ ============== ==================================================================
"""
tick = self.getTick(tick)
return self.ticks[tick]
@@ -319,11 +319,11 @@ class TickSliderItem(GraphicsWidget):
## public
"""Return the Tick object at the specified index.
- ============= ==================================================================
- **Arguments**
- tick An integer corresponding to the index of the desired tick. If the
- argument is not an integer it will be returned unchanged.
- ============= ==================================================================
+ ============== ==================================================================
+ **Arguments:**
+ tick An integer corresponding to the index of the desired tick. If the
+ argument is not an integer it will be returned unchanged.
+ ============== ==================================================================
"""
if type(tick) is int:
tick = self.listTicks()[tick][0]
@@ -349,7 +349,7 @@ class GradientEditorItem(TickSliderItem):
with a GradientEditorItem that can be added to a GUI.
================================ ===========================================================
- **Signals**
+ **Signals:**
sigGradientChanged(self) Signal is emitted anytime the gradient changes. The signal
is emitted in real time while ticks are being dragged or
colors are being changed.
@@ -366,14 +366,14 @@ class GradientEditorItem(TickSliderItem):
Create a new GradientEditorItem.
All arguments are passed to :func:`TickSliderItem.__init__ <pyqtgraph.TickSliderItem.__init__>`
- ============= =================================================================================
- **Arguments**
- orientation Set the orientation of the gradient. Options are: 'left', 'right'
- 'top', and 'bottom'.
- allowAdd Default is True. Specifies whether ticks can be added to the item.
- tickPen Default is white. Specifies the color of the outline of the ticks.
- Can be any of the valid arguments for :func:`mkPen <pyqtgraph.mkPen>`
- ============= =================================================================================
+ =============== =================================================================================
+ **Arguments:**
+ orientation Set the orientation of the gradient. Options are: 'left', 'right'
+ 'top', and 'bottom'.
+ allowAdd Default is True. Specifies whether ticks can be added to the item.
+ tickPen Default is white. Specifies the color of the outline of the ticks.
+ Can be any of the valid arguments for :func:`mkPen <pyqtgraph.mkPen>`
+ =============== =================================================================================
"""
self.currentTick = None
self.currentTickColor = None
@@ -445,13 +445,13 @@ class GradientEditorItem(TickSliderItem):
"""
Set the orientation of the GradientEditorItem.
- ============= ===================================================================
- **Arguments**
- orientation Options are: 'left', 'right', 'top', 'bottom'
- The orientation option specifies which side of the gradient the
- ticks are on, as well as whether the gradient is vertical ('right'
- and 'left') or horizontal ('top' and 'bottom').
- ============= ===================================================================
+ ============== ===================================================================
+ **Arguments:**
+ orientation Options are: 'left', 'right', 'top', 'bottom'
+ The orientation option specifies which side of the gradient the
+ ticks are on, as well as whether the gradient is vertical ('right'
+ and 'left') or horizontal ('top' and 'bottom').
+ ============== ===================================================================
"""
TickSliderItem.setOrientation(self, orientation)
self.translate(0, self.rectSize)
@@ -588,11 +588,11 @@ class GradientEditorItem(TickSliderItem):
"""
Return a color for a given value.
- ============= ==================================================================
- **Arguments**
- x Value (position on gradient) of requested color.
- toQColor If true, returns a QColor object, else returns a (r,g,b,a) tuple.
- ============= ==================================================================
+ ============== ==================================================================
+ **Arguments:**
+ x Value (position on gradient) of requested color.
+ toQColor If true, returns a QColor object, else returns a (r,g,b,a) tuple.
+ ============== ==================================================================
"""
ticks = self.listTicks()
if x <= ticks[0][1]:
@@ -648,12 +648,12 @@ class GradientEditorItem(TickSliderItem):
"""
Return an RGB(A) lookup table (ndarray).
- ============= ============================================================================
- **Arguments**
- nPts The number of points in the returned lookup table.
- alpha True, False, or None - Specifies whether or not alpha values are included
- in the table.If alpha is None, alpha will be automatically determined.
- ============= ============================================================================
+ ============== ============================================================================
+ **Arguments:**
+ nPts The number of points in the returned lookup table.
+ alpha True, False, or None - Specifies whether or not alpha values are included
+ in the table.If alpha is None, alpha will be automatically determined.
+ ============== ============================================================================
"""
if alpha is None:
alpha = self.usesAlpha()
@@ -702,13 +702,13 @@ class GradientEditorItem(TickSliderItem):
"""
Add a tick to the gradient. Return the tick.
- ============= ==================================================================
- **Arguments**
- x Position where tick should be added.
- color Color of added tick. If color is not specified, the color will be
- the color of the gradient at the specified position.
- movable Specifies whether the tick is movable with the mouse.
- ============= ==================================================================
+ ============== ==================================================================
+ **Arguments:**
+ x Position where tick should be added.
+ color Color of added tick. If color is not specified, the color will be
+ the color of the gradient at the specified position.
+ movable Specifies whether the tick is movable with the mouse.
+ ============== ==================================================================
"""
@@ -748,16 +748,16 @@ class GradientEditorItem(TickSliderItem):
"""
Restore the gradient specified in state.
- ============= ====================================================================
- **Arguments**
- state A dictionary with same structure as those returned by
- :func:`saveState <pyqtgraph.GradientEditorItem.saveState>`
+ ============== ====================================================================
+ **Arguments:**
+ state A dictionary with same structure as those returned by
+ :func:`saveState <pyqtgraph.GradientEditorItem.saveState>`
- Keys must include:
+ Keys must include:
- - 'mode': hsv or rgb
- - 'ticks': a list of tuples (pos, (r,g,b,a))
- ============= ====================================================================
+ - 'mode': hsv or rgb
+ - 'ticks': a list of tuples (pos, (r,g,b,a))
+ ============== ====================================================================
"""
## public
self.setColorMode(state['mode'])
diff --git a/pyqtgraph/graphicsItems/GraphItem.py b/pyqtgraph/graphicsItems/GraphItem.py
index 97759522e4dbd5f8d39749a95014167957c49218..6860790cc806cec2b1f501417ce7b666dccf646c 100644
--- a/pyqtgraph/graphicsItems/GraphItem.py
+++ b/pyqtgraph/graphicsItems/GraphItem.py
@@ -28,29 +28,29 @@ class GraphItem(GraphicsObject):
"""
Change the data displayed by the graph.
- ============ =========================================================
- Arguments
- pos (N,2) array of the positions of each node in the graph.
- adj (M,2) array of connection data. Each row contains indexes
- of two nodes that are connected.
- pen The pen to use when drawing lines between connected
- nodes. May be one of:
+ ============== =========================================================
+ **Arguments:**
+ pos (N,2) array of the positions of each node in the graph.
+ adj (M,2) array of connection data. Each row contains indexes
+ of two nodes that are connected.
+ pen The pen to use when drawing lines between connected
+ nodes. May be one of:
- * QPen
- * a single argument to pass to pg.mkPen
- * a record array of length M
- with fields (red, green, blue, alpha, width). Note
- that using this option may have a significant performance
- cost.
- * None (to disable connection drawing)
- * 'default' to use the default foreground color.
+ * QPen
+ * a single argument to pass to pg.mkPen
+ * a record array of length M
+ with fields (red, green, blue, alpha, width). Note
+ that using this option may have a significant performance
+ cost.
+ * None (to disable connection drawing)
+ * 'default' to use the default foreground color.
- symbolPen The pen used for drawing nodes.
- ``**opts`` All other keyword arguments are given to
- :func:`ScatterPlotItem.setData() <pyqtgraph.ScatterPlotItem.setData>`
- to affect the appearance of nodes (symbol, size, brush,
- etc.)
- ============ =========================================================
+ symbolPen The pen used for drawing nodes.
+ ``**opts`` All other keyword arguments are given to
+ :func:`ScatterPlotItem.setData() <pyqtgraph.ScatterPlotItem.setData>`
+ to affect the appearance of nodes (symbol, size, brush,
+ etc.)
+ ============== =========================================================
"""
if 'adj' in kwds:
self.adjacency = kwds.pop('adj')
diff --git a/pyqtgraph/graphicsItems/InfiniteLine.py b/pyqtgraph/graphicsItems/InfiniteLine.py
index edf6b19e0b4db5b3e333472edae016a6bcc2b7f1..08a55f83cdcd59b8a61ea57eb2ac966756e14248 100644
--- a/pyqtgraph/graphicsItems/InfiniteLine.py
+++ b/pyqtgraph/graphicsItems/InfiniteLine.py
@@ -15,7 +15,7 @@ class InfiniteLine(GraphicsObject):
This line may be dragged to indicate a position in data coordinates.
=============================== ===================================================
- **Signals**
+ **Signals:**
sigDragged(self)
sigPositionChangeFinished(self)
sigPositionChanged(self)
@@ -28,18 +28,18 @@ class InfiniteLine(GraphicsObject):
def __init__(self, pos=None, angle=90, pen=None, movable=False, bounds=None):
"""
- ============= ==================================================================
- **Arguments**
- pos Position of the line. This can be a QPointF or a single value for
- vertical/horizontal lines.
- angle Angle of line in degrees. 0 is horizontal, 90 is vertical.
- pen Pen to use when drawing line. Can be any arguments that are valid
- for :func:`mkPen <pyqtgraph.mkPen>`. Default pen is transparent
- yellow.
- movable If True, the line can be dragged to a new position by the user.
- bounds Optional [min, max] bounding values. Bounds are only valid if the
- line is vertical or horizontal.
- ============= ==================================================================
+ =============== ==================================================================
+ **Arguments:**
+ pos Position of the line. This can be a QPointF or a single value for
+ vertical/horizontal lines.
+ angle Angle of line in degrees. 0 is horizontal, 90 is vertical.
+ pen Pen to use when drawing line. Can be any arguments that are valid
+ for :func:`mkPen <pyqtgraph.mkPen>`. Default pen is transparent
+ yellow.
+ movable If True, the line can be dragged to a new position by the user.
+ bounds Optional [min, max] bounding values. Bounds are only valid if the
+ line is vertical or horizontal.
+ =============== ==================================================================
"""
GraphicsObject.__init__(self)
diff --git a/pyqtgraph/graphicsItems/IsocurveItem.py b/pyqtgraph/graphicsItems/IsocurveItem.py
index 71113ba8ff5b4a52c74d1a738fd921e12ddd49e8..897df9992d025fbfbc8e726b2a2caedfab5d609c 100644
--- a/pyqtgraph/graphicsItems/IsocurveItem.py
+++ b/pyqtgraph/graphicsItems/IsocurveItem.py
@@ -18,14 +18,14 @@ class IsocurveItem(GraphicsObject):
"""
Create a new isocurve item.
- ============= ===============================================================
- **Arguments**
- data A 2-dimensional ndarray. Can be initialized as None, and set
- later using :func:`setData <pyqtgraph.IsocurveItem.setData>`
- level The cutoff value at which to draw the isocurve.
- pen The color of the curve item. Can be anything valid for
- :func:`mkPen <pyqtgraph.mkPen>`
- ============= ===============================================================
+ ============== ===============================================================
+ **Arguments:**
+ data A 2-dimensional ndarray. Can be initialized as None, and set
+ later using :func:`setData <pyqtgraph.IsocurveItem.setData>`
+ level The cutoff value at which to draw the isocurve.
+ pen The color of the curve item. Can be anything valid for
+ :func:`mkPen <pyqtgraph.mkPen>`
+ ============== ===============================================================
"""
GraphicsObject.__init__(self)
@@ -45,12 +45,12 @@ class IsocurveItem(GraphicsObject):
"""
Set the data/image to draw isocurves for.
- ============= ========================================================================
- **Arguments**
- data A 2-dimensional ndarray.
- level The cutoff value at which to draw the curve. If level is not specified,
- the previously set level is used.
- ============= ========================================================================
+ ============== ========================================================================
+ **Arguments:**
+ data A 2-dimensional ndarray.
+ level The cutoff value at which to draw the curve. If level is not specified,
+ the previously set level is used.
+ ============== ========================================================================
"""
if level is None:
level = self.level
diff --git a/pyqtgraph/graphicsItems/LegendItem.py b/pyqtgraph/graphicsItems/LegendItem.py
index ba6a6897761277bad25d898529dd16710fac4ba7..ea6798fb8e19b522d09af97a4d9b2153b2d742b2 100644
--- a/pyqtgraph/graphicsItems/LegendItem.py
+++ b/pyqtgraph/graphicsItems/LegendItem.py
@@ -21,17 +21,17 @@ class LegendItem(GraphicsWidget, GraphicsWidgetAnchor):
"""
def __init__(self, size=None, offset=None):
"""
- ========== ===============================================================
- Arguments
- size Specifies the fixed size (width, height) of the legend. If
- this argument is omitted, the legend will autimatically resize
- to fit its contents.
- offset Specifies the offset position relative to the legend's parent.
- Positive values offset from the left or top; negative values
- offset from the right or bottom. If offset is None, the
- legend must be anchored manually by calling anchor() or
- positioned by calling setPos().
- ========== ===============================================================
+ ============== ===============================================================
+ **Arguments:**
+ size Specifies the fixed size (width, height) of the legend. If
+ this argument is omitted, the legend will autimatically resize
+ to fit its contents.
+ offset Specifies the offset position relative to the legend's parent.
+ Positive values offset from the left or top; negative values
+ offset from the right or bottom. If offset is None, the
+ legend must be anchored manually by calling anchor() or
+ positioned by calling setPos().
+ ============== ===============================================================
"""
@@ -61,14 +61,14 @@ class LegendItem(GraphicsWidget, GraphicsWidgetAnchor):
"""
Add a new entry to the legend.
- =========== ========================================================
- Arguments
- item A PlotDataItem from which the line and point style
- of the item will be determined or an instance of
- ItemSample (or a subclass), allowing the item display
- to be customized.
- title The title to display for this item. Simple HTML allowed.
- =========== ========================================================
+ ============== ========================================================
+ **Arguments:**
+ item A PlotDataItem from which the line and point style
+ of the item will be determined or an instance of
+ ItemSample (or a subclass), allowing the item display
+ to be customized.
+ title The title to display for this item. Simple HTML allowed.
+ ============== ========================================================
"""
label = LabelItem(name)
if isinstance(item, ItemSample):
@@ -85,10 +85,10 @@ class LegendItem(GraphicsWidget, GraphicsWidgetAnchor):
"""
Removes one item from the legend.
- =========== ========================================================
- Arguments
- title The title displayed for this item.
- =========== ========================================================
+ ============== ========================================================
+ **Arguments:**
+ title The title displayed for this item.
+ ============== ========================================================
"""
# Thanks, Ulrich!
# cycle for a match
diff --git a/pyqtgraph/graphicsItems/LinearRegionItem.py b/pyqtgraph/graphicsItems/LinearRegionItem.py
index 4f9d28dc9e617705577d7955b2c2a209c7f6350f..e139190bc4d7a044fbe1edf3edc01e418dd159c8 100644
--- a/pyqtgraph/graphicsItems/LinearRegionItem.py
+++ b/pyqtgraph/graphicsItems/LinearRegionItem.py
@@ -30,19 +30,19 @@ class LinearRegionItem(UIGraphicsItem):
def __init__(self, values=[0,1], orientation=None, brush=None, movable=True, bounds=None):
"""Create a new LinearRegionItem.
- ============= =====================================================================
- **Arguments**
- values A list of the positions of the lines in the region. These are not
- limits; limits can be set by specifying bounds.
- orientation Options are LinearRegionItem.Vertical or LinearRegionItem.Horizontal.
- If not specified it will be vertical.
- brush Defines the brush that fills the region. Can be any arguments that
- are valid for :func:`mkBrush <pyqtgraph.mkBrush>`. Default is
- transparent blue.
- movable If True, the region and individual lines are movable by the user; if
- False, they are static.
- bounds Optional [min, max] bounding values for the region
- ============= =====================================================================
+ ============== =====================================================================
+ **Arguments:**
+ values A list of the positions of the lines in the region. These are not
+ limits; limits can be set by specifying bounds.
+ orientation Options are LinearRegionItem.Vertical or LinearRegionItem.Horizontal.
+ If not specified it will be vertical.
+ brush Defines the brush that fills the region. Can be any arguments that
+ are valid for :func:`mkBrush <pyqtgraph.mkBrush>`. Default is
+ transparent blue.
+ movable If True, the region and individual lines are movable by the user; if
+ False, they are static.
+ bounds Optional [min, max] bounding values for the region
+ ============== =====================================================================
"""
UIGraphicsItem.__init__(self)
@@ -89,10 +89,10 @@ class LinearRegionItem(UIGraphicsItem):
def setRegion(self, rgn):
"""Set the values for the edges of the region.
- ============= ==============================================
- **Arguments**
- rgn A list or tuple of the lower and upper values.
- ============= ==============================================
+ ============== ==============================================
+ **Arguments:**
+ rgn A list or tuple of the lower and upper values.
+ ============== ==============================================
"""
if self.lines[0].value() == rgn[0] and self.lines[1].value() == rgn[1]:
return
diff --git a/pyqtgraph/graphicsItems/PlotDataItem.py b/pyqtgraph/graphicsItems/PlotDataItem.py
index 29d48db6ebadf14c48055932ed72bb8d878f378e..d2d18fd91d330fde1d07d40408ac5c39a6d18282 100644
--- a/pyqtgraph/graphicsItems/PlotDataItem.py
+++ b/pyqtgraph/graphicsItems/PlotDataItem.py
@@ -56,10 +56,11 @@ class PlotDataItem(GraphicsObject):
=========================== =========================================
**Line style keyword arguments:**
+
========== ==============================================================================
- connect Specifies how / whether vertexes should be connected.
- See :func:`arrayToQPath() <pyqtgraph.arrayToQPath>`
- pen Pen to use for drawing line between points.
+ connect Specifies how / whether vertexes should be connected. See
+ :func:`arrayToQPath() <pyqtgraph.arrayToQPath>`
+ pen Pen to use for drawing line between points.
Default is solid grey, 1px width. Use None to disable line drawing.
May be any single argument accepted by :func:`mkPen() <pyqtgraph.mkPen>`
shadowPen Pen for secondary line to draw behind the primary line. disabled by default.
@@ -294,18 +295,18 @@ class PlotDataItem(GraphicsObject):
Set the downsampling mode of this item. Downsampling reduces the number
of samples drawn to increase performance.
- =========== =================================================================
- Arguments
- ds (int) Reduce visible plot samples by this factor. To disable,
- set ds=1.
- auto (bool) If True, automatically pick *ds* based on visible range.
- mode 'subsample': Downsample by taking the first of N samples.
- This method is fastest and least accurate.
- 'mean': Downsample by taking the mean of N samples.
- 'peak': Downsample by drawing a saw wave that follows the min
- and max of the original data. This method produces the best
- visual representation of the data but is slower.
- =========== =================================================================
+ ============== =================================================================
+ **Arguments:**
+ ds (int) Reduce visible plot samples by this factor. To disable,
+ set ds=1.
+ auto (bool) If True, automatically pick *ds* based on visible range
+ mode 'subsample': Downsample by taking the first of N samples.
+ This method is fastest and least accurate.
+ 'mean': Downsample by taking the mean of N samples.
+ 'peak': Downsample by drawing a saw wave that follows the min
+ and max of the original data. This method produces the best
+ visual representation of the data but is slower.
+ ============== =================================================================
"""
changed = False
if ds is not None:
diff --git a/pyqtgraph/graphicsItems/PlotItem/PlotItem.py b/pyqtgraph/graphicsItems/PlotItem/PlotItem.py
index 77413fc2e7206232939167cea1ad5d1d410eb594..7c02a534ff73266fc430e255b089747a62ec7ae9 100644
--- a/pyqtgraph/graphicsItems/PlotItem/PlotItem.py
+++ b/pyqtgraph/graphicsItems/PlotItem/PlotItem.py
@@ -83,7 +83,7 @@ class PlotItem(GraphicsWidget):
The ViewBox itself can be accessed by calling :func:`getViewBox() <pyqtgraph.PlotItem.getViewBox>`
==================== =======================================================================
- **Signals**
+ **Signals:**
sigYRangeChanged wrapped from :class:`ViewBox <pyqtgraph.ViewBox>`
sigXRangeChanged wrapped from :class:`ViewBox <pyqtgraph.ViewBox>`
sigRangeChanged wrapped from :class:`ViewBox <pyqtgraph.ViewBox>`
@@ -103,7 +103,7 @@ class PlotItem(GraphicsWidget):
Any extra keyword arguments are passed to PlotItem.plot().
============== ==========================================================================================
- **Arguments**
+ **Arguments:**
*title* Title to display at the top of the item. Html is allowed.
*labels* A dictionary specifying the axis labels to display::
@@ -931,18 +931,18 @@ class PlotItem(GraphicsWidget):
def setDownsampling(self, ds=None, auto=None, mode=None):
"""Change the default downsampling mode for all PlotDataItems managed by this plot.
- =========== =================================================================
- Arguments
- ds (int) Reduce visible plot samples by this factor, or
- (bool) To enable/disable downsampling without changing the value.
- auto (bool) If True, automatically pick *ds* based on visible range
- mode 'subsample': Downsample by taking the first of N samples.
- This method is fastest and least accurate.
- 'mean': Downsample by taking the mean of N samples.
- 'peak': Downsample by drawing a saw wave that follows the min
- and max of the original data. This method produces the best
- visual representation of the data but is slower.
- =========== =================================================================
+ =============== =================================================================
+ **Arguments:**
+ ds (int) Reduce visible plot samples by this factor, or
+ (bool) To enable/disable downsampling without changing the value.
+ auto (bool) If True, automatically pick *ds* based on visible range
+ mode 'subsample': Downsample by taking the first of N samples.
+ This method is fastest and least accurate.
+ 'mean': Downsample by taking the mean of N samples.
+ 'peak': Downsample by drawing a saw wave that follows the min
+ and max of the original data. This method produces the best
+ visual representation of the data but is slower.
+ =============== =================================================================
"""
if ds is not None:
if ds is False:
@@ -1113,15 +1113,15 @@ class PlotItem(GraphicsWidget):
"""
Set the label for an axis. Basic HTML formatting is allowed.
- ============= =================================================================
- **Arguments**
- axis must be one of 'left', 'bottom', 'right', or 'top'
- text text to display along the axis. HTML allowed.
- units units to display after the title. If units are given,
- then an SI prefix will be automatically appended
- and the axis values will be scaled accordingly.
- (ie, use 'V' instead of 'mV'; 'm' will be added automatically)
- ============= =================================================================
+ ============== =================================================================
+ **Arguments:**
+ axis must be one of 'left', 'bottom', 'right', or 'top'
+ text text to display along the axis. HTML allowed.
+ units units to display after the title. If units are given,
+ then an SI prefix will be automatically appended
+ and the axis values will be scaled accordingly.
+ (ie, use 'V' instead of 'mV'; 'm' will be added automatically)
+ ============== =================================================================
"""
self.getAxis(axis).setLabel(text=text, units=units, **args)
self.showAxis(axis)
diff --git a/pyqtgraph/graphicsItems/ROI.py b/pyqtgraph/graphicsItems/ROI.py
index bea0d730d73ecf699e100ef223d28cb2400da155..2f04a1642051b2ee4ea55ecffd9122c9d09bb72b 100644
--- a/pyqtgraph/graphicsItems/ROI.py
+++ b/pyqtgraph/graphicsItems/ROI.py
@@ -43,30 +43,9 @@ class ROI(GraphicsObject):
rotate/translate/scale handles.
ROIs can be customized to have a variety of shapes (by subclassing or using
any of the built-in subclasses) and any combination of draggable handles
- that allow the user to manibulate the ROI.
+ that allow the user to manipulate the ROI.
- ======================= ====================================================
- **Signals**
- sigRegionChangeFinished Emitted when the user stops dragging the ROI (or
- one of its handles) or if the ROI is changed
- programatically.
- sigRegionChangeStarted Emitted when the user starts dragging the ROI (or
- one of its handles).
- sigRegionChanged Emitted any time the position of the ROI changes,
- including while it is being dragged by the user.
- sigHoverEvent Emitted when the mouse hovers over the ROI.
- sigClicked Emitted when the user clicks on the ROI.
- Note that clicking is disabled by default to prevent
- stealing clicks from objects behind the ROI. To
- enable clicking, call
- roi.setAcceptedMouseButtons(QtCore.Qt.LeftButton).
- See QtGui.QGraphicsItem documentation for more
- details.
- sigRemoveRequested Emitted when the user selects 'remove' from the
- ROI's context menu (if available).
- ======================= ====================================================
-
================ ===========================================================
**Arguments**
@@ -102,6 +81,29 @@ class ROI(GraphicsObject):
sigRemoveRequested when this menu action is selected.
Default is False.
================ ===========================================================
+
+
+
+ ======================= ====================================================
+ **Signals**
+ sigRegionChangeFinished Emitted when the user stops dragging the ROI (or
+ one of its handles) or if the ROI is changed
+ programatically.
+ sigRegionChangeStarted Emitted when the user starts dragging the ROI (or
+ one of its handles).
+ sigRegionChanged Emitted any time the position of the ROI changes,
+ including while it is being dragged by the user.
+ sigHoverEvent Emitted when the mouse hovers over the ROI.
+ sigClicked Emitted when the user clicks on the ROI.
+ Note that clicking is disabled by default to prevent
+ stealing clicks from objects behind the ROI. To
+ enable clicking, call
+ roi.setAcceptedMouseButtons(QtCore.Qt.LeftButton).
+ See QtGui.QGraphicsItem documentation for more
+ details.
+ sigRemoveRequested Emitted when the user selects 'remove' from the
+ ROI's context menu (if available).
+ ======================= ====================================================
"""
sigRegionChangeFinished = QtCore.Signal(object)
diff --git a/pyqtgraph/graphicsItems/TextItem.py b/pyqtgraph/graphicsItems/TextItem.py
index 2b5ea51cecf5683de6d89123e649de25de28933b..22b1eee62cbe89c64115537e37277d0bc8ea3669 100644
--- a/pyqtgraph/graphicsItems/TextItem.py
+++ b/pyqtgraph/graphicsItems/TextItem.py
@@ -9,18 +9,18 @@ class TextItem(UIGraphicsItem):
"""
def __init__(self, text='', color=(200,200,200), html=None, anchor=(0,0), border=None, fill=None, angle=0):
"""
- =========== =================================================================================
- Arguments:
- *text* The text to display
- *color* The color of the text (any format accepted by pg.mkColor)
- *html* If specified, this overrides both *text* and *color*
- *anchor* A QPointF or (x,y) sequence indicating what region of the text box will
- be anchored to the item's position. A value of (0,0) sets the upper-left corner
- of the text box to be at the position specified by setPos(), while a value of (1,1)
- sets the lower-right corner.
- *border* A pen to use when drawing the border
- *fill* A brush to use when filling within the border
- =========== =================================================================================
+ ============== =================================================================================
+ **Arguments:**
+ *text* The text to display
+ *color* The color of the text (any format accepted by pg.mkColor)
+ *html* If specified, this overrides both *text* and *color*
+ *anchor* A QPointF or (x,y) sequence indicating what region of the text box will
+ be anchored to the item's position. A value of (0,0) sets the upper-left corner
+ of the text box to be at the position specified by setPos(), while a value of (1,1)
+ sets the lower-right corner.
+ *border* A pen to use when drawing the border
+ *fill* A brush to use when filling within the border
+ ============== =================================================================================
"""
## not working yet
diff --git a/pyqtgraph/graphicsItems/VTickGroup.py b/pyqtgraph/graphicsItems/VTickGroup.py
index 4b3156784c4de674d3bbfdd01dd4387a7044d14a..1db4a4a26ad4c4b738bb8b6647a70b960374b7e5 100644
--- a/pyqtgraph/graphicsItems/VTickGroup.py
+++ b/pyqtgraph/graphicsItems/VTickGroup.py
@@ -19,15 +19,15 @@ class VTickGroup(UIGraphicsItem):
"""
def __init__(self, xvals=None, yrange=None, pen=None):
"""
- ============= ===================================================================
- **Arguments**
- xvals A list of x values (in data coordinates) at which to draw ticks.
- yrange A list of [low, high] limits for the tick. 0 is the bottom of
- the view, 1 is the top. [0.8, 1] would draw ticks in the top
- fifth of the view.
- pen The pen to use for drawing ticks. Default is grey. Can be specified
- as any argument valid for :func:`mkPen<pyqtgraph.mkPen>`
- ============= ===================================================================
+ ============== ===================================================================
+ **Arguments:**
+ xvals A list of x values (in data coordinates) at which to draw ticks.
+ yrange A list of [low, high] limits for the tick. 0 is the bottom of
+ the view, 1 is the top. [0.8, 1] would draw ticks in the top
+ fifth of the view.
+ pen The pen to use for drawing ticks. Default is grey. Can be specified
+ as any argument valid for :func:`mkPen<pyqtgraph.mkPen>`
+ ============== ===================================================================
"""
if yrange is None:
yrange = [0, 1]
@@ -56,10 +56,10 @@ class VTickGroup(UIGraphicsItem):
def setXVals(self, vals):
"""Set the x values for the ticks.
- ============= =====================================================================
- **Arguments**
- vals A list of x values (in data/plot coordinates) at which to draw ticks.
- ============= =====================================================================
+ ============== =====================================================================
+ **Arguments:**
+ vals A list of x values (in data/plot coordinates) at which to draw ticks.
+ ============== =====================================================================
"""
self.xvals = vals
self.rebuildTicks()
diff --git a/pyqtgraph/graphicsItems/ViewBox/ViewBox.py b/pyqtgraph/graphicsItems/ViewBox/ViewBox.py
index adc089a7e70536d08c54b4ca0316ac6efe282779..6bff9c657df43c8fa2c09fdb81e0afa36be2c14d 100644
--- a/pyqtgraph/graphicsItems/ViewBox/ViewBox.py
+++ b/pyqtgraph/graphicsItems/ViewBox/ViewBox.py
@@ -71,16 +71,16 @@ class ViewBox(GraphicsWidget):
def __init__(self, parent=None, border=None, lockAspect=False, enableMouse=True, invertY=False, enableMenu=True, name=None):
"""
- ============= =============================================================
- **Arguments**
- *parent* (QGraphicsWidget) Optional parent widget
- *border* (QPen) Do draw a border around the view, give any
- single argument accepted by :func:`mkPen <pyqtgraph.mkPen>`
- *lockAspect* (False or float) The aspect ratio to lock the view
- coorinates to. (or False to allow the ratio to change)
- *enableMouse* (bool) Whether mouse can be used to scale/pan the view
- *invertY* (bool) See :func:`invertY <pyqtgraph.ViewBox.invertY>`
- ============= =============================================================
+ ============== =============================================================
+ **Arguments:**
+ *parent* (QGraphicsWidget) Optional parent widget
+ *border* (QPen) Do draw a border around the view, give any
+ single argument accepted by :func:`mkPen <pyqtgraph.mkPen>`
+ *lockAspect* (False or float) The aspect ratio to lock the view
+ coorinates to. (or False to allow the ratio to change)
+ *enableMouse* (bool) Whether mouse can be used to scale/pan the view
+ *invertY* (bool) See :func:`invertY <pyqtgraph.ViewBox.invertY>`
+ ============== =============================================================
"""
@@ -429,7 +429,7 @@ class ViewBox(GraphicsWidget):
Must specify at least one of *rect*, *xRange*, or *yRange*.
================== =====================================================================
- **Arguments**
+ **Arguments:**
*rect* (QRectF) The full range that should be visible in the view box.
*xRange* (min,max) The range that should be visible along the x-axis.
*yRange* (min,max) The range that should be visible along the y-axis.
@@ -571,14 +571,14 @@ class ViewBox(GraphicsWidget):
Note that this is not the same as enableAutoRange, which causes the view to
automatically auto-range whenever its contents are changed.
- =========== ============================================================
- Arguments
- padding The fraction of the total data range to add on to the final
- visible range. By default, this value is set between 0.02
- and 0.1 depending on the size of the ViewBox.
- items If specified, this is a list of items to consider when
- determining the visible range.
- =========== ============================================================
+ ============== ============================================================
+ **Arguments:**
+ padding The fraction of the total data range to add on to the final
+ visible range. By default, this value is set between 0.02
+ and 0.1 depending on the size of the ViewBox.
+ items If specified, this is a list of items to consider when
+ determining the visible range.
+ ============== ============================================================
"""
if item is None:
bounds = self.childrenBoundingRect(items=items)
diff --git a/pyqtgraph/multiprocess/parallelizer.py b/pyqtgraph/multiprocess/parallelizer.py
index 4ad30b6e0d18f9ea8f9945d2e421908a69403047..f4ddd95c75d000aceb7b21db7de56fa80dede944 100644
--- a/pyqtgraph/multiprocess/parallelizer.py
+++ b/pyqtgraph/multiprocess/parallelizer.py
@@ -40,7 +40,7 @@ class Parallelize(object):
def __init__(self, tasks=None, workers=None, block=True, progressDialog=None, randomReseed=True, **kwds):
"""
=============== ===================================================================
- Arguments:
+ **Arguments:**
tasks list of objects to be processed (Parallelize will determine how to
distribute the tasks). If unspecified, then each worker will receive
a single task with a unique id number.
diff --git a/pyqtgraph/multiprocess/processes.py b/pyqtgraph/multiprocess/processes.py
index 5a4ccb99b08267cdc8e21c079b3907049fd4dda2..a08b449c8e3624df9650820bff78af80d59ec31c 100644
--- a/pyqtgraph/multiprocess/processes.py
+++ b/pyqtgraph/multiprocess/processes.py
@@ -38,25 +38,25 @@ class Process(RemoteEventHandler):
def __init__(self, name=None, target=None, executable=None, copySysPath=True, debug=False, timeout=20, wrapStdout=None):
"""
- ============ =============================================================
- Arguments:
- name Optional name for this process used when printing messages
- from the remote process.
- target Optional function to call after starting remote process.
- By default, this is startEventLoop(), which causes the remote
- process to process requests from the parent process until it
- is asked to quit. If you wish to specify a different target,
- it must be picklable (bound methods are not).
- copySysPath If True, copy the contents of sys.path to the remote process
- debug If True, print detailed information about communication
- with the child process.
- wrapStdout If True (default on windows) then stdout and stderr from the
- child process will be caught by the parent process and
- forwarded to its stdout/stderr. This provides a workaround
- for a python bug: http://bugs.python.org/issue3905
- but has the side effect that child output is significantly
- delayed relative to the parent output.
- ============ =============================================================
+ ============== =============================================================
+ **Arguments:**
+ name Optional name for this process used when printing messages
+ from the remote process.
+ target Optional function to call after starting remote process.
+ By default, this is startEventLoop(), which causes the remote
+ process to process requests from the parent process until it
+ is asked to quit. If you wish to specify a different target,
+ it must be picklable (bound methods are not).
+ copySysPath If True, copy the contents of sys.path to the remote process
+ debug If True, print detailed information about communication
+ with the child process.
+ wrapStdout If True (default on windows) then stdout and stderr from the
+ child process will be caught by the parent process and
+ forwarded to its stdout/stderr. This provides a workaround
+ for a python bug: http://bugs.python.org/issue3905
+ but has the side effect that child output is significantly
+ delayed relative to the parent output.
+ ============== =============================================================
"""
if target is None:
target = startEventLoop
diff --git a/pyqtgraph/multiprocess/remoteproxy.py b/pyqtgraph/multiprocess/remoteproxy.py
index eba42ef3d6cd2f8527c726e63cd747ccfbc0320b..70ce90a60b090415591374d60220c690c08788e2 100644
--- a/pyqtgraph/multiprocess/remoteproxy.py
+++ b/pyqtgraph/multiprocess/remoteproxy.py
@@ -299,23 +299,23 @@ class RemoteEventHandler(object):
(The docstring has information that is nevertheless useful to the programmer
as it describes the internal protocol used to communicate between processes)
- ========== ====================================================================
- Arguments:
- request String describing the type of request being sent (see below)
- reqId Integer uniquely linking a result back to the request that generated
- it. (most requests leave this blank)
- callSync 'sync': return the actual result of the request
- 'async': return a Request object which can be used to look up the
- result later
- 'off': return no result
- timeout Time in seconds to wait for a response when callSync=='sync'
- opts Extra arguments sent to the remote process that determine the way
- the request will be handled (see below)
- returnType 'proxy', 'value', or 'auto'
- byteData If specified, this is a list of objects to be sent as byte messages
- to the remote process.
- This is used to send large arrays without the cost of pickling.
- ========== ====================================================================
+ ============== ====================================================================
+ **Arguments:**
+ request String describing the type of request being sent (see below)
+ reqId Integer uniquely linking a result back to the request that generated
+ it. (most requests leave this blank)
+ callSync 'sync': return the actual result of the request
+ 'async': return a Request object which can be used to look up the
+ result later
+ 'off': return no result
+ timeout Time in seconds to wait for a response when callSync=='sync'
+ opts Extra arguments sent to the remote process that determine the way
+ the request will be handled (see below)
+ returnType 'proxy', 'value', or 'auto'
+ byteData If specified, this is a list of objects to be sent as byte messages
+ to the remote process.
+ This is used to send large arrays without the cost of pickling.
+ ============== ====================================================================
Description of request strings and options allowed for each:
diff --git a/pyqtgraph/opengl/MeshData.py b/pyqtgraph/opengl/MeshData.py
index 9da430194138c948346d3d0d38a0dfa5ff06d553..74771255662eb3ec8bf2410b314064bf64f456f4 100644
--- a/pyqtgraph/opengl/MeshData.py
+++ b/pyqtgraph/opengl/MeshData.py
@@ -23,18 +23,18 @@ class MeshData(object):
def __init__(self, vertexes=None, faces=None, edges=None, vertexColors=None, faceColors=None):
"""
- ============= =====================================================
- Arguments
- vertexes (Nv, 3) array of vertex coordinates.
- If faces is not specified, then this will instead be
- interpreted as (Nf, 3, 3) array of coordinates.
- faces (Nf, 3) array of indexes into the vertex array.
- edges [not available yet]
- vertexColors (Nv, 4) array of vertex colors.
- If faces is not specified, then this will instead be
- interpreted as (Nf, 3, 4) array of colors.
- faceColors (Nf, 4) array of face colors.
- ============= =====================================================
+ ============== =====================================================
+ **Arguments:**
+ vertexes (Nv, 3) array of vertex coordinates.
+ If faces is not specified, then this will instead be
+ interpreted as (Nf, 3, 3) array of coordinates.
+ faces (Nf, 3) array of indexes into the vertex array.
+ edges [not available yet]
+ vertexColors (Nv, 4) array of vertex colors.
+ If faces is not specified, then this will instead be
+ interpreted as (Nf, 3, 4) array of colors.
+ faceColors (Nf, 4) array of face colors.
+ ============== =====================================================
All arguments are optional.
"""
diff --git a/pyqtgraph/opengl/items/GLLinePlotItem.py b/pyqtgraph/opengl/items/GLLinePlotItem.py
index 459d701ee2cde94b51cfe23e7241834017884876..29c7ab5a415e78d82e84b5cd4f31d2e43ac27f79 100644
--- a/pyqtgraph/opengl/items/GLLinePlotItem.py
+++ b/pyqtgraph/opengl/items/GLLinePlotItem.py
@@ -28,7 +28,7 @@ class GLLinePlotItem(GLGraphicsItem):
colors unchanged, etc.
==================== ==================================================
- Arguments:
+ **Arguments:**
------------------------------------------------------------------------
pos (N,3) array of floats specifying point locations.
color (N,4) array of floats (0.0-1.0) or
diff --git a/pyqtgraph/opengl/items/GLMeshItem.py b/pyqtgraph/opengl/items/GLMeshItem.py
index 14d178f883339e48fb43d01c3f8a0f9705a57fe0..c80fd488d7ef85ffd47730821751bc79d6f9a133 100644
--- a/pyqtgraph/opengl/items/GLMeshItem.py
+++ b/pyqtgraph/opengl/items/GLMeshItem.py
@@ -19,7 +19,7 @@ class GLMeshItem(GLGraphicsItem):
def __init__(self, **kwds):
"""
============== =====================================================
- Arguments
+ **Arguments:**
meshdata MeshData object from which to determine geometry for
this item.
color Default face color used if no vertex or face colors
diff --git a/pyqtgraph/opengl/items/GLScatterPlotItem.py b/pyqtgraph/opengl/items/GLScatterPlotItem.py
index 9ddd3b3417352cbeeb9e92275c71300adac00244..bb2c89a3ac69c854e51f9161e79903dc08ed5ece 100644
--- a/pyqtgraph/opengl/items/GLScatterPlotItem.py
+++ b/pyqtgraph/opengl/items/GLScatterPlotItem.py
@@ -28,8 +28,7 @@ class GLScatterPlotItem(GLGraphicsItem):
colors unchanged, etc.
==================== ==================================================
- Arguments:
- ------------------------------------------------------------------------
+ **Arguments:**
pos (N,3) array of floats specifying point locations.
color (N,4) array of floats (0.0-1.0) specifying
spot colors OR a tuple of floats specifying
diff --git a/pyqtgraph/opengl/items/GLSurfacePlotItem.py b/pyqtgraph/opengl/items/GLSurfacePlotItem.py
index 9c41a878ae76ff06a21a8025f3e219b7d161c2a1..e39ef3bba645681f40f1ea4aa0ff8eedb88887fa 100644
--- a/pyqtgraph/opengl/items/GLSurfacePlotItem.py
+++ b/pyqtgraph/opengl/items/GLSurfacePlotItem.py
@@ -36,14 +36,14 @@ class GLSurfacePlotItem(GLMeshItem):
"""
Update the data in this surface plot.
- ========== =====================================================================
- Arguments
- x,y 1D arrays of values specifying the x,y positions of vertexes in the
- grid. If these are omitted, then the values will be assumed to be
- integers.
- z 2D array of height values for each grid vertex.
- colors (width, height, 4) array of vertex colors.
- ========== =====================================================================
+ ============== =====================================================================
+ **Arguments:**
+ x,y 1D arrays of values specifying the x,y positions of vertexes in the
+ grid. If these are omitted, then the values will be assumed to be
+ integers.
+ z 2D array of height values for each grid vertex.
+ colors (width, height, 4) array of vertex colors.
+ ============== =====================================================================
All arguments are optional.
diff --git a/pyqtgraph/parametertree/Parameter.py b/pyqtgraph/parametertree/Parameter.py
index 11c81581df66e3498727011bf7f7a2ed065a8ddb..1c75c3331626446df827a2f945880fc88756c732 100644
--- a/pyqtgraph/parametertree/Parameter.py
+++ b/pyqtgraph/parametertree/Parameter.py
@@ -107,33 +107,33 @@ class Parameter(QtCore.QObject):
Parameter instance, the options available to this method are also allowed
by most Parameter subclasses.
- ================= =========================================================
- Keyword Arguments
- name The name to give this Parameter. This is the name that
- will appear in the left-most column of a ParameterTree
- for this Parameter.
- value The value to initially assign to this Parameter.
- default The default value for this Parameter (most Parameters
- provide an option to 'reset to default').
- children A list of children for this Parameter. Children
- may be given either as a Parameter instance or as a
- dictionary to pass to Parameter.create(). In this way,
- it is possible to specify complex hierarchies of
- Parameters from a single nested data structure.
- readonly If True, the user will not be allowed to edit this
- Parameter. (default=False)
- enabled If False, any widget(s) for this parameter will appear
- disabled. (default=True)
- visible If False, the Parameter will not appear when displayed
- in a ParameterTree. (default=True)
- renamable If True, the user may rename this Parameter.
- (default=False)
- removable If True, the user may remove this Parameter.
- (default=False)
- expanded If True, the Parameter will appear expanded when
- displayed in a ParameterTree (its children will be
- visible). (default=True)
- ================= =========================================================
+ ======================= =========================================================
+ **Keyword Arguments:**
+ name The name to give this Parameter. This is the name that
+ will appear in the left-most column of a ParameterTree
+ for this Parameter.
+ value The value to initially assign to this Parameter.
+ default The default value for this Parameter (most Parameters
+ provide an option to 'reset to default').
+ children A list of children for this Parameter. Children
+ may be given either as a Parameter instance or as a
+ dictionary to pass to Parameter.create(). In this way,
+ it is possible to specify complex hierarchies of
+ Parameters from a single nested data structure.
+ readonly If True, the user will not be allowed to edit this
+ Parameter. (default=False)
+ enabled If False, any widget(s) for this parameter will appear
+ disabled. (default=True)
+ visible If False, the Parameter will not appear when displayed
+ in a ParameterTree. (default=True)
+ renamable If True, the user may rename this Parameter.
+ (default=False)
+ removable If True, the user may remove this Parameter.
+ (default=False)
+ expanded If True, the Parameter will appear expanded when
+ displayed in a ParameterTree (its children will be
+ visible). (default=True)
+ ======================= =========================================================
"""
@@ -675,13 +675,13 @@ class Parameter(QtCore.QObject):
"""
Called when the state of any sub-parameter has changed.
- ========== ================================================================
- Arguments:
- param The immediate child whose tree state has changed.
- note that the change may have originated from a grandchild.
- changes List of tuples describing all changes that have been made
- in this event: (param, changeDescr, data)
- ========== ================================================================
+ ============== ================================================================
+ **Arguments:**
+ param The immediate child whose tree state has changed.
+ note that the change may have originated from a grandchild.
+ changes List of tuples describing all changes that have been made
+ in this event: (param, changeDescr, data)
+ ============== ================================================================
This function can be extended to react to tree state changes.
"""
diff --git a/pyqtgraph/parametertree/parameterTypes.py b/pyqtgraph/parametertree/parameterTypes.py
index f58145dd6c12d705934eaa20033af249672bff76..92eca90fee2b60d16e3f2f59ffe5d779711ced61 100644
--- a/pyqtgraph/parametertree/parameterTypes.py
+++ b/pyqtgraph/parametertree/parameterTypes.py
@@ -18,16 +18,16 @@ class WidgetParameterItem(ParameterItem):
* simple widget for editing value (displayed instead of label when item is selected)
* button that resets value to default
- ================= =============================================================
- Registered Types:
- int Displays a :class:`SpinBox <pyqtgraph.SpinBox>` in integer
- mode.
- float Displays a :class:`SpinBox <pyqtgraph.SpinBox>`.
- bool Displays a QCheckBox
- str Displays a QLineEdit
- color Displays a :class:`ColorButton <pyqtgraph.ColorButton>`
- colormap Displays a :class:`GradientWidget <pyqtgraph.GradientWidget>`
- ================= =============================================================
+ ========================== =============================================================
+ **Registered Types:**
+ int Displays a :class:`SpinBox <pyqtgraph.SpinBox>` in integer
+ mode.
+ float Displays a :class:`SpinBox <pyqtgraph.SpinBox>`.
+ bool Displays a QCheckBox
+ str Displays a QLineEdit
+ color Displays a :class:`ColorButton <pyqtgraph.ColorButton>`
+ colormap Displays a :class:`GradientWidget <pyqtgraph.GradientWidget>`
+ ========================== =============================================================
This class can be subclassed by overriding makeWidget() to provide a custom widget.
"""
diff --git a/pyqtgraph/widgets/ColorButton.py b/pyqtgraph/widgets/ColorButton.py
index 40f6740ff409212dd971486b5c6d0e0838d8dbdb..a0bb0c8eb1ccc521bd8241099f06ab420575ee4d 100644
--- a/pyqtgraph/widgets/ColorButton.py
+++ b/pyqtgraph/widgets/ColorButton.py
@@ -11,7 +11,7 @@ class ColorButton(QtGui.QPushButton):
Button displaying a color and allowing the user to select a new color.
====================== ============================================================
- **Signals**:
+ **Signals:**
sigColorChanging(self) emitted whenever a new color is picked in the color dialog
sigColorChanged(self) emitted when the selected color is accepted (user clicks OK)
====================== ============================================================
diff --git a/pyqtgraph/widgets/ColorMapWidget.py b/pyqtgraph/widgets/ColorMapWidget.py
index 1874f5d14549b001071a85d820713ffe82317a68..8cd72e153fd5408cfe174c5e2dcea1e03edb7392 100644
--- a/pyqtgraph/widgets/ColorMapWidget.py
+++ b/pyqtgraph/widgets/ColorMapWidget.py
@@ -86,14 +86,14 @@ class ColorMapParameter(ptree.types.GroupParameter):
"""
Return an array of colors corresponding to *data*.
- ========= =================================================================
- Arguments
- data A numpy record array where the fields in data.dtype match those
- defined by a prior call to setFields().
- mode Either 'byte' or 'float'. For 'byte', the method returns an array
- of dtype ubyte with values scaled 0-255. For 'float', colors are
- returned as 0.0-1.0 float values.
- ========= =================================================================
+ ============== =================================================================
+ **Arguments:**
+ data A numpy record array where the fields in data.dtype match those
+ defined by a prior call to setFields().
+ mode Either 'byte' or 'float'. For 'byte', the method returns an array
+ of dtype ubyte with values scaled 0-255. For 'float', colors are
+ returned as 0.0-1.0 float values.
+ ============== =================================================================
"""
colors = np.zeros((len(data),4))
for item in self.children():
diff --git a/pyqtgraph/widgets/GraphicsView.py b/pyqtgraph/widgets/GraphicsView.py
index 8f811c3fa6a6c8290434a3c072406c8797c36d76..3273ac603a1fc6c4b5bdc96f3504b5bb8c25ea69 100644
--- a/pyqtgraph/widgets/GraphicsView.py
+++ b/pyqtgraph/widgets/GraphicsView.py
@@ -50,21 +50,21 @@ class GraphicsView(QtGui.QGraphicsView):
def __init__(self, parent=None, useOpenGL=None, background='default'):
"""
- ============ ============================================================
- Arguments:
- parent Optional parent widget
- useOpenGL If True, the GraphicsView will use OpenGL to do all of its
- rendering. This can improve performance on some systems,
- but may also introduce bugs (the combination of
- QGraphicsView and QGLWidget is still an 'experimental'
- feature of Qt)
- background Set the background color of the GraphicsView. Accepts any
- single argument accepted by
- :func:`mkColor <pyqtgraph.mkColor>`. By
- default, the background color is determined using the
- 'backgroundColor' configuration option (see
- :func:`setConfigOption <pyqtgraph.setConfigOption>`.
- ============ ============================================================
+ ============== ============================================================
+ **Arguments:**
+ parent Optional parent widget
+ useOpenGL If True, the GraphicsView will use OpenGL to do all of its
+ rendering. This can improve performance on some systems,
+ but may also introduce bugs (the combination of
+ QGraphicsView and QGLWidget is still an 'experimental'
+ feature of Qt)
+ background Set the background color of the GraphicsView. Accepts any
+ single argument accepted by
+ :func:`mkColor <pyqtgraph.mkColor>`. By
+ default, the background color is determined using the
+ 'backgroundColor' configuration option (see
+ :func:`setConfigOption <pyqtgraph.setConfigOption>`.
+ ============== ============================================================
"""
self.closed = False
diff --git a/pyqtgraph/widgets/ValueLabel.py b/pyqtgraph/widgets/ValueLabel.py
index d395cd43d9f27de94614e2e502154255c8e427f5..4e5b3011d2600b7efdcfa644154b21ceaeefbb4a 100644
--- a/pyqtgraph/widgets/ValueLabel.py
+++ b/pyqtgraph/widgets/ValueLabel.py
@@ -16,18 +16,18 @@ class ValueLabel(QtGui.QLabel):
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 = []