<!DOCTYPE html>
<html lang="en">

<head>
  
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>3Dmol.js Documentation ArrowSpec</title>

  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
  <script src="./build/entry.js"></script>
  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
  <!--[if lt IE 9]>
    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  <![endif]-->
  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/github.min.css">
  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
  <link type="text/css" rel="stylesheet" href="../tutorials/style.css">
  <script async defer src="https://buttons.github.io/buttons.js"></script>

  
</head>



<body class="layout small-header">
    <div id="stickyNavbarOverlay"></div>
    

<div class="top-nav">
    <div class="inner">
        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
            <span aria-hidden="true"></span>
            <span aria-hidden="true"></span>
            <span aria-hidden="true"></span>
        </a>
        <div class="logo">
            
             
                <a href="index.html">
                    <h1 class="navbar-item"><a href="http://3dmol.org"><b>3Dmol</b>.js</a></h1>
                </a>
            
        </div>
        <div class="menu">
            
            <div class="navigation">
                <a
                    href="index.html"
                    class="link"
                >
                    Documentation
                </a>
                
                <div class="dropdown is-hoverable is-right">
                    <a class="dropdown-trigger link">
                        Tutorials
                        <i class="fas fa-chevron-down fa-xs"></i>
                    </a>
                    <div class="dropdown-menu">
                        <div class="dropdown-content">
                        
                            <a class="dropdown-item" href="tutorial-code.html">
                                Using 3Dmol within your code
                            </a>
                        
                            <a class="dropdown-item" href="tutorial-embeddable.html">
                                Embedding a 3Dmol Viewer
                            </a>
                        
                            <a class="dropdown-item" href="tutorial-learning_environment.html">
                                Active Learning with 3Dmol.js
                            </a>
                        
                            <a class="dropdown-item" href="tutorial-url.html">
                                Viewing Molecules with the 3Dmol Server
                            </a>
                        
                        </div>
                    </div>
                </div>
                
                 
                    
                        <a
                            class="link user-link "
                            href="https://github.com/3dmol/3Dmol.js"
                        >
                            Github
                        </a>
                    
                
                
            </div>
        </div>
    </div>
</div>
    <div id="main">
        <div
            class="sidebar "
            id="sidebarNav"
        >
            
            <nav>
                
                    <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Namespaces</h3><ul><li><a href="GLDraw.html">GLDraw</a></li></ul><h3>Classes</h3><ul><li><a href="$3Dmol.Label.html">Label</a></li><li><a href="$3Dmol.UI.html">UI</a></li><li><a href="Color.html">Color</a></li><li><a href="GLModel.html">GLModel</a></li><li><a href="GLShape.html">GLShape</a></li><li><a href="GLShape_GLShape.html">GLShape</a></li><li><a href="GLViewer.html">GLViewer</a></li><li><a href="GLVolumetricRender.html">GLVolumetricRender</a></li><li><a href="VolumeData.html">VolumeData</a></li></ul><h3>Classes / Gradients</h3><ul><li><a href="CustomLinear.html">CustomLinear</a></li><li><a href="ROYGB.html">ROYGB</a></li><li><a href="RWB.html">RWB</a></li><li><a href="Sinebow.html">Sinebow</a></li></ul><h3>Classes / Math</h3><ul><li><a href="Cylinder.html">Cylinder</a></li><li><a href="Matrix3.html">Matrix3</a></li><li><a href="Matrix4.html">Matrix4</a></li><li><a href="Quaternion.html">Quaternion</a></li><li><a href="Ray.html">Ray</a></li><li><a href="Sphere.html">Sphere</a></li><li><a href="Triangle.html">Triangle</a></li><li><a href="Vector2.html">Vector2</a></li><li><a href="global.html#Vector3">Vector3</a></li></ul><h3>Interfaces</h3><ul><li><a href="global.html#ArrowSpec">ArrowSpec</a></li></ul><h3>Interfaces / Specifications</h3><ul><li><a href="CartoonStyleSpec.html">CartoonStyleSpec</a></li><li><a href="ShapeSpec.html">ShapeSpec</a></li></ul><h3>Global</h3><ul><li><a href="global.html#CAP">CAP</a></li><li><a href="global.html#SurfaceType">SurfaceType</a></li><li><a href="global.html#builtinColorSchemes">builtinColorSchemes</a></li><li><a href="global.html#conversionMatrix3">conversionMatrix3</a></li><li><a href="global.html#createViewer">createViewer</a></li><li><a href="global.html#createViewerGrid">createViewerGrid</a></li><li><a href="global.html#download">download</a></li><li><a href="global.html#elementColors">elementColors</a></li><li><a href="global.html#get">get</a></li><li><a href="global.html#getbin">getbin</a></li><li><a href="global.html#ssColors">ssColors</a></li><li><a href="global.html#syncSurface">syncSurface</a></li><li><a href="global.html#viewers">viewers</a></li></ul></div><div class="category"><h2>Parsers</h2><h3>Global</h3><ul><li><a href="global.html#CDJSON">CDJSON</a></li><li><a href="global.html#CIF">CIF</a></li><li><a href="global.html#CUBE">CUBE</a></li><li><a href="global.html#GRO">GRO</a></li><li><a href="global.html#LAMMPSTRJ">LAMMPSTRJ</a></li><li><a href="global.html#MMTFparser">MMTFparser</a></li><li><a href="global.html#MOL2">MOL2</a></li><li><a href="global.html#PDB">PDB</a></li><li><a href="global.html#PQR">PQR</a></li><li><a href="global.html#PRMTOP">PRMTOP</a></li><li><a href="global.html#SDF">SDF</a></li><li><a href="global.html#VASP">VASP</a></li><li><a href="global.html#XYZ">XYZ</a></li></ul></div>
                
            </nav>
        </div>
        <div class="core" id="main-content-wrapper">
            <div class="content">
                <header class="page-title">
                    <p>Interface</p>
                    <h1>ArrowSpec</h1>
                </header>
                




