ASCEE/pyqtgraph
5
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

AxisItem fixes

Browse Source 
documentation update
removed documentation builds from repo.
This commit is contained in:
Luke Campagnola 2012-03-12 12:23:25 -04:00
parent 0945278b22
commit fe4e177d8e
159 changed files with 52 additions and 20473 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
canvas/Canvas.py
View File

@ -15,7 +15,7 @@ from pyqtgraph.graphicsItems.ViewBox import ViewBox
from pyqtgraph.graphicsItems.GridItem import GridItem
#import DataManager
import numpy as np
import debug
from pyqtgraph import debug
#import pyqtgraph as pg
import weakref
from CanvasManager import CanvasManager

2
canvas/CanvasItem.py
View File

@ -3,7 +3,7 @@ from pyqtgraph.Qt import QtGui, QtCore, QtSvg
from pyqtgraph.graphicsItems.ROI import ROI
import pyqtgraph as pg
import TransformGuiTemplate
import debug
from pyqtgraph import debug
class SelectBox(ROI):
def __init__(self, scalable=False, rotatable=True):

BIN
documentation/build/doctrees/environment.pickle
View File

Binary file not shown.

BIN
documentation/build/doctrees/graphicsItems/index.doctree
View File

Binary file not shown.

BIN
documentation/build/doctrees/graphicswindow.doctree
View File

Binary file not shown.

BIN
documentation/build/doctrees/how_to_use.doctree
View File

Binary file not shown.

BIN
documentation/build/doctrees/images.doctree
View File

Binary file not shown.

BIN
documentation/build/doctrees/index.doctree
View File

Binary file not shown.

BIN
documentation/build/doctrees/introduction.doctree
View File

Binary file not shown.

BIN
documentation/build/doctrees/parametertree.doctree
View File

Binary file not shown.

BIN
documentation/build/doctrees/plotting.doctree
View File

Binary file not shown.

BIN
documentation/build/doctrees/region_of_interest.doctree
View File

Binary file not shown.

BIN
documentation/build/doctrees/widgets/dockarea.doctree
View File

Binary file not shown.

BIN
documentation/build/doctrees/widgets/index.doctree
View File

Binary file not shown.

BIN
documentation/build/doctrees/widgets/parametertree.doctree
View File

Binary file not shown.

4
documentation/build/html/.buildinfo
View File

@ -1,4 +0,0 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: ba0221080f2c4e6cd48402ae7f991103
tags: fbb0d17656682115ca4d033fb2f83ba1

BIN
documentation/build/html/_images/plottingClasses.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 67 KiB

89
documentation/build/html/_modules/index.html
View File

@ -1,89 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Overview: module code &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="../index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>All modules for which code is available</h1>
<ul><li><a href="pyqtgraph.html">pyqtgraph</a></li>
</ul>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

192
documentation/build/html/_modules/pyqtgraph.html
View File

