blob: c56797f91928d56be9389774d81b532a4efb7d00 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: assignments.js</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">Source: assignments.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* @file DTPS assignment functions
* @author jottocraft
*
* @copyright Copyright (c) 2018-2020 jottocraft. All rights reserved.
* @license GPL-2.0-only
*/
/**
* Renders HTML for an assignment item in a list
*
* @param {Assignment} assignment The assignment object to render
* @todo Add support for points/letter scores
* @return {string} Assignment HTML for use in a list
*/
dtps.renderAssignment = function (assignment) {
var scoreHTML = "";
//Render points/letter score
//Use rubric score over points score if possible
if (assignment.rubric) {
var rubricHTML = [];
assignment.rubric.forEach(rubricItem => {
if (rubricItem.score) {
rubricHTML.push(/*html*/`
&lt;div title="${rubricItem.title}" style="color: ${rubricItem.color || "var(--text)"};">
${rubricItem.score}
&lt;/div>
`);
}
});
scoreHTML = `&lt;div class="dtpsRubricScore">${rubricHTML.join("")}&lt;/div>`;
}
var HTML = /*html*/`
&lt;div
onclick="${`dtps.assignment('` + assignment.id + `', ` + assignment.class + `)`}"
class="card graded assignment"
style="${'--classColor: ' + dtps.classes[assignment.class].color}"
>
&lt;!-- Color bar for the dashboard -->
&lt;div class="colorBar">&lt;/div>
&lt;!-- Assignment title and points -->
&lt;h4>
${assignment.title}
&lt;!-- Points display -->
&lt;div class="points">
${scoreHTML}
&lt;/div>
&lt;/h4>
&lt;h5 style="white-space: nowrap; overflow: hidden;">
&lt;!-- Assignment info -->
${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>` : ""}
${assignment.outcomes ? `&lt;div class="infoChip weighted">&lt;i class="material-icons">adjust&lt;/i>` + assignment.outcomes.length + `&lt;/div>` : ""}
${assignment.category ? `&lt;div class="infoChip weighted">&lt;i class="material-icons">category&lt;/i> ` + assignment.category + `&lt;/div>` : ""}
&lt;!-- Status icons -->
${assignment.turnedIn ? `&lt;i title="Assignment submitted" class="material-icons statusIcon" style="color: #0bb75b;">assignment_turned_in&lt;/i>` : ``}
${assignment.missing ? `&lt;i title="Assignment is missing" class="material-icons statusIcon" style="color: #c44848;">remove_circle_outline&lt;/i>` : ``}
${assignment.late ? `&lt;i title="Assignment is late" class="material-icons statusIcon" style="color: #c44848;">assignment_late&lt;/i>` : ``}
${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>` : ``}
${assignment.pending ? `&lt;i title="Grade is pending review" class="material-icons statusIcon" style="color: #b3b70b;">rate_review&lt;/i>` : ``}
&lt;/h5>
&lt;/div>
`;
return HTML;
}
/**
* Renders the DTPS dashboard and calls dtps.renderCalendar, dtps.renderUpdates, and dtps.renderUpcoming
*/
dtps.masterStream = function () {
//Ensure classes are rendered in the sidebar
dtps.presentClass("dash");
dtps.showClasses();
//Count amount of classes that are loaded
var ready = 0;
dtps.classes.forEach(course => {
if (course.assignments) ready++;
});
//Check if all classes are loaded
var doneLoading = ready == dtps.classes.length;
//Returns dashboard item container HTML for an item
function dashboardContainerHTML(dashboardItem) {
if (dashboardItem.id == "dtps.calendar") {
return $.fullCalendar !== undefined ? `&lt;div id="calendar" class="card" style="padding: 20px;">&lt;/div>` : "";
} else if (dashboardItem.id == "dtps.updates") {
return `&lt;div class="updatesStream recentlyGraded announcements">&lt;/div>`;
} else if (dashboardItem.id == "dtps.dueToday") {
return `&lt;div style="padding: 20px 0px;" class="dueToday">&lt;/div>`;
} else if (dashboardItem.id == "dtps.upcoming") {
return `&lt;div style="padding: 20px 0px;" class="assignmentStream">&lt;/div>`;
}
}
//Render HTML with loading placeholder
if (dtps.selectedClass == "dash") {
jQuery(".classContent").html(/*html*/`
&lt;div class="dash cal" style="width: 40%;display: inline-block; vertical-align: top;">
${dtps.leftDashboard.map(dashboardItem => {
return dashboardContainerHTML(dashboardItem);
}).join("")}
&lt;/div>
&lt;div style="width: 59%; display: inline-block;" class="dash stream">
${!doneLoading ? `&lt;div style="margin: 75px 25px 10px 75px;">&lt;div class="spinner">&lt;/div>&lt;/div>` : ""}
${dtps.rightDashboard.map(dashboardItem => {
return dashboardContainerHTML(dashboardItem);
}).join("")}
&lt;/div>
`);
}
//Render updates stream
dtps.renderUpdates();
//Render upcoming assignments stream
dtps.renderUpcoming();
//Render calendar
dtps.calendar();
//Render due today
dtps.renderDueToday();
}
/**
* Compiles and displays due today / to-do stream
*/
dtps.renderDueToday = function () {
//Combine class stream arrays
var combinedStream = [];
if (dtps.classes) {
dtps.classes.forEach(course => {
if (course.assignments) {
//If course has assignments, add them to the combined stream array
course.assignments.forEach(assignment => {
//Only assignments that are due today
if (dtps.isToday(assignment.dueAt)) {
combinedStream.push(assignment);
}
})
}
})
}
//Sort combined stream by date
combinedStream.sort(function (a, b) {
var keyA = new Date(a.dueAt).getTime(),
keyB = new Date(b.dueAt).getTime();
// Compare the 2 dates
if (keyA > keyB) return 1;
if (keyA &lt; keyB) return -1;
return 0;
});
//Get due today stream HTML
var combinedHTML = combinedStream.map(assignment => {
return dtps.renderAssignment(assignment);
}).join("");
if (combinedStream.length == 0) {
//Nothing due today
combinedHTML = `&lt;p style="text-align: center;margin: 10px 25px 10px 75px; font-size: 18px;">&lt;i class="material-icons">done&lt;/i> Nothing due today&lt;/p>`;
} else {
//Add header
combinedHTML = /*html*/`
&lt;h5 style="text-align: center; margin: 10px 25px 10px 75px; font-weight: bold;">Due today&lt;/h5>
` + combinedHTML;
}
if (dtps.selectedClass == "dash") {
jQuery(".classContent .dash .dueToday").html(combinedHTML);
}
}
/**
* Compiles and displays upcoming assignments stream
*/
dtps.renderUpcoming = function () {
//Combine class stream arrays
var combinedStream = [];
if (dtps.classes) {
dtps.classes.forEach(course => {
if (course.assignments) {
//If course has assignments, add them to the combined stream array
course.assignments.forEach(assignment => {
//Only include upcoming assignments that aren't due today
if ((new Date(assignment.dueAt) > new Date()) &amp;&amp; !dtps.isToday(assignment.dueAt)) {
combinedStream.push(assignment);
}
})
}
})
}
//Sort combined stream by date
combinedStream.sort(function (a, b) {
var keyA = new Date(a.dueAt).getTime(),
keyB = new Date(b.dueAt).getTime();
// Compare the 2 dates
if (keyA > keyB) return 1;
if (keyA &lt; keyB) return -1;
return 0;
});
//Render upcoming assignments stream
var combinedHTML = combinedStream.map(assignment => {
return dtps.renderAssignment(assignment);
}).join("");
//No upcoming assignments
if (combinedStream.length == 0) {
combinedHTML = "";
}
if (dtps.selectedClass == "dash") {
jQuery(".classContent .dash .assignmentStream").html(combinedHTML);
}
}
/**
* Renders updates stream (recently graded &amp; announcements)
*
* @todo pending v3 support
*/
dtps.renderUpdates = function () {
/*var context = [];
for (var i = 0; i &lt; dtps.classes.length; i++) {
if (fluid.get("pref-hideClass" + dtps.classes[i].id) !== "true") {
if (!context.length) { context.push("?context_codes[]=course_" + dtps.classes[i].id) } else { context.push("&amp;context_codes[]=course_" + dtps.classes[i].id) }
}
}
dtps.webReq("canvas", "/api/v1/announcements" + context.join(""), function (resp) {
var ann = JSON.parse(resp);
var updates = [];
for (var i = 0; i &lt; ann.length; i++) {
var dtpsClass = null;
for (var ii = 0; ii &lt; dtps.classes.length; ii++) {
if (dtps.classes[ii].id == ann[i].context_code.split("_")[1]) {
dtpsClass = ii;
}
}
updates.push({
type: "announcement",
date: ann[i].posted_at,
dom: `&lt;div onclick="$(this).toggleClass('open');" style="cursor: pointer; padding: 20px;" class="announcement card color ` + dtps.classes[dtpsClass].col + `">
&lt;div class="className">` + ann[i].title + `&lt;/div>` + ann[i].message + `
&lt;/div>
`
});
}
if (dtps.recentlyGraded) {
dtps.recentlyGraded.forEach(grade => {
updates.push({
type: "grade",
date: grade.date,
dom: `&lt;div onclick="dtps.assignment('` + grade.id + `', '` + grade.class + `')" class="card ` + dtps.classes[grade.class].col + ` recentGrade">
&lt;div style="float: right; margin-left: 10px;" class="earned outcomes">` + dtps.renderOutcomeScore(grade.rubric).join("") + `&lt;/div>
&lt;h5>` + grade.name + `&lt;/h5>
&lt;p>Graded at ` + (new Date(grade.date).toDateString().slice(0, -5) + ", " + dtps.ampm(new Date(grade.date))) + `&lt;/p>
&lt;/div>`
})
})
}
updates.sort((a, b) => {
return new Date(b.date) - new Date(a.date);
})
if ((dtps.selectedClass == "dash") &amp;&amp; (dtps.masterContent == "assignments")) {
jQuery(".dash .updatesStream").html(updates.map(update => update.dom).join(""));
}
});*/
}
/**
* Compiles and displays the assignment calendar
*/
dtps.calendar = function () {
if (dtps.selectedClass == "dash") {
//Calendar events array
var calEvents = [];
//Add assignments from every class to calEvents array
dtps.classes.forEach((course, courseIndex) => {
if (course.assignments) {
//Class has assignments
course.assignments.forEach(assignment => {
calEvents.push({
title: assignment.title,
start: moment(new Date(assignment.dueAt)).toISOString(true),
allDay: false,
color: course.color,
classNum: courseIndex,
assignmentID: assignment.id
});
});
}
});
//Render calendar
if ($.fullCalendar !== undefined) {
$('#calendar').fullCalendar({
events: calEvents,
header: {
left: 'title',
right: 'prev,next'
},
eventClick: function (calEvent, jsEvent, view) {
dtps.assignment(calEvent.assignmentID, calEvent.classNum);
},
eventAfterAllRender: function () {
$(".fc-prev-button").html(`&lt;i class="material-icons">keyboard_arrow_left&lt;/i>`);
$(".fc-next-button").html(`&lt;i class="material-icons">keyboard_arrow_right&lt;/i>`);
}
});
}
$(".fc-prev-button").html(`&lt;i class="material-icons">keyboard_arrow_left&lt;/i>`);
$(".fc-next-button").html(`&lt;i class="material-icons">keyboard_arrow_right&lt;/i>`);
}
}
/**
* Shows the assignments stream for a class
*
* @param {string} classID The class ID to show assignments for
*/
dtps.classStream = function (classID) {
//Get class index and set as selected class
var classNum = dtps.classes.map(course => course.id).indexOf(classID);
dtps.selectedClass = classNum;
//Set stream as the selected content
dtps.selectedContent = "stream";
$("#dtpsTabBar .btn").removeClass("active");
$("#dtpsTabBar .btn.stream").addClass("active");
//Load class color, name, etc.
dtps.presentClass(classNum);
//Ensure classes are shown in the sidebar
dtps.showClasses();
if (classNum == -1) {
//Class does not exist
dtps.error("The selected class doesn't exist", "classNum check failed @ dtps.classStream");
}
//Render assignments
if (!dtps.classes[dtps.selectedClass].assignments) {
//Assignments are still loading
jQuery(".classContent").html(`&lt;div class="spinner">&lt;/div>`);
} else if (dtps.classes[dtps.selectedClass].assignments.length == 0) {
//This class doesn't have any assignments
$(".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>`);
} else {
//Sort assignments
dtps.classes[dtps.selectedClass].assignments.sort(function (a, b) {
var keyA = new Date(a.dueAt).getTime(),
keyB = new Date(b.dueAt).getTime();
var now = new Date().getTime();
//Put assignments without a due date at the end
if (!a.dueAt) { keyA = 0; }
if (!b.dueAt) { keyB = 0; }
//Put upcoming assignments at the top
if ((keyA &lt; now) || (keyB &lt; now)) {
// Sort upcoming assignments from earliest -> latest
if (keyA &lt; keyB) return 1;
if (keyA > keyB) return -1;
return 0;
} else {
// Sort old assignments from latest -> earliest
if (keyA > keyB) return 1;
if (keyA &lt; keyB) return -1;
return 0;
}
});
//Render assignments
var streamHTML = dtps.classes[dtps.selectedClass].assignments.map(assignment => {
return dtps.renderAssignment(assignment);
}).join("");
//Add stream header with class info buttons and search box
streamHTML = dtps.renderClassTools(classNum, "stream") + streamHTML;
$(".classContent").html(streamHTML);
}
}
/**
* Shows details for an assignment given the assignment ID and class number
*
* @param {string} id Assignment ID
* @param {number} classNum Assignment class number
* @param {boolean} [submissions] If true, assignment submissions will be shown
* @todo Support numerical grades
*/
dtps.assignment = function (id, classNum, submissions) {
//Get assignment from the id prop
var assignmentIDs = dtps.classes[classNum].assignments.map(assignment => assignment.id);
var assignment = dtps.classes[classNum].assignments[assignmentIDs.indexOf(id)];
if (submissions) {
//Render assignment submissions
$(".card.details").css("background-color", "white");
$(".card.details").css("color", "black")
$(".card.details").html(`&lt;i style="color: black !important;" onclick="fluid.cards.close('.card.details')" class="material-icons close">close&lt;/i>
&lt;i style="left: 0; right: auto; color: black !important;" onclick="dtps.assignment(` + id + `, ` + classNum + `)" class="material-icons close">arrow_back&lt;/i>
&lt;br />&lt;br />
&lt;iframe style="width: 100%; height: calc(100vh - 175px); border: none;" src="` + assignment.submissions + `">&lt;/iframe>
`);
} else {
//Render assignment
//The assignment body is rendered in an iFrame to keep its content and styling isolated from the rest of the page
var assignmentBodyURL = null;
if (assignment.body) {
//Get computed background and text color to style the iFrame with
var computedBackgroundColor = getComputedStyle($(".card.details")[0]).getPropertyValue("--cards");
var computedTextColor = getComputedStyle($(".card.details")[0]).getPropertyValue("--text");
//Generate a blob with the assignment body and get its data URL
var blob = new Blob([`
&lt;base target="_blank" />
&lt;link type="text/css" rel="stylesheet" href="https://cdn.jottocraft.com/CanvasCSS.css" media="screen,projection"/>
&lt;style>body {background-color: ${computedBackgroundColor}; color: ${computedTextColor};&lt;/style>
${assignment.body}
`], { type: 'text/html' });
assignmentBodyURL = window.URL.createObjectURL(blob);
}
//Get assignment rubric HTML
var assignmentRubricHTML = "";
if (assignment.rubric) {
var assignmentRubricHTML = assignment.rubric.map(function (rubricItem) {
return /*html*/`
&lt;div class="dtpsAssignmentRubricItem">
&lt;h5>${rubricItem.title}&lt;/h5>
&lt;div class="score">
&lt;p style="color: ${rubricItem.color ? rubricItem.color : "var(--secText)"};" class="scoreName">
${rubricItem.score ? rubricItem.scoreName || "" : "Not assessed"}
&lt;div class="points">
&lt;p class="earned">${rubricItem.score || ""}&lt;/p>
&lt;p class="possible">${"/" + rubricItem.value}&lt;/p>
&lt;/div>
&lt;/p>
&lt;/div>
&lt;/div>
`
}).join("");
}
//Get assignment feedback HTML
var assignmentFeedbackHTML = "";
if (assignment.feedback) {
var assignmentFeedbackHTML = assignment.feedback.map(feedback => {
return /*html*/`
&lt;div class="dtpsSubmissionComment">
${feedback.author ? /*html*/`
&lt;img src="${feedback.author.photoURL}" />
&lt;h5>${feedback.author.name}&lt;/h5>
` : ``}
&lt;p>${feedback.comment}&lt;/p>
&lt;/div>
`
}).join("");
}
//Get assignment score HTML
var scoreHTML = "";
//Use rubric score over points score if possible
if (assignment.rubric) {
var rubricHTML = [];
//Loop over every rubric item to get HTML for each
assignment.rubric.forEach(rubricItem => {
if (rubricItem.score) {
rubricHTML.push(/*html*/`
&lt;div class="assignmentChip" title="${rubricItem.title}" style="color: ${rubricItem.color || "var(--text)"}; font-weight: bold;">
${rubricItem.score}
&lt;/div>
`);
}
});
scoreHTML = rubricHTML.join("");
}
//Render assignment details
$(".card.details").html(/*html*/`
&lt;i onclick="fluid.cards.close('.card.details'); $('.card.details').html('');" class="material-icons close">close&lt;/i>
&lt;h4 style="font-weight: bold;">${assignment.title}&lt;/h4>
&lt;div>
${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>` : ""}
${assignment.turnedIn ? `&lt;div title="Assignment submitted" class="assignmentChip" style="color: #0bb75b">&lt;i class="material-icons">assignment_turned_in&lt;/i>&lt;/div>` : ""}
${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>` : ""}
${assignment.late ? `&lt;div title="Assignment is late" class="assignmentChip" style="color: #c44848">&lt;i class="material-icons">assignment_late&lt;/i>&lt;/div>` : ""}
${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>` : ""}
${scoreHTML}
&lt;/div>
&lt;div style="margin-top: 20px;" class="assignmentBody">
${assignment.body ? `&lt;iframe id="assignmentIframe" onload="dtps.iframeLoad('assignmentIframe')" style="margin: 10px 0px; width: 100%; border: none; outline: none;" src="${assignmentBodyURL}" />` : ""}
&lt;/div>
${assignment.body ? `&lt;div style="margin: 5px 0px; background-color: var(--darker); height: 1px; width: 100%;" class="divider">&lt;/div>` : ""}
&lt;div style="width: calc(40% - 2px); margin-top: 20px; display: inline-block; overflow: hidden; vertical-align: top;">
${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>` : ""}
${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>` : ""}
${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>` : ""}
${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>` : ""}
${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>` : ""}
${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>` : ""}
${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("") : ""}
&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>
&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>
&lt;br />
&lt;div class="row">
&lt;div class="btn small outline" onclick="dtps.assignment('${assignment.id}', ${classNum}, true)">&lt;i class="material-icons">assignment&lt;/i> Submissions&lt;/div>
&lt;div class="btn small outline" onclick="window.open('${assignment.url}')">&lt;i class="material-icons">open_in_new&lt;/i> Open in ${dtpsLMS.shortName || dtpsLMS.name}&lt;/div>
&lt;/div>
&lt;/div>
&lt;div style="width: calc(60% - 7px); margin-top: 20px; margin-left: 5px; display: inline-block; overflow: hidden; vertical-align: middle;">
${assignmentFeedbackHTML}
${assignmentRubricHTML}
&lt;/div>
`);
}
//Close other active cards and open the assignment details card
fluid.cards.close(".card.focus");
fluid.modal(".card.details");
}
/**
* Searches the assignment stream for a keyword using Fuse.js
*
* @todo pending v3 support
*/
dtps.search = function () {
alert("This feature has not been implemented yet");
throw "DTPS v3 IMPLEMENTATION ERR";
if (dtps.selectedClass == "dash") {
if ($("input.search").val() == "") {
jQuery(".classContent .stream").html(dtps.renderStream(dtps.latestStream, ""))
} else {
jQuery(".classContent .stream").html(dtps.renderStream(dtps.fuse.search($("input.search").val()), $("input.search").val()))
}
$(".card.assignment").addClass("color");
} else {
if ($("input.search").val() == "") {
jQuery(".classContent").html(dtps.renderStream(dtps.latestStream, ""))
} else {
jQuery(".classContent").html(dtps.renderStream(dtps.fuse.search($("input.search").val()), $("input.search").val()))
}
}
}
/**
* Fetches module stream for a class
*
* @param {number} num Class number to fetch modules for
* @todo pending v3 support
*/
dtps.moduleStream = function (num) {
alert("This feature has not been implemented yet");
throw "DTPS v3 IMPLEMENTATION ERR";
dtps.selectedContent = "moduleStream";
var moduleRootHTML = dtps.renderClassTools(num, false, true);
if (dtps.selectedContent == "moduleStream") jQuery(".classContent").html(moduleRootHTML + `&lt;div class="spinner">&lt;/div>`);
streamData = [];
dtps.webReq("canvas", "/api/v1/courses/" + dtps.classes[num].id + "/modules?include[]=items&amp;include[]=content_details", function (resp) {
dtps.webReq("canvas", "/courses/" + dtps.classes[num].id + "/modules/progressions", function (progResp) {
var data = JSON.parse(resp);
var progData = JSON.parse(progResp);
var collapsed = {};
for (var i = 0; i &lt; progData.length; i++) {
collapsed[progData[i].context_module_progression.context_module_id] = progData[i].context_module_progression.collapsed;
}
for (var i = 0; i &lt; data.length; i++) {
var subsetData = [];
for (var ii = 0; ii &lt; data[i].items.length; ii++) {
var icon = "star_border";
if (data[i].items[ii].type == "ExternalTool") icon = "insert_link";
if (data[i].items[ii].type == "ExternalUrl") icon = "open_in_new";
if (data[i].items[ii].type == "Assignment") icon = "assignment";
if (data[i].items[ii].type == "Page") icon = "insert_drive_file";
if (data[i].items[ii].type == "Discussion") icon = "forum";
if (data[i].items[ii].type == "Quiz") icon = "assessment";
if (data[i].items[ii].type == "SubHeader") icon = "format_size";
var open = `window.open('` + data[i].items[ii].html_url + `')`;
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); });`
if (data[i].items[ii].type == "Assignment") open = `dtps.assignment(` + data[i].items[ii].content_id + `, dtps.selectedClass);`
if (data[i].items[ii].type == "Page") open = `dtps.getPage(dtps.classes[dtps.selectedClass].id, '` + data[i].items[ii].page_url + `', true)`
if (data[i].items[ii].type == "SubHeader") {
subsetData.push(`&lt;h5 style="font-size: 22px;padding: 2px 10px;">` + data[i].items[ii].title + `&lt;/h5>`);
} else {
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;">
&lt;i class="material-icons" style="vertical-align: middle; margin-right: 10px;">` + icon + `&lt;/i>` + data[i].items[ii].title + `&lt;/div>`);
}
}
streamData.push(`&lt;div class="card ` + (collapsed[data[i].id] ? "collapsed" : "") + `">
&lt;h4 style="margin: 5px 2px; font-size: 32px; font-weight: bold;">
&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>
` + data[i].name + `&lt;/h4>
&lt;div class="moduleContents" style="padding-top: 10px;">
` + subsetData.join("") + `
&lt;/div>
&lt;/div>`)
}
if (dtps.selectedContent == "moduleStream") jQuery(".classContent").html(moduleRootHTML + streamData.join(""));
});
});
}
/**
* Collapses a module
*
* @param {Element} ele Element of the module collapse arrow
* @param {string} classID Class ID
* @param {string} modID Module ID of the module to collapse
* @todo pending v3 support
*/
dtps.moduleCollapse = function (ele, classID, modID) {
alert("This feature has not been implemented yet");
throw "DTPS v3 IMPLEMENTATION ERR";
$(ele).parents('.card').toggleClass('collapsed');
if ($(ele).parents('.card').hasClass('collapsed')) {
dtps.webReq("canCOLLAPSE", "/courses/" + classID + "/modules/" + modID + "/collapse", undefined, { collapse: 1, forceLoad: true })
$(ele).html('keyboard_arrow_right');
} else {
dtps.webReq("canCOLLAPSE", "/courses/" + classID + "/modules/" + modID + "/collapse", undefined, { collapse: 0, forceLoad: true })
$(ele).html('keyboard_arrow_down');
}
}
/**
* Gets stream tools HTML (search box, class info, and modules/assignment switcher)
*
* @param {number} num Class number
* @param {string} type Class content these tools are for (e.g. "stream")
* @param {boolean} [modulesSelector] True if the class supports modules
* @return {string} Stream tools HTML
*/
dtps.renderClassTools = function (num, type, modulesSelector) {
return /*html*/`
&lt;div style="position: absolute;display:inline-block;margin: ${modulesSelector ? "82px" : "38px 82px"};">
${dtps.classes[num].teacher ? /*html*/`
&lt;div class="acrylicMaterial" style="border-radius: 20px; display: inline-block; margin-right: 5px;">
&lt;img src="${dtps.classes[num].teacher.photoURL}" style="width: 40px; height: 40px; border-radius: 50%;vertical-align: middle;">
&lt;div style="font-size: 16px;display: inline-block;vertical-align: middle;margin: 0px 10px;">${dtps.classes[num].teacher.name}&lt;/div>
&lt;/div>` : ``
}
&lt;div onclick="dtps.classInfo(${num})" class="acrylicMaterial" style="border-radius: 50%; height: 40px; width: 40px; text-align: center; display: inline-block; vertical-align: middle; cursor: pointer; margin-right: 3px;">
&lt;i style="line-height: 40px;" class="material-icons">info&lt;/i>
&lt;/div>
${dtps.classes[num].defaultView == "wiki" ? /*html*/`
&lt;div onclick="dtps.classHome(${num})" class="acrylicMaterial" style="border-radius: 50%; height: 40px; width: 40px; text-align: center; display: inline-block; vertical-align: middle; cursor: pointer;">
&lt;i style="line-height: 40px;" class="material-icons">home&lt;/i>
&lt;/div>` : ""
}
&lt;/div>
${(type == "modules") || (type == "stream") ? /*html*/`
&lt;div style="text-align: right;${modulesSelector ? "" : "margin-top: 20px;"}">
${type == "stream" ? `&lt;i class="inputIcon material-icons">search&lt;/i>&lt;input onchange="dtps.search()" class="search inputIcon shadow" placeholder="Search assignments" type="search" />` : ""}
&lt;br />
${modulesSelector ? /*html*/`
&lt;div class="btns row small acrylicMaterial assignmentPicker" style="margin: ${type == "stream" ? `20px 80px 20px 0px !important` : `63px 80px 20px 0px !important`};">
&lt;button class="btn ${type == "stream" ? "active" : ""}" onclick="dtps.classStream(dtps.selectedClass);">&lt;i class="material-icons">assignment&lt;/i>Assignments&lt;/button>
&lt;button class="btn ${type == "modules" ? "active" : ""}" onclick="dtps.moduleStream(dtps.selectedClass);">&lt;i class="material-icons">view_module&lt;/i>Modules&lt;/button>
&lt;/div>
` : ``}
&lt;/div>` : ``
}
`;
}
/**
* Displays class info &amp; syllabus card
*
* @param {number} num Class number to show info for
*/
dtps.classInfo = function (num) {
if ((dtps.classes[num].syllabus !== "") &amp;&amp; dtps.classes[num].syllabus !== null) {
var blob = new Blob([`&lt;base target="_blank" /> &lt;link type="text/css" rel="stylesheet" href="https://cdn.jottocraft.com/CanvasCSS.css" media="screen,projection"/>
&lt;style>body {background-color: ` + getComputedStyle($(".card.details")[0]).getPropertyValue("--cards") + `; color: ` + getComputedStyle($(".card.details")[0]).getPropertyValue("--text") + `}&lt;/style>` + dtps.classes[num].syllabus], { type: 'text/html' });
var newurl = window.URL.createObjectURL(blob);
}
$(".card.details").html(`&lt;i onclick="fluid.cards.close('.card.details')" class="material-icons close">close&lt;/i>
&lt;h4 style="font-weight: bold;">` + dtps.classes[num].name + `&lt;/h4>
&lt;p style="color: var(--secText)">` + (dtps.classes[num].description ? dtps.classes[num].description : "") + `&lt;/p>
&lt;div class="assignmentChip">&lt;i class="material-icons">group&lt;/i>&lt;span>` + dtps.classes[num].numStudents + ` students&lt;/span>&lt;/div>
&lt;div class="assignmentChip">&lt;i class="material-icons">bug_report&lt;/i>&lt;span>Class ID: ` + dtps.classes[num].id + `&lt;/span>&lt;/div>
` + (dtps.classes[num].favorite ? `&lt;div title="Favorited class" class="assignmentChip" style="background-color: #daa520">&lt;i style="color:white;font-family: 'Material Icons Outline'" class="material-icons">star_border&lt;/i>&lt;/div>` : "") + `
&lt;br />
&lt;div style="margin-top: 20px;" class="syllabusBody">` + ((dtps.classes[num].syllabus !== "") &amp;&amp; dtps.classes[num].syllabus !== null ? `&lt;iframe id="syllabusIframe" onload="dtps.iframeLoad('syllabusIframe')" style="margin: 10px 0px; width: 100%; border: none; outline: none;" src="` + newurl + `" />` : "") + `&lt;/div>
`)
fluid.modal(".card.details")
}
/**
* Displays the class homepage
*
* @param {number} num Class number to show the homepage for
*/
dtps.classHome = function (num) {
//Render loading screen
$(".card.details").html(/*html*/`
&lt;i onclick="fluid.cards.close('.card.details')" class="material-icons close">close&lt;/i>
&lt;h4 style="font-weight: bold;">${dtps.classes[num].subject} Homepage&lt;/h4>
&lt;br />
&lt;p>Loading...&lt;/p>
`);
dtps.webReq("canvas", "/api/v1/courses/" + dtps.classes[num].id + "/front_page", function (resp) {
var data = JSON.parse(resp);
if (!data.message) {
var blob = new Blob([`&lt;base target="_blank" /> &lt;link type="text/css" rel="stylesheet" href="https://cdn.jottocraft.com/CanvasCSS.css" media="screen,projection"/>
&lt;style>body {background-color: ` + getComputedStyle($(".card.details")[0]).getPropertyValue("--cards") + `; color: ` + getComputedStyle($(".card.details")[0]).getPropertyValue("--text") + `}&lt;/style>` + data.body], { type: 'text/html' });
var newurl = window.URL.createObjectURL(blob);
$(".card.details").html(`&lt;i onclick="fluid.cards.close('.card.details')" class="material-icons close">close&lt;/i>
&lt;h4 style="font-weight: bold;">` + data.title + `&lt;/h4>
&lt;br />
&lt;div style="margin-top: 20px;" class="homepageBody">&lt;iframe id="homepageIframe" onload="dtps.iframeLoad('homepageIframe')" style="margin: 10px 0px; width: 100%; border: none; outline: none;" src="` + newurl + `" />&lt;/div>
`)
fluid.modal(".card.details")
} else {
alert("Error: No homepage found for this class")
fluid.cards.close('.card.details')
}
})
}
//Fluid UI screen definitions
fluid.externalScreens.dashboard = () => {
dtps.masterStream();
}
fluid.externalScreens.stream = (courseID) => {
dtps.classStream(courseID);
}
//Type definitions
/**
* @typedef {Object} Assignment
* @description Defines assignments objects in DTPS
* @property {string} title Title of the assignment
* @property {string} [body] HTML of the assignment's body
* @property {string} id Assignment ID
* @property {Date} [dueAt] Assignment due date
* @property {string} url Assignment URL
* @property {AssignmentFeedback[]} [feedback] Feedback / private comments for this assignment
* @property {User} [grader] Assignment grader
* @property {boolean} [turnedIn] True if the assignment is turned in
* @property {boolean} [late] True if the assignment is late
* @property {boolean} [missing] True if the assignment is missing
* @property {boolean} [locked] True if assignment submissions are locked
* @property {string} [category] Assignment category
* @property {Date} [publishedAt] Date for when the assignment was published
* @property {Date} [gradedAt] Date for when the assignment was graded
* @property {number} [grade] Points earned on this assignment
* @property {string} [letter] Letter grade on this assignment
* @property {number} [value] Total amount of points possible for this assignment
* @property {RubricItem[]} [rubric] Assignment rubric
*/
/**
* @typedef {Object} AssignmentFeedback
* @description Defines assignment feedback objects in DTPS
* @property {string} comment Feedback comment
* @property {User} [author] Feedback author
*/
/**
* @typedef {Object} RubricItem
* @description Defines rubric item objects in DTPS
* @property {string} title Title of the rubric item
* @property {string} id Rubric item ID (does NOT have to be unique)
* @property {number} value Total amount of points possible
* @property {string} [outcome] The ID of the outcome this rubric item is assessing. This is only used for grade calculation.
* @property {string} [description] Rubric item description
* @property {number} [score] Rubric assessment score in points
* @property {string} [scoreName] Rubric assessment score name
* @property {string} [scoreColor] Score color in CSS color format
*/
/**
* @typedef {Object} DashboardItem
* @description Defines dashboard items in DTPS
* @property {string} name Dashbord item name
* @property {string} id Unique dashboard item ID
* @property {string} icon Dashboard item icon
* @property {boolean} supportsCompactMode True if this dashboard item supports compact mode
* @property {number} size The approximate size of this dashboard item relative to other dashboard items. Should be no less than 20.
* @property {string} defaultSide The default side of this dashboard item. Either "right" or "left".
* @property {boolean} compact True if the user has turned on compact mode for this item.
*/</code></pre>
</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="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 Sun Jun 07 2020 14:02:58 GMT-0700 (Pacific Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>