Documentation

Back to main page

Modules

ANIMATOR: animates the charts in respect to the elapsed time
COMPARE_ITEMS: manages the 'compare items' window
DATA_LOAD: manages the 'data load' window
DATA: processes and saves data
NODE: saves references to all HTML elements needed by the app
FILE: reads and validates the data from JSON data sets
MAIN: contains main methods to initialize the web app
MSG: manages overlay messages
FOCUS_CHAIN: manages chains of elements that can be focussed via the tab key (hijacks the tab key event, and prevents normal focussing via browser)
NAV: manages the UI of the navigation area
_: contains utility functions
VISUALIZER: generates HTML elements for charts

ANIMATOR

animates the charts in respect to the elapsed time

ANIMATOR

ANIMATOR.initialize()

initializes the animator

Kind: static method of ANIMATOR

ANIMATOR.setSpeed(speed)

sets the speed of the animation

Kind: static method of ANIMATOR

Param	Type
speed	`number`

ANIMATOR.setCSSTransitions()

sets CSS transition duration of animated HTML elements

Kind: static method of ANIMATOR

ANIMATOR.startLoop()

starts the animation loop

Kind: static method of ANIMATOR

ANIMATOR.stopLoop()

stops the animation loop

Kind: static method of ANIMATOR

ANIMATOR.play()

starts the animation

Kind: static method of ANIMATOR

ANIMATOR.pause()

pauses the animation

Kind: static method of ANIMATOR

ANIMATOR.restart()

restarts the animation

Kind: static method of ANIMATOR

ANIMATOR.end()

stops animation without resetting, freezes it in last frame (no 'unpause' possible)

Kind: static method of ANIMATOR

ANIMATOR.stop()

stops animation and resets it to start state

Kind: static method of ANIMATOR

ANIMATOR.update()

called by loop every frame and starts the animation pipeline

Kind: static method of ANIMATOR

ANIMATOR.refreshFrame()

refreshes rendered frame

Kind: static method of ANIMATOR

ANIMATOR.sortItems()

sorts items by their current value in tick

Kind: static method of ANIMATOR

ANIMATOR.updateBarChart()

updates 'bar chart' values for current frame

Kind: static method of ANIMATOR

ANIMATOR.updateRatioChart()

updates 'ratio chart' values for current tick

Kind: static method of ANIMATOR

ANIMATOR.updateLineChart()

updates 'line chart' for current frame

Kind: static method of ANIMATOR

ANIMATOR.drawLineGraph(canvas, context, padding, item_id, min, max)

draws a line graph for an item on the line chart

Kind: static method of ANIMATOR

Param	Type	Description
canvas	`Object`	HTML canvas
context	`Object`	Context of drawing canvas
padding	`Object`	Object holds 4 numbers for the padding on each site of the canvas
item_id	`string`
min	`number`	smallest value of all items displayed in line chart
max	`number`	biggest value of all items displayed in line chart

COMPARE_ITEMS

manages the 'compare items' window

COMPARE_ITEMS
- .setItemIds(ids)
- .addItemId(id)
- .removeItemId(id)
- .hasItemId(id) ⇒ boolean
- .resetItemIds()
- .initialize()
- .openWindow()
- .closeWindow()
- .createButtons()
- .orderButtons()
- .moveButton(e)

COMPARE_ITEMS.setItemIds(ids)

sets items ids to compare in line chart

Kind: static method of COMPARE_ITEMS

Param	Type	Description
ids	`Array`	array of item ids (strings)

COMPARE_ITEMS.addItemId(id)

adds an items id to compare in line chart

Kind: static method of COMPARE_ITEMS

Param	Type	Description
id	`string`	item id

COMPARE_ITEMS.removeItemId(id)

removes an items id, not to compare in line chart

Kind: static method of COMPARE_ITEMS

Param	Type	Description
id	`string`	item id

COMPARE_ITEMS.hasItemId(id) ⇒ `boolean`

check if an item is set to be compared in line chart

Kind: static method of COMPARE_ITEMS
Returns: boolean - true, if the item id is selected for comparison

Param	Type	Description
id	`string`	item id

COMPARE_ITEMS.resetItemIds()

resets item IDs selected for comparison in line chart

Kind: static method of COMPARE_ITEMS

COMPARE_ITEMS.initialize()

initializes the 'compare items' window

Kind: static method of COMPARE_ITEMS

COMPARE_ITEMS.openWindow()

opens the 'compare items' window

Kind: static method of COMPARE_ITEMS

COMPARE_ITEMS.closeWindow()

closes the 'compare items' window

Kind: static method of COMPARE_ITEMS

COMPARE_ITEMS.createButtons()

creates the buttons in the 'compare items' window

