JSDoc: Global

Members

content

Source:

js/components/event.js, line 47

Example

{
       content: "CSE 110 Lecture",
       tags: ["Lecture", ...],
       from: hh:mm AM, (12hr)
       to: hh:mm PM (12hr)
   }

Methods

addCustomTag(tagName)

add custom tag

Parameters:

Name	Type	Description
`tagName`		string for the name of tag

Source:

js/storage.js, line 122

Returns:

true/false if successful

addEvent(key:, event:)

addEvent add an event into local storage

Parameters:

Name	Type	Description
`key:`		2021-05-17
`event:`		the json data returned from Event.content

Source:

js/storage.js, line 66

Returns:

true/false if successful

addLink(key, link)

addLink

Parameters:

Name	Type	Description
`key`		2021-05-17
`link`		string that represents link of media

Source:

js/storage.js, line 79

Returns:

true/false if successful

addTask(key:, task:)

addTask add a task into local storage

Parameters:

Name	Type	Description
`key:`		2021-05-17
`task:`		the json data returned from Task.content

Source:

js/storage.js, line 52

Returns:

true/false if successful

convert12To24(oldTime)

Parameters:

Name	Type	Description
`oldTime`	string	"hh:mm AM"

Source:

js/components/event.js, line 65

Returns:

"hh:mm" (24hr)

convert24To12(oldTime)

Parameters:

Name	Type	Description
`oldTime`	string	"hh:mm (24hr)"

Source:

js/button_controller.js, line 32

Returns:

"hh:mm AM" (12hr)

eventsIntercept(a, b)

returns if events a and b intercept

Parameters:

Name	Type	Description
`a`	Object	an event obj
`b`	Object	an event obj

Source:

js/components/sortEvents.js, line 34

getCustomTagColor(tagName)

get color for a custom tag

Parameters:

Name	Type	Description
`tagName`		string for the name of tag

Source:

js/storage.js, line 140

Returns:

the tag color

getData(key:)

get/set the relevant data for the day specified in key

Parameters:

Name	Type	Description
`key:`		2021-05-17

Source:

js/storage.js, line 12

getDaysKey()

getDaysKey returns a string that represents the key that corresponds to the current date

Source:

js/date.js, line 6

Returns:

2021-05-17

getEventWidths(eventArr)

Parameters:

Name	Type	Description
`eventArr`	Array	event objects eventArr

Source:

js/components/sortEvents.js, line 56

Returns:

array of integers that represent width

getName()

getName Returns a descriptive name for a day.

Source:

js/date.js, line 23

getWeek()

getWeek Returns an array of keys for the days of the week.

Source:

js/date.js, line 36

minutesSinceMidnight(time)

ex: 12:00 AM returns 0

Parameters:

Name	Type	Description
`time`	string

Source:

js/components/sortEvents.js, line 6

populate(key)

Changes the date title, removes existing content, populates page with current date's content

Parameters:

Name	Type	Description
`key`	string	The date of the journal

Source:

js/navigation.js, line 60

populateW(keyT)

Changes the date title, removes existing content, populates page with current date's content

Parameters:

Name	Type	Description
`keyT`	string	The date of the journal

Source:

js/weekly_navigation.js, line 70

rectsIntercept(a, b)

returns if rects a and b intercept

Parameters:

Name	Type	Description
`a`	Object	a rect obj
`b`	Object	a rect obj

Source:

js/components/sortEvents.js, line 44

removeAll()

Removes the current content from the log, notepad, and media tab

Source:

js/navigation.js, line 21

removeAll()

TODO: Removes the current content from the weekly log

Source:

js/weekly_navigation.js, line 29

returnStudentInfo(name, major, gpa)

Print information representing a student. This function will print the values given. This documentation was updated on Thursday, May 27.

Parameters:

Name	Type	Description
`name`	string	The name of the student.
`major`	string	The student's major.
`gpa`	number	The student's GPA.

Source:

ci-cd/jsDocDemo.js, line 7

sortPoints(a, b)

helper function for Array.sort()

Parameters:

Name	Type	Description
`a`	Object	a point obj
`b`	Object	a point obj

Source:

js/components/sortEvents.js, line 24

Returns:

Integer <0 if a < b

test()

temporary test function to satisfy linter

Source:

js/date.js, line 53

test()

temporary test function to satisfy linter dont run this

Source:

js/storage.js, line 169

toggle(elementID, displayType)

Toggle the display of the HTML element with elementID between displayType and none

Parameters:

Name	Type	Description
`elementID`	string	The ID for the HTML element
`displayType`	string	The desired display type

Source:

js/media.js, line 14

toggleOptionsDisplay()

toggle the css display value for the tag selection options

Source:

js/button_controller.js, line 16

updateNotepad(key:, text:)

update paragraph

Parameters:

Name	Type	Description
`key:`		2021-05-17
`text:`		content of the notepad

Source:

js/storage.js, line 157

Returns:

true/false if successful

.onkeyup()

Saves notepad content to localStorage when pressing the navigation button

Source:

js/main.js, line 65

Listens to Events:

sidebarButton#event:onkeyup