<section>

<header>
    
        <h2>ArrowSpec</h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
            <div class="description"><p>Arrow shape specification.  Extends <a href="ShapeSpec.html"><code>ShapeSpec</code></a></p></div>
        

        


<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
        <p class="tag-source">
            <a href="GLShape.ts.html" class="button">View Source</a>
            <span>
                <a href="GLShape.ts.html">GLShape.ts</a>, <a href="GLShape.ts.html#line1375">line 1375</a>
            </span>
        </p>
    
</dl>


        
    
    </div>
    
    

    

    

    

    

    

    
        <div class='vertical-section'>
            <h1>Members</h1>
            <div class="members">
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>Type:</label>
        
<code class="param-type">number</code>


    </span>

<h4 class="name" id="mid">
    <a class="href-link" href="#mid">#</a>
    
    <span class="code-name">
        mid
    </span>
    
        <span class='tag'>Optional</span>
    
</h4>




<div class="description">
    <p>relative position of arrow base (0.618034 default)</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
        <p class="tag-source">
            <a href="GLShape.ts.html" class="button">View Source</a>
            <span>
                <a href="GLShape.ts.html">GLShape.ts</a>, <a href="GLShape.ts.html#line1389">line 1389</a>
            </span>
        </p>
    
</dl>





</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>Type:</label>
        
<code class="param-type">number</code>


    </span>

<h4 class="name" id="midpos">
    <a class="href-link" href="#midpos">#</a>
    
    <span class="code-name">
        midpos
    </span>
    
        <span class='tag'>Optional</span>
    
</h4>




<div class="description">
    <p>position of arrow base in length units, if negative positioned from end instead of start.  Overrides mid.</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
        <p class="tag-source">
            <a href="GLShape.ts.html" class="button">View Source</a>
            <span>
                <a href="GLShape.ts.html">GLShape.ts</a>, <a href="GLShape.ts.html#line1394">line 1394</a>
            </span>
        </p>
    
</dl>





</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>Type:</label>
        
<code class="param-type">number</code>


    </span>

<h4 class="name" id="radius">
    <a class="href-link" href="#radius">#</a>
    
    <span class="code-name">
        radius
    </span>
    
        <span class='tag'>Optional</span>
    
</h4>




<div class="description">
    <p>radius (default 0.1A)</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
        <p class="tag-source">
            <a href="GLShape.ts.html" class="button">View Source</a>
            <span>
                <a href="GLShape.ts.html">GLShape.ts</a>, <a href="GLShape.ts.html#line1379">line 1379</a>
            </span>
        </p>
    
</dl>





</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>Type:</label>
        
<code class="param-type">number</code>


    </span>

<h4 class="name" id="radiusRatio">
    <a class="href-link" href="#radiusRatio">#</a>
    
    <span class="code-name">
        radiusRatio
    </span>
    
        <span class='tag'>Optional</span>
    
</h4>




<div class="description">
    <p>ratio of arrow base to cylinder (1.618034 default)</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
        <p class="tag-source">
            <a href="GLShape.ts.html" class="button">View Source</a>
            <span>
                <a href="GLShape.ts.html">GLShape.ts</a>, <a href="GLShape.ts.html#line1384">line 1384</a>
            </span>
        </p>
    
</dl>





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

    

    

    
</article>

</section>




            </div>
            
            <footer class="footer">
                <div class="content has-text-centered">
                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a></p>
                    <p class="sidebar-created-by">
                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
                    </p>
                </div>
            </footer>
            
        </div>
        <div id="side-nav" class="side-nav">
        </div>
    </div>
<script src="scripts/app.min.js"></script>
<script>hljs.highlightAll();</script>
<script src="scripts/linenumber.js"> </script>


</body>
</html>