Kind: static method of COMPARE_ITEMS

COMPARE_ITEMS.orderButtons()

moves the buttons into the correct position in the window

Kind: static method of COMPARE_ITEMS

COMPARE_ITEMS.moveButton(e)

handles the click on buttons in window for (un-)selecting items for line chart

Kind: static method of COMPARE_ITEMS

Param	Type	Description
e	`event`	click event

DATA_LOAD

manages the 'data load' window

DATA_LOAD
- .initialize()
- .openWindow()
- .closeWindow()
- .getDroppedFile(e) ⇒ Object

DATA_LOAD.initialize()

initializes the 'data load' window

Kind: static method of DATA_LOAD

DATA_LOAD.openWindow()

opens the 'data load' window

Kind: static method of DATA_LOAD

DATA_LOAD.closeWindow()

closes the 'data load' window

Kind: static method of DATA_LOAD

DATA_LOAD.getDroppedFile(e) ⇒ `Object`

gets dropped file from a drop event

Kind: static method of DATA_LOAD
Returns: Object - file

Param	Type	Description
e	`event`	drop event

DATA

processes and saves data

DATA
- .set(obj)
- .setItems(obj)
- .setRange(from, to)
- .setDataPoints(data)
- .getMax(item) ⇒ Object
- .getMin(item) ⇒ Object
- .getMean(item) ⇒ Object
- .getTotalMax(index) ⇒ number
- .getTotalMin(index) ⇒ number
- .getTotalMean(index) ⇒ number
- .calculateFixedData()
- .calculateUpscaledData()
- .calculateStatistics()
- .getItemColor(index) ⇒ string
- .formatNumber(num) ⇒ string

DATA.set(obj)

sets all values for the data set

Kind: static method of DATA

Param	Type	Description
obj	`Object`	JSON data object

DATA.setItems(obj)

sets all meta information of the items

Kind: static method of DATA

Param	Type	Description
obj	`Object`	object holding meta information about the items in the data set

DATA.setRange(from, to)

sets the range for the animation

Kind: static method of DATA

Param	Type	Description
from	`number`	start time
to	`number`	end time

DATA.setDataPoints(data)

sets the data points (original, fixed, upscaled)

Kind: static method of DATA

Param	Type
data	`Object`

DATA.getMax(item) ⇒ `Object`

returns the highest value of item's data points

Kind: static method of DATA
Returns: Object - holding the maximum as 'value' and 'formatted'

Param	Type	Description
item	`string`	item id

DATA.getMin(item) ⇒ `Object`

returns the smallest value of item's data points

Kind: static method of DATA
Returns: Object - holding the minimum as 'value' and 'formatted'

Param	Type	Description
item	`string`	item id

DATA.getMean(item) ⇒ `Object`

returns the mean average value of item's data points

Kind: static method of DATA
Returns: Object - holding the mean average as 'value' and 'formatted'

Param	Type	Description
item	`string`	item id

DATA.getTotalMax(index) ⇒ `number`

returns the highest value of all item at the index

Kind: static method of DATA

Param	Type	Description
index	`number`	tick

DATA.getTotalMin(index) ⇒ `number`

returns the smallest value of all item at the index

Kind: static method of DATA

Param	Type	Description
index	`number`	tick

DATA.getTotalMean(index) ⇒ `number`

returns the mean average value of all item at the index

Kind: static method of DATA

Param	Type	Description
index	`number`	tick

DATA.calculateFixedData()

calculates an object with missing data values being filled in

Kind: static method of DATA

DATA.calculateUpscaledData()

calculates an object with data points increased to (item_num-1)*50+1

Kind: static method of DATA

DATA.calculateStatistics()

calculates the min, max and mean of all data point values for every item

Kind: static method of DATA

DATA.getItemColor(index) ⇒ `string`

returns a HEX color code from a limited selection; depends on given index

Kind: static method of DATA
Returns: string - HEX color code

Param	Type	Description
index	`number`	integer

DATA.formatNumber(num) ⇒ `string`

formats a number to its shortened word equivalent, e.g. 1300000 -> "1.3 Million"

Kind: static method of DATA
Returns: string - formatted number

Param	Type
num	`number`

NODE

saves references to all HTML elements needed by the app

NODE

NODE.initializeDataLoadWindow()

adds missing references to HTML elements for 'data load' window

Kind: static method of NODE

NODE.initializeCompareItemsWindow()

adds missing references to HTML elements for 'compare items' window

Kind: static method of NODE

NODE.initializeBarChart()

adds missing references to HTML elements for 'bar chart'

Kind: static method of NODE

NODE.initialize()

adds missing references to HTML elements

Kind: static method of NODE

FILE

