blob: fac695a42265da98e11b5cf8bb0119f26503cfd8 [file] [log] [blame]
j1c53f822020-06-07 15:32:06 -07001<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Source: scripts/assignments.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: scripts/assignments.js</h1>
21
22
23
24
25
26
27 <section>
28 <article>
29 <pre class="prettyprint source linenums"><code>/**
30 * @file DTPS assignment functions
31 * @author jottocraft
32 *
33 * @copyright Copyright (c) 2018-2020 jottocraft. All rights reserved.
34 * @license GPL-2.0-only
35 */
36
37
38/**
39 * Renders HTML for an assignment item in a list
40 *
41 * @param {Assignment} assignment The assignment object to render
42 * @todo Add support for points/letter scores
43 * @return {string} Assignment HTML for use in a list
44 */
45dtps.renderAssignment = function (assignment) {
46 var scoreHTML = "";
47 //Render points/letter score
48
49 //Use rubric score over points score if possible
50 if (assignment.rubric) {
51 var rubricHTML = [];
52
53 assignment.rubric.forEach(rubricItem => {
54 if (rubricItem.score) {
55 rubricHTML.push(/*html*/`
56 &lt;div title="${rubricItem.title}" style="color: ${dtps.cblColor(rubricItem.score)}">
57 ${rubricItem.score}
58 &lt;/div>
59 `);
60 }
61 });
62
63 scoreHTML = `&lt;div class="dtpsRubricScore">${rubricHTML.join("")}&lt;/div>`;
64 }
65
66 var HTML = /*html*/`
67 &lt;div
68 onclick="${`dtps.assignment('` + assignment.id + `', ` + assignment.class + `)`}"
69 class="card graded assignment"
70 style="${'--classColor: ' + dtps.classes[assignment.class].color}"
71 >
72
73 &lt;!-- Color bar for the dashboard -->
74 &lt;div class="colorBar">&lt;/div>
75
76 &lt;!-- Assignment title and points -->
77 &lt;h4>
78 ${assignment.title}
79
80 &lt;!-- Points display -->
81 &lt;div class="points">
82 ${scoreHTML}
83 &lt;/div>
84 &lt;/h4>
85
86 &lt;h5 style="white-space: nowrap; overflow: hidden;">
87 &lt;!-- Assignment info -->
88 ${assignment.dueAt ? `&lt;div class="infoChip">&lt;i style="margin-top: -2px;" class="material-icons">alarm&lt;/i> Due ` + dtps.formatDate(assignment.dueAt) + `&lt;/div>` : ""}
89 ${assignment.outcomes ? `&lt;div class="infoChip weighted">&lt;i class="material-icons">adjust&lt;/i>` + assignment.outcomes.length + `&lt;/div>` : ""}
90 ${assignment.category ? `&lt;div class="infoChip weighted">&lt;i class="material-icons">category&lt;/i> ` + assignment.category + `&lt;/div>` : ""}
91
92 &lt;!-- Status icons -->
93 ${assignment.turnedIn ? `&lt;i title="Assignment submitted" class="material-icons statusIcon" style="color: #0bb75b;">assignment_turned_in&lt;/i>` : ``}
94 ${assignment.missing ? `&lt;i title="Assignment is missing" class="material-icons statusIcon" style="color: #c44848;">remove_circle_outline&lt;/i>` : ``}
95 ${assignment.late ? `&lt;i title="Assignment is late" class="material-icons statusIcon" style="color: #c44848;">assignment_late&lt;/i>` : ``}
96 ${assignment.locked ? `&lt;i title="Assignment submissions are locked" class="material-icons statusIcon" style="font-family: 'Material Icons Extended'; color: var(--secText, gray);">lock_outline&lt;/i>` : ``}
97 ${assignment.pending ? `&lt;i title="Grade is pending review" class="material-icons statusIcon" style="color: #b3b70b;">rate_review&lt;/i>` : ``}
98 &lt;/h5>
99 &lt;/div>
100 `;
101
102 return HTML;
103}
104
105/**
106 * Renders the DTPS dashboard and calls dtps.renderCalendar, dtps.renderUpdates, and dtps.renderUpcoming
107 */
108dtps.masterStream = function () {
109 //Ensure classes are rendered in the sidebar
110 dtps.presentClass("dash");
111 dtps.showClasses();
112
113 //Count amount of classes that are loaded
114 var ready = 0;
115 dtps.classes.forEach(course => {
116 if (course.assignments) ready++;
117 });
118
119 //Check if all classes are loaded
120 var doneLoading = ready == dtps.classes.length;
121
122 //Render HTML with loading placeholder
123 if (dtps.selectedClass == "dash") {
124 jQuery(".classContent").html(/*html*/`
125 &lt;div class="dash cal" style="width: 40%;display: inline-block; vertical-align: top;">
126 ${$.fullCalendar !== undefined ? `&lt;div id="calendar" class="card" style="padding: 20px;">&lt;/div>` : ""}
127 &lt;div class="updatesStream recentlyGraded announcements">&lt;/div>
128 &lt;/div>
129
130 &lt;div style="width: 59%; display: inline-block;" class="dash stream">
131 ${!doneLoading ? `&lt;div style="margin: 75px 25px 10px 75px;">&lt;div class="spinner">&lt;/div>&lt;/div>` : ""}
132 &lt;div class="assignmentStream">&lt;/div>
133 &lt;/div>
134 `);
135 }
136
137 //Render updates stream
138 dtps.renderUpdates();
139
140 //If fully loaded, log grades to local grade history
141 if (doneLoading) dtps.logGrades();
142
143 //Render upcoming assignments stream
144 dtps.renderUpcoming();
145
146 //Render calendar
147 dtps.calendar();
148}
149
150/**
151 * Compiles and displays upcoming assignments / to-do stream
152 */
153dtps.renderUpcoming = function () {
154 //Combine class stream arrays
155 var combinedStream = [];
156 if (dtps.classes) {
157 dtps.classes.forEach(course => {
158 if (course.assignments) {
159 //If course has assignments, add them to the combined stream array
160 course.assignments.forEach(assignment => {
161 //Only include upcoming assignments
162 if (new Date(assignment.dueAt) > new Date()) {
163 combinedStream.push(assignment);
164 }
165 })
166 }
167 })
168 }
169
170 //Sort combined stream by date
171 combinedStream.sort(function (a, b) {
172 var keyA = new Date(a.dueAt).getTime(),
173 keyB = new Date(b.dueAt).getTime();
174
175 // Compare the 2 dates
176 if (keyA > keyB) return 1;
177 if (keyA &lt; keyB) return -1;
178 return 0;
179 });
180
181 //Render upcoming assignments stream
182 var combinedHTML = combinedStream.map(assignment => {
183 return dtps.renderAssignment(assignment);
184 }).join("");
185
186 //No upcoming assignments
187 if (combinedStream.length == 0) {
188 combinedHTML = `&lt;p style="text-align: center;margin: 75px 25px 10px 75px; font-size: 18px;">No upcoming assignments&lt;/p>`;
189 }
190
191 if (dtps.selectedClass == "dash") {
192 jQuery(".classContent .dash .assignmentStream").html(combinedHTML);
193 }
194}
195
196
197/**
198 * Compiles and displays the assignment calendar
199 */
200dtps.calendar = function () {
201 if (dtps.selectedClass == "dash") {
202 //Calendar events array
203 var calEvents = [];
204
205 //Add assignments from every class to calEvents array
206 dtps.classes.forEach((course, courseIndex) => {
207 if (course.assignments) {
208 //Class has assignments
209 course.assignments.forEach(assignment => {
210 calEvents.push({
211 title: assignment.title,
212 start: moment(new Date(assignment.dueAt)).toISOString(true),
213 allDay: false,
214 color: course.color,
215 classNum: courseIndex,
216 assignmentID: assignment.id
217 });
218 });
219 }
220 });
221
222 //Render calendar
223 if ($.fullCalendar !== undefined) {
224 $('#calendar').fullCalendar({
225 events: calEvents,
226 header: {
227 left: 'title',
228 right: 'prev,next'
229 },
230 eventClick: function (calEvent, jsEvent, view) {
231 dtps.assignment(calEvent.assignmentID, calEvent.classNum);
232 },
233 eventAfterAllRender: function () {
234 $(".fc-prev-button").html(`&lt;i class="material-icons">keyboard_arrow_left&lt;/i>`);
235 $(".fc-next-button").html(`&lt;i class="material-icons">keyboard_arrow_right&lt;/i>`);
236 }
237 });
238 }
239 $(".fc-prev-button").html(`&lt;i class="material-icons">keyboard_arrow_left&lt;/i>`);
240 $(".fc-next-button").html(`&lt;i class="material-icons">keyboard_arrow_right&lt;/i>`);
241
242 }
243}
244
245/**
246 * Shows the assignments stream for a class
247 *
248 * @param {string} classID The class ID to show assignments for
249 */
250dtps.classStream = function (classID) {
251 //Get class index and set as selected class
252 var classNum = dtps.classes.map(course => course.id).indexOf(classID);
253 dtps.selectedClass = classNum;
254
255 //Set stream as the selected content
256 dtps.selectedContent = "stream";
257 $("#dtpsTabBar .btn").removeClass("active");
258 $("#dtpsTabBar .btn.stream").addClass("active");
259
260 //Load class color, name, etc.
261 dtps.presentClass(classNum);
262
263 //Ensure classes are shown in the sidebar
264 dtps.showClasses();
265
266 if (classNum == -1) {
267 //Class does not exist
268 dtps.error("The selected class doesn't exist", "classNum check failed @ dtps.classStream");
269 }
270
271 //Render assignments
272 if (!dtps.classes[dtps.selectedClass].assignments) {
273 //Assignments are still loading
274 jQuery(".classContent").html(`&lt;div class="spinner">&lt;/div>`);
275 } else if (dtps.classes[dtps.selectedClass].assignments.length == 0) {
276 //This class doesn't have any assignments
277 $(".classContent").html(`&lt;div style="cursor: auto;" class="card assignment">&lt;h4>No assignments&lt;/h4>&lt;p>There aren't any assignments in this class yet&lt;/p>&lt;/div>`);
278 } else {
279 //Sort assignments
280 dtps.classes[dtps.selectedClass].assignments.sort(function (a, b) {
281 var keyA = new Date(a.dueAt).getTime(),
282 keyB = new Date(b.dueAt).getTime();
283
284 var now = new Date().getTime();
285
286 //Put assignments without a due date at the end
287 if (!a.dueAt) { keyA = 0; }
288 if (!b.dueAt) { keyB = 0; }
289
290 //Put upcoming assignments at the top
291 if ((keyA &lt; now) || (keyB &lt; now)) {
292 // Sort upcoming assignments from earliest -> latest
293 if (keyA &lt; keyB) return 1;
294 if (keyA > keyB) return -1;
295 return 0;
296 } else {
297 // Sort old assignments from latest -> earliest
298 if (keyA > keyB) return 1;
299 if (keyA &lt; keyB) return -1;
300 return 0;
301 }
302 });
303
304 //Render assignments
305 var streamHTML = dtps.classes[dtps.selectedClass].assignments.map(assignment => {
306 return dtps.renderAssignment(assignment);
307 }).join("");
308
309 //Add stream header with class info buttons and search box
310 streamHTML = dtps.renderClassTools(classNum, "stream") + streamHTML;
311
312 $(".classContent").html(streamHTML);
313 }
314}
315
316/**
317 * Shows details for an assignment given the assignment ID and class number
318 *
319 * @param {string} id Assignment ID
320 * @param {number} classNum Assignment class number
321 * @param {boolean} [submissions] If true, assignment submissions will be shown
322 */
323dtps.assignment = function (id, classNum, submissions) {
324 //Get assignment from the id prop
325 var assignmentIDs = dtps.classes[classNum].assignments.map(assignment => assignment.id);
326 var assignment = dtps.classes[classNum].assignments[assignmentIDs.indexOf(id)];
327
328 if (submissions) {
329 //Render assignment submissions
330 $(".card.details").css("background-color", "white");
331 $(".card.details").css("color", "black")
332 $(".card.details").html(`&lt;i style="color: black !important;" onclick="fluid.cards.close('.card.details')" class="material-icons close">close&lt;/i>
333 &lt;i style="left: 0; right: auto; color: black !important;" onclick="dtps.assignment(` + id + `, ` + classNum + `)" class="material-icons close">arrow_back&lt;/i>
334 &lt;br />&lt;br />
335 &lt;iframe style="width: 100%; height: calc(100vh - 175px); border: none;" src="` + assignment.submissions + `">&lt;/iframe>
336 `);
337 } else {
338 //Render assignment
339
340 //The assignment body is rendered in an iFrame to keep its content and styling isolated from the rest of the page
341 var assignmentBodyURL = null;
342 if (assignment.body) {
343 //Get computed background and text color to style the iFrame with
344 var computedBackgroundColor = getComputedStyle($(".card.details")[0]).getPropertyValue("--cards");
345 var computedTextColor = getComputedStyle($(".card.details")[0]).getPropertyValue("--text");
346
347 //Generate a blob with the assignment body and get its data URL
348 var blob = new Blob([`
349 &lt;base target="_blank" />
350 &lt;link type="text/css" rel="stylesheet" href="https://cdn.jottocraft.com/CanvasCSS.css" media="screen,projection"/>
351 &lt;style>body {background-color: ${computedBackgroundColor}; color: ${computedTextColor};&lt;/style>
352 ${assignment.body}
353 `], { type: 'text/html' });
354 assignmentBodyURL = window.URL.createObjectURL(blob);
355 }
356
357 //Get assignment rubric HTML
358 var assignmentRubricHTML = "";
359 if (assignment.rubric) {
360 var assignmentRubricHTML = assignment.rubric.map(function (rubricItem) {
361 return /*html*/`
362 &lt;div class="dtpsAssignmentRubricItem">
363 &lt;h5>${rubricItem.title}&lt;/h5>
364 &lt;div class="score">
365 &lt;p style="color: ${rubricItem.score ? dtps.cblColor(rubricItem.score) : "var(--secText)"};" class="scoreName">
366 ${rubricItem.score ? rubricItem.scoreName || "" : "Not assessed"}
367
368 &lt;div class="points">
369 &lt;p class="earned">${rubricItem.score || ""}&lt;/p>
370 &lt;p class="possible">${"/" + rubricItem.value}&lt;/p>
371 &lt;/div>
372 &lt;/p>
373 &lt;/div>
374 &lt;/div>
375 `
376 }).join("");
377 }
378
379 //Get assignment feedback HTML
380 var assignmentFeedbackHTML = "";
381 if (assignment.feedback) {
382 var assignmentFeedbackHTML = assignment.feedback.map(feedback => {
383 return /*html*/`
384 &lt;div class="dtpsSubmissionComment">
385 ${feedback.author ? /*html*/`
386 &lt;img src="${feedback.author.photoURL}" />
387 &lt;h5>${feedback.author.name}&lt;/h5>
388 ` : ``}
389
390 &lt;p>${feedback.comment}&lt;/p>
391 &lt;/div>
392 `
393 }).join("");
394 }
395
396 //Get assignment score HTML
397 var scoreHTML = "";
398
399 //Use rubric score over points score if possible
400 if (assignment.rubric) {
401 var rubricHTML = [];
402
403 //Loop over every rubric item to get HTML for each
404 assignment.rubric.forEach(rubricItem => {
405 if (rubricItem.score) {
406 rubricHTML.push(/*html*/`
407 &lt;div class="assignmentChip" title="${rubricItem.title}" style="color: ${dtps.cblColor(rubricItem.score)}; font-weight: bold;">
408 ${rubricItem.score}
409 &lt;/div>
410 `);
411 }
412 });
413
414 scoreHTML = rubricHTML.join("");
415 }
416
417 //Render assignment details
418 $(".card.details").html(/*html*/`
419 &lt;i onclick="fluid.cards.close('.card.details'); $('.card.details').html('');" class="material-icons close">close&lt;/i>
420
421 &lt;h4 style="font-weight: bold;">${assignment.title}&lt;/h4>
422
423 &lt;div>
424 ${assignment.dueAt ? `&lt;div class="assignmentChip">&lt;i class="material-icons">alarm&lt;/i>&lt;span>Due ${dtps.formatDate(assignment.dueAt)}&lt;/span>&lt;/div>` : ""}
425 ${assignment.turnedIn ? `&lt;div title="Assignment submitted" class="assignmentChip" style="color: #0bb75b">&lt;i class="material-icons">assignment_turned_in&lt;/i>&lt;/div>` : ""}
426 ${assignment.missing ? `&lt;div title="Assignment is missing" class="assignmentChip" style="color: #c44848">&lt;i class="material-icons">remove_circle_outline&lt;/i>&lt;/div>` : ""}
427 ${assignment.late ? `&lt;div title="Assignment is late" class="assignmentChip" style="color: #c44848">&lt;i class="material-icons">assignment_late&lt;/i>&lt;/div>` : ""}
428 ${assignment.locked ? `&lt;div title="Assignment submissions are locked" class="assignmentChip" style="color: var(--secText, gray);">&lt;i style="font-family: 'Material Icons Extended';" class="material-icons">lock_outline&lt;/i>&lt;/div>` : ""}
429 ${scoreHTML}
430 &lt;/div>
431
432 &lt;div style="margin-top: 20px;" class="assignmentBody">
433 ${assignment.body ? `&lt;iframe id="assignmentIframe" onload="dtps.iframeLoad('assignmentIframe')" style="margin: 10px 0px; width: 100%; border: none; outline: none;" src="${assignmentBodyURL}" />` : ""}
434 &lt;/div>
435
436 ${assignment.body ? `&lt;div style="margin: 5px 0px; background-color: var(--darker); height: 1px; width: 100%;" class="divider">&lt;/div>` : ""}
437
438 &lt;div style="width: calc(40% - 2px); margin-top: 20px; display: inline-block; overflow: hidden; vertical-align: top;">
439 ${assignment.publishedAt ? `&lt;p style="color: var(--secText); margin: 5px 0px;">&lt;i style="vertical-align: middle;" class="material-icons">add_box&lt;/i> Published: ${dtps.formatDate(assignment.publishedAt)}&lt;/p>` : ""}
440 ${assignment.dueAt ? `&lt;p style="color: var(--secText); margin: 5px 0px;">&lt;i style="vertical-align: middle;" class="material-icons">alarm&lt;/i> Due: ${dtps.formatDate(assignment.dueAt)}&lt;/p>` : ""}
441 ${assignment.value ? `&lt;p style="color: var(--secText); margin: 5px 0px;">&lt;i style="vertical-align: middle;" class="material-icons">bar_chart&lt;/i> Point value: ${assignment.value}&lt;/p>` : ""}
442 ${assignment.grade ? `&lt;p style="color: var(--secText); margin: 5px 0px;">&lt;i style="vertical-align: middle;" class="material-icons">assessment&lt;/i> Points earned: ${assignment.grade}&lt;/p>` : ""}
443 ${assignment.letter ? `&lt;p style="color: var(--secText); margin: 5px 0px;">&lt;i style="vertical-align: middle;" class="material-icons">font_download&lt;/i> Letter grade: ${assignment.letter}&lt;/p>` : ""}
444 ${assignment.category ? `&lt;p style="color: var(--secText); margin: 5px 0px;">&lt;i style="vertical-align: middle;" class="material-icons">category&lt;/i> Category: ${assignment.category}&lt;/p>` : ""}
445 ${assignment.rubric ? assignment.rubric.map(function (rubricItem) { return `&lt;p style="color: var(--secText); margin: 5px 0px;">&lt;i style="vertical-align: middle;" class="material-icons">adjust&lt;/i> ${rubricItem.title}&lt;/p>`; }).join("") : ""}
446 &lt;p style="color: var(--secText); margin: 5px 0px;">&lt;i style="vertical-align: middle;" class="material-icons">class&lt;/i> Class: ${dtps.classes[assignment.class].subject}&lt;/p>
447 &lt;p style="color: var(--secText); margin: 5px 0px;">&lt;i style="vertical-align: middle;" class="material-icons">bug_report&lt;/i> Assignment ID: ${assignment.id}&lt;/p>
448
449 &lt;br />
450 &lt;div class="row">
451 &lt;div class="btn small outline" onclick="dtps.assignment('${assignment.id}', ${classNum}, true)">&lt;i class="material-icons">assignment&lt;/i> Submissions&lt;/div>
452 &lt;div class="btn small outline" onclick="window.open('${assignment.url}')">&lt;i class="material-icons">open_in_new&lt;/i> Open in ${dtpsLMS.name}&lt;/div>
453 &lt;/div>
454 &lt;/div>
455
456 &lt;div style="width: calc(60% - 7px); margin-top: 20px; margin-left: 5px; display: inline-block; overflow: hidden; vertical-align: middle;">
457 ${assignmentFeedbackHTML}
458
459 ${assignmentRubricHTML}
460 &lt;/div>
461 `);
462 }
463
464 //Close other active cards and open the assignment details card
465 fluid.cards.close(".card.focus");
466 fluid.modal(".card.details");
467}
468
469/**
470 * Searches the assignment stream for a keyword using Fuse.js
471 *
472 * @todo pending v3 support
473 */
474dtps.search = function () {
475 alert("This feature has not been implemented yet");
476 throw "DTPS v3 IMPLEMENTATION ERR";
477 if (dtps.selectedClass == "dash") {
478 if ($("input.search").val() == "") {
479 jQuery(".classContent .stream").html(dtps.renderStream(dtps.latestStream, ""))
480 } else {
481 jQuery(".classContent .stream").html(dtps.renderStream(dtps.fuse.search($("input.search").val()), $("input.search").val()))
482 }
483 $(".card.assignment").addClass("color");
484 } else {
485 if ($("input.search").val() == "") {
486 jQuery(".classContent").html(dtps.renderStream(dtps.latestStream, ""))
487 } else {
488 jQuery(".classContent").html(dtps.renderStream(dtps.fuse.search($("input.search").val()), $("input.search").val()))
489 }
490 }
491}
492
493/**
494 * Fetches module stream for a class
495 *
496 * @param {number} num Class number to fetch modules for
497 * @todo pending v3 support
498 */
499dtps.moduleStream = function (num) {
500 alert("This feature has not been implemented yet");
501 throw "DTPS v3 IMPLEMENTATION ERR";
502 dtps.selectedContent = "moduleStream";
503 var moduleRootHTML = dtps.renderClassTools(num, false, true);
504 if (dtps.selectedContent == "moduleStream") jQuery(".classContent").html(moduleRootHTML + `&lt;div class="spinner">&lt;/div>`);
505 streamData = [];
506 dtps.webReq("canvas", "/api/v1/courses/" + dtps.classes[num].id + "/modules?include[]=items&amp;include[]=content_details", function (resp) {
507 dtps.webReq("canvas", "/courses/" + dtps.classes[num].id + "/modules/progressions", function (progResp) {
508 var data = JSON.parse(resp);
509 var progData = JSON.parse(progResp);
510 var collapsed = {};
511 for (var i = 0; i &lt; progData.length; i++) {
512 collapsed[progData[i].context_module_progression.context_module_id] = progData[i].context_module_progression.collapsed;
513 }
514 for (var i = 0; i &lt; data.length; i++) {
515 var subsetData = [];
516 for (var ii = 0; ii &lt; data[i].items.length; ii++) {
517 var icon = "star_border";
518 if (data[i].items[ii].type == "ExternalTool") icon = "insert_link";
519 if (data[i].items[ii].type == "ExternalUrl") icon = "open_in_new";
520 if (data[i].items[ii].type == "Assignment") icon = "assignment";
521 if (data[i].items[ii].type == "Page") icon = "insert_drive_file";
522 if (data[i].items[ii].type == "Discussion") icon = "forum";
523 if (data[i].items[ii].type == "Quiz") icon = "assessment";
524 if (data[i].items[ii].type == "SubHeader") icon = "format_size";
525 var open = `window.open('` + data[i].items[ii].html_url + `')`;
526 if (data[i].items[ii].type == "ExternalTool") open = `$('#moduleIFrame').attr('src', ''); fluid.cards('.card.moduleURL'); $.getJSON('` + data[i].items[ii].url + `', function (data) { $('#moduleIFrame').attr('src', data.url); });`
527 if (data[i].items[ii].type == "Assignment") open = `dtps.assignment(` + data[i].items[ii].content_id + `, dtps.selectedClass);`
528 if (data[i].items[ii].type == "Page") open = `dtps.getPage(dtps.classes[dtps.selectedClass].id, '` + data[i].items[ii].page_url + `', true)`
529 if (data[i].items[ii].type == "SubHeader") {
530 subsetData.push(`&lt;h5 style="font-size: 22px;padding: 2px 10px;">` + data[i].items[ii].title + `&lt;/h5>`);
531 } else {
532 subsetData.push(`&lt;div onclick="` + open + `" style="color: var(--lightText); padding:10px;font-size:17px;border-radius:15px;margin:5px 0;margin-left: ` + (data[i].items[ii].indent * 15) + `px; cursor: pointer;">
533&lt;i class="material-icons" style="vertical-align: middle; margin-right: 10px;">` + icon + `&lt;/i>` + data[i].items[ii].title + `&lt;/div>`);
534 }
535 }
536 streamData.push(`&lt;div class="card ` + (collapsed[data[i].id] ? "collapsed" : "") + `">
537&lt;h4 style="margin: 5px 2px; font-size: 32px; font-weight: bold;">
538&lt;i onclick="dtps.moduleCollapse(this, '` + dtps.classes[num].id + `', '` + data[i].id + `');" style="cursor: pointer; vertical-align: middle; color:var(--lightText);" class="material-icons collapseIcon">` + (collapsed[data[i].id] ? "keyboard_arrow_right" : "keyboard_arrow_down") + `&lt;/i>
539` + data[i].name + `&lt;/h4>
540&lt;div class="moduleContents" style="padding-top: 10px;">
541` + subsetData.join("") + `
542&lt;/div>
543&lt;/div>`)
544 }
545 if (dtps.selectedContent == "moduleStream") jQuery(".classContent").html(moduleRootHTML + streamData.join(""));
546 });
547 });
548}
549
550/**
551 * Collapses a module
552 *
553 * @param {Element} ele Element of the module collapse arrow
554 * @param {string} classID Class ID
555 * @param {string} modID Module ID of the module to collapse
556 * @todo pending v3 support
557 */
558dtps.moduleCollapse = function (ele, classID, modID) {
559 alert("This feature has not been implemented yet");
560 throw "DTPS v3 IMPLEMENTATION ERR";
561 $(ele).parents('.card').toggleClass('collapsed');
562 if ($(ele).parents('.card').hasClass('collapsed')) {
563 dtps.webReq("canCOLLAPSE", "/courses/" + classID + "/modules/" + modID + "/collapse", undefined, { collapse: 1, forceLoad: true })
564 $(ele).html('keyboard_arrow_right');
565 } else {
566 dtps.webReq("canCOLLAPSE", "/courses/" + classID + "/modules/" + modID + "/collapse", undefined, { collapse: 0, forceLoad: true })
567 $(ele).html('keyboard_arrow_down');
568 }
569
570}
571
572//Fluid UI screen definitions
573fluid.externalScreens.dashboard = () => {
574 dtps.masterStream();
575}
576
577fluid.externalScreens.stream = (courseID) => {
578 dtps.classStream(courseID);
579}
580
581//Type definitions
582
583/**
584* @typedef {Object} Assignment
585* @description Defines assignments objects in DTPS
586* @property {string} title Title of the assignment
587* @property {string} [body] HTML of the assignment's body
588* @property {string} id Assignment ID
589* @property {Date} [dueAt] Assignment due date
590* @property {string} url Assignment URL
591* @property {AssignmentFeedback[]} [feedback] Feedback / private comments for this assignment
592* @property {User} [grader] Assignment grader
593* @property {boolean} [turnedIn] True if the assignment is turned in
594* @property {boolean} [late] True if the assignment is late
595* @property {boolean} [missing] True if the assignment is missing
596* @property {boolean} [locked] True if assignment submissions are locked
597* @property {string} [category] Assignment category
598* @property {Date} [publishedAt] Date for when the assignment was published
599* @property {Date} [gradedAt] Date for when the assignment was graded
600* @property {number} [grade] Points earned on this assignment
601* @property {string} [letter] Letter grade on this assignment
602* @property {number} [value] Total amount of points possible for this assignment
603* @property {RubricItem[]} [rubric] Assignment rubric
604*/
605
606/**
607* @typedef {Object} AssignmentFeedback
608* @description Defines assignment feedback objects in DTPS
609* @property {string} comment Feedback comment
610* @property {User} [author] Feedback author
611*/
612
613/**
614* @typedef {Object} RubricItem
615* @description Defines rubric item objects in DTPS
616* @property {string} title Title of the rubric item
617* @property {string} id Rubric item ID (does NOT have to be unique)
618* @property {number} value Total amount of points possible
619* @property {string} [outcome] The ID of the outcome this rubric item is assessing. This is only used for grade calculation.
620* @property {string} [description] Rubric item description
621* @property {number} [score] Rubric assessment score in points
622* @property {string} [scoreName] Rubric assessment score name
623*/</code></pre>
624 </article>
625 </section>
626
627
628
629
630</div>
631
632<nav>
633 <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>
634</nav>
635
636<br class="clear">
637
638<footer>
639 Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Fri May 29 2020 18:46:26 GMT-0700 (Pacific Daylight Time)
640</footer>
641
642<script> prettyPrint(); </script>
643<script src="scripts/linenumber.js"> </script>
644</body>
645</html>