@ -1,192 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>pyqtgraph &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="../index.html" />
<link rel="up" title="Module code" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Module code</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for pyqtgraph</h1><div class="highlight"><pre>
<span class="c"># -*- coding: utf-8 -*-</span>
<span class="c">### import all the goodies and add some helper functions for easy CLI use</span>
<span class="c">## &#39;Qt&#39; is a local module; it is intended mainly to cover up the differences</span>
<span class="c">## between PyQt4 and PySide.</span>
<span class="kn">from</span> <span class="nn">Qt</span> <span class="kn">import</span> <span class="n">QtGui</span>
<span class="n">CONFIG_OPTIONS</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">&#39;leftButtonPan&#39;</span><span class="p">:</span> <span class="bp">True</span>
<span class="p">}</span>
<span class="k">def</span> <span class="nf">setConfigOption</span><span class="p">(</span><span class="n">opt</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="n">CONFIG_OPTIONS</span><span class="p">[</span><span class="n">opt</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">def</span> <span class="nf">getConfigOption</span><span class="p">(</span><span class="n">opt</span><span class="p">):</span>
<span class="k">return</span> <span class="n">CONFIG_OPTIONS</span><span class="p">[</span><span class="n">opt</span><span class="p">]</span>
<span class="c">## Import almost everything to make it available from a single namespace</span>
<span class="c">## don&#39;t import the more complex systems--canvas, parametertree, flowchart, dockarea</span>
<span class="c">## these must be imported separately.</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="k">def</span> <span class="nf">importAll</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">__file__</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="n">path</span><span class="p">)</span>
<span class="n">files</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">d</span><span class="p">):</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">f</span><span class="p">)):</span>
<span class="n">files</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">:]</span> <span class="o">==</span> <span class="s">&#39;.py&#39;</span> <span class="ow">and</span> <span class="n">f</span> <span class="o">!=</span> <span class="s">&#39;__init__.py&#39;</span><span class="p">:</span>
<span class="n">files</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">[:</span><span class="o">-</span><span class="mi">3</span><span class="p">])</span>
<span class="k">for</span> <span class="n">modName</span> <span class="ow">in</span> <span class="n">files</span><span class="p">:</span>
<span class="n">mod</span> <span class="o">=</span> <span class="nb">__import__</span><span class="p">(</span><span class="n">path</span><span class="o">+</span><span class="s">&quot;.&quot;</span><span class="o">+</span><span class="n">modName</span><span class="p">,</span> <span class="nb">globals</span><span class="p">(),</span> <span class="nb">locals</span><span class="p">(),</span> <span class="n">fromlist</span><span class="o">=</span><span class="p">[</span><span class="s">&#39;*&#39;</span><span class="p">])</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">mod</span><span class="p">,</span> <span class="s">&#39;__all__&#39;</span><span class="p">):</span>
<span class="n">names</span> <span class="o">=</span> <span class="n">mod</span><span class="o">.</span><span class="n">__all__</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">names</span> <span class="o">=</span> <span class="p">[</span><span class="n">n</span> <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">mod</span><span class="p">)</span> <span class="k">if</span> <span class="n">n</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s">&#39;_&#39;</span><span class="p">]</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">names</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">mod</span><span class="p">,</span> <span class="n">k</span><span class="p">):</span>
<span class="nb">globals</span><span class="p">()[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">mod</span><span class="p">,</span> <span class="n">k</span><span class="p">)</span>
<span class="n">importAll</span><span class="p">(</span><span class="s">&#39;graphicsItems&#39;</span><span class="p">)</span>
<span class="n">importAll</span><span class="p">(</span><span class="s">&#39;widgets&#39;</span><span class="p">)</span>
<span class="kn">from</span> <span class="nn">imageview</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">WidgetGroup</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">Point</span> <span class="kn">import</span> <span class="n">Point</span>
<span class="kn">from</span> <span class="nn">Transform</span> <span class="kn">import</span> <span class="n">Transform</span>
<span class="kn">from</span> <span class="nn">functions</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">graphicsWindows</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">SignalProxy</span> <span class="kn">import</span> <span class="o">*</span>
<span class="c">## Convenience functions for command-line use</span>
<span class="n">plots</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">images</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">QAPP</span> <span class="o">=</span> <span class="bp">None</span>
<div class="viewcode-block" id="plot"><a class="viewcode-back" href="../functions.html#pyqtgraph.plot">[docs]</a><span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> | Create and return a PlotWindow (this is just a window with PlotWidget inside), plot data in it.</span>
<span class="sd"> | Accepts a *title* argument to set the title of the window.</span>
<span class="sd"> | All other arguments are used to plot data. (see :func:`PlotItem.plot() &lt;pyqtgraph.PlotItem.plot&gt;`)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">mkQApp</span><span class="p">()</span>
<span class="k">if</span> <span class="s">&#39;title&#39;</span> <span class="ow">in</span> <span class="n">kargs</span><span class="p">:</span>
<span class="n">w</span> <span class="o">=</span> <span class="n">PlotWindow</span><span class="p">(</span><span class="n">title</span><span class="o">=</span><span class="n">kargs</span><span class="p">[</span><span class="s">&#39;title&#39;</span><span class="p">])</span>
<span class="k">del</span> <span class="n">kargs</span><span class="p">[</span><span class="s">&#39;title&#39;</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">w</span> <span class="o">=</span> <span class="n">PlotWindow</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span><span class="o">+</span><span class="nb">len</span><span class="p">(</span><span class="n">kargs</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">w</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kargs</span><span class="p">)</span>
<span class="n">plots</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">w</span><span class="p">)</span>
<span class="n">w</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
<span class="k">return</span> <span class="n">w</span>
</div>
<div class="viewcode-block" id="image"><a class="viewcode-back" href="../functions.html#pyqtgraph.image">[docs]</a><span class="k">def</span> <span class="nf">image</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> | Create and return an ImageWindow (this is just a window with ImageView widget inside), show image data inside.</span>
<span class="sd"> | Will show 2D or 3D image data.</span>
<span class="sd"> | Accepts a *title* argument to set the title of the window.</span>
<span class="sd"> | All other arguments are used to show data. (see :func:`ImageView.setImage() &lt;pyqtgraph.ImageView.setImage&gt;`)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">mkQApp</span><span class="p">()</span>
<span class="n">w</span> <span class="o">=</span> <span class="n">ImageWindow</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kargs</span><span class="p">)</span>
<span class="n">images</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">w</span><span class="p">)</span>
<span class="n">w</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
<span class="k">return</span> <span class="n">w</span></div>
<span class="n">show</span> <span class="o">=</span> <span class="n">image</span> <span class="c">## for backward compatibility</span>
<span class="k">def</span> <span class="nf">mkQApp</span><span class="p">():</span>
<span class="k">if</span> <span class="n">QtGui</span><span class="o">.</span><span class="n">QApplication</span><span class="o">.</span><span class="n">instance</span><span class="p">()</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">global</span> <span class="n">QAPP</span>
<span class="n">QAPP</span> <span class="o">=</span> <span class="n">QtGui</span><span class="o">.</span><span class="n">QApplication</span><span class="p">([])</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="index.html" >Module code</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

11
documentation/build/html/_sources/apireference.txt
View File

@ -1,11 +0,0 @@
API Reference
=============
Contents:
.. toctree::
:maxdepth: 2
functions
graphicsItems/index
widgets/index

53
documentation/build/html/_sources/functions.txt
View File

@ -1,53 +0,0 @@
Pyqtgraph's Helper Functions
============================
Simple Data Display Functions
-----------------------------
.. autofunction:: pyqtgraph.plot
.. autofunction:: pyqtgraph.image
Color, Pen, and Brush Functions
-------------------------------
Qt uses the classes QColor, QPen, and QBrush to determine how to draw lines and fill shapes. These classes are highly capable but somewhat awkward to use. Pyqtgraph offers the functions :func:`~pyqtgraph.mkColor`, :func:`~pyqtgraph.mkPen`, and :func:`~pyqtgraph.mkBrush` to simplify the process of creating these classes. In most cases, however, it will be unnecessary to call these functions directly--any function or method that accepts *pen* or *brush* arguments will make use of these functions for you. For example, the following three lines all have the same effect::
pg.plot(xdata, ydata, pen='r')
pg.plot(xdata, ydata, pen=pg.mkPen('r'))
pg.plot(xdata, ydata, pen=QPen(QColor(255, 0, 0)))
.. autofunction:: pyqtgraph.mkColor
.. autofunction:: pyqtgraph.mkPen
.. autofunction:: pyqtgraph.mkBrush
.. autofunction:: pyqtgraph.hsvColor
.. autofunction:: pyqtgraph.intColor
.. autofunction:: pyqtgraph.colorTuple
.. autofunction:: pyqtgraph.colorStr
Data Slicing
------------
.. autofunction:: pyqtgraph.affineSlice
SI Unit Conversion Functions
----------------------------
.. autofunction:: pyqtgraph.siFormat
.. autofunction:: pyqtgraph.siScale
.. autofunction:: pyqtgraph.siEval

8
documentation/build/html/_sources/graphicsItems/arrowitem.txt
View File

@ -1,8 +0,0 @@
ArrowItem
=========
.. autoclass:: pyqtgraph.ArrowItem
:members:
.. automethod:: pyqtgraph.ArrowItem.__init__

8
documentation/build/html/_sources/graphicsItems/axisitem.txt
View File

@ -1,8 +0,0 @@
AxisItem
========
.. autoclass:: pyqtgraph.AxisItem
:members:
.. automethod:: pyqtgraph.AxisItem.__init__

8
documentation/build/html/_sources/graphicsItems/buttonitem.txt
View File

@ -1,8 +0,0 @@
ButtonItem
==========
.. autoclass:: pyqtgraph.ButtonItem
:members:
.. automethod:: pyqtgraph.ButtonItem.__init__

8
documentation/build/html/_sources/graphicsItems/curvearrow.txt
View File

@ -1,8 +0,0 @@
CurveArrow
==========
.. autoclass:: pyqtgraph.CurveArrow
:members:
.. automethod:: pyqtgraph.CurveArrow.__init__

8
documentation/build/html/_sources/graphicsItems/curvepoint.txt
View File

@ -1,8 +0,0 @@
CurvePoint
==========
.. autoclass:: pyqtgraph.CurvePoint
:members:
.. automethod:: pyqtgraph.CurvePoint.__init__

8
documentation/build/html/_sources/graphicsItems/gradienteditoritem.txt
View File

@ -1,8 +0,0 @@
GradientEditorItem
==================
.. autoclass:: pyqtgraph.GradientEditorItem
:members:
.. automethod:: pyqtgraph.GradientEditorItem.__init__

8
documentation/build/html/_sources/graphicsItems/gradientlegend.txt
View File

@ -1,8 +0,0 @@
GradientLegend
==============
.. autoclass:: pyqtgraph.GradientLegend
:members:
.. automethod:: pyqtgraph.GradientLegend.__init__

8
documentation/build/html/_sources/graphicsItems/graphicslayout.txt
View File

@ -1,8 +0,0 @@
GraphicsLayout
==============
.. autoclass:: pyqtgraph.GraphicsLayout
:members:
.. automethod:: pyqtgraph.GraphicsLayout.__init__

8
documentation/build/html/_sources/graphicsItems/graphicsobject.txt
View File

@ -1,8 +0,0 @@
GraphicsObject
==============
.. autoclass:: pyqtgraph.GraphicsObject
:members:
.. automethod:: pyqtgraph.GraphicsObject.__init__

8
documentation/build/html/_sources/graphicsItems/graphicswidget.txt
View File

@ -1,8 +0,0 @@
GraphicsWidget
==============
.. autoclass:: pyqtgraph.GraphicsWidget
:members:
.. automethod:: pyqtgraph.GraphicsWidget.__init__

8
documentation/build/html/_sources/graphicsItems/griditem.txt
View File

@ -1,8 +0,0 @@
GridItem
========
.. autoclass:: pyqtgraph.GridItem
:members:
.. automethod:: pyqtgraph.GridItem.__init__

8
documentation/build/html/_sources/graphicsItems/histogramlutitem.txt
View File

@ -1,8 +0,0 @@
HistogramLUTItem
================
.. autoclass:: pyqtgraph.HistogramLUTItem
:members:
.. automethod:: pyqtgraph.HistogramLUTItem.__init__

8
documentation/build/html/_sources/graphicsItems/imageitem.txt
View File

@ -1,8 +0,0 @@
ImageItem
=========
.. autoclass:: pyqtgraph.ImageItem
:members:
.. automethod:: pyqtgraph.ImageItem.__init__

37
documentation/build/html/_sources/graphicsItems/index.txt
View File

@ -1,37 +0,0 @@
Pyqtgraph's Graphics Items
==========================
Since pyqtgraph relies on Qt's GraphicsView framework, most of its graphics functionality is implemented as QGraphicsItem subclasses. This has two important consequences: 1) virtually anything you want to draw can be easily accomplished using the functionality provided by Qt. 2) Many of pyqtgraph's GraphicsItem classes can be used in any normal QGraphicsScene.
Contents:
.. toctree::
:maxdepth: 2
plotdataitem
plotcurveitem
scatterplotitem
plotitem
imageitem
viewbox
linearregionitem
infiniteline
roi
graphicslayout
axisitem
arrowitem
curvepoint
curvearrow
griditem
scalebar
labelitem
vtickgroup
gradienteditoritem
histogramlutitem
gradientlegend
buttonitem
graphicsobject
graphicswidget
uigraphicsitem

8
documentation/build/html/_sources/graphicsItems/infiniteline.txt
View File

@ -1,8 +0,0 @@
InfiniteLine
============
.. autoclass:: pyqtgraph.InfiniteLine
:members:
.. automethod:: pyqtgraph.InfiniteLine.__init__

8
documentation/build/html/_sources/graphicsItems/labelitem.txt
View File

@ -1,8 +0,0 @@
LabelItem
=========
.. autoclass:: pyqtgraph.LabelItem
:members:
.. automethod:: pyqtgraph.LabelItem.__init__

8
documentation/build/html/_sources/graphicsItems/linearregionitem.txt
View File

@ -1,8 +0,0 @@
LinearRegionItem
================
.. autoclass:: pyqtgraph.LinearRegionItem
:members:
.. automethod:: pyqtgraph.LinearRegionItem.__init__

8
documentation/build/html/_sources/graphicsItems/plotcurveitem.txt
View File

@ -1,8 +0,0 @@
PlotCurveItem
=============
.. autoclass:: pyqtgraph.PlotCurveItem
:members:
.. automethod:: pyqtgraph.PlotCurveItem.__init__

8
documentation/build/html/_sources/graphicsItems/plotdataitem.txt
View File

@ -1,8 +0,0 @@
PlotDataItem
============
.. autoclass:: pyqtgraph.PlotDataItem
:members:
.. automethod:: pyqtgraph.PlotDataItem.__init__

7
documentation/build/html/_sources/graphicsItems/plotitem.txt
View File

@ -1,7 +0,0 @@
PlotItem
========
.. autoclass:: pyqtgraph.PlotItem
:members:
.. automethod:: pyqtgraph.PlotItem.__init__

8
documentation/build/html/_sources/graphicsItems/roi.txt
View File

@ -1,8 +0,0 @@
ROI
===
.. autoclass:: pyqtgraph.ROI
:members:
.. automethod:: pyqtgraph.ROI.__init__

8
documentation/build/html/_sources/graphicsItems/scalebar.txt
View File

@ -1,8 +0,0 @@
ScaleBar
========
.. autoclass:: pyqtgraph.ScaleBar
:members:
.. automethod:: pyqtgraph.ScaleBar.__init__

8
documentation/build/html/_sources/graphicsItems/scatterplotitem.txt
View File

@ -1,8 +0,0 @@
ScatterPlotItem
===============
.. autoclass:: pyqtgraph.ScatterPlotItem
:members:
.. automethod:: pyqtgraph.ScatterPlotItem.__init__

8
documentation/build/html/_sources/graphicsItems/uigraphicsitem.txt
View File

@ -1,8 +0,0 @@
UIGraphicsItem
==============
.. autoclass:: pyqtgraph.UIGraphicsItem
:members:
.. automethod:: pyqtgraph.UIGraphicsItem.__init__

8
documentation/build/html/_sources/graphicsItems/viewbox.txt
View File

@ -1,8 +0,0 @@
ViewBox
=======
.. autoclass:: pyqtgraph.ViewBox
:members:
.. automethod:: pyqtgraph.ViewBox.__init__

8
documentation/build/html/_sources/graphicsItems/vtickgroup.txt
View File

@ -1,8 +0,0 @@
VTickGroup
==========
.. autoclass:: pyqtgraph.VTickGroup
:members:
.. automethod:: pyqtgraph.VTickGroup.__init__

8
documentation/build/html/_sources/graphicswindow.txt
View File

@ -1,8 +0,0 @@
Basic display widgets
=====================
- GraphicsWindow
- GraphicsView
- GraphicsLayoutItem
- ViewBox

47
documentation/build/html/_sources/how_to_use.txt
View File

@ -1,47 +0,0 @@
How to use pyqtgraph
====================
There are a few suggested ways to use pyqtgraph:
* From the interactive shell (python -i, ipython, etc)
* Displaying pop-up windows from an application
* Embedding widgets in a PyQt application
Command-line use
----------------
Pyqtgraph makes it very easy to visualize data from the command line. Observe::
import pyqtgraph as pg
pg.plot(data) # data can be a list of values or a numpy array
The example above would open a window displaying a line plot of the data given. I don't think it could reasonably be any simpler than that. The call to pg.plot returns a handle to the plot widget that is created, allowing more data to be added to the same window.
Further examples::
pw = pg.plot(xVals, yVals, pen='r') # plot x vs y in red
pw.plot(xVals, yVals2, pen='b')
win = pg.GraphicsWindow() # Automatically generates grids with multiple items
win.addPlot(data1, row=0, col=0)
win.addPlot(data2, row=0, col=1)
win.addPlot(data3, row=1, col=0, colspan=2)
pg.show(imageData) # imageData must be a numpy array with 2 to 4 dimensions
We're only scratching the surface here--these functions accept many different data formats and options for customizing the appearance of your data.
Displaying windows from within an application
---------------------------------------------
While I consider this approach somewhat lazy, it is often the case that 'lazy' is indistinguishable from 'highly efficient'. The approach here is simply to use the very same functions that would be used on the command line, but from within an existing application. I often use this when I simply want to get a immediate feedback about the state of data in my application without taking the time to build a user interface for it.
Embedding widgets inside PyQt applications
------------------------------------------
For the serious application developer, all of the functionality in pyqtgraph is available via widgets that can be embedded just like any other Qt widgets. Most importantly, see: PlotWidget, ImageView, GraphicsView, GraphicsLayoutWidget. Pyqtgraph's widgets can be included in Designer's ui files via the "Promote To..." functionality.

26
documentation/build/html/_sources/images.txt
View File

@ -1,26 +0,0 @@
Displaying images and video
===========================
Pyqtgraph displays 2D numpy arrays as images and provides tools for determining how to translate between the numpy data type and RGB values on the screen. If you want to display data from common image and video file formats, you will need to load the data first using another library (PIL works well for images and built-in numpy conversion).
The easiest way to display 2D or 3D data is using the :func:`pyqtgraph.image` function::
import pyqtgraph as pg
pg.image(imageData)
This function will accept any floating-point or integer data types and displays a single :class:`~pyqtgraph.ImageView` widget containing your data. This widget includes controls for determining how the image data will be converted to 32-bit RGBa values. Conversion happens in two steps (both are optional):
1. Scale and offset the data (by selecting the dark/light levels on the displayed histogram)
2. Convert the data to color using a lookup table (determined by the colors shown in the gradient editor)
If the data is 3D (time, x, y), then a time axis will be shown with a slider that can set the currently displayed frame. (if the axes in your data are ordered differently, use numpy.transpose to rearrange them)
There are a few other methods for displaying images as well:
* The :class:`~pyqtgraph.ImageView` class can also be instantiated directly and embedded in Qt applications.
* Instances of :class:`~pyqtgraph.ImageItem` can be used inside a GraphicsView.
* For higher performance, use :class:`~pyqtgraph.RawImageWidget`.
Any of these classes are acceptable for displaying video by calling setImage() to display a new frame. To increase performance, the image processing system uses scipy.weave to produce compiled libraries. If your computer has a compiler available, weave will automatically attempt to build the libraries it needs on demand. If this fails, then the slower pure-python methods will be used instead.
For more information, see the classes listed above and the 'VideoSpeedTest', 'ImageItem', 'ImageView', and 'HistogramLUT' :ref:`examples`.

32
documentation/build/html/_sources/index.txt
View File

@ -1,32 +0,0 @@
.. pyqtgraph documentation master file, created by
sphinx-quickstart on Fri Nov 18 19:33:12 2011.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to the documentation for pyqtgraph 1.8
==============================================
Contents:
.. toctree::
:maxdepth: 2
introduction
how_to_use
plotting
images
style
region_of_interest
graphicswindow
parametertree
internals
apireference
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

51
documentation/build/html/_sources/introduction.txt
View File

@ -1,51 +0,0 @@
Introduction
============
What is pyqtgraph?
------------------
Pyqtgraph is a graphics and user interface library for Python that provides functionality commonly required in engineering and science applications. Its primary goals are 1) to provide fast, interactive graphics for displaying data (plots, video, etc.) and 2) to provide tools to aid in rapid application development (for example, property trees such as used in Qt Designer).
Pyqtgraph makes heavy use of the Qt GUI platform (via PyQt or PySide) for its high-performance graphics and numpy for heavy number crunching. In particular, pyqtgraph uses Qt's GraphicsView framework which is a highly capable graphics system on its own; we bring optimized and simplified primitives to this framework to allow data visualization with minimal effort.
It is known to run on Linux, Windows, and OSX
What can it do?
---------------
Amongst the core features of pyqtgraph are:
* Basic data visualization primitives: Images, line and scatter plots
* Fast enough for realtime update of video/plot data
* Interactive scaling/panning, averaging, FFTs, SVG/PNG export
* Widgets for marking/selecting plot regions
* Widgets for marking/selecting image region-of-interest and automatically slicing multi-dimensional image data
* Framework for building customized image region-of-interest widgets
* Docking system that replaces/complements Qt's dock system to allow more complex (and more predictable) docking arrangements
* ParameterTree widget for rapid prototyping of dynamic interfaces (Similar to the property trees in Qt Designer and many other applications)
.. _examples:
Examples
--------
Pyqtgraph includes an extensive set of examples that can be accessed by running::
import pyqtgraph.examples
pyqtgraph.examples.run()
This will start a launcher with a list of available examples. Select an item from the list to view its source code and double-click an item to run the example.
How does it compare to...
-------------------------
* matplotlib: For plotting and making publication-quality graphics, matplotlib is far more mature than pyqtgraph. However, matplotlib is also much slower and not suitable for applications requiring realtime update of plots/video or rapid interactivity. It also does not provide any of the GUI tools and image interaction/slicing functionality in pyqtgraph.
* pyqwt5: pyqwt is generally more mature than pyqtgraph for plotting and is about as fast. The major differences are 1) pyqtgraph is written in pure python, so it is somewhat more portable than pyqwt, which often lags behind pyqt in development (and can be a pain to install on some platforms) and 2) like matplotlib, pyqwt does not provide any of the GUI tools and image interaction/slicing functionality in pyqtgraph.
(My experience with these libraries is somewhat outdated; please correct me if I am wrong here)

7
documentation/build/html/_sources/parametertree.txt
View File

@ -1,7 +0,0 @@
Rapid GUI prototyping
=====================
- parametertree
- dockarea
- flowchart
- canvas

73
documentation/build/html/_sources/plotting.txt
View File

@ -1,73 +0,0 @@
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
================================================================ ==================================================
All of these will accept the same basic arguments which control how the plot data is interpreted and displayed:
* x - Optional X data; if not specified, then a range of integers will be generated automatically.
* y - Y data.
* pen - The pen to use when drawing plot lines, or None to disable lines.
* symbol - A string describing the shape of symbols to use for each point. Optionally, this may also be a sequence of strings with a different symbol for each point.
* symbolPen - The pen (or sequence of pens) to use when drawing the symbol outline.
* symbolBrush - The brush (or sequence of brushes) to use when filling the symbol.
* fillLevel - Fills the area under the plot curve to this Y-value.
* brush - The brush to use when filling under the curve.
See the 'plotting' :ref:`example <examples>` for a demonstration of these arguments.
All of the above functions also return handles to the objects that are created, allowing the plots and data to be further modified.
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.
* 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.
* 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.
.. image:: images/plottingClasses.png
Examples
--------
See the 'plotting' and 'PlotWidget' :ref:`examples included with pyqtgraph <examples>` for more information.
Show x,y data as scatter plot::
import pyqtgraph as pg
import numpy as np
x = np.random.normal(size=1000)
y = np.random.normal(size=1000)
pg.plot(x, y, pen=None, symbol='o') ## setting pen=None disables line drawing
Create/show a plot widget, display three data curves::
import pyqtgraph as pg
import numpy as np
x = np.arange(1000)
y = np.random.normal(size=(3, 1000))
plotWidget = pg.plot(title="Three plot curves")
for i in range(3):
plotWidget.plot(x, y[i], pen=(i,3)) ## setting pen=(i,3) automaticaly creates three different-colored pens

19
documentation/build/html/_sources/region_of_interest.txt
View File

@ -1,19 +0,0 @@
Region-of-interest controls
===========================
Slicing Multidimensional Data
-----------------------------
Linear Selection and Marking
----------------------------
2D Selection and Marking
------------------------
- translate / rotate / scale
- highly configurable control handles
- automated data slicing
- linearregion, infiniteline

17
documentation/build/html/_sources/style.txt
View File

@ -1,17 +0,0 @@
Line, Fill, and Color
=====================
Many functions and methods in pyqtgraph accept arguments specifying the line style (pen), fill style (brush), or color.
For these function arguments, the following values may be used:
* single-character string representing color (b, g, r, c, m, y, k, w)
* (r, g, b) or (r, g, b, a) tuple
* single greyscale value (0.0 - 1.0)
* (index, maximum) tuple for automatically iterating through colors (see functions.intColor)
* QColor
* QPen / QBrush where appropriate
Notably, more complex pens and brushes can be easily built using the mkPen() / mkBrush() functions or with Qt's QPen and QBrush classes.
Colors can also be built using mkColor(), intColor(), hsvColor(), or Qt's QColor class

8
documentation/build/html/_sources/widgets/checktable.txt
View File

@ -1,8 +0,0 @@
CheckTable
==========
.. autoclass:: pyqtgraph.CheckTable
:members:
.. automethod:: pyqtgraph.CheckTable.__init__

8
documentation/build/html/_sources/widgets/colorbutton.txt
View File

@ -1,8 +0,0 @@
ColorButton
===========
.. autoclass:: pyqtgraph.ColorButton
:members:
.. automethod:: pyqtgraph.ColorButton.__init__

8
documentation/build/html/_sources/widgets/datatreewidget.txt
View File

@ -1,8 +0,0 @@
DataTreeWidget
==============
.. autoclass:: pyqtgraph.DataTreeWidget
:members:
.. automethod:: pyqtgraph.DataTreeWidget.__init__

5
documentation/build/html/_sources/widgets/dockarea.txt
View File

@ -1,5 +0,0 @@
dockarea module
===============
.. automodule:: pyqtgraph.dockarea
:members:

8
documentation/build/html/_sources/widgets/filedialog.txt
View File

@ -1,8 +0,0 @@
FileDialog
==========
.. autoclass:: pyqtgraph.FileDialog
:members:
.. automethod:: pyqtgraph.FileDialog.__init__

8
documentation/build/html/_sources/widgets/gradientwidget.txt
View File

@ -1,8 +0,0 @@
GradientWidget
==============
.. autoclass:: pyqtgraph.GradientWidget
:members:
.. automethod:: pyqtgraph.GradientWidget.__init__

8
documentation/build/html/_sources/widgets/graphicslayoutwidget.txt
View File

@ -1,8 +0,0 @@
GraphicsLayoutWidget
====================
.. autoclass:: pyqtgraph.GraphicsLayoutWidget
:members:
.. automethod:: pyqtgraph.GraphicsLayoutWidget.__init__

8
documentation/build/html/_sources/widgets/graphicsview.txt
View File

@ -1,8 +0,0 @@
GraphicsView
============
.. autoclass:: pyqtgraph.GraphicsView
:members:
.. automethod:: pyqtgraph.GraphicsView.__init__

8
documentation/build/html/_sources/widgets/histogramlutwidget.txt
View File

@ -1,8 +0,0 @@
HistogramLUTWidget
==================
.. autoclass:: pyqtgraph.HistogramLUTWidget
:members:
.. automethod:: pyqtgraph.HistogramLUTWidget.__init__

31
documentation/build/html/_sources/widgets/index.txt
View File

@ -1,31 +0,0 @@
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.
Contents:
.. toctree::
:maxdepth: 2
plotwidget
imageview
datatreewidget
checktable
tablewidget
gradientwidget
colorbutton
graphicslayoutwidget
dockarea
parametertree
histogramlutwidget
progressdialog
spinbox
filedialog
graphicsview
joystickbutton
multiplotwidget
treewidget
verticallabel
rawimagewidget

8
documentation/build/html/_sources/widgets/joystickbutton.txt
View File

@ -1,8 +0,0 @@
JoystickButton
==============
.. autoclass:: pyqtgraph.JoystickButton
:members:
.. automethod:: pyqtgraph.JoystickButton.__init__

8
documentation/build/html/_sources/widgets/multiplotwidget.txt
View File

@ -1,8 +0,0 @@
MultiPlotWidget
===============
.. autoclass:: pyqtgraph.MultiPlotWidget
:members:
.. automethod:: pyqtgraph.MultiPlotWidget.__init__

5
documentation/build/html/_sources/widgets/parametertree.txt
View File

@ -1,5 +0,0 @@
parametertree module
====================
.. automodule:: pyqtgraph.parametertree
:members:

8
documentation/build/html/_sources/widgets/plotwidget.txt
View File

@ -1,8 +0,0 @@
PlotWidget
==========
.. autoclass:: pyqtgraph.PlotWidget
:members:
.. automethod:: pyqtgraph.PlotWidget.__init__

8
documentation/build/html/_sources/widgets/progressdialog.txt
View File

@ -1,8 +0,0 @@
ProgressDialog
==============
.. autoclass:: pyqtgraph.ProgressDialog
:members:
.. automethod:: pyqtgraph.ProgressDialog.__init__

8
documentation/build/html/_sources/widgets/rawimagewidget.txt
View File

@ -1,8 +0,0 @@
RawImageWidget
==============
.. autoclass:: pyqtgraph.RawImageWidget
:members:
.. automethod:: pyqtgraph.RawImageWidget.__init__

8
documentation/build/html/_sources/widgets/spinbox.txt
View File

@ -1,8 +0,0 @@
SpinBox
=======
.. autoclass:: pyqtgraph.SpinBox
:members:
.. automethod:: pyqtgraph.SpinBox.__init__

8
documentation/build/html/_sources/widgets/tablewidget.txt
View File

@ -1,8 +0,0 @@
TableWidget
===========
.. autoclass:: pyqtgraph.TableWidget
:members:
.. automethod:: pyqtgraph.TableWidget.__init__

8
documentation/build/html/_sources/widgets/treewidget.txt
View File

@ -1,8 +0,0 @@
TreeWidget
==========
.. autoclass:: pyqtgraph.TreeWidget
:members:
.. automethod:: pyqtgraph.TreeWidget.__init__

8
documentation/build/html/_sources/widgets/verticallabel.txt
View File

@ -1,8 +0,0 @@
VerticalLabel
=============
.. autoclass:: pyqtgraph.VerticalLabel
:members:
.. automethod:: pyqtgraph.VerticalLabel.__init__

509
documentation/build/html/_static/basic.css
View File

@ -1,509 +0,0 @@
/*
* basic.css
* ~~~~~~~~~
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
}
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
}
div.sphinxsidebar ul {
list-style: none;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
img {
border: 0;
}
/* -- search page ----------------------------------------------------------- */
ul.search {
margin: 10px 0 0 20px;
padding: 0;
}
ul.search li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}
ul.search li a {
font-weight: bold;
}
ul.search li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
}
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable dl, table.indextable dd {
margin-top: 0;
margin-bottom: 0;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
/* -- general body styles --------------------------------------------------- */
a.headerlink {
visibility: hidden;
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink {
visibility: visible;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
.field-list ul {
padding-left: 1em;
}
.first {
margin-top: 0 !important;
}
p.rubric {
margin-top: 30px;
font-weight: bold;
}
.align-left {
text-align: left;
}
.align-center {
clear: both;
text-align: center;
}
.align-right {
text-align: right;
}
/* -- sidebars -------------------------------------------------------------- */
div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px 7px 0 7px;
background-color: #ffe;
width: 40%;
float: right;
}
p.sidebar-title {
font-weight: bold;
}
/* -- topics ---------------------------------------------------------------- */
div.topic {
border: 1px solid #ccc;
padding: 7px 7px 0 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
div.admonition dl {
margin-bottom: 0;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
/* -- tables ---------------------------------------------------------------- */
table.docutils {
border: 0;
border-collapse: collapse;
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
table.field-list td, table.field-list th {
border: 0 !important;
}
table.footnote td, table.footnote th {
border: 0 !important;
}
th {
text-align: left;
padding-right: 5px;
}
table.citation {
border-left: solid 1px gray;
margin-left: 1px;
}
table.citation td {
border-bottom: none;
}
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
list-style: decimal;
}
ol.loweralpha {
list-style: lower-alpha;
}
ol.upperalpha {
list-style: upper-alpha;
}
ol.lowerroman {
list-style: lower-roman;
}
ol.upperroman {
list-style: upper-roman;
}
dl {
margin-bottom: 15px;
}
dd p {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
dt:target, .highlighted {
background-color: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.refcount {
color: #060;
}
.optional {
font-size: 1.3em;
}
.versionmodified {
font-style: italic;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
.footnote:target {
background-color: #ffa
}
.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em;
}
.line-block .line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em;
}
.guilabel, .menuselection {
font-family: sans-serif;
}
.accelerator {
text-decoration: underline;
}
.classifier {
font-style: oblique;
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
}
td.linenos pre {
padding: 5px 0px;
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
margin-left: 0.5em;
}
table.highlighttable td {
padding: 0 0.5em 0 0.5em;
}
tt.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
}
tt.descclassname {
background-color: transparent;
}
tt.xref, a tt {
background-color: transparent;
font-weight: bold;
}
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
background-color: transparent;
}
.viewcode-link {
float: right;
}
.viewcode-back {
float: right;
font-family: sans-serif;
}
div.viewcode-block:target {
margin: -1px -10px;
padding: 0 10px;
}
/* -- math display ---------------------------------------------------------- */
img.math {
vertical-align: middle;
}
div.body div.math p {
text-align: center;
}
span.eqno {
float: right;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0 !important;
width: 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
#top-link {
display: none;
}
}

255
documentation/build/html/_static/default.css
View File

@ -1,255 +0,0 @@
/*
* default.css_t
* ~~~~~~~~~~~~~
*
* Sphinx stylesheet -- default theme.
*
* :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@import url("basic.css");
/* -- page layout ----------------------------------------------------------- */
body {
font-family: sans-serif;
font-size: 100%;
background-color: #11303d;
color: #000;
margin: 0;
padding: 0;
}
div.document {
background-color: #1c4e63;
}
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 0 0 230px;
}
div.body {
background-color: #ffffff;
color: #000000;
padding: 0 20px 30px 20px;
}
div.footer {
color: #ffffff;
width: 100%;
padding: 9px 0 9px 0;
text-align: center;
font-size: 75%;
}
div.footer a {
color: #ffffff;
text-decoration: underline;
}
div.related {
background-color: #133f52;
line-height: 30px;
color: #ffffff;
}
div.related a {
color: #ffffff;
}
div.sphinxsidebar {
}
div.sphinxsidebar h3 {
font-family: 'Trebuchet MS', sans-serif;
color: #ffffff;
font-size: 1.4em;
font-weight: normal;
margin: 0;
padding: 0;
}
div.sphinxsidebar h3 a {
color: #ffffff;
}
div.sphinxsidebar h4 {
font-family: 'Trebuchet MS', sans-serif;
color: #ffffff;
font-size: 1.3em;
font-weight: normal;
margin: 5px 0 0 0;
padding: 0;
}
div.sphinxsidebar p {
color: #ffffff;
}
div.sphinxsidebar p.topless {
margin: 5px 10px 10px 10px;
}
div.sphinxsidebar ul {
margin: 10px;
padding: 0;
color: #ffffff;
}
div.sphinxsidebar a {
color: #98dbcc;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
/* -- hyperlink styles ------------------------------------------------------ */
a {
color: #355f7c;
text-decoration: none;
}
a:visited {
color: #355f7c;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
/* -- body styles ----------------------------------------------------------- */
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: 'Trebuchet MS', sans-serif;
background-color: #f2f2f2;
font-weight: normal;
color: #20435c;
border-bottom: 1px solid #ccc;
margin: 20px -20px 10px -20px;
padding: 3px 0 3px 10px;
}
div.body h1 { margin-top: 0; font-size: 200%; }
div.body h2 { font-size: 160%; }
div.body h3 { font-size: 140%; }
div.body h4 { font-size: 120%; }
div.body h5 { font-size: 110%; }
div.body h6 { font-size: 100%; }
a.headerlink {
color: #c60f0f;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
}
a.headerlink:hover {
background-color: #c60f0f;
color: white;
}
div.body p, div.body dd, div.body li {
text-align: justify;
line-height: 130%;
}
div.admonition p.admonition-title + p {
display: inline;
}
div.admonition p {
margin-bottom: 5px;
}
div.admonition pre {
margin-bottom: 5px;
}
div.admonition ul, div.admonition ol {
margin-bottom: 5px;
}
div.note {
background-color: #eee;
border: 1px solid #ccc;
}
div.seealso {
background-color: #ffc;
border: 1px solid #ff6;
}
div.topic {
background-color: #eee;
}
div.warning {
background-color: #ffe4e4;
border: 1px solid #f66;
}
p.admonition-title {
display: inline;
}
p.admonition-title:after {
content: ":";
}
pre {
padding: 5px;
background-color: #eeffcc;
color: #333333;
line-height: 120%;
border: 1px solid #ac9;
border-left: none;
border-right: none;
}
tt {
background-color: #ecf0f3;
padding: 0 1px 0 1px;
font-size: 0.95em;
}
th {
background-color: #ede;
}
.warning tt {
background: #efc2c2;
}
.note tt {
background: #d6d6d6;
}
.viewcode-back {
font-family: sans-serif;
}
div.viewcode-block:target {
background-color: #f4debf;
border-top: 1px solid #ac9;
border-bottom: 1px solid #ac9;
}

247
documentation/build/html/_static/doctools.js
View File

@ -1,247 +0,0 @@
/*
* doctools.js
* ~~~~~~~~~~~
*
* Sphinx JavaScript utilties for all documentation.
*
* :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/**
* select a different prefix for underscore
*/
$u = _.noConflict();
/**
* make the code below compatible with browsers without
* an installed firebug like debugger
if (!window.console || !console.firebug) {
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
"profile", "profileEnd"];
window.console = {};
for (var i = 0; i < names.length; ++i)
window.console[names[i]] = function() {};
}
*/
/**
* small helper function to urldecode strings
*/
jQuery.urldecode = function(x) {
return decodeURIComponent(x).replace(/\+/g, ' ');
}
/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;
/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s == 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};
/**
* small function to check if an array contains
* a given item.
*/
jQuery.contains = function(arr, item) {
for (var i = 0; i < arr.length; i++) {
if (arr[i] == item)
return true;
}
return false;
};
/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node) {
if (node.nodeType == 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
var span = document.createElement("span");
span.className = className;
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this);
});
}
}
return this.each(function() {
highlight(this);
});
};
/**
* Small JavaScript module for the documentation.
*/
var Documentation = {
init : function() {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
},
/**
* i18n support
*/
TRANSLATIONS : {},
PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext : function(string) {
var translated = Documentation.TRANSLATIONS[string];
if (typeof translated == 'undefined')
return string;
return (typeof translated == 'string') ? translated : translated[0];
},
ngettext : function(singular, plural, n) {
var translated = Documentation.TRANSLATIONS[singular];
if (typeof translated == 'undefined')
return (n == 1) ? singular : plural;
return translated[Documentation.PLURALEXPR(n)];
},
addTranslations : function(catalog) {
for (var key in catalog.messages)
this.TRANSLATIONS[key] = catalog.messages[key];
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
this.LOCALE = catalog.locale;
},
/**
* add context elements like header anchor links
*/
addContextElements : function() {
$('div[id] > :header:first').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this headline')).
appendTo(this);
});
$('dt[id]').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this definition')).
appendTo(this);
});
},
/**
* workaround a firefox stupidity
*/
fixFirefoxAnchorBug : function() {
if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() {
document.location.href += '';
}, 10);
},
/**
* highlight the search words provided in the url in the text
*/
highlightSearchWords : function() {
var params = $.getQueryParameters();
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
if (terms.length) {
var body = $('div.body');
window.setTimeout(function() {
$.each(terms, function() {
body.highlightText(this.toLowerCase(), 'highlighted');
});
}, 10);
$('<li class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></li>')
.appendTo($('.sidebar .this-page-menu'));
}
},
/**
* init the domain index toggle buttons
*/
initIndexTable : function() {
var togglers = $('img.toggler').click(function() {
var src = $(this).attr('src');
var idnum = $(this).attr('id').substr(7);
$('tr.cg-' + idnum).toggle();
if (src.substr(-9) == 'minus.png')
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
else
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
}).css('display', '');
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
togglers.click();
}
},
/**
* helper function to hide the search marks again
*/
hideSearchWords : function() {
$('.sidebar .this-page-menu li.highlight-link').fadeOut(300);
$('span.highlighted').removeClass('highlighted');
},
/**
* make the url absolute
*/
makeURL : function(relativeURL) {
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
},
/**
* get the current relative url
*/
getCurrentURL : function() {
var path = document.location.pathname;
var parts = path.split(/\//);
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
if (this == '..')
parts.pop();
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
}
};
// quick alias for translations
_ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
});