reads and validates the data from JSON data sets

FILE
- .highlightDropArea()
- .unhighlightDropArea()
- .loadURL(url, [showConfirmation]) ⇒ Object
- .process(file)
- .getObjectFromJSON(str) ⇒ Object
- .isValidData(json) ⇒ boolean | string

FILE.highlightDropArea()

adds the 'highlight' effect to the file drop area

Kind: static method of FILE

FILE.unhighlightDropArea()

removes the 'highlight' effect from the file drop area

Kind: static method of FILE

FILE.loadURL(url, [showConfirmation]) ⇒ `Object`

loads a data set from a URL (same origin)

Kind: static method of FILE
Returns: Object - request - XMLHttpRequest

Param	Type	Default	Description
url	`string`		link to JSON data set
[showConfirmation]	`boolean`	`false`	set to true, if a confirmation message that a 'data set' was loaded, should be shown in 'data load' window

FILE.process(file)

reads a JSON file and sends the generated object to MAIN

Kind: static method of FILE

Param	Type	Description
file	`Object`	file reference

FILE.getObjectFromJSON(str) ⇒ `Object`

parses a string into a JSON object

Kind: static method of FILE

Param	Type	Description
str	`string`	JSON data

FILE.isValidData(json) ⇒ `boolean` | `string`

determines if the given data set is valid

Kind: static method of FILE
Returns: boolean - true, if data set is validstring - error message, if it's an invalid object

Param	Type
json	`Object`

MAIN

contains main methods to initialize the web app

MAIN
- .initializeDataSet(str, [showConfirmation])
- .initialize()

MAIN.initializeDataSet(str, [showConfirmation])

takes a data set as a string, and initializes the web app with the values

Kind: static method of MAIN

Param	Type	Default	Description
str	`string`		JSON data as string
[showConfirmation]	`boolean`	`false`	on true, shows a message that a 'data set' was loaded in 'data load' window

MAIN.initialize()

initializes all components of the web app and loads example data set

Kind: static method of MAIN

MSG

manages overlay messages

MSG

MSG.generateHTML(text, type) ⇒ `Object`

generates the HTML for a message element

Kind: static method of MSG
Returns: Object - HTML element

Param	Type	Description
text	`string`	content of the message
type	`string`	type of the message, defined in MSG.type

MSG.show(text, close_after_ms, type)

displays an overlay message

Kind: static method of MSG

Param	Type	Description
text	`string`	content of the message
close_after_ms	`number`	milliseconds until the message gets closed
type	`string`	type of the message, defined in MSG.type

MSG.error(text, close_after_ms)

displays an overlay error message

Kind: static method of MSG

Param	Type	Description
text	`string`	content of the message
close_after_ms	`number`	milliseconds until the message gets closed

MSG.warn(text, close_after_ms)

displays an overlay warning message

Kind: static method of MSG

Param	Type	Description
text	`string`	content of the message
close_after_ms	`number`	milliseconds until the message gets closed

MSG.hide()

hides the current overlay message

Kind: static method of MSG

FOCUS_CHAIN

manages chains of elements that can be focussed via the tab key (hijacks the tab key event, and prevents normal focussing via browser)

FOCUS_CHAIN
- .isActive() ⇒ boolean
- .set(a)
- .reset()
- .event(e)
- .handleSelectionType1(e, go_backwards)
- .handleSelectionType2(e, go_backwards)

FOCUS_CHAIN.isActive() ⇒ `boolean`

checks if the focus chain is currently active

Kind: static method of FOCUS_CHAIN
Returns: boolean - true, if the focus chain is active

FOCUS_CHAIN.set(a)

sets elements as a focus chain

Kind: static method of FOCUS_CHAIN

Param	Type	Description
a	`Array` \| `Object`	either array of HTML elements or object: { start : HTML element (start of chain) end : HTML element (end of chain) container : HTML element (contains all focussable elements in chain) }

FOCUS_CHAIN.reset()

removes the current focus chain

Kind: static method of FOCUS_CHAIN

FOCUS_CHAIN.event(e)

event function that hijacks the tab key event and sets the focus depending on the user's current position in the focus chain

Kind: static method of FOCUS_CHAIN

Param	Type	Description
e	`event`	keydown event

FOCUS_CHAIN.handleSelectionType1(e, go_backwards)

handles setting the user focus if the focus chain consists of an array of elements

Kind: static method of FOCUS_CHAIN

Param	Type	Description
e	`event`	keydown event
go_backwards	`boolean`	if the focus go forward or backwards in focus chain

FOCUS_CHAIN.handleSelectionType2(e, go_backwards)

handles setting the user focus if the focus chain consists of a start and end element

