Commit e46439b9 authored by Luke Campagnola's avatar Luke Campagnola
Browse files

minor docstring updates

parent d4553a1e
......@@ -123,9 +123,11 @@ class AxisItem(GraphicsWidget):
(6, 0.2)] # If we already have 6 ticks with text,
# fill no more than 20% of the axis
showValues (bool) indicates whether text is displayed adjacent
showValues (bool) indicates whether text is displayed adjacent
to ticks.
=================== =======================================================
Added in version 0.9.9
"""
for kwd,value in kwds.items():
if kwd not in self.style:
......
......@@ -22,7 +22,10 @@ class FillBetweenItem(QtGui.QGraphicsPathItem):
def setCurves(self, curve1, curve2):
"""Set the curves to fill between.
Arguments must be instances of PlotDataItem or PlotCurveItem."""
Arguments must be instances of PlotDataItem or PlotCurveItem.
Added in version 0.9.9
"""
if self.curves is not None:
for c in self.curves:
......
......@@ -140,6 +140,11 @@ class ImageItem(GraphicsObject):
self.updateImage()
def setAutoDownsample(self, ads):
"""
Set the automatic downsampling mode for this ImageItem.
Added in version 0.9.9
"""
self.autoDownsample = ads
self.qimage = None
self.update()
......
......@@ -326,6 +326,8 @@ class ViewBox(GraphicsWidget):
Set the background color of the ViewBox.
If color is None, then no background will be drawn.
Added in version 0.9.9
"""
self.background.setVisible(color is not None)
self.state['background'] = color
......@@ -639,6 +641,7 @@ class ViewBox(GraphicsWidget):
**Panning limits**. The following arguments define the region within the
viewbox coordinate system that may be accessed by panning the view.
=========== ============================================================
xMin Minimum allowed x-axis value
xMax Maximum allowed x-axis value
......@@ -648,12 +651,15 @@ class ViewBox(GraphicsWidget):
**Scaling limits**. These arguments prevent the view being zoomed in or
out too far.
=========== ============================================================
minXRange Minimum allowed left-to-right span across the view.
maxXRange Maximum allowed left-to-right span across the view.
minYRange Minimum allowed top-to-bottom span across the view.
maxYRange Maximum allowed top-to-bottom span across the view.
=========== ============================================================
=========== ============================================================
Added in version 0.9.9
"""
update = False
......
......@@ -36,6 +36,8 @@ class MultiPlotWidget(GraphicsView):
If the total height of all plots is greater than the height of the
widget, then a scroll bar will appear to provide access to the entire
set of plots.
Added in version 0.9.9
"""
self.minPlotHeight = min
self.resizeEvent(None)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment