| j | 1c53f82 | 2020-06-07 15:32:06 -0700 | [diff] [blame^] | 1 | <!DOCTYPE html> |
| 2 | <html lang="en"> |
| 3 | <head> |
| 4 | <meta charset="utf-8"> |
| 5 | <title>JSDoc: Source: generic-gradebook.js</title> |
| 6 | |
| 7 | <script src="scripts/prettify/prettify.js"> </script> |
| 8 | <script src="scripts/prettify/lang-css.js"> </script> |
| 9 | <!--[if lt IE 9]> |
| 10 | <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> |
| 11 | <![endif]--> |
| 12 | <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> |
| 13 | <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> |
| 14 | </head> |
| 15 | |
| 16 | <body> |
| 17 | |
| 18 | <div id="main"> |
| 19 | |
| 20 | <h1 class="page-title">Source: generic-gradebook.js</h1> |
| 21 | |
| 22 | |
| 23 | |
| 24 | |
| 25 | |
| 26 | |
| 27 | <section> |
| 28 | <article> |
| 29 | <pre class="prettyprint source linenums"><code>/** |
| 30 | * @file DTPS Generic Gradebook |
| 31 | * @author jottocraft |
| 32 | * |
| 33 | * @copyright Copyright (c) 2018-2020 jottocraft. All rights reserved. |
| 34 | * @license GPL-2.0-only |
| 35 | */ |
| 36 | |
| 37 | //True if the gradebook is expanded |
| 38 | var gradebookExpanded = false; |
| 39 | |
| 40 | /** |
| 41 | * Shows the generic gradebook |
| 42 | * |
| 43 | * @param {string} classID Class ID |
| 44 | * @todo Show assignments |
| 45 | */ |
| 46 | dtps.gradebook = function (classID) { |
| 47 | //Get class index and set as selected class |
| 48 | var classNum = dtps.classes.map(course => course.id).indexOf(classID); |
| 49 | dtps.selectedClass = classNum; |
| 50 | |
| 51 | //Set stream as the selected content |
| 52 | dtps.selectedContent = "grades"; |
| 53 | $("#dtpsTabBar .btn").removeClass("active"); |
| 54 | $("#dtpsTabBar .btn.grades").addClass("active"); |
| 55 | |
| 56 | //Load class color, name, etc. |
| 57 | dtps.presentClass(classNum); |
| 58 | |
| 59 | //Ensure classes are shown in the sidebar |
| 60 | dtps.showClasses(); |
| 61 | |
| 62 | if (classNum == -1) { |
| 63 | //Class does not exist |
| 64 | dtps.error("The selected class doesn't exist", "classNum check failed @ dtps.gradebook"); |
| 65 | } |
| 66 | |
| 67 | //Show loading indicator |
| 68 | jQuery(".classContent").html(`<div class="spinner"></div>`); |
| 69 | |
| 70 | //Terminate function if the class doesn't have a letter grade or assignments |
| 71 | if (!dtps.classes[classNum].letter || !dtps.classes[classNum].assignments) { |
| 72 | return; |
| 73 | } |
| 74 | |
| 75 | //Define variables for total points and zeros |
| 76 | var zeros = 0; |
| 77 | var totalPoints = 0; |
| 78 | var earnedPoints = 0; |
| 79 | var gradedAssignments = 0; |
| 80 | |
| 81 | //Calculate total points and zeros |
| 82 | dtps.classes[classNum].assignments.forEach(assignment => { |
| 83 | if (assignment.grade || (assignment.grade == 0)) { |
| 84 | earnedPoints += assignment.grade; |
| 85 | gradedAssignments++; |
| 86 | } |
| 87 | |
| 88 | if (assignment.value) { |
| 89 | totalPoints += assignment.value; |
| 90 | } |
| 91 | |
| 92 | if ((assignment.grade == 0) && assignment.value) { |
| 93 | zeros++; |
| 94 | } |
| 95 | }) |
| 96 | |
| 97 | //Grade calculation summary |
| 98 | var gradeCalcSummary = /*html*/` |
| 99 | <div style="--classColor: ${dtps.classes[classNum].color}" class="card"> |
| 100 | <h3 class="gradeTitle"> |
| 101 | Grade Summary |
| 102 | <div class="classGradeCircle"> |
| 103 | ${dtps.classes[classNum].grade ? `<span class="percentage">${dtps.classes[classNum].grade}%</span>` : ``} |
| 104 | <div class="letter">${dtps.classes[classNum].letter || ``}</div> |
| 105 | </div> |
| 106 | </h3> |
| 107 | |
| 108 | ${zeros ? /*html*/` |
| 109 | <h5 style="color: #d63d3d;" class="gradeStat"> |
| 110 | Zeros |
| 111 | <div style="color: #d63d3d;" class="numFont">${zeros}</div> |
| 112 | </h5> |
| 113 | ` : ``} |
| 114 | |
| 115 | <div style="${gradebookExpanded ? "" : "display: none;"}" id="classGradeMore"> |
| 116 | <br /> |
| 117 | |
| 118 | ${dtps.classes[classNum].previousLetter ? /*html*/` |
| 119 | <h5 class="smallStat"> |
| 120 | Previous Grade |
| 121 | <div class="numFont">${dtps.classes[classNum].previousLetter}</div> |
| 122 | </h5> |
| 123 | ` : ``} |
| 124 | |
| 125 | <h5 class="smallStat"> |
| 126 | Points |
| 127 | <div class="numFont fraction"> |
| 128 | <span class="earned">${earnedPoints}</span> |
| 129 | <span class="total">/${totalPoints}</span> |
| 130 | </div> |
| 131 | </h5> |
| 132 | |
| 133 | <h5 class="smallStat"> |
| 134 | Graded Assignments |
| 135 | <div class="numFont">${gradedAssignments}</div> |
| 136 | </h5> |
| 137 | </div> |
| 138 | |
| 139 | <br /> |
| 140 | <a onclick="$('#classGradeMore').toggle(); if ($('#classGradeMore').is(':visible')) {$(this).html('Show less'); gradebookExpanded = true;} else {$(this).html('Show more'); gradebookExpanded = false;}" |
| 141 | style="color: var(--secText, gray); cursor: pointer; margin-right: 10px;">${gradebookExpanded ? "Show less" : "Show more"}</a> |
| 142 | </div> |
| 143 | `; |
| 144 | |
| 145 | //Render HTML |
| 146 | $(".classContent").html(gradeCalcSummary); |
| 147 | } |
| 148 | |
| 149 | //Fluid UI screen definitions |
| 150 | fluid.externalScreens.gradebook = (courseID) => { |
| 151 | dtps.gradebook(courseID); |
| 152 | }</code></pre> |
| 153 | </article> |
| 154 | </section> |
| 155 | |
| 156 | |
| 157 | |
| 158 | |
| 159 | </div> |
| 160 | |
| 161 | <nav> |
| 162 | <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="dtps.html">dtps</a></li><li><a href="dtpsLMS.html">dtpsLMS</a></li></ul><h3><a href="global.html">Global</a></h3> |
| 163 | </nav> |
| 164 | |
| 165 | <br class="clear"> |
| 166 | |
| 167 | <footer> |
| 168 | Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Sun Jun 07 2020 14:02:58 GMT-0700 (Pacific Daylight Time) |
| 169 | </footer> |
| 170 | |
| 171 | <script> prettyPrint(); </script> |
| 172 | <script src="scripts/linenumber.js"> </script> |
| 173 | </body> |
| 174 | </html> |