BlockPyCorgis.html 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: BlockPyCorgis</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: BlockPyCorgis</h1>
  17. <section>
  18. <header>
  19. <h2>BlockPyCorgis</h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <h4 class="name" id="BlockPyCorgis"><span class="type-signature"></span>new BlockPyCorgis<span class="signature">(main)</span><span class="type-signature"></span></h4>
  24. <div class="description">
  25. Module that connects to the CORGIS datasets and manages interactions
  26. with them. This includes loading in datasets at launch and on-the-fly.
  27. Note that this has no presence on screen, so it does not have a tag.
  28. </div>
  29. <h5>This:</h5>
  30. <ul><li>{<a href="BlockPyCorgis.html">BlockPyCorgis</a>}</li></ul>
  31. <h5>Parameters:</h5>
  32. <table class="params">
  33. <thead>
  34. <tr>
  35. <th>Name</th>
  36. <th>Type</th>
  37. <th class="last">Description</th>
  38. </tr>
  39. </thead>
  40. <tbody>
  41. <tr>
  42. <td class="name"><code>main</code></td>
  43. <td class="type">
  44. <span class="param-type">Object</span>
  45. </td>
  46. <td class="description last">The main BlockPy instance</td>
  47. </tr>
  48. </tbody>
  49. </table>
  50. <dl class="details">
  51. <dt class="tag-source">Source:</dt>
  52. <dd class="tag-source"><ul class="dummy"><li>
  53. <a href="corgis.js.html">corgis.js</a>, <a href="corgis.js.html#line12">line 12</a>
  54. </li></ul></dd>
  55. </dl>
  56. </div>
  57. <h3 class="subsection-title">Methods</h3>
  58. <h4 class="name" id="importDataset"><span class="type-signature"></span>importDataset<span class="signature">(slug, name)</span><span class="type-signature"> &rarr; {Array.&lt;Deferred>}</span></h4>
  59. <div class="description">
  60. Loads the definitions for a dataset into the environment, including
  61. the dataset (as a JS file), the skulpt bindings, and the blockly
  62. bindings. This requires access to a CORGIS server, and occurs
  63. asynchronously. The requests are fired and their deferred objects
  64. are returned - callers can use this information to perform an action
  65. on completion of the import.
  66. </div>
  67. <h5>Parameters:</h5>
  68. <table class="params">
  69. <thead>
  70. <tr>
  71. <th>Name</th>
  72. <th>Type</th>
  73. <th class="last">Description</th>
  74. </tr>
  75. </thead>
  76. <tbody>
  77. <tr>
  78. <td class="name"><code>slug</code></td>
  79. <td class="type">
  80. <span class="param-type">String</span>
  81. </td>
  82. <td class="description last">The URL safe version of the dataset name</td>
  83. </tr>
  84. <tr>
  85. <td class="name"><code>name</code></td>
  86. <td class="type">
  87. <span class="param-type">String</span>
  88. </td>
  89. <td class="description last">The user-friendly version of the dataset name.</td>
  90. </tr>
  91. </tbody>
  92. </table>
  93. <dl class="details">
  94. <dt class="tag-source">Source:</dt>
  95. <dd class="tag-source"><ul class="dummy"><li>
  96. <a href="corgis.js.html">corgis.js</a>, <a href="corgis.js.html#line52">line 52</a>
  97. </li></ul></dd>
  98. </dl>
  99. <h5>Returns:</h5>
  100. <div class="param-desc">
  101. - Returns the async requests as deferred objects.
  102. </div>
  103. <dl>
  104. <dt>
  105. Type
  106. </dt>
  107. <dd>
  108. <span class="param-type">Array.&lt;Deferred></span>
  109. </dd>
  110. </dl>
  111. <h4 class="name" id="openDialog"><span class="type-signature"></span>openDialog<span class="signature">(name)</span><span class="type-signature"></span></h4>
  112. <div class="description">
  113. Opens a dialog box to present the user with the datasets available
  114. through the CORGIS server. This requires a call, so this method
  115. completes asynchronously. The dialog is composed of a table with
  116. buttons to load the datasets (More than one dataset can be loaded
  117. from within the dialog at a time).
  118. </div>
  119. <h5>Parameters:</h5>
  120. <table class="params">
  121. <thead>
  122. <tr>
  123. <th>Name</th>
  124. <th>Type</th>
  125. <th class="last">Description</th>
  126. </tr>
  127. </thead>
  128. <tbody>
  129. <tr>
  130. <td class="name"><code>name</code></td>
  131. <td class="type">
  132. <span class="param-type">String</span>
  133. </td>
  134. <td class="description last">The name of the dataset to open. This is basically the user friendly version of the name, though it will be mangled into a slug.</td>
  135. </tr>
  136. </tbody>
  137. </table>
  138. <dl class="details">
  139. <dt class="tag-source">Source:</dt>
  140. <dd class="tag-source"><ul class="dummy"><li>
  141. <a href="corgis.js.html">corgis.js</a>, <a href="corgis.js.html#line85">line 85</a>
  142. </li></ul></dd>
  143. </dl>
  144. </article>
  145. </section>
  146. </div>
  147. <nav>
  148. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BlockPy.html">BlockPy</a></li><li><a href="BlockPyCorgis.html">BlockPyCorgis</a></li><li><a href="BlockPyDialog.html">BlockPyDialog</a></li><li><a href="BlockPyEditor.html">BlockPyEditor</a></li><li><a href="BlockPyEngine.html">BlockPyEngine</a></li><li><a href="BlockPyEnglish.html">BlockPyEnglish</a></li><li><a href="BlockPyFeedback.html">BlockPyFeedback</a></li><li><a href="BlockPyHistory.html">BlockPyHistory</a></li><li><a href="BlockPyPresentation.html">BlockPyPresentation</a></li><li><a href="BlockPyPrinter.html">BlockPyPrinter</a></li><li><a href="BlockPyServer.html">BlockPyServer</a></li><li><a href="BlockPyToolbar.html">BlockPyToolbar</a></li><li><a href="LocalStorageWrapper.html">LocalStorageWrapper</a></li><li><a href="PythonToBlocks.html">PythonToBlocks</a></li></ul><h3>Global</h3><ul><li><a href="global.html#BlockPyInterface">BlockPyInterface</a></li><li><a href="global.html#cloneNode">cloneNode</a></li><li><a href="global.html#encodeHTML">encodeHTML</a></li><li><a href="global.html#expandArray">expandArray</a></li><li><a href="global.html#EXTENDED_ERROR_EXPLANATION">EXTENDED_ERROR_EXPLANATION</a></li><li><a href="global.html#indent">indent</a></li><li><a href="global.html#instructor_module">instructor_module</a></li><li><a href="global.html#prettyPrintDateTime">prettyPrintDateTime</a></li><li><a href="global.html#randomInteger">randomInteger</a></li><li><a href="global.html#set_button_loaded">set_button_loaded</a></li><li><a href="global.html#timerGuard">timerGuard</a></li></ul>
  149. </nav>
  150. <br class="clear">
  151. <footer>
  152. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sun Mar 26 2017 09:45:04 GMT-0400 (Eastern Daylight Time)
  153. </footer>
  154. <script> prettyPrint(); </script>
  155. <script src="scripts/linenumber.js"> </script>
  156. </body>
  157. </html>