Kind: static method of FOCUS_CHAIN

Param	Type	Description
e	`event`	keydown event
go_backwards	`boolean`	if the focus go forward or backwards in focus chain

NAV

manages the UI of the navigation area

NAV

NAV.initialize()

initializes navigation elements with events

Kind: static method of NAV

NAV.initializeSettingsWindow()

initializes elements in and for settings window

Kind: static method of NAV

NAV.openSettingsWindow()

opens settings window

Kind: static method of NAV

NAV.closeSettingsWindow()

closes settings window

Kind: static method of NAV

NAV.toggleDarkMode()

toggles dark mode setting

Kind: static method of NAV

NAV.enableButton(btn)

enables a button

Kind: static method of NAV

Param	Type	Description
btn	`Object`	HTML element

NAV.disableButton(btn)

disables a button

Kind: static method of NAV

Param	Type	Description
btn	`Object`	HTML element

NAV.onlyEnableButton(btn)

sets a specific 'speed setter' button active and disables all others

Kind: static method of NAV

Param	Type	Description
btn	`Object`	HTML element

NAV.showBarChart()

shows the 'bar chart' and hides the 'line chart'

Kind: static method of NAV

NAV.showLineChart()

shows the 'line chart' and hides the 'bar chart'

Kind: static method of NAV

NAV.setSpeed(e)

sets the animation speed in ANIMATOR relative to the button pressed

Kind: static method of NAV

Param	Type	Description
e	`event`	from click on animation speed buttons

NAV.setCustomSpeed(e)

sets a custom animation speed defined by input value of text input

Kind: static method of NAV

Param	Type	Description
e	`event`	from input on custom animation speed text input

NAV.showCustomSpeedMenu()

shows 'custom speed' menu and hides 'defined speed' menu

Kind: static method of NAV

NAV.showDefinedSpeedMenu()

shows 'defined speed' menu and hides 'custom speed' menu

Kind: static method of NAV

NAV.downloadLineChart()

downloads 'line chart' canvas as .png image

Kind: static method of NAV

_

contains utility functions

_
- .id(selector) ⇒ Object
- .class(selector, [context]) ⇒ HTMLCollection
- .tag(selector, [context]) ⇒ HTMLCollection
- .select(selector, [context], [callback]) ⇒ HTMLCollection
- .contains(parent, child) ⇒ boolean
- .create(str, [settings]) ⇒ Object
- .append(elem1, elem2)
- .prepend(elem1, elem2)
- .after(elem1, elem2)
- .before(elem1, elem2)
- .remove(elem)
- .empty(elem)
- .addEvent(elem, event, fn, [useCapture])
- .removeEvent(elem, event, fn, [useCapture])
- .onClick(elem, fn, [useCapture])
- .removeClick(elem, fn, [useCapture])
- .onInput(elem, fn, [useCapture])
- .removeInput(elem, fn, [useCapture])
- .onLoad(elem, fn, [useCapture])
- .removeLoad(elem, fn, [useCapture])
- .target(e) ⇒ Object
- .preventDefault(e)
- .addClass(elem, class_)
- .removeClass(elem, class_)
- .toggleClass(elem, class_)
- .hasClass(elem, class_) ⇒ boolean
- .getStyle(elem, style) ⇒ string
- .setStyles(elem, styles)
- .getHeight(elem) ⇒ number
- .getWidth(elem) ⇒ number
- .exists(val) ⇒ boolean
- .isElement(val) ⇒ boolean
- .isElementInDOM(val) ⇒ boolean
- .isNodelist(val) ⇒ boolean
- .isHTMLCollection(val) ⇒ boolean
- .isFunction(n) ⇒ boolean
- .isObject(n) ⇒ boolean
- .isArray(n) ⇒ boolean
- .isString(n) ⇒ boolean
- .isNumber(n) ⇒ boolean
- .isInteger(n) ⇒ boolean
- .isFloat(n) ⇒ boolean
- .escapeRegex(str) ⇒ string
- .encodeHTML(str) ⇒ string
- .decodeHTML(str) ⇒ string
- .escapeDoubleQuotes(str) ⇒ string
- .parseJSON(str) ⇒ Object
- .getMean(arr) ⇒ number
- .getMin(arr, [start_minimum]) ⇒ number
- .getMax(arr, [start_maximum]) ⇒ number
- .limitNumber(num, min, max, [callback]) ⇒ number
- .truncate(num) ⇒ number
- .sortArrayObjects(arr, property, [descending]) ⇒ Array
- .isEmptyObject(obj) ⇒ boolean
- .removeArrayIndex(arr, index) ⇒ Array
- .getObjectSize(obj) ⇒ number

_.id(selector) ⇒ `Object`