BIN
documentation/build/html/_static/file.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 392 B

8176
documentation/build/html/_static/jquery.js vendored
View File

File diff suppressed because it is too large Load Diff

BIN
documentation/build/html/_static/minus.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 199 B

BIN
documentation/build/html/_static/plus.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 199 B

61
documentation/build/html/_static/pygments.css
View File

@ -1,61 +0,0 @@
.hll { background-color: #ffffcc }
.c { color: #408090; font-style: italic } /* Comment */
.err { border: 1px solid #FF0000 } /* Error */
.k { color: #007020; font-weight: bold } /* Keyword */
.o { color: #666666 } /* Operator */
.cm { color: #408090; font-style: italic } /* Comment.Multiline */
.cp { color: #007020 } /* Comment.Preproc */
.c1 { color: #408090; font-style: italic } /* Comment.Single */
.cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.gd { color: #A00000 } /* Generic.Deleted */
.ge { font-style: italic } /* Generic.Emph */
.gr { color: #FF0000 } /* Generic.Error */
.gh { color: #000080; font-weight: bold } /* Generic.Heading */
.gi { color: #00A000 } /* Generic.Inserted */
.go { color: #303030 } /* Generic.Output */
.gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.gs { font-weight: bold } /* Generic.Strong */
.gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.gt { color: #0040D0 } /* Generic.Traceback */
.kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.kp { color: #007020 } /* Keyword.Pseudo */
.kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.kt { color: #902000 } /* Keyword.Type */
.m { color: #208050 } /* Literal.Number */
.s { color: #4070a0 } /* Literal.String */
.na { color: #4070a0 } /* Name.Attribute */
.nb { color: #007020 } /* Name.Builtin */
.nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.no { color: #60add5 } /* Name.Constant */
.nd { color: #555555; font-weight: bold } /* Name.Decorator */
.ni { color: #d55537; font-weight: bold } /* Name.Entity */
.ne { color: #007020 } /* Name.Exception */
.nf { color: #06287e } /* Name.Function */
.nl { color: #002070; font-weight: bold } /* Name.Label */
.nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.nt { color: #062873; font-weight: bold } /* Name.Tag */
.nv { color: #bb60d5 } /* Name.Variable */
.ow { color: #007020; font-weight: bold } /* Operator.Word */
.w { color: #bbbbbb } /* Text.Whitespace */
.mf { color: #208050 } /* Literal.Number.Float */
.mh { color: #208050 } /* Literal.Number.Hex */
.mi { color: #208050 } /* Literal.Number.Integer */
.mo { color: #208050 } /* Literal.Number.Oct */
.sb { color: #4070a0 } /* Literal.String.Backtick */
.sc { color: #4070a0 } /* Literal.String.Char */
.sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.s2 { color: #4070a0 } /* Literal.String.Double */
.se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.sh { color: #4070a0 } /* Literal.String.Heredoc */
.si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.sx { color: #c65d09 } /* Literal.String.Other */
.sr { color: #235388 } /* Literal.String.Regex */
.s1 { color: #4070a0 } /* Literal.String.Single */
.ss { color: #517918 } /* Literal.String.Symbol */
.bp { color: #007020 } /* Name.Builtin.Pseudo */
.vc { color: #bb60d5 } /* Name.Variable.Class */
.vg { color: #bb60d5 } /* Name.Variable.Global */
.vi { color: #bb60d5 } /* Name.Variable.Instance */
.il { color: #208050 } /* Literal.Number.Integer.Long */

518
documentation/build/html/_static/searchtools.js
View File

@ -1,518 +0,0 @@
/*
* searchtools.js
* ~~~~~~~~~~~~~~
*
* Sphinx JavaScript utilties for the full-text search.
*
* :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/**
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, hlwords is the list of normal, unstemmed
* words. the first one is used to find the occurance, the
* latter for highlighting it.
*/
jQuery.makeSearchSummary = function(text, keywords, hlwords) {
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {
var i = textLower.indexOf(this.toLowerCase());
if (i > -1)
start = i;
});
start = Math.max(start - 120, 0);
var excerpt = ((start > 0) ? '...' : '') +
$.trim(text.substr(start, 240)) +
((start + 240 - text.length) ? '...' : '');
var rv = $('<div class="context"></div>').text(excerpt);
$.each(hlwords, function() {
rv = rv.highlightText(this, 'highlighted');
});
return rv;
}
/**
* Porter Stemmer
*/
var PorterStemmer = function() {
var step2list = {
ational: 'ate',
tional: 'tion',
enci: 'ence',
anci: 'ance',
izer: 'ize',
bli: 'ble',
alli: 'al',
entli: 'ent',
eli: 'e',
ousli: 'ous',
ization: 'ize',
ation: 'ate',
ator: 'ate',
alism: 'al',
iveness: 'ive',
fulness: 'ful',
ousness: 'ous',
aliti: 'al',
iviti: 'ive',
biliti: 'ble',
logi: 'log'
};
var step3list = {
icate: 'ic',
ative: '',
alize: 'al',
iciti: 'ic',
ical: 'ic',
ful: '',
ness: ''
};
var c = "[^aeiou]"; // consonant
var v = "[aeiouy]"; // vowel
var C = c + "[^aeiouy]*"; // consonant sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
var stem;
var suffix;
var firstch;
var origword = w;
if (w.length < 3)
return w;
var re;
var re2;
var re3;
var re4;
firstch = w.substr(0,1);
if (firstch == "y")
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
re = /^(.+?)(ss|i)es$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
w = w.replace(re,"$1$2");
else if (re2.test(w))
w = w.replace(re2,"$1$2");
// Step 1b
re = /^(.+?)eed$/;
re2 = /^(.+?)(ed|ing)$/;
if (re.test(w)) {
var fp = re.exec(w);
re = new RegExp(mgr0);
if (re.test(fp[1])) {
re = /.$/;
w = w.replace(re,"");
}
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1];
re2 = new RegExp(s_v);
if (re2.test(stem)) {
w = stem;
re2 = /(at|bl|iz)$/;
re3 = new RegExp("([^aeiouylsz])\\1$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re2.test(w))
w = w + "e";
else if (re3.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
else if (re4.test(w))
w = w + "e";
}
}
// Step 1c
re = /^(.+?)y$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(s_v);
if (re.test(stem))
w = stem + "i";
}
// Step 2
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step2list[suffix];
}
// Step 3
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step3list[suffix];
}
// Step 4
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re2 = /^(.+?)(s|t)(ion)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
if (re.test(stem))
w = stem;
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1] + fp[2];
re2 = new RegExp(mgr1);
if (re2.test(stem))
w = stem;
}
// Step 5
re = /^(.+?)e$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
re2 = new RegExp(meq1);
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
w = stem;
}
re = /ll$/;
re2 = new RegExp(mgr1);
if (re.test(w) && re2.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
// and turn initial Y back to y
if (firstch == "y")
w = firstch.toLowerCase() + w.substr(1);
return w;
}
}
/**
* Search Module
*/
var Search = {
_index : null,
_queued_query : null,
_pulse_status : -1,
init : function() {
var params = $.getQueryParameters();
if (params.q) {
var query = params.q[0];
$('input[name="q"]')[0].value = query;
this.performSearch(query);
}
},
loadIndex : function(url) {
$.ajax({type: "GET", url: url, data: null, success: null,
dataType: "script", cache: true});
},
setIndex : function(index) {
var q;
this._index = index;
if ((q = this._queued_query) !== null) {
this._queued_query = null;
Search.query(q);
}
},
hasIndex : function() {
return this._index !== null;
},
deferQuery : function(query) {
this._queued_query = query;
},
stopPulse : function() {
this._pulse_status = 0;
},
startPulse : function() {
if (this._pulse_status >= 0)
return;
function pulse() {
Search._pulse_status = (Search._pulse_status + 1) % 4;
var dotString = '';
for (var i = 0; i < Search._pulse_status; i++)
dotString += '.';
Search.dots.text(dotString);
if (Search._pulse_status > -1)
window.setTimeout(pulse, 500);
};
pulse();
},
/**
* perform a search for something
*/
performSearch : function(query) {
// create the required interface elements
this.out = $('#search-results');
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
this.dots = $('<span></span>').appendTo(this.title);
this.status = $('<p style="display: none"></p>').appendTo(this.out);
this.output = $('<ul class="search"/>').appendTo(this.out);
$('#search-progress').text(_('Preparing search...'));
this.startPulse();
// index already loaded, the browser was quick!
if (this.hasIndex())
this.query(query);
else
this.deferQuery(query);
},
query : function(query) {
var stopwords = ['and', 'then', 'into', 'it', 'as', 'are', 'in',
'if', 'for', 'no', 'there', 'their', 'was', 'is',
'be', 'to', 'that', 'but', 'they', 'not', 'such',
'with', 'by', 'a', 'on', 'these', 'of', 'will',
'this', 'near', 'the', 'or', 'at'];
// stem the searchterms and add them to the correct list
var stemmer = new PorterStemmer();
var searchterms = [];
var excluded = [];
var hlterms = [];
var tmp = query.split(/\s+/);
var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null;
for (var i = 0; i < tmp.length; i++) {
if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) ||
tmp[i] == "") {
// skip this "word"
continue;
}
// stem the word
var word = stemmer.stemWord(tmp[i]).toLowerCase();
// select the correct list
if (word[0] == '-') {
var toAppend = excluded;
word = word.substr(1);
}
else {
var toAppend = searchterms;
hlterms.push(tmp[i].toLowerCase());
}
// only add if not already in the list
if (!$.contains(toAppend, word))
toAppend.push(word);
};
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
// console.debug('SEARCH: searching for:');
// console.info('required: ', searchterms);
// console.info('excluded: ', excluded);
// prepare search
var filenames = this._index.filenames;
var titles = this._index.titles;
var terms = this._index.terms;
var objects = this._index.objects;
var objtypes = this._index.objtypes;
var objnames = this._index.objnames;
var fileMap = {};
var files = null;
// different result priorities
var importantResults = [];
var objectResults = [];
var regularResults = [];
var unimportantResults = [];
$('#search-progress').empty();
// lookup as object
if (object != null) {
for (var prefix in objects) {
for (var name in objects[prefix]) {
var fullname = (prefix ? prefix + '.' : '') + name;
if (fullname.toLowerCase().indexOf(object) > -1) {
match = objects[prefix][name];
descr = objnames[match[1]] + _(', in ') + titles[match[0]];
// XXX the generated anchors are not generally correct
// XXX there may be custom prefixes
result = [filenames[match[0]], fullname, '#'+fullname, descr];
switch (match[2]) {
case 1: objectResults.push(result); break;
case 0: importantResults.push(result); break;
case 2: unimportantResults.push(result); break;
}
}
}
}
}
// sort results descending
objectResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
importantResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
unimportantResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
// perform the search on the required terms
for (var i = 0; i < searchterms.length; i++) {
var word = searchterms[i];
// no match but word was a required one
if ((files = terms[word]) == null)
break;
if (files.length == undefined) {
files = [files];
}
// create the mapping
for (var j = 0; j < files.length; j++) {
var file = files[j];
if (file in fileMap)
fileMap[file].push(word);
else
fileMap[file] = [word];
}
}
// now check if the files don't contain excluded terms
for (var file in fileMap) {
var valid = true;
// check if all requirements are matched
if (fileMap[file].length != searchterms.length)
continue;
// ensure that none of the excluded terms is in the
// search result.
for (var i = 0; i < excluded.length; i++) {
if (terms[excluded[i]] == file ||
$.contains(terms[excluded[i]] || [], file)) {
valid = false;
break;
}
}
// if we have still a valid result we can add it
// to the result list
if (valid)
regularResults.push([filenames[file], titles[file], '', null]);
}
// delete unused variables in order to not waste
// memory until list is retrieved completely
delete filenames, titles, terms;
// now sort the regular results descending by title
regularResults.sort(function(a, b) {
var left = a[1].toLowerCase();
var right = b[1].toLowerCase();
return (left > right) ? -1 : ((left < right) ? 1 : 0);
});
// combine all results
var results = unimportantResults.concat(regularResults)
.concat(objectResults).concat(importantResults);
// print the results
var resultCount = results.length;
function displayNextItem() {
// results left, load the summary and display it
if (results.length) {
var item = results.pop();
var listItem = $('<li style="display:none"></li>');
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') {
// dirhtml builder
var dirname = item[0] + '/';
if (dirname.match(/\/index\/$/)) {
dirname = dirname.substring(0, dirname.length-6);
} else if (dirname == 'index/') {
dirname = '';
}
listItem.append($('<a/>').attr('href',
DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
highlightstring + item[2]).html(item[1]));
} else {
// normal html builders
listItem.append($('<a/>').attr('href',
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
highlightstring + item[2]).html(item[1]));
}
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
$.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' +
item[0] + '.txt', function(data) {
if (data != '') {
listItem.append($.makeSearchSummary(data, searchterms, hlterms));
Search.output.append(listItem);
}
listItem.slideDown(5, function() {
displayNextItem();
});
});
} else {
// no source available, just display title
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
}
}
// search finished, update title and status message
else {
Search.stopPulse();
Search.title.text(_('Search Results'));
if (!resultCount)
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
else
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
Search.status.fadeIn(500);
}
}
displayNextItem();
}
}
$(document).ready(function() {
Search.init();
});

147
documentation/build/html/_static/sidebar.js
View File

@ -1,147 +0,0 @@
/*
* sidebar.js
* ~~~~~~~~~~
*
* This script makes the Sphinx sidebar collapsible.
*
* .sphinxsidebar contains .sphinxsidebarwrapper. This script adds
* in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton
* used to collapse and expand the sidebar.
*
* When the sidebar is collapsed the .sphinxsidebarwrapper is hidden
* and the width of the sidebar and the margin-left of the document
* are decreased. When the sidebar is expanded the opposite happens.
* This script saves a per-browser/per-session cookie used to
* remember the position of the sidebar among the pages.
* Once the browser is closed the cookie is deleted and the position
* reset to the default (expanded).
*
* :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
$(function() {
// global elements used by the functions.
// the 'sidebarbutton' element is defined as global after its
// creation, in the add_sidebar_button function
var bodywrapper = $('.bodywrapper');
var sidebar = $('.sphinxsidebar');
var sidebarwrapper = $('.sphinxsidebarwrapper');
// original margin-left of the bodywrapper and width of the sidebar
// with the sidebar expanded
var bw_margin_expanded = bodywrapper.css('margin-left');
var ssb_width_expanded = sidebar.width();
// margin-left of the bodywrapper and width of the sidebar
// with the sidebar collapsed
var bw_margin_collapsed = '.8em';
var ssb_width_collapsed = '.8em';
// colors used by the current theme
var dark_color = $('.related').css('background-color');
var light_color = $('.document').css('background-color');
function sidebar_is_collapsed() {
return sidebarwrapper.is(':not(:visible)');
}
function toggle_sidebar() {
if (sidebar_is_collapsed())
expand_sidebar();
else
collapse_sidebar();
}
function collapse_sidebar() {
sidebarwrapper.hide();
sidebar.css('width', ssb_width_collapsed);
bodywrapper.css('margin-left', bw_margin_collapsed);
sidebarbutton.css({
'margin-left': '0',
'height': bodywrapper.height()
});
sidebarbutton.find('span').text('»');
sidebarbutton.attr('title', _('Expand sidebar'));
document.cookie = 'sidebar=collapsed';
}
function expand_sidebar() {
bodywrapper.css('margin-left', bw_margin_expanded);
sidebar.css('width', ssb_width_expanded);
sidebarwrapper.show();
sidebarbutton.css({
'margin-left': ssb_width_expanded-12,
'height': bodywrapper.height()
});
sidebarbutton.find('span').text('«');
sidebarbutton.attr('title', _('Collapse sidebar'));
document.cookie = 'sidebar=expanded';
}
function add_sidebar_button() {
sidebarwrapper.css({
'float': 'left',
'margin-right': '0',
'width': ssb_width_expanded - 28
});
// create the button
sidebar.append(
'<div id="sidebarbutton"><span>&laquo;</span></div>'
);
var sidebarbutton = $('#sidebarbutton');
// find the height of the viewport to center the '<<' in the page
var viewport_height;
if (window.innerHeight)
viewport_height = window.innerHeight;
else
viewport_height = $(window).height();
sidebarbutton.find('span').css({
'display': 'block',
'margin-top': (viewport_height - sidebar.position().top - 20) / 2
});
sidebarbutton.click(toggle_sidebar);
sidebarbutton.attr('title', _('Collapse sidebar'));
sidebarbutton.css({
'color': '#FFFFFF',
'border-left': '1px solid ' + dark_color,
'font-size': '1.2em',
'cursor': 'pointer',
'height': bodywrapper.height(),
'padding-top': '1px',
'margin-left': ssb_width_expanded - 12
});
sidebarbutton.hover(
function () {
$(this).css('background-color', dark_color);
},
function () {
$(this).css('background-color', light_color);
}
);
}
function set_position_from_cookie() {
if (!document.cookie)
return;
var items = document.cookie.split(';');
for(var k=0; k<items.length; k++) {
var key_val = items[k].split('=');
var key = key_val[0];
if (key == 'sidebar') {
var value = key_val[1];
if ((value == 'collapsed') && (!sidebar_is_collapsed()))
collapse_sidebar();
else if ((value == 'expanded') && (sidebar_is_collapsed()))
expand_sidebar();
}
}
}
add_sidebar_button();
var sidebarbutton = $('#sidebarbutton');
set_position_from_cookie();
});

16
documentation/build/html/_static/underscore.js
View File

@ -1,16 +0,0 @@
(function(){var j=this,n=j._,i=function(a){this._wrapped=a},m=typeof StopIteration!=="undefined"?StopIteration:"__break__",b=j._=function(a){return new i(a)};if(typeof exports!=="undefined")exports._=b;var k=Array.prototype.slice,o=Array.prototype.unshift,p=Object.prototype.toString,q=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;b.VERSION="0.5.5";b.each=function(a,c,d){try{if(a.forEach)a.forEach(c,d);else if(b.isArray(a)||b.isArguments(a))for(var e=0,f=a.length;e<f;e++)c.call(d,
a[e],e,a);else{var g=b.keys(a);f=g.length;for(e=0;e<f;e++)c.call(d,a[g[e]],g[e],a)}}catch(h){if(h!=m)throw h;}return a};b.map=function(a,c,d){if(a&&b.isFunction(a.map))return a.map(c,d);var e=[];b.each(a,function(f,g,h){e.push(c.call(d,f,g,h))});return e};b.reduce=function(a,c,d,e){if(a&&b.isFunction(a.reduce))return a.reduce(b.bind(d,e),c);b.each(a,function(f,g,h){c=d.call(e,c,f,g,h)});return c};b.reduceRight=function(a,c,d,e){if(a&&b.isFunction(a.reduceRight))return a.reduceRight(b.bind(d,e),c);
var f=b.clone(b.toArray(a)).reverse();b.each(f,function(g,h){c=d.call(e,c,g,h,a)});return c};b.detect=function(a,c,d){var e;b.each(a,function(f,g,h){if(c.call(d,f,g,h)){e=f;b.breakLoop()}});return e};b.select=function(a,c,d){if(a&&b.isFunction(a.filter))return a.filter(c,d);var e=[];b.each(a,function(f,g,h){c.call(d,f,g,h)&&e.push(f)});return e};b.reject=function(a,c,d){var e=[];b.each(a,function(f,g,h){!c.call(d,f,g,h)&&e.push(f)});return e};b.all=function(a,c,d){c=c||b.identity;if(a&&b.isFunction(a.every))return a.every(c,
d);var e=true;b.each(a,function(f,g,h){(e=e&&c.call(d,f,g,h))||b.breakLoop()});return e};b.any=function(a,c,d){c=c||b.identity;if(a&&b.isFunction(a.some))return a.some(c,d);var e=false;b.each(a,function(f,g,h){if(e=c.call(d,f,g,h))b.breakLoop()});return e};b.include=function(a,c){if(b.isArray(a))return b.indexOf(a,c)!=-1;var d=false;b.each(a,function(e){if(d=e===c)b.breakLoop()});return d};b.invoke=function(a,c){var d=b.rest(arguments,2);return b.map(a,function(e){return(c?e[c]:e).apply(e,d)})};b.pluck=
function(a,c){return b.map(a,function(d){return d[c]})};b.max=function(a,c,d){if(!c&&b.isArray(a))return Math.max.apply(Math,a);var e={computed:-Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;g>=e.computed&&(e={value:f,computed:g})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);var e={computed:Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;g<e.computed&&(e={value:f,computed:g})});return e.value};b.sortBy=function(a,c,d){return b.pluck(b.map(a,
function(e,f,g){return{value:e,criteria:c.call(d,e,f,g)}}).sort(function(e,f){e=e.criteria;f=f.criteria;return e<f?-1:e>f?1:0}),"value")};b.sortedIndex=function(a,c,d){d=d||b.identity;for(var e=0,f=a.length;e<f;){var g=e+f>>1;d(a[g])<d(c)?(e=g+1):(f=g)}return e};b.toArray=function(a){if(!a)return[];if(a.toArray)return a.toArray();if(b.isArray(a))return a;if(b.isArguments(a))return k.call(a);return b.values(a)};b.size=function(a){return b.toArray(a).length};b.first=function(a,c,d){return c&&!d?k.call(a,
0,c):a[0]};b.rest=function(a,c,d){return k.call(a,b.isUndefined(c)||d?1:c)};b.last=function(a){return a[a.length-1]};b.compact=function(a){return b.select(a,function(c){return!!c})};b.flatten=function(a){return b.reduce(a,[],function(c,d){if(b.isArray(d))return c.concat(b.flatten(d));c.push(d);return c})};b.without=function(a){var c=b.rest(arguments);return b.select(a,function(d){return!b.include(c,d)})};b.uniq=function(a,c){return b.reduce(a,[],function(d,e,f){if(0==f||(c===true?b.last(d)!=e:!b.include(d,
e)))d.push(e);return d})};b.intersect=function(a){var c=b.rest(arguments);return b.select(b.uniq(a),function(d){return b.all(c,function(e){return b.indexOf(e,d)>=0})})};b.zip=function(){for(var a=b.toArray(arguments),c=b.max(b.pluck(a,"length")),d=new Array(c),e=0;e<c;e++)d[e]=b.pluck(a,String(e));return d};b.indexOf=function(a,c){if(a.indexOf)return a.indexOf(c);for(var d=0,e=a.length;d<e;d++)if(a[d]===c)return d;return-1};b.lastIndexOf=function(a,c){if(a.lastIndexOf)return a.lastIndexOf(c);for(var d=
a.length;d--;)if(a[d]===c)return d;return-1};b.range=function(a,c,d){var e=b.toArray(arguments),f=e.length<=1;a=f?0:e[0];c=f?e[0]:e[1];d=e[2]||1;e=Math.ceil((c-a)/d);if(e<=0)return[];e=new Array(e);f=a;for(var g=0;1;f+=d){if((d>0?f-c:c-f)>=0)return e;e[g++]=f}};b.bind=function(a,c){var d=b.rest(arguments,2);return function(){return a.apply(c||j,d.concat(b.toArray(arguments)))}};b.bindAll=function(a){var c=b.rest(arguments);if(c.length==0)c=b.functions(a);b.each(c,function(d){a[d]=b.bind(a[d],a)});
return a};b.delay=function(a,c){var d=b.rest(arguments,2);return setTimeout(function(){return a.apply(a,d)},c)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(b.rest(arguments)))};b.wrap=function(a,c){return function(){var d=[a].concat(b.toArray(arguments));return c.apply(c,d)}};b.compose=function(){var a=b.toArray(arguments);return function(){for(var c=b.toArray(arguments),d=a.length-1;d>=0;d--)c=[a[d].apply(this,c)];return c[0]}};b.keys=function(a){if(b.isArray(a))return b.range(0,a.length);
var c=[];for(var d in a)q.call(a,d)&&c.push(d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=function(a){return b.select(b.keys(a),function(c){return b.isFunction(a[c])}).sort()};b.extend=function(a,c){for(var d in c)a[d]=c[d];return a};b.clone=function(a){if(b.isArray(a))return a.slice(0);return b.extend({},a)};b.tap=function(a,c){c(a);return a};b.isEqual=function(a,c){if(a===c)return true;var d=typeof a;if(d!=typeof c)return false;if(a==c)return true;if(!a&&c||a&&!c)return false;
if(a.isEqual)return a.isEqual(c);if(b.isDate(a)&&b.isDate(c))return a.getTime()===c.getTime();if(b.isNaN(a)&&b.isNaN(c))return true;if(b.isRegExp(a)&&b.isRegExp(c))return a.source===c.source&&a.global===c.global&&a.ignoreCase===c.ignoreCase&&a.multiline===c.multiline;if(d!=="object")return false;if(a.length&&a.length!==c.length)return false;d=b.keys(a);var e=b.keys(c);if(d.length!=e.length)return false;for(var f in a)if(!b.isEqual(a[f],c[f]))return false;return true};b.isEmpty=function(a){return b.keys(a).length==
0};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=function(a){return!!(a&&a.concat&&a.unshift)};b.isArguments=function(a){return a&&b.isNumber(a.length)&&!b.isArray(a)&&!r.call(a,"length")};b.isFunction=function(a){return!!(a&&a.constructor&&a.call&&a.apply)};b.isString=function(a){return!!(a===""||a&&a.charCodeAt&&a.substr)};b.isNumber=function(a){return p.call(a)==="[object Number]"};b.isDate=function(a){return!!(a&&a.getTimezoneOffset&&a.setUTCFullYear)};b.isRegExp=function(a){return!!(a&&
a.test&&a.exec&&(a.ignoreCase||a.ignoreCase===false))};b.isNaN=function(a){return b.isNumber(a)&&isNaN(a)};b.isNull=function(a){return a===null};b.isUndefined=function(a){return typeof a=="undefined"};b.noConflict=function(){j._=n;return this};b.identity=function(a){return a};b.breakLoop=function(){throw m;};var s=0;b.uniqueId=function(a){var c=s++;return a?a+c:c};b.template=function(a,c){a=new Function("obj","var p=[],print=function(){p.push.apply(p,arguments);};with(obj){p.push('"+a.replace(/[\r\t\n]/g,
" ").replace(/'(?=[^%]*%>)/g,"\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g,"',$1,'").split("<%").join("');").split("%>").join("p.push('")+"');}return p.join('');");return c?a(c):a};b.forEach=b.each;b.foldl=b.inject=b.reduce;b.foldr=b.reduceRight;b.filter=b.select;b.every=b.all;b.some=b.any;b.head=b.first;b.tail=b.rest;b.methods=b.functions;var l=function(a,c){return c?b(a).chain():a};b.each(b.functions(b),function(a){var c=b[a];i.prototype[a]=function(){var d=b.toArray(arguments);
o.call(d,this._wrapped);return l(c.apply(b,d),this._chain)}});b.each(["pop","push","reverse","shift","sort","splice","unshift"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){c.apply(this._wrapped,arguments);return l(this._wrapped,this._chain)}});b.each(["concat","join","slice"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){return l(c.apply(this._wrapped,arguments),this._chain)}});i.prototype.chain=function(){this._chain=true;return this};i.prototype.value=function(){return this._wrapped}})();

178
documentation/build/html/apireference.html
View File

@ -1,178 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>API Reference &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="index.html" />
<link rel="next" title="Pyqtgraph’s Helper Functions" href="functions.html" />
<link rel="prev" title="Rapid GUI prototyping" href="parametertree.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="functions.html" title="Pyqtgraph’s Helper Functions"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="parametertree.html" title="Rapid GUI prototyping"
accesskey="P">previous</a> |</li>
<li><a href="index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="api-reference">
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline"></a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="functions.html">Pyqtgraph&#8217;s Helper Functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="functions.html#simple-data-display-functions">Simple Data Display Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="functions.html#color-pen-and-brush-functions">Color, Pen, and Brush Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="functions.html#data-slicing">Data Slicing</a></li>
<li class="toctree-l2"><a class="reference internal" href="functions.html#si-unit-conversion-functions">SI Unit Conversion Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="graphicsItems/index.html">Pyqtgraph&#8217;s Graphics Items</a><ul>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/plotdataitem.html">PlotDataItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/plotcurveitem.html">PlotCurveItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/scatterplotitem.html">ScatterPlotItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/plotitem.html">PlotItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/imageitem.html">ImageItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/viewbox.html">ViewBox</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/linearregionitem.html">LinearRegionItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/infiniteline.html">InfiniteLine</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/roi.html">ROI</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/graphicslayout.html">GraphicsLayout</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/axisitem.html">AxisItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/arrowitem.html">ArrowItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/curvepoint.html">CurvePoint</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/curvearrow.html">CurveArrow</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/griditem.html">GridItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/scalebar.html">ScaleBar</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/labelitem.html">LabelItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/vtickgroup.html">VTickGroup</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/gradienteditoritem.html">GradientEditorItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/histogramlutitem.html">HistogramLUTItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/gradientlegend.html">GradientLegend</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/buttonitem.html">ButtonItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/graphicsobject.html">GraphicsObject</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/graphicswidget.html">GraphicsWidget</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphicsItems/uigraphicsitem.html">UIGraphicsItem</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="widgets/index.html">Pyqtgraph&#8217;s Widgets</a><ul>
<li class="toctree-l2"><a class="reference internal" href="widgets/plotwidget.html">PlotWidget</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/imageview.html">ImageView</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/datatreewidget.html">DataTreeWidget</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/checktable.html">CheckTable</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/tablewidget.html">TableWidget</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/gradientwidget.html">GradientWidget</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/colorbutton.html">ColorButton</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/graphicslayoutwidget.html">GraphicsLayoutWidget</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/dockarea.html">dockarea module</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/parametertree.html">parametertree module</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/histogramlutwidget.html">HistogramLUTWidget</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/progressdialog.html">ProgressDialog</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/spinbox.html">SpinBox</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/filedialog.html">FileDialog</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/graphicsview.html">GraphicsView</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/joystickbutton.html">JoystickButton</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/multiplotwidget.html">MultiPlotWidget</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/treewidget.html">TreeWidget</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/verticallabel.html">VerticalLabel</a></li>
<li class="toctree-l2"><a class="reference internal" href="widgets/rawimagewidget.html">RawImageWidget</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="parametertree.html"
title="previous chapter">Rapid GUI prototyping</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="functions.html"
title="next chapter">Pyqtgraph&#8217;s Helper Functions</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/apireference.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="functions.html" title="Pyqtgraph’s Helper Functions"
>next</a> |</li>
<li class="right" >
<a href="parametertree.html" title="Rapid GUI prototyping"
>previous</a> |</li>
<li><a href="index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

341
documentation/build/html/functions.html
View File

@ -1,341 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Pyqtgraph’s Helper Functions &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="index.html" />
<link rel="up" title="API Reference" href="apireference.html" />
<link rel="next" title="Pyqtgraph’s Graphics Items" href="graphicsItems/index.html" />
<link rel="prev" title="API Reference" href="apireference.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="graphicsItems/index.html" title="Pyqtgraph’s Graphics Items"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="apireference.html" title="API Reference"
accesskey="P">previous</a> |</li>
<li><a href="index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="apireference.html" accesskey="U">API Reference</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="pyqtgraph-s-helper-functions">
<h1>Pyqtgraph&#8217;s Helper Functions<a class="headerlink" href="#pyqtgraph-s-helper-functions" title="Permalink to this headline"></a></h1>
<div class="section" id="simple-data-display-functions">
<h2>Simple Data Display Functions<a class="headerlink" href="#simple-data-display-functions" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="pyqtgraph.plot">
<tt class="descclassname">pyqtgraph.</tt><tt class="descname">plot</tt><big>(</big><em>*args</em>, <em>**kargs</em><big>)</big><a class="reference internal" href="_modules/pyqtgraph.html#plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyqtgraph.plot" title="Permalink to this definition"></a></dt>
<dd><div class="line-block">
<div class="line">Create and return a PlotWindow (this is just a window with PlotWidget inside), plot data in it.</div>
<div class="line">Accepts a <em>title</em> argument to set the title of the window.</div>
<div class="line">All other arguments are used to plot data. (see <a class="reference internal" href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.plot" title="pyqtgraph.PlotItem.plot"><tt class="xref py py-func docutils literal"><span class="pre">PlotItem.plot()</span></tt></a>)</div>
</div>
</dd></dl>
<dl class="function">
<dt id="pyqtgraph.image">
<tt class="descclassname">pyqtgraph.</tt><tt class="descname">image</tt><big>(</big><em>*args</em>, <em>**kargs</em><big>)</big><a class="reference internal" href="_modules/pyqtgraph.html#image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyqtgraph.image" title="Permalink to this definition"></a></dt>
<dd><div class="line-block">
<div class="line">Create and return an ImageWindow (this is just a window with ImageView widget inside), show image data inside.</div>
<div class="line">Will show 2D or 3D image data.</div>
<div class="line">Accepts a <em>title</em> argument to set the title of the window.</div>
<div class="line">All other arguments are used to show data. (see <a class="reference internal" href="widgets/imageview.html#pyqtgraph.ImageView.setImage" title="pyqtgraph.ImageView.setImage"><tt class="xref py py-func docutils literal"><span class="pre">ImageView.setImage()</span></tt></a>)</div>
</div>
</dd></dl>
</div>
<div class="section" id="color-pen-and-brush-functions">
<h2>Color, Pen, and Brush Functions<a class="headerlink" href="#color-pen-and-brush-functions" title="Permalink to this headline"></a></h2>
<p>Qt uses the classes QColor, QPen, and QBrush to determine how to draw lines and fill shapes. These classes are highly capable but somewhat awkward to use. Pyqtgraph offers the functions <a class="reference internal" href="#pyqtgraph.mkColor" title="pyqtgraph.mkColor"><tt class="xref py py-func docutils literal"><span class="pre">mkColor()</span></tt></a>, <a class="reference internal" href="#pyqtgraph.mkPen" title="pyqtgraph.mkPen"><tt class="xref py py-func docutils literal"><span class="pre">mkPen()</span></tt></a>, and <a class="reference internal" href="#pyqtgraph.mkBrush" title="pyqtgraph.mkBrush"><tt class="xref py py-func docutils literal"><span class="pre">mkBrush()</span></tt></a> to simplify the process of creating these classes. In most cases, however, it will be unnecessary to call these functions directly&#8211;any function or method that accepts <em>pen</em> or <em>brush</em> arguments will make use of these functions for you. For example, the following three lines all have the same effect:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">pg</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">xdata</span><span class="p">,</span> <span class="n">ydata</span><span class="p">,</span> <span class="n">pen</span><span class="o">=</span><span class="s">&#39;r&#39;</span><span class="p">)</span>
<span class="n">pg</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">xdata</span><span class="p">,</span> <span class="n">ydata</span><span class="p">,</span> <span class="n">pen</span><span class="o">=</span><span class="n">pg</span><span class="o">.</span><span class="n">mkPen</span><span class="p">(</span><span class="s">&#39;r&#39;</span><span class="p">))</span>
<span class="n">pg</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">xdata</span><span class="p">,</span> <span class="n">ydata</span><span class="p">,</span> <span class="n">pen</span><span class="o">=</span><span class="n">QPen</span><span class="p">(</span><span class="n">QColor</span><span class="p">(</span><span class="mi">255</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)))</span>
</pre></div>
</div>
<dl class="function">
<dt id="pyqtgraph.mkColor">
<tt class="descclassname">pyqtgraph.</tt><tt class="descname">mkColor</tt><big>(</big><em>*args</em><big>)</big><a class="headerlink" href="#pyqtgraph.mkColor" title="Permalink to this definition"></a></dt>
<dd><p>Convenience function for constructing QColor from a variety of argument types. Accepted arguments are:</p>
<table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="75%" />
</colgroup>
<tbody valign="top">
<tr><td>&#8216;c&#8217;</td>
<td>one of: r, g, b, c, m, y, k, w</td>
</tr>
<tr><td>R, G, B, [A]</td>
<td>integers 0-255</td>
</tr>
<tr><td>(R, G, B, [A])</td>
<td>tuple of integers 0-255</td>
</tr>
<tr><td>float</td>
<td>greyscale, 0.0-1.0</td>
</tr>
<tr><td>int</td>
<td>see <a class="reference internal" href="#pyqtgraph.intColor" title="pyqtgraph.intColor"><tt class="xref py py-func docutils literal"><span class="pre">intColor()</span></tt></a></td>
</tr>
<tr><td>(int, hues)</td>
<td>see <a class="reference internal" href="#pyqtgraph.intColor" title="pyqtgraph.intColor"><tt class="xref py py-func docutils literal"><span class="pre">intColor()</span></tt></a></td>
</tr>
<tr><td>&#8220;RGB&#8221;</td>
<td>hexadecimal strings; may begin with &#8216;#&#8217;</td>
</tr>
<tr><td>&#8220;RGBA&#8221;</td>
<td>&nbsp;</td>
</tr>
<tr><td>&#8220;RRGGBB&#8221;</td>
<td>&nbsp;</td>
</tr>
<tr><td>&#8220;RRGGBBAA&#8221;</td>
<td>&nbsp;</td>
</tr>
<tr><td>QColor</td>
<td>QColor instance; makes a copy.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyqtgraph.mkPen">
<tt class="descclassname">pyqtgraph.</tt><tt class="descname">mkPen</tt><big>(</big><em>*args</em>, <em>**kargs</em><big>)</big><a class="headerlink" href="#pyqtgraph.mkPen" title="Permalink to this definition"></a></dt>
<dd><p>Convenience function for constructing QPen.</p>
<p>Examples:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">mkPen</span><span class="p">(</span><span class="n">color</span><span class="p">)</span>
<span class="n">mkPen</span><span class="p">(</span><span class="n">color</span><span class="p">,</span> <span class="n">width</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="n">mkPen</span><span class="p">(</span><span class="n">cosmetic</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">width</span><span class="o">=</span><span class="mf">4.5</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s">&#39;r&#39;</span><span class="p">)</span>
<span class="n">mkPen</span><span class="p">({</span><span class="s">&#39;color&#39;</span><span class="p">:</span> <span class="s">&quot;FF0&quot;</span><span class="p">,</span> <span class="n">width</span><span class="p">:</span> <span class="mi">2</span><span class="p">})</span>
<span class="n">mkPen</span><span class="p">(</span><span class="bp">None</span><span class="p">)</span> <span class="c"># (no pen)</span>
</pre></div>
</div>
<p>In these examples, <em>color</em> may be replaced with any arguments accepted by <a class="reference internal" href="#pyqtgraph.mkColor" title="pyqtgraph.mkColor"><tt class="xref py py-func docutils literal"><span class="pre">mkColor()</span></tt></a></p>
</dd></dl>
<dl class="function">
<dt id="pyqtgraph.mkBrush">
<tt class="descclassname">pyqtgraph.</tt><tt class="descname">mkBrush</tt><big>(</big><em>*args</em><big>)</big><a class="headerlink" href="#pyqtgraph.mkBrush" title="Permalink to this definition"></a></dt>
<dd><div class="line-block">
<div class="line">Convenience function for constructing Brush.</div>
<div class="line">This function always constructs a solid brush and accepts the same arguments as <a class="reference internal" href="#pyqtgraph.mkColor" title="pyqtgraph.mkColor"><tt class="xref py py-func docutils literal"><span class="pre">mkColor()</span></tt></a></div>
<div class="line">Calling mkBrush(None) returns an invisible brush.</div>
</div>
</dd></dl>
<dl class="function">
<dt id="pyqtgraph.hsvColor">
<tt class="descclassname">pyqtgraph.</tt><tt class="descname">hsvColor</tt><big>(</big><em>h</em>, <em>s=1.0</em>, <em>v=1.0</em>, <em>a=1.0</em><big>)</big><a class="headerlink" href="#pyqtgraph.hsvColor" title="Permalink to this definition"></a></dt>
<dd><p>Generate a QColor from HSVa values.</p>
</dd></dl>
<dl class="function">
<dt id="pyqtgraph.intColor">
<tt class="descclassname">pyqtgraph.</tt><tt class="descname">intColor</tt><big>(</big><em>index</em>, <em>hues=9</em>, <em>values=1</em>, <em>maxValue=255</em>, <em>minValue=150</em>, <em>maxHue=360</em>, <em>minHue=0</em>, <em>sat=255</em>, <em>alpha=255</em>, <em>**kargs</em><big>)</big><a class="headerlink" href="#pyqtgraph.intColor" title="Permalink to this definition"></a></dt>
<dd><p>Creates a QColor from a single index. Useful for stepping through a predefined list of colors.</p>
<p>The argument <em>index</em> determines which color from the set will be returned. All other arguments determine what the set of predefined colors will be</p>
<p>Colors are chosen by cycling across hues while varying the value (brightness).
By default, this selects from a list of 9 hues.</p>
</dd></dl>
<dl class="function">
<dt id="pyqtgraph.colorTuple">
<tt class="descclassname">pyqtgraph.</tt><tt class="descname">colorTuple</tt><big>(</big><em>c</em><big>)</big><a class="headerlink" href="#pyqtgraph.colorTuple" title="Permalink to this definition"></a></dt>
<dd><p>Return a tuple (R,G,B,A) from a QColor</p>
</dd></dl>
<dl class="function">
<dt id="pyqtgraph.colorStr">
<tt class="descclassname">pyqtgraph.</tt><tt class="descname">colorStr</tt><big>(</big><em>c</em><big>)</big><a class="headerlink" href="#pyqtgraph.colorStr" title="Permalink to this definition"></a></dt>
<dd><p>Generate a hex string code from a QColor</p>
</dd></dl>
</div>
<div class="section" id="data-slicing">
<h2>Data Slicing<a class="headerlink" href="#data-slicing" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="pyqtgraph.affineSlice">
<tt class="descclassname">pyqtgraph.</tt><tt class="descname">affineSlice</tt><big>(</big><em>data</em>, <em>shape</em>, <em>origin</em>, <em>vectors</em>, <em>axes</em>, <em>**kargs</em><big>)</big><a class="headerlink" href="#pyqtgraph.affineSlice" title="Permalink to this definition"></a></dt>
<dd><p>Take a slice of any orientation through an array. This is useful for extracting sections of multi-dimensional arrays such as MRI images for viewing as 1D or 2D data.</p>
<p>The slicing axes are aribtrary; they do not need to be orthogonal to the original data or even to each other. It is possible to use this function to extract arbitrary linear, rectangular, or parallelepiped shapes from within larger datasets.</p>
<p>For a graphical interface to this function, see <tt class="xref py py-func docutils literal"><span class="pre">ROI.getArrayRegion()</span></tt></p>
<p>Arguments:</p>
<blockquote>
<div class="line-block">
<div class="line"><em>data</em> (ndarray): the original dataset</div>
<div class="line"><em>shape</em>: the shape of the slice to take (Note the return value may have more dimensions than len(shape))</div>
<div class="line"><em>origin</em>: the location in the original dataset that will become the origin in the sliced data.</div>
<div class="line"><em>vectors</em>: list of unit vectors which point in the direction of the slice axes</div>
</div>
<ul class="simple">
<li>each vector must have the same length as <em>axes</em></li>
<li>If the vectors are not unit length, the result will be scaled.</li>
<li>If the vectors are not orthogonal, the result will be sheared.</li>
</ul>
<p><em>axes</em>: the axes in the original dataset which correspond to the slice <em>vectors</em></p>
</blockquote>
<p>Example: start with a 4D fMRI data set, take a diagonal-planar slice out of the last 3 axes</p>
<blockquote>
<ul class="simple">
<li>data = array with dims (time, x, y, z) = (100, 40, 40, 40)</li>
<li>The plane to pull out is perpendicular to the vector (x,y,z) = (1,1,1)</li>
<li>The origin of the slice will be at (x,y,z) = (40, 0, 0)</li>
<li>We will slice a 20x20 plane from each timepoint, giving a final shape (100, 20, 20)</li>
</ul>
</blockquote>
<p>The call for this example would look like:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">affineSlice</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span><span class="mi">20</span><span class="p">),</span> <span class="n">origin</span><span class="o">=</span><span class="p">(</span><span class="mi">40</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">),</span> <span class="n">vectors</span><span class="o">=</span><span class="p">((</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">)),</span> <span class="n">axes</span><span class="o">=</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">))</span>
</pre></div>
</div>
<p>Note the following must be true:</p>
<blockquote>
<div class="line-block">
<div class="line">len(shape) == len(vectors) </div>
<div class="line">len(origin) == len(axes) == len(vectors[0])</div>
</div>
</blockquote>
</dd></dl>
</div>
<div class="section" id="si-unit-conversion-functions">
<h2>SI Unit Conversion Functions<a class="headerlink" href="#si-unit-conversion-functions" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="pyqtgraph.siFormat">
<tt class="descclassname">pyqtgraph.</tt><tt class="descname">siFormat</tt><big>(</big><em>x</em>, <em>precision=3</em>, <em>suffix=''</em>, <em>space=True</em>, <em>error=None</em>, <em>minVal=1e-25</em>, <em>allowUnicode=True</em><big>)</big><a class="headerlink" href="#pyqtgraph.siFormat" title="Permalink to this definition"></a></dt>
<dd><p>Return the number x formatted in engineering notation with SI prefix.</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">siFormat</span><span class="p">(</span><span class="mf">0.0001</span><span class="p">,</span> <span class="n">suffix</span><span class="o">=</span><span class="s">&#39;V&#39;</span><span class="p">)</span> <span class="c"># returns &quot;100 μV&quot;</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="pyqtgraph.siScale">
<tt class="descclassname">pyqtgraph.</tt><tt class="descname">siScale</tt><big>(</big><em>x</em>, <em>minVal=1e-25</em>, <em>allowUnicode=True</em><big>)</big><a class="headerlink" href="#pyqtgraph.siScale" title="Permalink to this definition"></a></dt>
<dd><p>Return the recommended scale factor and SI prefix string for x.</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">siScale</span><span class="p">(</span><span class="mf">0.0001</span><span class="p">)</span> <span class="c"># returns (1e6, &#39;μ&#39;)</span>
<span class="c"># This indicates that the number 0.0001 is best represented as 0.0001 * 1e6 = 100 μUnits</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="pyqtgraph.siEval">
<tt class="descclassname">pyqtgraph.</tt><tt class="descname">siEval</tt><big>(</big><em>s</em><big>)</big><a class="headerlink" href="#pyqtgraph.siEval" title="Permalink to this definition"></a></dt>
<dd><p>Convert a value written in SI notation to its equivalent prefixless value</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">siEval</span><span class="p">(</span><span class="s">&quot;100 μV&quot;</span><span class="p">)</span> <span class="c"># returns 0.0001</span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Pyqtgraph&#8217;s Helper Functions</a><ul>
<li><a class="reference internal" href="#simple-data-display-functions">Simple Data Display Functions</a></li>
<li><a class="reference internal" href="#color-pen-and-brush-functions">Color, Pen, and Brush Functions</a></li>
<li><a class="reference internal" href="#data-slicing">Data Slicing</a></li>
<li><a class="reference internal" href="#si-unit-conversion-functions">SI Unit Conversion Functions</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="apireference.html"
title="previous chapter">API Reference</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="graphicsItems/index.html"
title="next chapter">Pyqtgraph&#8217;s Graphics Items</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/functions.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="graphicsItems/index.html" title="Pyqtgraph’s Graphics Items"
>next</a> |</li>
<li class="right" >
<a href="apireference.html" title="API Reference"
>previous</a> |</li>
<li><a href="index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="apireference.html" >API Reference</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

457
documentation/build/html/genindex.html
View File

@ -1,457 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#_"><strong>_</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#J"><strong>J</strong></a> | <a href="#K"><strong>K</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a> | <a href="#V"><strong>V</strong></a>
</div>
<h2 id="_">_</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/arrowitem.html#pyqtgraph.ArrowItem.__init__">__init__() (pyqtgraph.ArrowItem method)</a></dt>
<dd><dl>
<dt><a href="graphicsItems/axisitem.html#pyqtgraph.AxisItem.__init__">(pyqtgraph.AxisItem method)</a></dt>
<dt><a href="graphicsItems/buttonitem.html#pyqtgraph.ButtonItem.__init__">(pyqtgraph.ButtonItem method)</a></dt>
<dt><a href="widgets/checktable.html#pyqtgraph.CheckTable.__init__">(pyqtgraph.CheckTable method)</a></dt>
<dt><a href="widgets/colorbutton.html#pyqtgraph.ColorButton.__init__">(pyqtgraph.ColorButton method)</a></dt>
<dt><a href="graphicsItems/curvearrow.html#pyqtgraph.CurveArrow.__init__">(pyqtgraph.CurveArrow method)</a></dt>
<dt><a href="graphicsItems/curvepoint.html#pyqtgraph.CurvePoint.__init__">(pyqtgraph.CurvePoint method)</a></dt>
<dt><a href="widgets/datatreewidget.html#pyqtgraph.DataTreeWidget.__init__">(pyqtgraph.DataTreeWidget method)</a></dt>
<dt><a href="widgets/filedialog.html#pyqtgraph.FileDialog.__init__">(pyqtgraph.FileDialog method)</a></dt>
<dt><a href="graphicsItems/gradienteditoritem.html#pyqtgraph.GradientEditorItem.__init__">(pyqtgraph.GradientEditorItem method)</a></dt>
<dt><a href="graphicsItems/gradientlegend.html#pyqtgraph.GradientLegend.__init__">(pyqtgraph.GradientLegend method)</a></dt>
<dt><a href="widgets/gradientwidget.html#pyqtgraph.GradientWidget.__init__">(pyqtgraph.GradientWidget method)</a></dt>
<dt><a href="graphicsItems/graphicslayout.html#pyqtgraph.GraphicsLayout.__init__">(pyqtgraph.GraphicsLayout method)</a></dt>
<dt><a href="widgets/graphicslayoutwidget.html#pyqtgraph.GraphicsLayoutWidget.__init__">(pyqtgraph.GraphicsLayoutWidget method)</a></dt>
<dt><a href="graphicsItems/graphicsobject.html#pyqtgraph.GraphicsObject.__init__">(pyqtgraph.GraphicsObject method)</a></dt>
<dt><a href="widgets/graphicsview.html#pyqtgraph.GraphicsView.__init__">(pyqtgraph.GraphicsView method)</a></dt>
<dt><a href="graphicsItems/graphicswidget.html#pyqtgraph.GraphicsWidget.__init__">(pyqtgraph.GraphicsWidget method)</a></dt>
<dt><a href="graphicsItems/griditem.html#pyqtgraph.GridItem.__init__">(pyqtgraph.GridItem method)</a></dt>
<dt><a href="graphicsItems/histogramlutitem.html#pyqtgraph.HistogramLUTItem.__init__">(pyqtgraph.HistogramLUTItem method)</a></dt>
<dt><a href="widgets/histogramlutwidget.html#pyqtgraph.HistogramLUTWidget.__init__">(pyqtgraph.HistogramLUTWidget method)</a></dt>
<dt><a href="graphicsItems/imageitem.html#pyqtgraph.ImageItem.__init__">(pyqtgraph.ImageItem method)</a></dt>
<dt><a href="widgets/imageview.html#pyqtgraph.ImageView.__init__">(pyqtgraph.ImageView method)</a></dt>
<dt><a href="graphicsItems/infiniteline.html#pyqtgraph.InfiniteLine.__init__">(pyqtgraph.InfiniteLine method)</a></dt>
<dt><a href="widgets/joystickbutton.html#pyqtgraph.JoystickButton.__init__">(pyqtgraph.JoystickButton method)</a></dt>
<dt><a href="graphicsItems/labelitem.html#pyqtgraph.LabelItem.__init__">(pyqtgraph.LabelItem method)</a></dt>
<dt><a href="graphicsItems/linearregionitem.html#pyqtgraph.LinearRegionItem.__init__">(pyqtgraph.LinearRegionItem method)</a></dt>
<dt><a href="widgets/multiplotwidget.html#pyqtgraph.MultiPlotWidget.__init__">(pyqtgraph.MultiPlotWidget method)</a></dt>
<dt><a href="graphicsItems/plotcurveitem.html#pyqtgraph.PlotCurveItem.__init__">(pyqtgraph.PlotCurveItem method)</a></dt>
<dt><a href="graphicsItems/plotdataitem.html#pyqtgraph.PlotDataItem.__init__">(pyqtgraph.PlotDataItem method)</a></dt>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.__init__">(pyqtgraph.PlotItem method)</a></dt>
<dt><a href="widgets/plotwidget.html#pyqtgraph.PlotWidget.__init__">(pyqtgraph.PlotWidget method)</a></dt>
<dt><a href="widgets/progressdialog.html#pyqtgraph.ProgressDialog.__init__">(pyqtgraph.ProgressDialog method)</a></dt>
<dt><a href="graphicsItems/roi.html#pyqtgraph.ROI.__init__">(pyqtgraph.ROI method)</a></dt>
<dt><a href="widgets/rawimagewidget.html#pyqtgraph.RawImageWidget.__init__">(pyqtgraph.RawImageWidget method)</a></dt>
<dt><a href="graphicsItems/scalebar.html#pyqtgraph.ScaleBar.__init__">(pyqtgraph.ScaleBar method)</a></dt>
<dt><a href="graphicsItems/scatterplotitem.html#pyqtgraph.ScatterPlotItem.__init__">(pyqtgraph.ScatterPlotItem method)</a></dt>
<dt><a href="widgets/spinbox.html#pyqtgraph.SpinBox.__init__">(pyqtgraph.SpinBox method)</a></dt>
<dt><a href="widgets/tablewidget.html#pyqtgraph.TableWidget.__init__">(pyqtgraph.TableWidget method)</a></dt>
<dt><a href="widgets/treewidget.html#pyqtgraph.TreeWidget.__init__">(pyqtgraph.TreeWidget method)</a></dt>
<dt><a href="graphicsItems/uigraphicsitem.html#pyqtgraph.UIGraphicsItem.__init__">(pyqtgraph.UIGraphicsItem method)</a></dt>
<dt><a href="graphicsItems/vtickgroup.html#pyqtgraph.VTickGroup.__init__">(pyqtgraph.VTickGroup method)</a></dt>
<dt><a href="widgets/verticallabel.html#pyqtgraph.VerticalLabel.__init__">(pyqtgraph.VerticalLabel method)</a></dt>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.__init__">(pyqtgraph.ViewBox method)</a></dt>
</dl></dd>
</dl></td>
</tr></table>
<h2 id="A">A</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.addAvgCurve">addAvgCurve() (pyqtgraph.PlotItem method)</a></dt>
<dt><a href="functions.html#pyqtgraph.affineSlice">affineSlice() (in module pyqtgraph)</a></dt>
<dt><a href="widgets/tablewidget.html#pyqtgraph.TableWidget.appendData">appendData() (pyqtgraph.TableWidget method)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/arrowitem.html#pyqtgraph.ArrowItem">ArrowItem (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/axisitem.html#pyqtgraph.AxisItem">AxisItem (class in pyqtgraph)</a></dt>
</dl></td>
</tr></table>
<h2 id="B">B</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/buttonitem.html#pyqtgraph.ButtonItem">ButtonItem (class in pyqtgraph)</a></dt>
</dl></td>
</tr></table>
<h2 id="C">C</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="widgets/checktable.html#pyqtgraph.CheckTable">CheckTable (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.childrenBoundingRect">childrenBoundingRect() (pyqtgraph.ViewBox method)</a></dt>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.childTransform">childTransform() (pyqtgraph.ViewBox method)</a></dt>
<dt><a href="widgets/colorbutton.html#pyqtgraph.ColorButton">ColorButton (class in pyqtgraph)</a></dt>
<dt><a href="functions.html#pyqtgraph.colorStr">colorStr() (in module pyqtgraph)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="functions.html#pyqtgraph.colorTuple">colorTuple() (in module pyqtgraph)</a></dt>
<dt><a href="widgets/tablewidget.html#pyqtgraph.TableWidget.copy">copy() (pyqtgraph.TableWidget method)</a></dt>
<dt><a href="graphicsItems/curvearrow.html#pyqtgraph.CurveArrow">CurveArrow (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/curvepoint.html#pyqtgraph.CurvePoint">CurvePoint (class in pyqtgraph)</a></dt>
</dl></td>
</tr></table>
<h2 id="D">D</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="widgets/datatreewidget.html#pyqtgraph.DataTreeWidget">DataTreeWidget (class in pyqtgraph)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/graphicsobject.html#pyqtgraph.GraphicsObject.deviceTransform">deviceTransform() (pyqtgraph.GraphicsObject method)</a></dt>
</dl></td>
</tr></table>
<h2 id="E">E</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="widgets/spinbox.html#pyqtgraph.SpinBox.editingFinishedEvent">editingFinishedEvent() (pyqtgraph.SpinBox method)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.enableAutoScale">enableAutoScale() (pyqtgraph.PlotItem method)</a></dt>
</dl></td>
</tr></table>
<h2 id="F">F</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="widgets/filedialog.html#pyqtgraph.FileDialog">FileDialog (class in pyqtgraph)</a></dt>
</dl></td>
</tr></table>
<h2 id="G">G</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/roi.html#pyqtgraph.ROI.getArrayRegion">getArrayRegion() (pyqtgraph.ROI method)</a></dt>
<dt><a href="graphicsItems/roi.html#pyqtgraph.ROI.getArraySlice">getArraySlice() (pyqtgraph.ROI method)</a></dt>
<dt><a href="graphicsItems/graphicsobject.html#pyqtgraph.GraphicsObject.getBoundingParents">getBoundingParents() (pyqtgraph.GraphicsObject method)</a></dt>
<dt><a href="graphicsItems/roi.html#pyqtgraph.ROI.getGlobalTransform">getGlobalTransform() (pyqtgraph.ROI method)</a></dt>
<dt><a href="graphicsItems/imageitem.html#pyqtgraph.ImageItem.getHistogram">getHistogram() (pyqtgraph.ImageItem method)</a></dt>
<dt><a href="graphicsItems/roi.html#pyqtgraph.ROI.getLocalHandlePositions">getLocalHandlePositions() (pyqtgraph.ROI method)</a></dt>
<dt><a href="graphicsItems/gradienteditoritem.html#pyqtgraph.GradientEditorItem.getLookupTable">getLookupTable() (pyqtgraph.GradientEditorItem method)</a></dt>
<dt><a href="graphicsItems/linearregionitem.html#pyqtgraph.LinearRegionItem.getRegion">getRegion() (pyqtgraph.LinearRegionItem method)</a></dt>
<dt><a href="graphicsItems/graphicsobject.html#pyqtgraph.GraphicsObject.getViewBox">getViewBox() (pyqtgraph.GraphicsObject method)</a></dt>
<dt><a href="graphicsItems/graphicsobject.html#pyqtgraph.GraphicsObject.getViewWidget">getViewWidget() (pyqtgraph.GraphicsObject method)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/gradienteditoritem.html#pyqtgraph.GradientEditorItem">GradientEditorItem (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/gradientlegend.html#pyqtgraph.GradientLegend">GradientLegend (class in pyqtgraph)</a></dt>
<dt><a href="widgets/gradientwidget.html#pyqtgraph.GradientWidget">GradientWidget (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/graphicslayout.html#pyqtgraph.GraphicsLayout">GraphicsLayout (class in pyqtgraph)</a></dt>
<dt><a href="widgets/graphicslayoutwidget.html#pyqtgraph.GraphicsLayoutWidget">GraphicsLayoutWidget (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/graphicsobject.html#pyqtgraph.GraphicsObject">GraphicsObject (class in pyqtgraph)</a></dt>
<dt><a href="widgets/graphicsview.html#pyqtgraph.GraphicsView">GraphicsView (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/graphicswidget.html#pyqtgraph.GraphicsWidget">GraphicsWidget (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/griditem.html#pyqtgraph.GridItem">GridItem (class in pyqtgraph)</a></dt>
</dl></td>
</tr></table>
<h2 id="H">H</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/roi.html#pyqtgraph.ROI.handleChange">handleChange() (pyqtgraph.ROI method)</a></dt>
<dt><a href="graphicsItems/histogramlutitem.html#pyqtgraph.HistogramLUTItem">HistogramLUTItem (class in pyqtgraph)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="widgets/histogramlutwidget.html#pyqtgraph.HistogramLUTWidget">HistogramLUTWidget (class in pyqtgraph)</a></dt>
<dt><a href="functions.html#pyqtgraph.hsvColor">hsvColor() (in module pyqtgraph)</a></dt>
</dl></td>
</tr></table>
<h2 id="I">I</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="functions.html#pyqtgraph.image">image() (in module pyqtgraph)</a></dt>
<dt><a href="graphicsItems/imageitem.html#pyqtgraph.ImageItem">ImageItem (class in pyqtgraph)</a></dt>
<dt><a href="widgets/imageview.html#pyqtgraph.ImageView">ImageView (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/infiniteline.html#pyqtgraph.InfiniteLine">InfiniteLine (class in pyqtgraph)</a></dt>
<dt><a href="functions.html#pyqtgraph.intColor">intColor() (in module pyqtgraph)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="widgets/spinbox.html#pyqtgraph.SpinBox.interpret">interpret() (pyqtgraph.SpinBox method)</a></dt>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.itemBoundingRect">itemBoundingRect() (pyqtgraph.ViewBox method)</a></dt>
<dt><a href="widgets/treewidget.html#pyqtgraph.TreeWidget.itemMoving">itemMoving() (pyqtgraph.TreeWidget method)</a></dt>
<dt><a href="widgets/tablewidget.html#pyqtgraph.TableWidget.iteratorFn">iteratorFn() (pyqtgraph.TableWidget method)</a></dt>
</dl></td>
</tr></table>
<h2 id="J">J</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="widgets/joystickbutton.html#pyqtgraph.JoystickButton">JoystickButton (class in pyqtgraph)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="widgets/imageview.html#pyqtgraph.ImageView.jumpFrames">jumpFrames() (pyqtgraph.ImageView method)</a></dt>
</dl></td>
</tr></table>
<h2 id="K">K</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.keyPressEvent">keyPressEvent() (pyqtgraph.ViewBox method)</a></dt>
</dl></td>
</tr></table>
<h2 id="L">L</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/labelitem.html#pyqtgraph.LabelItem">LabelItem (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/linearregionitem.html#pyqtgraph.LinearRegionItem">LinearRegionItem (class in pyqtgraph)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.linkXChanged">linkXChanged() (pyqtgraph.PlotItem method)</a></dt>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.linkYChanged">linkYChanged() (pyqtgraph.PlotItem method)</a></dt>
</dl></td>
</tr></table>
<h2 id="M">M</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.mapFromView">mapFromView() (pyqtgraph.ViewBox method)</a></dt>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.mapSceneToView">mapSceneToView() (pyqtgraph.ViewBox method)</a></dt>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.mapToView">mapToView() (pyqtgraph.ViewBox method)</a></dt>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.mapViewToScene">mapViewToScene() (pyqtgraph.ViewBox method)</a></dt>
<dt><a href="functions.html#pyqtgraph.mkBrush">mkBrush() (in module pyqtgraph)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="functions.html#pyqtgraph.mkColor">mkColor() (in module pyqtgraph)</a></dt>
<dt><a href="functions.html#pyqtgraph.mkPen">mkPen() (in module pyqtgraph)</a></dt>
<dt><a href="graphicsItems/uigraphicsitem.html#pyqtgraph.UIGraphicsItem.mouseShape">mouseShape() (pyqtgraph.UIGraphicsItem method)</a></dt>
<dt><a href="widgets/multiplotwidget.html#pyqtgraph.MultiPlotWidget">MultiPlotWidget (class in pyqtgraph)</a></dt>
</dl></td>
</tr></table>
<h2 id="N">N</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/graphicslayout.html#pyqtgraph.GraphicsLayout.nextCol">nextCol() (pyqtgraph.GraphicsLayout method)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/graphicslayout.html#pyqtgraph.GraphicsLayout.nextRow">nextRow() (pyqtgraph.GraphicsLayout method)</a></dt>
</dl></td>
</tr></table>
<h2 id="P">P</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/graphicsobject.html#pyqtgraph.GraphicsObject.pixelLength">pixelLength() (pyqtgraph.GraphicsObject method)</a></dt>
<dt><a href="widgets/graphicsview.html#pyqtgraph.GraphicsView.pixelSize">pixelSize() (pyqtgraph.GraphicsView method)</a></dt>
<dd><dl>
<dt><a href="graphicsItems/imageitem.html#pyqtgraph.ImageItem.pixelSize">(pyqtgraph.ImageItem method)</a></dt>
</dl></dd>
<dt><a href="graphicsItems/graphicsobject.html#pyqtgraph.GraphicsObject.pixelVectors">pixelVectors() (pyqtgraph.GraphicsObject method)</a></dt>
<dt><a href="functions.html#pyqtgraph.plot">plot() (in module pyqtgraph)</a></dt>
<dd><dl>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.plot">(pyqtgraph.PlotItem method)</a></dt>
</dl></dd>
<dt><a href="graphicsItems/plotcurveitem.html#pyqtgraph.PlotCurveItem">PlotCurveItem (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/plotdataitem.html#pyqtgraph.PlotDataItem">PlotDataItem (class in pyqtgraph)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem">PlotItem (class in pyqtgraph)</a></dt>
<dt><a href="widgets/plotwidget.html#pyqtgraph.PlotWidget">PlotWidget (class in pyqtgraph)</a></dt>
<dt><a href="widgets/progressdialog.html#pyqtgraph.ProgressDialog">ProgressDialog (class in pyqtgraph)</a></dt>
<dt><a href="widgets/dockarea.html#module-pyqtgraph.dockarea">pyqtgraph.dockarea (module)</a></dt>
<dt><a href="widgets/parametertree.html#module-pyqtgraph.parametertree">pyqtgraph.parametertree (module)</a></dt>
</dl></td>
</tr></table>
<h2 id="R">R</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="widgets/rawimagewidget.html#pyqtgraph.RawImageWidget">RawImageWidget (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/uigraphicsitem.html#pyqtgraph.UIGraphicsItem.realBoundingRect">realBoundingRect() (pyqtgraph.UIGraphicsItem method)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/roi.html#pyqtgraph.ROI">ROI (class in pyqtgraph)</a></dt>
</dl></td>
</tr></table>
<h2 id="S">S</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/roi.html#pyqtgraph.ROI.saveState">saveState() (pyqtgraph.ROI method)</a></dt>
<dt><a href="graphicsItems/scalebar.html#pyqtgraph.ScaleBar">ScaleBar (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.scaleBy">scaleBy() (pyqtgraph.ViewBox method)</a></dt>
<dt><a href="widgets/graphicsview.html#pyqtgraph.GraphicsView.scaleToImage">scaleToImage() (pyqtgraph.GraphicsView method)</a></dt>
<dt><a href="graphicsItems/scatterplotitem.html#pyqtgraph.ScatterPlotItem">ScatterPlotItem (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/infiniteline.html#pyqtgraph.InfiniteLine.setAngle">setAngle() (pyqtgraph.InfiniteLine method)</a></dt>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.setAspectLocked">setAspectLocked() (pyqtgraph.ViewBox method)</a></dt>
<dt><a href="graphicsItems/labelitem.html#pyqtgraph.LabelItem.setAttr">setAttr() (pyqtgraph.LabelItem method)</a></dt>
<dt><a href="graphicsItems/infiniteline.html#pyqtgraph.InfiniteLine.setBounds">setBounds() (pyqtgraph.InfiniteLine method)</a></dt>
<dt><a href="widgets/graphicsview.html#pyqtgraph.GraphicsView.setCentralWidget">setCentralWidget() (pyqtgraph.GraphicsView method)</a></dt>
<dt><a href="widgets/datatreewidget.html#pyqtgraph.DataTreeWidget.setData">setData() (pyqtgraph.DataTreeWidget method)</a></dt>
<dd><dl>
<dt><a href="graphicsItems/plotcurveitem.html#pyqtgraph.PlotCurveItem.setData">(pyqtgraph.PlotCurveItem method)</a></dt>
<dt><a href="graphicsItems/plotdataitem.html#pyqtgraph.PlotDataItem.setData">(pyqtgraph.PlotDataItem method)</a></dt>
</dl></dd>
<dt><a href="graphicsItems/axisitem.html#pyqtgraph.AxisItem.setGrid">setGrid() (pyqtgraph.AxisItem method)</a></dt>
<dt><a href="graphicsItems/imageitem.html#pyqtgraph.ImageItem.setImage">setImage() (pyqtgraph.ImageItem method)</a></dt>
<dd><dl>
<dt><a href="widgets/imageview.html#pyqtgraph.ImageView.setImage">(pyqtgraph.ImageView method)</a></dt>
<dt><a href="widgets/rawimagewidget.html#pyqtgraph.RawImageWidget.setImage">(pyqtgraph.RawImageWidget method)</a></dt>
</dl></dd>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.setLabel">setLabel() (pyqtgraph.PlotItem method)</a></dt>
<dt><a href="graphicsItems/gradientlegend.html#pyqtgraph.GradientLegend.setLabels">setLabels() (pyqtgraph.GradientLegend method)</a></dt>
<dt><a href="graphicsItems/imageitem.html#pyqtgraph.ImageItem.setLevels">setLevels() (pyqtgraph.ImageItem method)</a></dt>
<dt><a href="graphicsItems/imageitem.html#pyqtgraph.ImageItem.setLookupTable">setLookupTable() (pyqtgraph.ImageItem method)</a></dt>
<dt><a href="graphicsItems/uigraphicsitem.html#pyqtgraph.UIGraphicsItem.setNewBounds">setNewBounds() (pyqtgraph.UIGraphicsItem method)</a></dt>
<dt><a href="graphicsItems/plotdataitem.html#pyqtgraph.PlotDataItem.setPen">setPen() (pyqtgraph.PlotDataItem method)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/scatterplotitem.html#pyqtgraph.ScatterPlotItem.setPoints">setPoints() (pyqtgraph.ScatterPlotItem method)</a></dt>
<dt><a href="widgets/spinbox.html#pyqtgraph.SpinBox.setProperty">setProperty() (pyqtgraph.SpinBox method)</a></dt>
<dt><a href="graphicsItems/imageitem.html#pyqtgraph.ImageItem.setPxMode">setPxMode() (pyqtgraph.ImageItem method)</a></dt>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.setRange">setRange() (pyqtgraph.ViewBox method)</a></dt>
<dt><a href="graphicsItems/axisitem.html#pyqtgraph.AxisItem.setScale">setScale() (pyqtgraph.AxisItem method)</a></dt>
<dt><a href="graphicsItems/plotdataitem.html#pyqtgraph.PlotDataItem.setShadowPen">setShadowPen() (pyqtgraph.PlotDataItem method)</a></dt>
<dt><a href="graphicsItems/labelitem.html#pyqtgraph.LabelItem.setText">setText() (pyqtgraph.LabelItem method)</a></dt>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.setTitle">setTitle() (pyqtgraph.PlotItem method)</a></dt>
<dt><a href="widgets/spinbox.html#pyqtgraph.SpinBox.setValue">setValue() (pyqtgraph.SpinBox method)</a></dt>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.setXLink">setXLink() (pyqtgraph.PlotItem method)</a></dt>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.setYLink">setYLink() (pyqtgraph.PlotItem method)</a></dt>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.showAxis">showAxis() (pyqtgraph.PlotItem method)</a></dt>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.showLabel">showLabel() (pyqtgraph.PlotItem method)</a></dt>
<dt><a href="functions.html#pyqtgraph.siEval">siEval() (in module pyqtgraph)</a></dt>
<dt><a href="functions.html#pyqtgraph.siFormat">siFormat() (in module pyqtgraph)</a></dt>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.sigRangeChanged">sigRangeChanged (pyqtgraph.PlotItem attribute)</a></dt>
<dt><a href="functions.html#pyqtgraph.siScale">siScale() (in module pyqtgraph)</a></dt>
<dt><a href="widgets/spinbox.html#pyqtgraph.SpinBox">SpinBox (class in pyqtgraph)</a></dt>
</dl></td>
</tr></table>
<h2 id="T">T</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="widgets/tablewidget.html#pyqtgraph.TableWidget">TableWidget (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.targetRect">targetRect() (pyqtgraph.ViewBox method)</a></dt>
<dt><a href="widgets/imageview.html#pyqtgraph.ImageView.timeIndex">timeIndex() (pyqtgraph.ImageView method)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/roi.html#pyqtgraph.ROI.translate">translate() (pyqtgraph.ROI method)</a></dt>
<dt><a href="widgets/treewidget.html#pyqtgraph.TreeWidget">TreeWidget (class in pyqtgraph)</a></dt>
</dl></td>
</tr></table>
<h2 id="U">U</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/uigraphicsitem.html#pyqtgraph.UIGraphicsItem">UIGraphicsItem (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.updatePlotList">updatePlotList() (pyqtgraph.PlotItem method)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.updateXScale">updateXScale() (pyqtgraph.PlotItem method)</a></dt>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.updateYScale">updateYScale() (pyqtgraph.PlotItem method)</a></dt>
</dl></td>
</tr></table>
<h2 id="V">V</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="widgets/verticallabel.html#pyqtgraph.VerticalLabel">VerticalLabel (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox">ViewBox (class in pyqtgraph)</a></dt>
<dt><a href="graphicsItems/uigraphicsitem.html#pyqtgraph.UIGraphicsItem.viewChangedEvent">viewChangedEvent() (pyqtgraph.UIGraphicsItem method)</a></dt>
<dt><a href="graphicsItems/plotitem.html#pyqtgraph.PlotItem.viewGeometry">viewGeometry() (pyqtgraph.PlotItem method)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="graphicsItems/uigraphicsitem.html#pyqtgraph.UIGraphicsItem.viewRangeChanged">viewRangeChanged() (pyqtgraph.UIGraphicsItem method)</a></dt>
<dt><a href="graphicsItems/graphicsobject.html#pyqtgraph.GraphicsObject.viewRect">viewRect() (pyqtgraph.GraphicsObject method)</a></dt>
<dd><dl>
<dt><a href="widgets/graphicsview.html#pyqtgraph.GraphicsView.viewRect">(pyqtgraph.GraphicsView method)</a></dt>
<dt><a href="graphicsItems/viewbox.html#pyqtgraph.ViewBox.viewRect">(pyqtgraph.ViewBox method)</a></dt>
</dl></dd>
<dt><a href="graphicsItems/graphicsobject.html#pyqtgraph.GraphicsObject.viewTransform">viewTransform() (pyqtgraph.GraphicsObject method)</a></dt>
<dt><a href="graphicsItems/vtickgroup.html#pyqtgraph.VTickGroup">VTickGroup (class in pyqtgraph)</a></dt>
</dl></td>
</tr></table>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

132
documentation/build/html/graphicsItems/arrowitem.html
View File

@ -1,132 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>ArrowItem &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="../index.html" />
<link rel="up" title="Pyqtgraph’s Graphics Items" href="index.html" />
<link rel="next" title="CurvePoint" href="curvepoint.html" />
<link rel="prev" title="AxisItem" href="axisitem.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="curvepoint.html" title="CurvePoint"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="axisitem.html" title="AxisItem"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="arrowitem">
<h1>ArrowItem<a class="headerlink" href="#arrowitem" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pyqtgraph.ArrowItem">
<em class="property">class </em><tt class="descclassname">pyqtgraph.</tt><tt class="descname">ArrowItem</tt><big>(</big><em>**opts</em><big>)</big><a class="headerlink" href="#pyqtgraph.ArrowItem" title="Permalink to this definition"></a></dt>
<dd><p>For displaying scale-invariant arrows.
For arrows pointing to a location on a curve, see CurveArrow</p>
<dl class="method">
<dt id="pyqtgraph.ArrowItem.__init__">
<tt class="descname">__init__</tt><big>(</big><em>**opts</em><big>)</big><a class="headerlink" href="#pyqtgraph.ArrowItem.__init__" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="axisitem.html"
title="previous chapter">AxisItem</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="curvepoint.html"
title="next chapter">CurvePoint</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/graphicsItems/arrowitem.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="curvepoint.html" title="CurvePoint"
>next</a> |</li>
<li class="right" >
<a href="axisitem.html" title="AxisItem"
>previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" >Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

154
documentation/build/html/graphicsItems/axisitem.html
View File

@ -1,154 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>AxisItem &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="../index.html" />
<link rel="up" title="Pyqtgraph’s Graphics Items" href="index.html" />
<link rel="next" title="ArrowItem" href="arrowitem.html" />
<link rel="prev" title="GraphicsLayout" href="graphicslayout.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="arrowitem.html" title="ArrowItem"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="graphicslayout.html" title="GraphicsLayout"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="axisitem">
<h1>AxisItem<a class="headerlink" href="#axisitem" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pyqtgraph.AxisItem">
<em class="property">class </em><tt class="descclassname">pyqtgraph.</tt><tt class="descname">AxisItem</tt><big>(</big><em>orientation</em>, <em>pen=None</em>, <em>linkView=None</em>, <em>parent=None</em>, <em>maxTickLength=-5</em><big>)</big><a class="headerlink" href="#pyqtgraph.AxisItem" title="Permalink to this definition"></a></dt>
<dd><dl class="method">
<dt id="pyqtgraph.AxisItem.__init__">
<tt class="descname">__init__</tt><big>(</big><em>orientation</em>, <em>pen=None</em>, <em>linkView=None</em>, <em>parent=None</em>, <em>maxTickLength=-5</em><big>)</big><a class="headerlink" href="#pyqtgraph.AxisItem.__init__" title="Permalink to this definition"></a></dt>
<dd><p>GraphicsItem showing a single plot axis with ticks, values, and label.
Can be configured to fit on any side of a plot, and can automatically synchronize its displayed scale with ViewBox items.
Ticks can be extended to make a grid.</p>
</dd></dl>
<dl class="method">
<dt id="pyqtgraph.AxisItem.setGrid">
<tt class="descname">setGrid</tt><big>(</big><em>grid</em><big>)</big><a class="headerlink" href="#pyqtgraph.AxisItem.setGrid" title="Permalink to this definition"></a></dt>
<dd><p>Set the alpha value for the grid, or False to disable.</p>
</dd></dl>
<dl class="method">
<dt id="pyqtgraph.AxisItem.setScale">
<tt class="descname">setScale</tt><big>(</big><em>scale=None</em><big>)</big><a class="headerlink" href="#pyqtgraph.AxisItem.setScale" title="Permalink to this definition"></a></dt>
<dd><p>Set the value scaling for this axis.
The scaling value 1) multiplies the values displayed along the axis
and 2) changes the way units are displayed in the label.
For example:</p>
<blockquote>
If the axis spans values from -0.1 to 0.1 and has units set to &#8216;V&#8217;
then a scale of 1000 would cause the axis to display values -100 to 100
and the units would appear as &#8216;mV&#8217;</blockquote>
<p>If scale is None, then it will be determined automatically based on the current
range displayed by the axis.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="graphicslayout.html"
title="previous chapter">GraphicsLayout</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="arrowitem.html"
title="next chapter">ArrowItem</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/graphicsItems/axisitem.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="arrowitem.html" title="ArrowItem"
>next</a> |</li>
<li class="right" >
<a href="graphicslayout.html" title="GraphicsLayout"
>previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" >Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

131
documentation/build/html/graphicsItems/buttonitem.html
View File

@ -1,131 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>ButtonItem &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="../index.html" />
<link rel="up" title="Pyqtgraph’s Graphics Items" href="index.html" />
<link rel="next" title="GraphicsObject" href="graphicsobject.html" />
<link rel="prev" title="GradientLegend" href="gradientlegend.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="graphicsobject.html" title="GraphicsObject"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="gradientlegend.html" title="GradientLegend"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="buttonitem">
<h1>ButtonItem<a class="headerlink" href="#buttonitem" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pyqtgraph.ButtonItem">
<em class="property">class </em><tt class="descclassname">pyqtgraph.</tt><tt class="descname">ButtonItem</tt><big>(</big><em>imageFile</em>, <em>width=None</em>, <em>parentItem=None</em><big>)</big><a class="headerlink" href="#pyqtgraph.ButtonItem" title="Permalink to this definition"></a></dt>
<dd><p>Button graphicsItem displaying an image.</p>
<dl class="method">
<dt id="pyqtgraph.ButtonItem.__init__">
<tt class="descname">__init__</tt><big>(</big><em>imageFile</em>, <em>width=None</em>, <em>parentItem=None</em><big>)</big><a class="headerlink" href="#pyqtgraph.ButtonItem.__init__" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="gradientlegend.html"
title="previous chapter">GradientLegend</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="graphicsobject.html"
title="next chapter">GraphicsObject</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/graphicsItems/buttonitem.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="graphicsobject.html" title="GraphicsObject"
>next</a> |</li>
<li class="right" >
<a href="gradientlegend.html" title="GradientLegend"
>previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" >Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

132
documentation/build/html/graphicsItems/curvearrow.html
View File

@ -1,132 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>CurveArrow &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="../index.html" />
<link rel="up" title="Pyqtgraph’s Graphics Items" href="index.html" />
<link rel="next" title="GridItem" href="griditem.html" />
<link rel="prev" title="CurvePoint" href="curvepoint.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="griditem.html" title="GridItem"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="curvepoint.html" title="CurvePoint"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="curvearrow">
<h1>CurveArrow<a class="headerlink" href="#curvearrow" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pyqtgraph.CurveArrow">
<em class="property">class </em><tt class="descclassname">pyqtgraph.</tt><tt class="descname">CurveArrow</tt><big>(</big><em>curve</em>, <em>index=0</em>, <em>pos=None</em>, <em>**opts</em><big>)</big><a class="headerlink" href="#pyqtgraph.CurveArrow" title="Permalink to this definition"></a></dt>
<dd><p>Provides an arrow that points to any specific sample on a PlotCurveItem.
Provides properties that can be animated.</p>
<dl class="method">
<dt id="pyqtgraph.CurveArrow.__init__">
<tt class="descname">__init__</tt><big>(</big><em>curve</em>, <em>index=0</em>, <em>pos=None</em>, <em>**opts</em><big>)</big><a class="headerlink" href="#pyqtgraph.CurveArrow.__init__" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="curvepoint.html"
title="previous chapter">CurvePoint</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="griditem.html"
title="next chapter">GridItem</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/graphicsItems/curvearrow.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="griditem.html" title="GridItem"
>next</a> |</li>
<li class="right" >
<a href="curvepoint.html" title="CurvePoint"
>previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" >Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

136
documentation/build/html/graphicsItems/curvepoint.html
View File

@ -1,136 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>CurvePoint &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="../index.html" />
<link rel="up" title="Pyqtgraph’s Graphics Items" href="index.html" />
<link rel="next" title="CurveArrow" href="curvearrow.html" />
<link rel="prev" title="ArrowItem" href="arrowitem.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="curvearrow.html" title="CurveArrow"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="arrowitem.html" title="ArrowItem"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="curvepoint">
<h1>CurvePoint<a class="headerlink" href="#curvepoint" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pyqtgraph.CurvePoint">
<em class="property">class </em><tt class="descclassname">pyqtgraph.</tt><tt class="descname">CurvePoint</tt><big>(</big><em>curve</em>, <em>index=0</em>, <em>pos=None</em><big>)</big><a class="headerlink" href="#pyqtgraph.CurvePoint" title="Permalink to this definition"></a></dt>
<dd><p>A GraphicsItem that sets its location to a point on a PlotCurveItem.
Also rotates to be tangent to the curve.
The position along the curve is a Qt property, and thus can be easily animated.</p>
<p>Note: This class does not display anything; see CurveArrow for an applied example</p>
<dl class="method">
<dt id="pyqtgraph.CurvePoint.__init__">
<tt class="descname">__init__</tt><big>(</big><em>curve</em>, <em>index=0</em>, <em>pos=None</em><big>)</big><a class="headerlink" href="#pyqtgraph.CurvePoint.__init__" title="Permalink to this definition"></a></dt>
<dd><p>Position can be set either as an index referring to the sample number or
the position 0.0 - 1.0</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="arrowitem.html"
title="previous chapter">ArrowItem</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="curvearrow.html"
title="next chapter">CurveArrow</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/graphicsItems/curvepoint.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="curvearrow.html" title="CurveArrow"
>next</a> |</li>
<li class="right" >
<a href="arrowitem.html" title="ArrowItem"
>previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" >Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

136
documentation/build/html/graphicsItems/gradienteditoritem.html
View File

@ -1,136 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>GradientEditorItem &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="../index.html" />
<link rel="up" title="Pyqtgraph’s Graphics Items" href="index.html" />
<link rel="next" title="HistogramLUTItem" href="histogramlutitem.html" />
<link rel="prev" title="VTickGroup" href="vtickgroup.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="histogramlutitem.html" title="HistogramLUTItem"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="vtickgroup.html" title="VTickGroup"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="gradienteditoritem">
<h1>GradientEditorItem<a class="headerlink" href="#gradienteditoritem" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pyqtgraph.GradientEditorItem">
<em class="property">class </em><tt class="descclassname">pyqtgraph.</tt><tt class="descname">GradientEditorItem</tt><big>(</big><em>*args</em>, <em>**kargs</em><big>)</big><a class="headerlink" href="#pyqtgraph.GradientEditorItem" title="Permalink to this definition"></a></dt>
<dd><dl class="method">
<dt id="pyqtgraph.GradientEditorItem.__init__">
<tt class="descname">__init__</tt><big>(</big><em>*args</em>, <em>**kargs</em><big>)</big><a class="headerlink" href="#pyqtgraph.GradientEditorItem.__init__" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyqtgraph.GradientEditorItem.getLookupTable">
<tt class="descname">getLookupTable</tt><big>(</big><em>nPts</em>, <em>alpha=True</em><big>)</big><a class="headerlink" href="#pyqtgraph.GradientEditorItem.getLookupTable" title="Permalink to this definition"></a></dt>
<dd><p>Return an RGB/A lookup table.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="vtickgroup.html"
title="previous chapter">VTickGroup</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="histogramlutitem.html"
title="next chapter">HistogramLUTItem</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/graphicsItems/gradienteditoritem.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="histogramlutitem.html" title="HistogramLUTItem"
>next</a> |</li>
<li class="right" >
<a href="vtickgroup.html" title="VTickGroup"
>previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" >Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

138
documentation/build/html/graphicsItems/gradientlegend.html
View File

@ -1,138 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>GradientLegend &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="../index.html" />
<link rel="up" title="Pyqtgraph’s Graphics Items" href="index.html" />
<link rel="next" title="ButtonItem" href="buttonitem.html" />
<link rel="prev" title="HistogramLUTItem" href="histogramlutitem.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="buttonitem.html" title="ButtonItem"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="histogramlutitem.html" title="HistogramLUTItem"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="gradientlegend">
<h1>GradientLegend<a class="headerlink" href="#gradientlegend" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pyqtgraph.GradientLegend">
<em class="property">class </em><tt class="descclassname">pyqtgraph.</tt><tt class="descname">GradientLegend</tt><big>(</big><em>view</em>, <em>size</em>, <em>offset</em><big>)</big><a class="headerlink" href="#pyqtgraph.GradientLegend" title="Permalink to this definition"></a></dt>
<dd><p>Draws a color gradient rectangle along with text labels denoting the value at specific
points along the gradient.</p>
<dl class="method">
<dt id="pyqtgraph.GradientLegend.__init__">
<tt class="descname">__init__</tt><big>(</big><em>view</em>, <em>size</em>, <em>offset</em><big>)</big><a class="headerlink" href="#pyqtgraph.GradientLegend.__init__" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyqtgraph.GradientLegend.setLabels">
<tt class="descname">setLabels</tt><big>(</big><em>l</em><big>)</big><a class="headerlink" href="#pyqtgraph.GradientLegend.setLabels" title="Permalink to this definition"></a></dt>
<dd><p>Defines labels to appear next to the color scale. Accepts a dict of {text: value} pairs</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="histogramlutitem.html"
title="previous chapter">HistogramLUTItem</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="buttonitem.html"
title="next chapter">ButtonItem</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/graphicsItems/gradientlegend.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="buttonitem.html" title="ButtonItem"
>next</a> |</li>
<li class="right" >
<a href="histogramlutitem.html" title="HistogramLUTItem"
>previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" >Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

144
documentation/build/html/graphicsItems/graphicslayout.html
View File

@ -1,144 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>GraphicsLayout &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="../index.html" />
<link rel="up" title="Pyqtgraph’s Graphics Items" href="index.html" />
<link rel="next" title="AxisItem" href="axisitem.html" />
<link rel="prev" title="ROI" href="roi.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="axisitem.html" title="AxisItem"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="roi.html" title="ROI"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="graphicslayout">
<h1>GraphicsLayout<a class="headerlink" href="#graphicslayout" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pyqtgraph.GraphicsLayout">
<em class="property">class </em><tt class="descclassname">pyqtgraph.</tt><tt class="descname">GraphicsLayout</tt><big>(</big><em>parent=None</em>, <em>border=None</em><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsLayout" title="Permalink to this definition"></a></dt>
<dd><p>Used for laying out GraphicsWidgets in a grid.</p>
<dl class="method">
<dt id="pyqtgraph.GraphicsLayout.__init__">
<tt class="descname">__init__</tt><big>(</big><em>parent=None</em>, <em>border=None</em><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsLayout.__init__" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyqtgraph.GraphicsLayout.nextCol">
<tt class="descname">nextCol</tt><big>(</big><em>colspan=1</em><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsLayout.nextCol" title="Permalink to this definition"></a></dt>
<dd><p>Advance to next column, while returning the current column number
(generally only for internal use&#8211;called by addItem)</p>
</dd></dl>
<dl class="method">
<dt id="pyqtgraph.GraphicsLayout.nextRow">
<tt class="descname">nextRow</tt><big>(</big><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsLayout.nextRow" title="Permalink to this definition"></a></dt>
<dd><p>Advance to next row for automatic item placement</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="roi.html"
title="previous chapter">ROI</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="axisitem.html"
title="next chapter">AxisItem</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/graphicsItems/graphicslayout.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="axisitem.html" title="AxisItem"
>next</a> |</li>
<li class="right" >
<a href="roi.html" title="ROI"
>previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" >Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

189
documentation/build/html/graphicsItems/graphicsobject.html
View File

@ -1,189 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>GraphicsObject &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="../index.html" />
<link rel="up" title="Pyqtgraph’s Graphics Items" href="index.html" />
<link rel="next" title="GraphicsWidget" href="graphicswidget.html" />
<link rel="prev" title="ButtonItem" href="buttonitem.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="graphicswidget.html" title="GraphicsWidget"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="buttonitem.html" title="ButtonItem"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="graphicsobject">
<h1>GraphicsObject<a class="headerlink" href="#graphicsobject" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pyqtgraph.GraphicsObject">
<em class="property">class </em><tt class="descclassname">pyqtgraph.</tt><tt class="descname">GraphicsObject</tt><big>(</big><em>*args</em><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsObject" title="Permalink to this definition"></a></dt>
<dd><p>Extends QGraphicsObject with a few important functions.
(Most of these assume that the object is in a scene with a single view)</p>
<p>This class also generates a cache of the Qt-internal addresses of each item
so that GraphicsScene.items() can return the correct objects (this is a PyQt bug)</p>
<dl class="method">
<dt id="pyqtgraph.GraphicsObject.__init__">
<tt class="descname">__init__</tt><big>(</big><em>*args</em><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsObject.__init__" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyqtgraph.GraphicsObject.deviceTransform">
<tt class="descname">deviceTransform</tt><big>(</big><em>viewportTransform=None</em><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsObject.deviceTransform" title="Permalink to this definition"></a></dt>
<dd><p>Return the transform that converts item coordinates to device coordinates (usually pixels).
Extends deviceTransform to automatically determine the viewportTransform.</p>
</dd></dl>
<dl class="method">
<dt id="pyqtgraph.GraphicsObject.getBoundingParents">
<tt class="descname">getBoundingParents</tt><big>(</big><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsObject.getBoundingParents" title="Permalink to this definition"></a></dt>
<dd><p>Return a list of parents to this item that have child clipping enabled.</p>
</dd></dl>
<dl class="method">
<dt id="pyqtgraph.GraphicsObject.getViewBox">
<tt class="descname">getViewBox</tt><big>(</big><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsObject.getViewBox" title="Permalink to this definition"></a></dt>
<dd><p>Return the first ViewBox or GraphicsView which bounds this item&#8217;s visible space.
If this item is not contained within a ViewBox, then the GraphicsView is returned.
If the item is contained inside nested ViewBoxes, then the inner-most ViewBox is returned.
The result is cached; clear the cache with forgetViewBox()</p>
</dd></dl>
<dl class="method">
<dt id="pyqtgraph.GraphicsObject.getViewWidget">
<tt class="descname">getViewWidget</tt><big>(</big><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsObject.getViewWidget" title="Permalink to this definition"></a></dt>
<dd><p>Return the view widget for this item. If the scene has multiple views, only the first view is returned.
The return value is cached; clear the cached value with forgetViewWidget()</p>
</dd></dl>
<dl class="method">
<dt id="pyqtgraph.GraphicsObject.pixelLength">
<tt class="descname">pixelLength</tt><big>(</big><em>direction</em><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsObject.pixelLength" title="Permalink to this definition"></a></dt>
<dd><p>Return the length of one pixel in the direction indicated (in local coordinates)</p>
</dd></dl>
<dl class="method">
<dt id="pyqtgraph.GraphicsObject.pixelVectors">
<tt class="descname">pixelVectors</tt><big>(</big><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsObject.pixelVectors" title="Permalink to this definition"></a></dt>
<dd><p>Return vectors in local coordinates representing the width and height of a view pixel.</p>
</dd></dl>
<dl class="method">
<dt id="pyqtgraph.GraphicsObject.viewRect">
<tt class="descname">viewRect</tt><big>(</big><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsObject.viewRect" title="Permalink to this definition"></a></dt>
<dd><p>Return the bounds (in item coordinates) of this item&#8217;s ViewBox or GraphicsWidget</p>
</dd></dl>
<dl class="method">
<dt id="pyqtgraph.GraphicsObject.viewTransform">
<tt class="descname">viewTransform</tt><big>(</big><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsObject.viewTransform" title="Permalink to this definition"></a></dt>
<dd><p>Return the transform that maps from local coordinates to the item&#8217;s ViewBox coordinates
If there is no ViewBox, return the scene transform.
Returns None if the item does not have a view.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="buttonitem.html"
title="previous chapter">ButtonItem</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="graphicswidget.html"
title="next chapter">GraphicsWidget</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/graphicsItems/graphicsobject.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="graphicswidget.html" title="GraphicsWidget"
>next</a> |</li>
<li class="right" >
<a href="buttonitem.html" title="ButtonItem"
>previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" >Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

132
documentation/build/html/graphicsItems/graphicswidget.html
View File

@ -1,132 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>GraphicsWidget &mdash; pyqtgraph v1.8 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pyqtgraph v1.8 documentation" href="../index.html" />
<link rel="up" title="Pyqtgraph’s Graphics Items" href="index.html" />
<link rel="next" title="UIGraphicsItem" href="uigraphicsitem.html" />
<link rel="prev" title="GraphicsObject" href="graphicsobject.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="uigraphicsitem.html" title="UIGraphicsItem"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="graphicsobject.html" title="GraphicsObject"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="graphicswidget">
<h1>GraphicsWidget<a class="headerlink" href="#graphicswidget" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pyqtgraph.GraphicsWidget">
<em class="property">class </em><tt class="descclassname">pyqtgraph.</tt><tt class="descname">GraphicsWidget</tt><big>(</big><em>*args</em>, <em>**kargs</em><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsWidget" title="Permalink to this definition"></a></dt>
<dd><dl class="method">
<dt id="pyqtgraph.GraphicsWidget.__init__">
<tt class="descname">__init__</tt><big>(</big><em>*args</em>, <em>**kargs</em><big>)</big><a class="headerlink" href="#pyqtgraph.GraphicsWidget.__init__" title="Permalink to this definition"></a></dt>
<dd><p>Extends QGraphicsWidget with a workaround for a PyQt bug.
This class is otherwise identical to QGraphicsWidget.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="graphicsobject.html"
title="previous chapter">GraphicsObject</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="uigraphicsitem.html"
title="next chapter">UIGraphicsItem</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/graphicsItems/graphicswidget.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="uigraphicsitem.html" title="UIGraphicsItem"
>next</a> |</li>
<li class="right" >
<a href="graphicsobject.html" title="GraphicsObject"
>previous</a> |</li>
<li><a href="../index.html">pyqtgraph v1.8 documentation</a> &raquo;</li>
<li><a href="../apireference.html" >API Reference</a> &raquo;</li>
<li><a href="index.html" >Pyqtgraph&#8217;s Graphics Items</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Luke Campagnola.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show More