source: sasview/plottools/docs/sphinx/html/api/binder.html @ eaa85e7

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since eaa85e7 was 82a54b8, checked in by Mathieu Doucet <doucetm@…>, 13 years ago

adding plottools Part 2

  • Property mode set to 100644
File size: 9.7 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>binder &mdash; plottools 0.10 documentation</title>
12   
13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../',
19        VERSION:     '0.10',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../_static/jquery.js"></script>
26    <script type="text/javascript" src="../_static/underscore.js"></script>
27    <script type="text/javascript" src="../_static/doctools.js"></script>
28    <link rel="top" title="plottools 0.10 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="canvas" href="canvas.html" />
31    <link rel="prev" title="BaseInteractor" href="BaseInteractor.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="canvas.html" title="canvas"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="BaseInteractor.html" title="BaseInteractor"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">plottools 0.10 documentation</a> &raquo;</li>
50          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="binder">
60<h1>binder<a class="headerlink" href="#binder" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="danse-common-plottools-binder">
62<h2><a class="reference internal" href="#module-danse.common.plottools.binder" title="danse.common.plottools.binder"><tt class="xref py py-mod docutils literal"><span class="pre">danse.common.plottools.binder</span></tt></a><a class="headerlink" href="#danse-common-plottools-binder" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-danse.common.plottools.binder"></span><p>Extension to MPL to support the binding of artists to key/mouse events.</p>
64<dl class="class">
65<dt id="danse.common.plottools.binder.BindArtist">
66<em class="property">class </em><tt class="descclassname">danse.common.plottools.binder.</tt><tt class="descname">BindArtist</tt><a class="headerlink" href="#danse.common.plottools.binder.BindArtist" title="Permalink to this definition">¶</a></dt>
67<dd><dl class="attribute">
68<dt id="danse.common.plottools.binder.BindArtist.alt">
69<tt class="descname">alt</tt><em class="property"> = False</em><a class="headerlink" href="#danse.common.plottools.binder.BindArtist.alt" title="Permalink to this definition">¶</a></dt>
70<dd></dd></dl>
71
72<dl class="method">
73<dt id="danse.common.plottools.binder.BindArtist.clear">
74<tt class="descname">clear</tt><big>(</big><em>h1</em>, <em>h2</em>, <em>...</em><big>)</big><a class="headerlink" href="#danse.common.plottools.binder.BindArtist.clear" title="Permalink to this definition">¶</a></dt>
75<dd><blockquote>
76<div>Remove connections for artists h1, h2, ...</div></blockquote>
77<p>Use clearall() to reset all connections.</p>
78</dd></dl>
79
80<dl class="method">
81<dt id="danse.common.plottools.binder.BindArtist.clearall">
82<tt class="descname">clearall</tt><big>(</big><big>)</big><a class="headerlink" href="#danse.common.plottools.binder.BindArtist.clearall" title="Permalink to this definition">¶</a></dt>
83<dd><p>Clear connections to all artists.</p>
84<p>Use clear(h1,h2,...) to reset specific artists.</p>
85</dd></dl>
86
87<dl class="attribute">
88<dt id="danse.common.plottools.binder.BindArtist.control">
89<tt class="descname">control</tt><em class="property"> = False</em><a class="headerlink" href="#danse.common.plottools.binder.BindArtist.control" title="Permalink to this definition">¶</a></dt>
90<dd></dd></dl>
91
92<dl class="attribute">
93<dt id="danse.common.plottools.binder.BindArtist.dclick_threshhold">
94<tt class="descname">dclick_threshhold</tt><em class="property"> = 0.25</em><a class="headerlink" href="#danse.common.plottools.binder.BindArtist.dclick_threshhold" title="Permalink to this definition">¶</a></dt>
95<dd></dd></dl>
96
97<dl class="method">
98<dt id="danse.common.plottools.binder.BindArtist.disconnect">
99<tt class="descname">disconnect</tt><big>(</big><big>)</big><a class="headerlink" href="#danse.common.plottools.binder.BindArtist.disconnect" title="Permalink to this definition">¶</a></dt>
100<dd><p>In case we need to disconnect from the canvas...</p>
101</dd></dl>
102
103<dl class="attribute">
104<dt id="danse.common.plottools.binder.BindArtist.events">
105<tt class="descname">events</tt><em class="property"> = ['enter', 'leave', 'motion', 'click', 'dclick', 'drag', 'release', 'scroll', 'key', 'keyup']</em><a class="headerlink" href="#danse.common.plottools.binder.BindArtist.events" title="Permalink to this definition">¶</a></dt>
106<dd></dd></dl>
107
108<dl class="attribute">
109<dt id="danse.common.plottools.binder.BindArtist.meta">
110<tt class="descname">meta</tt><em class="property"> = False</em><a class="headerlink" href="#danse.common.plottools.binder.BindArtist.meta" title="Permalink to this definition">¶</a></dt>
111<dd></dd></dl>
112
113<dl class="attribute">
114<dt id="danse.common.plottools.binder.BindArtist.shift">
115<tt class="descname">shift</tt><em class="property"> = False</em><a class="headerlink" href="#danse.common.plottools.binder.BindArtist.shift" title="Permalink to this definition">¶</a></dt>
116<dd></dd></dl>
117
118<dl class="method">
119<dt id="danse.common.plottools.binder.BindArtist.trigger">
120<tt class="descname">trigger</tt><big>(</big><big>)</big><a class="headerlink" href="#danse.common.plottools.binder.BindArtist.trigger" title="Permalink to this definition">¶</a></dt>
121<dd><p>Trigger a particular event for the artist.  Fallback to axes,
122to figure, and to &#8216;all&#8217; if the event is not processed.</p>
123</dd></dl>
124
125</dd></dl>
126
127<dl class="class">
128<dt id="danse.common.plottools.binder.Selection">
129<em class="property">class </em><tt class="descclassname">danse.common.plottools.binder.</tt><tt class="descname">Selection</tt><a class="headerlink" href="#danse.common.plottools.binder.Selection" title="Permalink to this definition">¶</a></dt>
130<dd><p>Store and compare selections.</p>
131<dl class="attribute">
132<dt id="danse.common.plottools.binder.Selection.artist">
133<tt class="descname">artist</tt><em class="property"> = None</em><a class="headerlink" href="#danse.common.plottools.binder.Selection.artist" title="Permalink to this definition">¶</a></dt>
134<dd></dd></dl>
135
136<dl class="attribute">
137<dt id="danse.common.plottools.binder.Selection.prop">
138<tt class="descname">prop</tt><em class="property"> = {}</em><a class="headerlink" href="#danse.common.plottools.binder.Selection.prop" title="Permalink to this definition">¶</a></dt>
139<dd></dd></dl>
140
141</dd></dl>
142
143</div>
144</div>
145
146
147          </div>
148        </div>
149      </div>
150      <div class="sphinxsidebar">
151        <div class="sphinxsidebarwrapper">
152  <h3><a href="../index.html">Table Of Contents</a></h3>
153  <ul>
154<li><a class="reference internal" href="#">binder</a><ul>
155<li><a class="reference internal" href="#danse-common-plottools-binder"><tt class="docutils literal"><span class="pre">danse.common.plottools.binder</span></tt></a></li>
156</ul>
157</li>
158</ul>
159
160  <h4>Previous topic</h4>
161  <p class="topless"><a href="BaseInteractor.html"
162                        title="previous chapter">BaseInteractor</a></p>
163  <h4>Next topic</h4>
164  <p class="topless"><a href="canvas.html"
165                        title="next chapter">canvas</a></p>
166  <h3>This Page</h3>
167  <ul class="this-page-menu">
168    <li><a href="../_sources/api/binder.txt"
169           rel="nofollow">Show Source</a></li>
170  </ul>
171<div id="searchbox" style="display: none">
172  <h3>Quick search</h3>
173    <form class="search" action="../search.html" method="get">
174      <input type="text" name="q" />
175      <input type="submit" value="Go" />
176      <input type="hidden" name="check_keywords" value="yes" />
177      <input type="hidden" name="area" value="default" />
178    </form>
179    <p class="searchtip" style="font-size: 90%">
180    Enter search terms or a module, class or function name.
181    </p>
182</div>
183<script type="text/javascript">$('#searchbox').show(0);</script>
184        </div>
185      </div>
186      <div class="clearer"></div>
187    </div>
188    <div class="related">
189      <h3>Navigation</h3>
190      <ul>
191        <li class="right" style="margin-right: 10px">
192          <a href="../genindex.html" title="General Index"
193             >index</a></li>
194        <li class="right" >
195          <a href="../py-modindex.html" title="Python Module Index"
196             >modules</a> |</li>
197        <li class="right" >
198          <a href="canvas.html" title="canvas"
199             >next</a> |</li>
200        <li class="right" >
201          <a href="BaseInteractor.html" title="BaseInteractor"
202             >previous</a> |</li>
203        <li><a href="../index.html">plottools 0.10 documentation</a> &raquo;</li>
204          <li><a href="index.html" >Reference</a> &raquo;</li> 
205      </ul>
206    </div>
207    <div class="footer">
208        &copy; Copyright 2010, sans/reflectometry group.
209      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
210    </div>
211  </body>
212</html>
Note: See TracBrowser for help on using the repository browser.