APIJS.html

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>API Javascript &mdash; brainsprite  documentation</title>
  

  
  
    <link rel="shortcut icon" href="_static/logo_brainsprite_small.png"/>
  
  
  

  
  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/doctools.js"></script>
        <script src="_static/language_data.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
  <link rel="stylesheet" href="_static/gallery.css" type="text/css" />
  <link rel="stylesheet" href="_static/gallery-binder.css" type="text/css" />
  <link rel="stylesheet" href="_static/gallery-dataframe.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="API Python" href="APIPY.html" />
    <link rel="prev" title="Statistical map viewer" href="auto_examples/plot_stat_map.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="index.html" class="icon icon-home"> brainsprite
          

          
            
            <img src="_static/logo_brainsprite.png" class="logo" alt="Logo"/>
          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="QUICKSTART.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">Tutorials</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Javascript</a></li>
<li class="toctree-l1"><a class="reference internal" href="APIPY.html">API Python</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">brainsprite</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>API Javascript</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/APIJS.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="api-javascript">
<h1>API Javascript<a class="headerlink" href="#api-javascript" title="Permalink to this headline">¶</a></h1>
<dl class="js function">
<dt id="brainsprite">
<code class="sig-name descname">brainsprite</code><span class="sig-paren">(</span><em class="sig-param">params</em><span class="sig-paren">)</span><a class="headerlink" href="#brainsprite" title="Permalink to this definition">¶</a></dt>
<dd><p>Brainsprite viewer object prototype</p>
<dl class="field-list simple">
<dt class="field-odd">Arguments</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>params.smooth</strong> (<em>boolean</em>) – turn on/off smoothing of the main slices.</p></li>
<li><p><strong>params.flagValue</strong> (<em>boolean</em>) – turn on/off display of the current value.</p></li>
<li><p><strong>params.colorBackground</strong> (<em>string</em>) – the color for background.</p></li>
<li><p><strong>params.colorFont</strong> (<em>string</em>) – the color for the fonts.</p></li>
<li><p><strong>params.colorCrosshair</strong> (<em>string</em>) – the color of the crosshair.</p></li>
<li><p><strong>params.flagCoordinates</strong> (<em>boolean</em>) – turn on/off slice coordinates.</p></li>
<li><p><strong>params.origin</strong> (<em>object</em>) – {“X”,”Y”,”Z”} coordinates of the origin .</p></li>
<li><p><strong>params.voxelSize</strong> (<em>number</em>) – the size of one voxel (assumed to be isotropic)</p></li>
<li><p><strong>params.affine</strong> (<em>array</em>) – the voxel-to-world transform. Use folse for isotropic diagonal using origin and voxelSize.</p></li>
<li><p><strong>params.heightColorBar</strong> (<em>number</em>) – height of the text for the colorbar.</p></li>
<li><p><strong>params.sizeFont</strong> (<em>number</em>) – the size of other texts.</p></li>
<li><p><strong>params.nbDecimals</strong> (<em>integer</em>) – the number of decimals when showing the value.</p></li>
<li><p><strong>params.crosshair</strong> (<em>boolean</em>) – turns on/off the crosshair.</p></li>
<li><p><strong>params.sizeCrosshair</strong> (<em>float</em>) – the size of the crosshair, expressed as a fraction of the slice (comprised between 0 and 1).</p></li>
<li><p><strong>params.title</strong> (<em>string</em>) – the title for the viewer. false will use no title.</p></li>
<li><p><strong>params.numSlice</strong> (<em>object</em>) – {“X”, “Y”, “Z”} coordinates of the initial cut. false will use the middle of the volume.</p></li>
<li><p><strong>params.overlay</strong> (<em>object</em>) – object. If false, no overlay.</p></li>
<li><p><strong>params.overlay.opacity</strong> (<em>number</em>) – the opacity of the overlay.</p></li>
<li><p><strong>params.onclick</strong> (<em>string</em>) – command to call on click.</p></li>
<li><p><strong>params.colormap</strong> (<em>object</em>) – object. if false, no colormap.</p></li>
<li><p><strong>params.nanValue</strong> (<em>boolean</em>) – unable to read values.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><strong>object</strong> – a brainsprite viewer object.</p>
</dd>
</dl>
</dd></dl>

</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="APIPY.html" class="btn btn-neutral float-right" title="API Python" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="auto_examples/plot_stat_map.html" class="btn btn-neutral float-left" title="Statistical map viewer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2020, Brainsprite team

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>