Unverified Commit 7f0254de authored by Kaitlyn Lee's avatar Kaitlyn Lee Committed by GitHub
Browse files

Merge pull request #71 from scottaames/master 

Commented GUI and styled WKT input
parents 0915975d e0e9fb2c

app/docs/AstroMap.html

0 → 100644
+1253 −0
Original line number Diff line number Diff line 
<!DOCTYPE html>

<html lang="en">

<head>



  <meta charset="utf-8">

  <meta name="viewport" content="width=device-width, initial-scale=1.0">



  <title>

      AstroMap - Documentation

  </title>



  <link href="https://www.braintreepayments.com/images/favicon-ccda0b14.png" rel="icon" type="image/png">



  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"></script>

  <script>hljs.initHighlightingOnLoad();</script>



  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>



  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">

  <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">

  



  



  <!-- start Mixpanel -->

  <script type="text/javascript">(function(e,a){if(!a.__SV){var b=window;try{var c,l,i,j=b.location,g=j.hash;c=function(a,b){return(l=a.match(RegExp(b+"=([^&]*)")))?l[1]:null};g&&c(g,"state")&&(i=JSON.parse(decodeURIComponent(c(g,"state"))),"mpeditor"===i.action&&(b.sessionStorage.setItem("_mpcehash",g),history.replaceState(i.desiredHash||"",e.title,j.pathname+j.search)))}catch(m){}var k,h;window.mixpanel=a;a._i=[];a.init=function(b,c,f){function e(b,a){var c=a.split(".");2==c.length&&(b=b[c[0]],a=c[1]);b[a]=function(){b.push([a].concat(Array.prototype.slice.call(arguments,

  0)))}}var d=a;"undefined"!==typeof f?d=a[f]=[]:f="mixpanel";d.people=d.people||[];d.toString=function(b){var a="mixpanel";"mixpanel"!==f&&(a+="."+f);b||(a+=" (stub)");return a};d.people.toString=function(){return d.toString(1)+".people (stub)"};k="disable time_event track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config reset people.set people.set_once people.increment people.append people.union people.track_charge people.clear_charges people.delete_user".split(" ");

  for(h=0;h<k.length;h++)e(d,k[h]);a._i.push([b,c,f])};a.__SV=1.2;b=e.createElement("script");b.type="text/javascript";b.async=!0;b.src="undefined"!==typeof MIXPANEL_CUSTOM_LIB_URL?MIXPANEL_CUSTOM_LIB_URL:"file:"===e.location.protocol&&"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js".match(/^\/\//)?"https://cdn.mxpnl.com/libs/mixpanel-2-latest.min.js":"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";c=e.getElementsByTagName("script")[0];c.parentNode.insertBefore(b,c)}})(document,window.mixpanel||[]);

  mixpanel.init("1919205b2da72e4da3b9b6639b444d59");</script>

  <!-- end Mixpanel -->

</head>



<body>

  <svg style="display: none;">

    <defs>

      <symbol id="linkIcon" fill="#706d77" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">

          <path d="M0 0h24v24H0z" fill="none"/>

          <path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/>

      </symbol>

    </defs>

  </svg>



  <input type="checkbox" id="nav-trigger" class="nav-trigger" />

  <label for="nav-trigger" class="navicon-button x">

    <div class="navicon"></div>

  </label>



  <label for="nav-trigger" class="overlay"></label>



  <div class="top-nav-wrapper">

    <ul>

      <li >

        <a href="index.html">

          

            <svg fill="#6D6D6D" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">

              <path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"/>

              <path d="M0 0h24v24H0z" fill="none"/>

            </svg>

          

          

        </a>

      </li>



      



    </ul>

  </div>



  <nav>

    <h3 class="reference-title">

      Braintree SDK Client Reference

    </h3>



    



    <h3>Classes</h3><ul><li id="AstroMap-nav"><a href="AstroMap.html">AstroMap</a><ul class='methods'><li data-type="method" id="AstroMap-changeProjection-nav"><a href="AstroMap.html#changeProjection">changeProjection</a></li><li data-type="method" id="AstroMap-currentLayer-nav"><a href="AstroMap.html#currentLayer">currentLayer</a></li><li data-type="method" id="AstroMap-hasNorthPolar-nav"><a href="AstroMap.html#hasNorthPolar">hasNorthPolar</a></li><li data-type="method" id="AstroMap-hasSouthPolar-nav"><a href="AstroMap.html#hasSouthPolar">hasSouthPolar</a></li><li data-type="method" id="AstroMap-loadLayerCollection-nav"><a href="AstroMap.html#loadLayerCollection">loadLayerCollection</a></li><li data-type="method" id="AstroMap-projection-nav"><a href="AstroMap.html#projection">projection</a></li><li data-type="method" id="AstroMap-setCurrentLayer-nav"><a href="AstroMap.html#setCurrentLayer">setCurrentLayer</a></li><li data-type="method" id="AstroMap-target-nav"><a href="AstroMap.html#target">target</a></li></ul></li><li id="AstroMath-nav"><a href="AstroMath.html">AstroMath</a><ul class='methods'><li data-type="method" id="AstroMath-domainToPositiveWest-nav"><a href="AstroMath.html#domainToPositiveWest">domainToPositiveWest</a></li><li data-type="method" id="AstroMath-getMajorRadius-nav"><a href="AstroMath.html#getMajorRadius">getMajorRadius</a></li><li data-type="method" id="AstroMath-getMinorRadius-nav"><a href="AstroMath.html#getMinorRadius">getMinorRadius</a></li><li data-type="method" id="AstroMath-latToPlanetOgraphic-nav"><a href="AstroMath.html#latToPlanetOgraphic">latToPlanetOgraphic</a></li><li data-type="method" id="AstroMath-lonTo360-nav"><a href="AstroMath.html#lonTo360">lonTo360</a></li><li data-type="method" id="AstroMath-toDegrees-nav"><a href="AstroMath.html#toDegrees">toDegrees</a></li><li data-type="method" id="AstroMath-toRadians-nav"><a href="AstroMath.html#toRadians">toRadians</a></li><li data-type="method" id="AstroMath-wrapLongitude-nav"><a href="AstroMath.html#wrapLongitude">wrapLongitude</a></li></ul></li><li id="AstroProj-nav"><a href="AstroProj.html">AstroProj</a><ul class='methods'><li data-type="method" id="AstroProj-getRadii-nav"><a href="AstroProj.html#getRadii">getRadii</a></li><li data-type="method" id="AstroProj-getStringAndCode-nav"><a href="AstroProj.html#getStringAndCode">getStringAndCode</a></li></ul></li></ul><h3 id="global-nav">Global</h3><ul><li><a href="global.html#addTo">addTo</a></li><li><a href="global.html#changeLatType">changeLatType</a></li><li><a href="global.html#changeLonDirection">changeLonDirection</a></li><li><a href="global.html#changeLonDomain">changeLonDomain</a></li><li><a href="global.html#createBaseLayers">createBaseLayers</a></li><li><a href="global.html#createOverlays">createOverlays</a></li><li><a href="global.html#initialize">initialize</a></li><li><a href="global.html#isEmpty">isEmpty</a></li><li><a href="global.html#loadCylindrical">loadCylindrical</a></li><li><a href="global.html#loadNorthPolar">loadNorthPolar</a></li><li><a href="global.html#loadSouthPolar">loadSouthPolar</a></li><li><a href="global.html#loadWFS">loadWFS</a></li><li><a href="global.html#mapWKTString">mapWKTString</a></li><li><a href="global.html#onAdd">onAdd</a></li><li><a href="global.html#onMouseMove">onMouseMove</a></li><li><a href="global.html#onRemove">onRemove</a></li><li><a href="global.html#parseJSON">parseJSON</a></li><li><a href="global.html#shapesToWKT">shapesToWKT</a></li><li><a href="global.html#sortFeatures">sortFeatures</a></li></ul>

  </nav>



  <div id="main">

    

      <h1 class="page-title">

        AstroMap

      </h1>

    



    



<section>

  <header>

    

      <h2>

        

        AstroMap

        

      </h2>



      

        <div class="class-description">

          The central class that creates an interactive map in the HTML.

Works with all target bodies supported by the USGS by loading the body's

base layers and overlays in a LayerCollection. Allows users to change

the projection of the map.

        </div>

      

    

  </header>



  <article>

    <div class="container-overview">

      

        





  

    <h2>Constructor</h2>

  



  <span class='name-container'>

    <a class="link-icon" href="#AstroMap">

      <svg height="20" width="20" style="fill: black;">

        <use xlink:href="#linkIcon"></use>

      </svg>

    </a>

    <h4 class="name" id="AstroMap">

      <span class="type-signature"></span>new AstroMap<span class="signature">(mapDiv, target, options)</span><span class="type-signature"></span>

    </h4>

  </span>



  



















  <h5>Parameters:</h5>

  



<table class="params">

  <thead>

    <tr>

      

        <th>Name</th>

      



      <th>Type</th>



      



      



      <th class="last">Description</th>

    </tr>

  </thead>



  <tbody>

    

      <tr>

        

          <td class="name"><code>mapDiv</code></td>

        



        <td class="type">

          

            

    <span class="param-type">

      String

    </span>



    





          

        </td>



        



        



        <td class="description last">

          ID of the div for the map.

          

        </td>

      </tr>



    

      <tr>

        

          <td class="name"><code>target</code></td>

        



        <td class="type">

          

            

    <span class="param-type">

      String

    </span>



    





          

        </td>



        



        



        <td class="description last">

          Name of target to display layers for.

          

        </td>

      </tr>



    

      <tr>

        

          <td class="name"><code>options</code></td>

        



        <td class="type">

          

            

    <span class="param-type">

      Object

    </span>



    





          

        </td>



        



        



        <td class="description last">

          Options for the map.

          

        </td>

      </tr>



    

  </tbody>

</table>











<dl class="details">



  



  



  



  



  



  



  



  



  



  



  



  



  

    <dt class="tag-source">Source:</dt>

    <dd class="tag-source">

      <ul class="dummy">

        <li>

          <a href="AstroMap.js.html">AstroMap.js</a>, <a href="AstroMap.js.html#line4">line 4</a>

        </li>

      </ul>

    </dd>

  



  



  



  

</dl>



























  <div class="example-container">

    <a class="link-icon" href="#AstroMap-examples">

      <svg height="20" width="20" style="fill: black;">

        <use xlink:href="#linkIcon"></use>

      </svg>

    </a>

    <h5 id="AstroMap-examples">Example</h5>

    



  <pre class="prettyprint"><code>// initialize the map on the "map" div with the target Mars

L.Map.AstroMap("map", "Mars", {});</code></pre>





  </div>





      

    </div>



    

      <h3 class="subsection-title">Extends</h3>



      





  <ul>

    <li>L.Map</li>

  </ul>





    



    



    



     



    



    



    

      <h3 class="subsection-title">Methods</h3>



      

        





  



  <span class='name-container'>

    <a class="link-icon" href="#changeProjection">

      <svg height="20" width="20" style="fill: black;">

        <use xlink:href="#linkIcon"></use>

      </svg>

    </a>

    <h4 class="name" id="changeProjection">

      <span class="type-signature"></span>changeProjection<span class="signature">(name, center)</span><span class="type-signature"></span>

    </h4>

  </span>



  







  <div class="description">

    Changes the projection of the map and resets the center and view.

  </div>















  <h5>Parameters:</h5>

  



<table class="params">

  <thead>

    <tr>

      

        <th>Name</th>

      



      <th>Type</th>



      



      



      <th class="last">Description</th>

    </tr>

  </thead>



  <tbody>

    

      <tr>

        

          <td class="name"><code>name</code></td>

        



        <td class="type">

          

            

    <span class="param-type">

      String

    </span>



    





          

        </td>



        



        



        <td class="description last">

          Name of Projection.

          

        </td>

      </tr>



    

      <tr>

        

          <td class="name"><code>center</code></td>

        



        <td class="type">

          

            

    <span class="param-type">

      List

    </span>



    





          

        </td>



        



        



        <td class="description last">

          Center of map based off of projection.

]

          

        </td>

      </tr>



    

  </tbody>

</table>











<dl class="details">



  



  



  



  



  



  



  



  



  



  



  



  



  

    <dt class="tag-source">Source:</dt>

    <dd class="tag-source">

      <ul class="dummy">

        <li>

          <a href="AstroMap.js.html">AstroMap.js</a>, <a href="AstroMap.js.html#line82">line 82</a>

        </li>

      </ul>

    </dd>

  



  



  



  

</dl>





























      

        





  



  <span class='name-container'>

    <a class="link-icon" href="#currentLayer">

      <svg height="20" width="20" style="fill: black;">

        <use xlink:href="#linkIcon"></use>

      </svg>

    </a>

    <h4 class="name" id="currentLayer">

      <span class="type-signature"></span>currentLayer<span class="signature">()</span><span class="type-signature"> &rarr; {L.Layer}</span>

    </h4>

  </span>



  







  <div class="description">

    Returns the current layer of the map. Used by the LayerCollection

         so that it can remove the layer of the map without having to

         remove all layers, including drawn shapes.

  </div>





















<dl class="details">



  



  



  



  



  



  



  



  



  



  



  



  



  

    <dt class="tag-source">Source:</dt>

    <dd class="tag-source">

      <ul class="dummy">

        <li>

          <a href="AstroMap.js.html">AstroMap.js</a>, <a href="AstroMap.js.html#line159">line 159</a>

        </li>

      </ul>

    </dd>

  



  



  



  

</dl>





























      

        





  



  <span class='name-container'>

    <a class="link-icon" href="#hasNorthPolar">

      <svg height="20" width="20" style="fill: black;">

        <use xlink:href="#linkIcon"></use>

      </svg>

    </a>

    <h4 class="name" id="hasNorthPolar">

      <span class="type-signature"></span>hasNorthPolar<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span>

    </h4>

  </span>



  







  <div class="description">

    Checks if the map has a layer collection for northPolar.

  </div>





















<dl class="details">



  



  



  



  



  



  



  



  



  



  



  



  



  

    <dt class="tag-source">Source:</dt>

    <dd class="tag-source">

      <ul class="dummy">

        <li>

          <a href="AstroMap.js.html">AstroMap.js</a>, <a href="AstroMap.js.html#line110">line 110</a>

        </li>

      </ul>

    </dd>

  



  



  



  

</dl>





























      

        





  



  <span class='name-container'>

    <a class="link-icon" href="#hasSouthPolar">

      <svg height="20" width="20" style="fill: black;">

        <use xlink:href="#linkIcon"></use>

      </svg>

    </a>

    <h4 class="name" id="hasSouthPolar">

      <span class="type-signature"></span>hasSouthPolar<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span>

    </h4>

  </span>



  







  <div class="description">

    Checks if the map has a layer collection for southPolar.

  </div>





















<dl class="details">



  



  



  



  



  



  



  



  



  



  



  



  



  

    <dt class="tag-source">Source:</dt>

    <dd class="tag-source">

      <ul class="dummy">

        <li>

          <a href="AstroMap.js.html">AstroMap.js</a>, <a href="AstroMap.js.html#line120">line 120</a>

        </li>

      </ul>

    </dd>

  



  



  



  

</dl>





























      

        





  



  <span class='name-container'>

    <a class="link-icon" href="#loadLayerCollection">

      <svg height="20" width="20" style="fill: black;">

        <use xlink:href="#linkIcon"></use>

      </svg>

    </a>

    <h4 class="name" id="loadLayerCollection">

      <span class="type-signature"></span>loadLayerCollection<span class="signature">(name)</span><span class="type-signature"></span>

    </h4>

  </span>



  







  <div class="description">

    Adds the LayerCollection with the requrested projection name.

  </div>















  <h5>Parameters:</h5>

  



<table class="params">

  <thead>

    <tr>

      

        <th>Name</th>

      



      <th>Type</th>



      



      



      <th class="last">Description</th>

    </tr>

  </thead>



  <tbody>

    

      <tr>

        

          <td class="name"><code>name</code></td>

        



        <td class="type">

          

            

    <span class="param-type">

      String

    </span>



    





          

        </td>



        



        



        <td class="description last">

          Name of the projection.

          

        </td>

      </tr>



    

  </tbody>

</table>











<dl class="details">



  



  



  



  



  



  



  



  



  



  



  



  



  

    <dt class="tag-source">Source:</dt>

    <dd class="tag-source">

      <ul class="dummy">

        <li>

          <a href="AstroMap.js.html">AstroMap.js</a>, <a href="AstroMap.js.html#line72">line 72</a>

        </li>

      </ul>

    </dd>

  



  



  



  

</dl>





























      

        





  



  <span class='name-container'>

    <a class="link-icon" href="#projection">

      <svg height="20" width="20" style="fill: black;">

        <use xlink:href="#linkIcon"></use>

      </svg>

    </a>

    <h4 class="name" id="projection">

      <span class="type-signature"></span>projection<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span>

    </h4>

  </span>



  







  <div class="description">

    Returns the name of the current projection of the map.

  </div>





















<dl class="details">



  



  



  



  



  



  



  



  



  



  



  



  



  

    <dt class="tag-source">Source:</dt>

    <dd class="tag-source">

      <ul class="dummy">

        <li>

          <a href="AstroMap.js.html">AstroMap.js</a>, <a href="AstroMap.js.html#line140">line 140</a>

        </li>

      </ul>

    </dd>

  



  



  



  

</dl>





























      

        





  



  <span class='name-container'>

    <a class="link-icon" href="#setCurrentLayer">

      <svg height="20" width="20" style="fill: black;">

        <use xlink:href="#linkIcon"></use>

      </svg>

    </a>

    <h4 class="name" id="setCurrentLayer">

      <span class="type-signature"></span>setCurrentLayer<span class="signature">()</span><span class="type-signature"></span>

    </h4>

  </span>



  







  <div class="description">

    Sets the value of the current layer of the map.

         Set by the LayerCollection in the onAdd method.

  </div>





















<dl class="details">



  



  



  



  



  



  



  



  



  



  



  



  



  

    <dt class="tag-source">Source:</dt>

    <dd class="tag-source">

      <ul class="dummy">

        <li>

          <a href="AstroMap.js.html">AstroMap.js</a>, <a href="AstroMap.js.html#line150">line 150</a>

        </li>

      </ul>

    </dd>

  



  



  



  

</dl>





























      

        





  



  <span class='name-container'>

    <a class="link-icon" href="#target">

      <svg height="20" width="20" style="fill: black;">

        <use xlink:href="#linkIcon"></use>

      </svg>

    </a>

    <h4 class="name" id="target">

      <span class="type-signature"></span>target<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span>

    </h4>

  </span>



  







  <div class="description">

    Returns the name of the target.

  </div>





















<dl class="details">



  



  



  



  



  



  



  



  



  



  



  



  



  

    <dt class="tag-source">Source:</dt>

    <dd class="tag-source">

      <ul class="dummy">

        <li>

          <a href="AstroMap.js.html">AstroMap.js</a>, <a href="AstroMap.js.html#line130">line 130</a>

        </li>

      </ul>

    </dd>

  



  



  



  

</dl>





























      

    



    



    

  </article>

</section>









  </div>



  <br class="clear">



  <footer>

    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a>

  </footer>



  <script src="scripts/linenumber.js"></script>

  <script src="scripts/pagelocation.js"></script>



  



</body>

</html>
 
 No newline at end of file

app/docs/AstroMap.js.html

0 → 100644
+284 −0

File added.

Preview size limit exceeded, changes collapsed.

app/docs/AstroMath.html

0 → 100644
+1414 −0

File added.

Preview size limit exceeded, changes collapsed.

app/docs/AstroMath.js.html

0 → 100644
+273 −0

File added.

Preview size limit exceeded, changes collapsed.

app/docs/AstroProj.html

0 → 100644
+562 −0

File added.

Preview size limit exceeded, changes collapsed.