selects HTML element by id

Kind: static method of _
Returns: Object - if an element was found, returns HTML element

Param	Type	Description
selector	`string`	string containing a HTML id

_.class(selector, [context]) ⇒ `HTMLCollection`

selects HTML element(s) by class

Kind: static method of _
Returns: HTMLCollection - if the selector and context (if given) were valid

Param	Type	Default	Description
selector	`string`		string containing one or multiple space-seperated HTML classes
[context]	`Object`	`document`	container element in which to search for class

_.tag(selector, [context]) ⇒ `HTMLCollection`

selects HTML element(s) by tag

Kind: static method of _
Returns: HTMLCollection - if the selector and context (if given) were valid

Param	Type	Default	Description
selector	`string`		string containing a HTML tag
[context]	`Object`	`document`	container element in which to search for tag

_.select(selector, [context], [callback]) ⇒ `HTMLCollection`

selects HTML element(s) using a CSS selector

Kind: static method of _
Returns: HTMLCollection - if the selector and context (if given) were valid

Param	Type	Default	Description
selector	`string`		string containing a valid CSS selector
[context]	`Object`	`document`	container element in which to search
[callback]	`function`		called when querySelector is not supported by browser

_.contains(parent, child) ⇒ `boolean`

check if the first HTML element contains the second

Kind: static method of _
Returns: boolean - returns true if the first HTML element contains the second

Param	Type	Description
parent	`Object`	supposed parent HTML element
child	`Object`	supposed child HTML element

_.create(str, [settings]) ⇒ `Object`

creates a new HTML element

Kind: static method of _
Returns: Object - created HTML element

Param	Type	Description
str	`string`	selector in the form of tag#id.class1.class2
[settings]	`Object`	object holding the HTML and style properties

_.append(elem1, elem2)

appends elem2 in elem1

Kind: static method of _

Param	Type	Description
elem1	`Object`	HTML element
elem2	`Object`	HTML element to append

_.prepend(elem1, elem2)

prepends elem2 in elem1

Kind: static method of _

Param	Type	Description
elem1	`Object`	HTML element
elem2	`Object`	HTML element to prepend

_.after(elem1, elem2)

inserts elem2 after elem1

Kind: static method of _

Param	Type	Description
elem1	`Object`	HTML element
elem2	`Object`	HTML element to insert

_.before(elem1, elem2)

inserts elem2 before elem1

Kind: static method of _

Param	Type	Description
elem1	`Object`	HTML element
elem2	`Object`	HTML element to insert

_.remove(elem)

removes a HTML element from the DOM

Kind: static method of _

Param	Type	Description
elem	`Object`	HTML element

_.empty(elem)

removes all child HTML elements of a HTML element

Kind: static method of _

Param	Type	Description
elem	`Object`	HTML element

_.addEvent(elem, event, fn, [useCapture])

adds an event listener to a HTML element

Kind: static method of _

Param	Type	Default	Description
elem	`Object`		HTML element
event	`string`		event type
fn	`function`		function to be called when the event is triggered
[useCapture]	`boolean`	`false`

_.removeEvent(elem, event, fn, [useCapture])

removes an event listener from a HTML element

Kind: static method of _

Param	Type	Default	Description
elem	`Object`		HTML element on which the event was defined
event	`string`		event type
fn	`function`		function that was defined to be triggered from the event
[useCapture]	`boolean`	`false`	the same useCapture value defined when creating the event

_.onClick(elem, fn, [useCapture])

adds a 'click' event listener to a HTML element

Kind: static method of _

Param	Type	Default	Description
elem	`Object`		HTML element
fn	`function`		function called on trigger
[useCapture]	`boolean`	`false`

_.removeClick(elem, fn, [useCapture])

removes a 'click' event listener with the given parameters from a HTML element

Kind: static method of _

Param	Type	Default	Description
elem	`Object`		HTML element
fn	`function`		function
[useCapture]	`boolean`	`false`

_.onInput(elem, fn, [useCapture])

adds an 'input' event listener to a HTML element

Kind: static method of _

Param	Type	Default	Description
elem	`Object`		HTML element
fn	`function`		function called on trigger
[useCapture]	`boolean`	`false`

_.removeInput(elem, fn, [useCapture])

removes an 'input' event listener with the given parameters from a HTML element

Kind: static method of _

Param	Type	Default	Description
elem	`Object`		HTML element
fn	`function`		function
[useCapture]	`boolean`	`false`

_.onLoad(elem, fn, [useCapture])

adds a 'load' event listener to a HTML element

Kind: static method of _

Param	Type	Default	Description
elem	`Object`		HTML element
fn	`function`		function called on trigger
[useCapture]	`boolean`	`false`

