| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>JSDoc: Namespace: gradeCalc</title> |
| |
| <script src="scripts/prettify/prettify.js"> </script> |
| <script src="scripts/prettify/lang-css.js"> </script> |
| <!--[if lt IE 9]> |
| <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> |
| <![endif]--> |
| <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> |
| <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> |
| </head> |
| |
| <body> |
| |
| <div id="main"> |
| |
| <h1 class="page-title">Namespace: gradeCalc</h1> |
| |
| |
| |
| |
| |
| |
| <section> |
| |
| <header> |
| |
| <h2> |
| <span class="ancestors"><a href="dtps.html">dtps</a>.</span>gradeCalc</h2> |
| |
| |
| </header> |
| |
| <article> |
| <div class="container-overview"> |
| |
| |
| <div class="description">Grade calculation object for DTPS</div> |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>letters</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<string></span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">An array of letters that can be returned from highest -> lowest</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>percentageEq</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<number></span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">The percentage equivalent of each letter for visual representations of grades</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>params</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Parameters for each type of grade calculation, such as requirements for each criteria</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="core.js.html">core.js</a>, <a href="core.js.html#line207">line 207</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-todo">To Do:</dt> |
| <dd class="tag-todo"> |
| <ul> |
| <li>pending v3 support</li> |
| </ul> |
| </dd> |
| |
| </dl> |
| |
| |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h3 class="subsection-title">Methods</h3> |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id=".average"><span class="type-signature">(static) </span>average<span class="signature">(array)</span><span class="type-signature"> → {number}</span></h4> |
| |
| |
| |
| |
| |
| |
| <div class="description"> |
| A simple average function |
| </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>array</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<number></span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Array of numbers to average</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="core.js.html">core.js</a>, <a href="core.js.html#line256">line 256</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| Average of the numbers in the array |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">number</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id=".getLetter"><span class="type-signature">(static) </span>getLetter<span class="signature">(allOutcomeAvgs, formula)</span><span class="type-signature"> → {object}</span></h4> |
| |
| |
| |
| |
| |
| |
| <div class="description"> |
| Calculates a letter grade from an array of outcome averages |
| </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>allOutcomeAvgs</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<number></span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Array of outcome averages to use for letter grade calculation</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>formula</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Formula to use for grade calculation</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="core.js.html">core.js</a>, <a href="core.js.html#line397">line 397</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| Letter grade calculation results |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">object</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id=".run"><span class="type-signature">(static) </span>run<span class="signature">(outcomes, formula<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {object}</span></h4> |
| |
| |
| |
| |
| |
| |
| <div class="description"> |
| Runs grade calculation |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Parameters:</h5> |
| |
| |
| <table class="params"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| <th>Attributes</th> |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>outcomes</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<object></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Array of outcomes to use for grade calculation</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>formula</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Formula to use for grade calculation</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="core.js.html">core.js</a>, <a href="core.js.html#line268">line 268</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| Grade calculation results |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">object</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </article> |
| |
| </section> |
| |
| |
| |
| |
| </div> |
| |
| <nav> |
| <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="dtps.html">dtps</a></li><li><a href="dtps.gradeCalc.html">gradeCalc</a></li><li><a href="dtpsLMS.html">dtpsLMS</a></li></ul><h3><a href="global.html">Global</a></h3> |
| </nav> |
| |
| <br class="clear"> |
| |
| <footer> |
| Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Fri May 29 2020 18:46:27 GMT-0700 (Pacific Daylight Time) |
| </footer> |
| |
| <script> prettyPrint(); </script> |
| <script src="scripts/linenumber.js"> </script> |
| </body> |
| </html> |