deploy: 533f206

Author: jordibc

_modules/ete4/smartview/faces.html

@@ -523,6 +523,36 @@ <h1>Source code for ete4.smartview.faces</h1><div class="highlight"><pre>
         <span class="k">return</span> <span class="n">graphics</span><span class="p">,</span> <span class="n">size</span></div>
 </div>
 
+
+
+<div class="viewcode-block" id="LegendFace">
+<a class="viewcode-back" href="../../../reference/reference_smartview.html#ete4.smartview.faces.LegendFace">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">LegendFace</span><span class="p">(</span><span class="n">Face</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A legend with information about the data we are visualizing.&quot;&quot;&quot;</span>
+
+<div class="viewcode-block" id="LegendFace.__init__">
+<a class="viewcode-back" href="../../../reference/reference_smartview.html#ete4.smartview.faces.LegendFace.__init__">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">title</span><span class="p">,</span> <span class="n">variable</span><span class="p">,</span>
+                 <span class="n">colormap</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">value_range</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">color_range</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+        <span class="c1"># Do some very basic consistency checks first.</span>
+        <span class="k">if</span> <span class="n">variable</span> <span class="o">==</span> <span class="s1">&#39;discrete&#39;</span><span class="p">:</span>
+            <span class="k">assert</span> <span class="n">colormap</span> <span class="ow">and</span> <span class="n">value_range</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">color_range</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">,</span> \
+                <span class="s1">&#39;discrete variable needs a colormap (and no more)&#39;</span>
+        <span class="k">elif</span> <span class="n">variable</span> <span class="o">==</span> <span class="s1">&#39;continuous&#39;</span><span class="p">:</span>
+            <span class="k">assert</span> <span class="n">value_range</span> <span class="ow">and</span> <span class="n">color_range</span> <span class="ow">and</span> <span class="n">colormap</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">,</span> \
+                <span class="s1">&#39;continuous variable needs value and color ranges (and no more)&#39;</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;invalid variable value: </span><span class="si">{</span><span class="n">variable</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">title</span> <span class="o">=</span> <span class="n">title</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">variable</span> <span class="o">=</span> <span class="n">variable</span>  <span class="c1"># can be &quot;discrete&quot; or &quot;continuous&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">colormap</span> <span class="o">=</span> <span class="n">colormap</span>  <span class="c1"># dict {name: color}</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">value_range</span> <span class="o">=</span> <span class="n">value_range</span>  <span class="c1"># (min, max)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">color_range</span> <span class="o">=</span> <span class="n">color_range</span>  <span class="c1"># (min, max)</span></div>
+</div>
+
+
+    <span class="c1"># NOTE: We don&#39;t need a special draw() function, we use the info directly.</span>
 </pre></div>
 
           </div>

_modules/ete4/smartview/graphics.html

@@ -109,6 +109,13 @@ <h1>Source code for ete4.smartview.graphics</h1><div class="highlight"><pre>
 
 <span class="c1"># NOTE: the &quot;0&quot; is a x shift, so it can be translated in draw.js.</span>
 