_.removeLoad(elem, fn, [useCapture])

removes a 'load' event listener with the given parameters from a HTML element

Kind: static method of _

Param	Type	Default	Description
elem	`Object`		HTML element
fn	`function`		function
[useCapture]	`boolean`	`false`

_.target(e) ⇒ `Object`

returns the target element of an event object

Kind: static method of _
Returns: Object - target HTML element

Param	Type	Description
e	`event`	HTML element on which the event was defined

_.preventDefault(e)

prevents default event actions happening for this specific event

Kind: static method of _

Param	Type
e	`event`

.addClass(elem, class)

adds class to HTML element

Kind: static method of _

Param	Type	Description
elem	`Object`	HTML element
class_	`string`	class name (using multiple class names may not work in older browsers)

.removeClass(elem, class)

removes class from HTML element

Kind: static method of _

Param	Type	Description
elem	`Object`	HTML element
class_	`string`	class name (using multiple class names may not work in older browsers)

.toggleClass(elem, class)

toggles class on and off on HTML element

Kind: static method of _

Param	Type	Description
elem	`Object`	HTML element
class_	`string`	class name (using multiple class names may not work in older browsers)

.hasClass(elem, class) ⇒ `boolean`

checks if the HTML element has the given class

Kind: static method of _
Returns: boolean - true, if HTML element has the given class

Param	Type	Description
elem	`Object`	HTML element
class_	`string`	single class name

_.getStyle(elem, style) ⇒ `string`

returns value of given css property

Kind: static method of _
Returns: string - CSS property value

Param	Type	Description
elem	`Object`	HTML element
style	`string`	CSS property name

_.setStyles(elem, styles)

sets the given CSS property values to the HTML element

Kind: static method of _

Param	Type	Description
elem	`Object`	HTML element
styles	`Object`	Object holding key (CSS property name) and value (CSS property value) pairs

_.getHeight(elem) ⇒ `number`

returns browser-rendered height of HTML element

Kind: static method of _
Returns: number - height in pixels

Param	Type	Description
elem	`Object`	HTML element

_.getWidth(elem) ⇒ `number`

returns browser-rendered width of HTML element

Kind: static method of _
Returns: number - width in pixels

Param	Type	Description
elem	`Object`	HTML element

_.exists(val) ⇒ `boolean`

check if a value is defined and not null

Kind: static method of _
Returns: boolean - returns true if the element exists

Param	Type
val	`*`

_.isElement(val) ⇒ `boolean`

check if a value is a HTML element

Kind: static method of _

Param	Type
val	`*`

_.isElementInDOM(val) ⇒ `boolean`

check if a value is a HTML element in the DOM

Kind: static method of _

Param	Type
val	`*`

_.isNodelist(val) ⇒ `boolean`

check if a value is a HTML Nodelist

Kind: static method of _

Param	Type
val	`*`

_.isHTMLCollection(val) ⇒ `boolean`

check if a value is a HTMLCollection

Kind: static method of _

Param	Type
val	`*`

_.isFunction(n) ⇒ `boolean`

tests if variable is a function

Kind: static method of _
Returns: boolean - true, if variable is a function

Param	Type
n	`*`

_.isObject(n) ⇒ `boolean`

tests if variable is an object (excluding null object)

Kind: static method of _
Returns: boolean - true, if variable is an object (excluding null)

Param	Type
n	`*`

_.isArray(n) ⇒ `boolean`

tests if variable is an array

Kind: static method of _
Returns: boolean - true, if variable is an array

Param	Type
n	`*`

_.isString(n) ⇒ `boolean`

tests if variable is a string

Kind: static method of _
Returns: boolean - true, if variable is a string

Param	Type
n	`*`

_.isNumber(n) ⇒ `boolean`

tests if variable is a number

Kind: static method of _
Returns: boolean - true, if variable is a number

Param	Type
n	`*`

_.isInteger(n) ⇒ `boolean`

tests if variable is an integer

Kind: static method of _
Returns: boolean - true, if variable is an integer

Param	Type
n	`*`

_.isFloat(n) ⇒ `boolean`

tests if variable is a float (floating point number)

Kind: static method of _
Returns: boolean - true, if variable is a float

Param	Type
n	`*`

_.escapeRegex(str) ⇒ `string`

escapes string to be regex-compatible

Kind: static method of _
Returns: string - escaped regex-friendly string

Param	Type
str	`string`

_.encodeHTML(str) ⇒ `string`

encodes HTML reserved characters in a string

Kind: static method of _
Returns: string - encoded HTML-friendly string

Param	Type
str	`string`

_.decodeHTML(str) ⇒ `string`

decodes HTML reserved characters in a string

Kind: static method of _
Returns: string - decoded string

Param	Type
str	`string`

_.escapeDoubleQuotes(str) ⇒ `string`

escapes the double quotes in a string

Kind: static method of _

Param	Type
str	`string`

_.parseJSON(str) ⇒ `Object`

parses a string containing JSON data and returns it as an object

Kind: static method of _
Returns: Object - object with JSON structure

Param	Type	Description
str	`string`	JSON string

_.getMean(arr) ⇒ `number`

returns the mean average of an array of number

Kind: static method of _
Returns: number - average of numbers

Param	Type	Description
arr	`Array`	array of numbers

_.getMin(arr, [start_minimum]) ⇒ `number`

returns the smallest number of an array of number

Kind: static method of _
Returns: number - smallest number

Param	Type	Default	Description
arr	`Array`		array of numbers
[start_minimum]	`number`	`Number.MAX_VALUE`	returned number needs to be smaller than this number

_.getMax(arr, [start_maximum]) ⇒ `number`

returns the biggest number of an array of number

Kind: static method of _
Returns: number - biggest number

Param	Type	Default	Description
arr	`Array`		array of numbers
[start_maximum]	`number`	`Number.MIN_VALUE`	returned number needs to be at least this big

_.limitNumber(num, min, max, [callback]) ⇒ `number`

replaces a number if it exceeds the given upper or lower limit

Kind: static method of _
Returns: number - 'num' (or the closest number to it in range of min to max)

Param	Type	Description
num	`number`	number to process
min	`number`	smallest the number is allowed to be
max	`number`	biggest the number is allowed to be
[callback]	`function`	called if the number had been below or above the limit

_.truncate(num) ⇒ `number`

strips digits after comma from a number

Kind: static method of _
Returns: number - truncated number

Param	Type	Description
num	`number`	number to truncate

_.sortArrayObjects(arr, property, [descending]) ⇒ `Array`

sort array containing objects with the same key structure by the values of a given property

Kind: static method of _
Returns: Array - sorted array

Param	Type	Default	Description
arr	`Array`		array containing objects with the same key structure
property	`string`		property name (key) by which values to sort
[descending]	`Array`	`false`	final order of sorted values

_.isEmptyObject(obj) ⇒ `boolean`

check if an object is empty

Kind: static method of _
Returns: boolean - true, if the object is empty

Param	Type
obj	`Object`

_.removeArrayIndex(arr, index) ⇒ `Array`

removes an index from an array

Kind: static method of _
Returns: Array - array without this index

Param	Type	Description
arr	`Array`
index	`number`	index position to remove

_.getObjectSize(obj) ⇒ `number`

returns the amount of keys in an object

Kind: static method of _

Param	Type
obj	`Object`

VISUALIZER

generates HTML elements for charts

VISUALIZER
- .createCharts()
- .getBar(item_id) ⇒ Object
- .getRatioPart(item_id) ⇒ Object
- .openLineChartOnClick(event)
- .generateStatistics()
- .getStatisticPart(index, dominant_metric) ⇒ Object
- .sortStatistics(metric)

VISUALIZER.createCharts()

creates the HTML elements needed for the charts using current DATA

Kind: static method of VISUALIZER

VISUALIZER.getBar(item_id) ⇒ `Object`

generates HTML element for a item in the bar chart

Kind: static method of VISUALIZER
Returns: Object - multiple HTML elements in object

Param	Type
item_id	`string`

VISUALIZER.getRatioPart(item_id) ⇒ `Object`

generates HTML element for item in ratio chart

Kind: static method of VISUALIZER
Returns: Object - multiple HTML elements in object

Param	Type
item_id	`string`

VISUALIZER.openLineChartOnClick(event)

called by a click event to open a specific line chart

Kind: static method of VISUALIZER

Param	Type	Description
event	`e`	click event

VISUALIZER.generateStatistics()

generates full statistics HTML section

Kind: static method of VISUALIZER

VISUALIZER.getStatisticPart(index, dominant_metric) ⇒ `Object`

generates a HTML element containing a HTML structure with statistical information about an item

Kind: static method of VISUALIZER
Returns: Object - HTML element

Param	Type	Description
index	`integer`	Index in statistics array
dominant_metric	`string`	Sorting metric by which the statistic is currently sorted

VISUALIZER.sortStatistics(metric)

sorts items in statistic by a certain metric

Kind: static method of VISUALIZER

Param	Type	Description
metric	`string`	Sorting metric: min

Files

documentation.md

Latest commit

History

documentation.md

File metadata and controls

Documentation

Modules

ANIMATOR

ANIMATOR.initialize()

ANIMATOR.setSpeed(speed)

ANIMATOR.setCSSTransitions()