+<div class="viewcode-block" id="draw_legend">
+<a class="viewcode-back" href="../../../reference/reference_smartview.html#ete4.smartview.graphics.draw_legend">[docs]</a>
+<span class="k">def</span><span class="w"> </span><span class="nf">draw_legend</span><span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">variable</span><span class="p">,</span> <span class="n">colormap</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+                <span class="n">value_range</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">color_range</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+    <span class="k">return</span> <span class="p">[</span><span class="s1">&#39;legend&#39;</span><span class="p">,</span> <span class="n">title</span><span class="p">,</span> <span class="n">variable</span><span class="p">,</span> <span class="n">colormap</span><span class="p">,</span> <span class="n">value_range</span><span class="p">,</span> <span class="n">color_range</span><span class="p">]</span></div>
+
+
 
 <span class="c1"># Other (drawing) commands.</span>
 

genindex.html

@@ -83,6 +83,8 @@ <h2 id="_">_</h2>
         <li><a href="reference/reference_smartview.html#ete4.smartview.faces.ImageFace.__init__">(ImageFace method)</a>
 </li>
         <li><a href="reference/reference_smartview.html#ete4.smartview.layout.Layout.__init__">(Layout method)</a>
+</li>
+        <li><a href="reference/reference_smartview.html#ete4.smartview.faces.LegendFace.__init__">(LegendFace method)</a>
 </li>
         <li><a href="reference/reference_taxonomy.html#ete4.NCBITaxa.__init__">(NCBITaxa method)</a>
 </li>
@@ -263,11 +265,13 @@ <h2 id="D">D</h2>
 </li>
       <li><a href="reference/reference_smartview.html#ete4.smartview.graphics.draw_header">draw_header() (in module ete4.smartview.graphics)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/reference_smartview.html#ete4.smartview.graphics.draw_hz_line">draw_hz_line() (in module ete4.smartview.graphics)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/reference_smartview.html#ete4.smartview.graphics.draw_image">draw_image() (in module ete4.smartview.graphics)</a>
+</li>
+      <li><a href="reference/reference_smartview.html#ete4.smartview.graphics.draw_legend">draw_legend() (in module ete4.smartview.graphics)</a>
 </li>
       <li><a href="reference/reference_smartview.html#ete4.smartview.graphics.draw_line">draw_line() (in module ete4.smartview.graphics)</a>
 </li>
@@ -637,10 +641,12 @@ <h2 id="L">L</h2>
 </li>
       <li><a href="reference/reference_tree.html#ete4.Tree.leaves">leaves() (Tree method)</a>
 </li>
-      <li><a href="reference/reference_tree.html#ete4.Tree.level">level (Tree attribute)</a>
+      <li><a href="reference/reference_smartview.html#ete4.smartview.faces.LegendFace">LegendFace (class in ete4.smartview.faces)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="reference/reference_tree.html#ete4.Tree.level">level (Tree attribute)</a>
+</li>
       <li><a href="reference/reference_tree.html#ete4.Tree.lineage">lineage() (Tree method)</a>
 </li>
       <li><a href="reference/reference_phylo.html#ete4.PhyloTree.link_to_alignment">link_to_alignment() (PhyloTree method)</a>

objects.inv

@@ -571,6 +571,18 @@ <h1><a class="toc-backref" href="#id1" role="doc-backlink">Smartview (web graphi
 
 </dd></dl>
 
+<dl class="py class">
+<dt class="sig sig-object py" id="ete4.smartview.faces.LegendFace">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LegendFace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">variable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colormap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_range</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color_range</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ete4/smartview/faces.html#LegendFace"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ete4.smartview.faces.LegendFace" title="Link to this definition">¶</a></dt>
+<dd><p>A legend with information about the data we are visualizing.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="ete4.smartview.faces.LegendFace.__init__">
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">variable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colormap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_range</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color_range</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ete4/smartview/faces.html#LegendFace.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ete4.smartview.faces.LegendFace.__init__" title="Link to this definition">¶</a></dt>
+<dd><p>Save all the parameters that we may want to use.</p>
+</dd></dl>
+
+</dd></dl>
+
 <dl class="py class">
 <dt class="sig sig-object py" id="ete4.smartview.faces.PolygonFace">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PolygonFace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rmax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ete4/smartview/faces.html#PolygonFace"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ete4.smartview.faces.PolygonFace" title="Link to this definition">¶</a></dt>
@@ -763,6 +775,11 @@ <h1><a class="toc-backref" href="#id1" role="doc-backlink">Smartview (web graphi
 <span class="sig-name descname"><span class="pre">draw_image</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">box</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">href</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ete4/smartview/graphics.html#draw_image"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ete4.smartview.graphics.draw_image" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="ete4.smartview.graphics.draw_legend">
+<span class="sig-name descname"><span class="pre">draw_legend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">variable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colormap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_range</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color_range</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ete4/smartview/graphics.html#draw_legend"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ete4.smartview.graphics.draw_legend" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="ete4.smartview.graphics.draw_line">
 <span class="sig-name descname"><span class="pre">draw_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">p1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ete4/smartview/graphics.html#draw_line"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ete4.smartview.graphics.draw_line" title="Link to this definition">¶</a></dt>