ANIMATOR.startLoop()

ANIMATOR.stopLoop()

ANIMATOR.play()

ANIMATOR.pause()

ANIMATOR.restart()

ANIMATOR.end()

ANIMATOR.stop()

ANIMATOR.update()

ANIMATOR.refreshFrame()

ANIMATOR.sortItems()

ANIMATOR.updateBarChart()

ANIMATOR.updateRatioChart()

ANIMATOR.updateLineChart()

ANIMATOR.drawLineGraph(canvas, context, padding, item_id, min, max)

COMPARE_ITEMS

COMPARE_ITEMS.setItemIds(ids)

COMPARE_ITEMS.addItemId(id)

COMPARE_ITEMS.removeItemId(id)

COMPARE_ITEMS.hasItemId(id) ⇒ boolean

COMPARE_ITEMS.resetItemIds()

COMPARE_ITEMS.initialize()

COMPARE_ITEMS.openWindow()

COMPARE_ITEMS.closeWindow()

COMPARE_ITEMS.createButtons()

COMPARE_ITEMS.orderButtons()

COMPARE_ITEMS.moveButton(e)

DATA_LOAD

DATA_LOAD.initialize()

DATA_LOAD.openWindow()

DATA_LOAD.closeWindow()

DATA_LOAD.getDroppedFile(e) ⇒ Object

DATA

DATA.set(obj)

DATA.setItems(obj)

DATA.setRange(from, to)

DATA.setDataPoints(data)

DATA.getMax(item) ⇒ Object

DATA.getMin(item) ⇒ Object

DATA.getMean(item) ⇒ Object

DATA.getTotalMax(index) ⇒ number

DATA.getTotalMin(index) ⇒ number

DATA.getTotalMean(index) ⇒ number

DATA.calculateFixedData()

DATA.calculateUpscaledData()

DATA.calculateStatistics()

DATA.getItemColor(index) ⇒ string

DATA.formatNumber(num) ⇒ string

NODE

NODE.initializeDataLoadWindow()

NODE.initializeCompareItemsWindow()

NODE.initializeBarChart()

NODE.initialize()

FILE

FILE.highlightDropArea()

FILE.unhighlightDropArea()

FILE.loadURL(url, [showConfirmation]) ⇒ Object

FILE.process(file)

FILE.getObjectFromJSON(str) ⇒ Object

FILE.isValidData(json) ⇒ boolean | string

MAIN

MAIN.initializeDataSet(str, [showConfirmation])

MAIN.initialize()

MSG

MSG.generateHTML(text, type) ⇒ Object

MSG.show(text, close_after_ms, type)

MSG.error(text, close_after_ms)

MSG.warn(text, close_after_ms)

MSG.hide()

COMPARE_ITEMS.hasItemId(id) ⇒ `boolean`

DATA_LOAD.getDroppedFile(e) ⇒ `Object`

DATA.getMax(item) ⇒ `Object`

DATA.getMin(item) ⇒ `Object`

DATA.getMean(item) ⇒ `Object`

DATA.getTotalMax(index) ⇒ `number`

DATA.getTotalMin(index) ⇒ `number`

DATA.getTotalMean(index) ⇒ `number`

DATA.getItemColor(index) ⇒ `string`

DATA.formatNumber(num) ⇒ `string`

FILE.loadURL(url, [showConfirmation]) ⇒ `Object`

FILE.getObjectFromJSON(str) ⇒ `Object`

FILE.isValidData(json) ⇒ `boolean` | `string`

MSG.generateHTML(text, type) ⇒ `Object`

FOCUS_CHAIN.isActive() ⇒ `boolean`

_.id(selector) ⇒ `Object`

_.class(selector, [context]) ⇒ `HTMLCollection`

_.tag(selector, [context]) ⇒ `HTMLCollection`

_.select(selector, [context], [callback]) ⇒ `HTMLCollection`

_.contains(parent, child) ⇒ `boolean`

_.create(str, [settings]) ⇒ `Object`

_.target(e) ⇒ `Object`

.hasClass(elem, class) ⇒ `boolean`

_.getStyle(elem, style) ⇒ `string`

_.getHeight(elem) ⇒ `number`

_.getWidth(elem) ⇒ `number`

_.exists(val) ⇒ `boolean`

_.isElement(val) ⇒ `boolean`

_.isElementInDOM(val) ⇒ `boolean`

_.isNodelist(val) ⇒ `boolean`

_.isHTMLCollection(val) ⇒ `boolean`

_.isFunction(n) ⇒ `boolean`

_.isObject(n) ⇒ `boolean`

_.isArray(n) ⇒ `boolean`

_.isString(n) ⇒ `boolean`