SAGE2: SAGE2_runtime

Add a key-value pair as a cookie

• sKey <String>

  key

• sValue <String>

  value

Test if all values of an object are true

• dict <Object>

  values

Calculate the average value of an array

• arr <Array>

  values to be averaged

Decode base64 into string

• base64 <String>

  content to be decoded

Convert a string to Uint8Array typed array

• base64 <String>

  string to be converted

Send the broadcast call to the server

• dataObject <Object>

  data to be sent

Convert an array of byte to an integer

• buff <Array>

  buffer to be processed

Convert an array of byte to a string (using fromCharCode on every character)

• buff <Array>

  buffer to be processed

Cleanup a URL and replace the origin to match the client (to mitigate CORS problems, cross-origin resource sharing)

• url <String>

  URL to clenaup

From stackoverflow: Copies a string to the clipboard. Must be called from within an event handler such as click. May return false if it failed, but this is not always possible. Browser support for Chrome 43+, Firefox 42+, Safari 10+, Edge and IE 10+. IE: The clipboard feature may be disabled by an administrator. By default a prompt is shown the first time the clipboard is used (per session)

• text <String>

  The text to be copied

Basic function for creating a canvas in the DOM

• id <String>

  DOM id to be created

• className <String>

  CSS class

• posx <Number>

  position x

• posy <Number>

  position y

• width <Number>

  width (number in pixel)

• height <Number>

  height (number in pixel)

• depth <Number>

  z index

Convert CSV data to an array (used by the readFile function)

• strData <String>

  data to be converter

• strDelimiter <String>

  string delimter (parsing using RegExp)

Delete a cookie for a given key

• sKey <String>

  key

Delete an element in the DOM

• id <Element>

  DOM element to delete

Convert date into 24h string format

• date <Object>

  momentjs object for time

Pretty print a date object into string

• date <Object>

  momentjs object for time

Convert a duration number into readable string

• duration <Number>

  duration

Return a cookie value for given key

• sKey <String>

  key

Extract the parameter value from the current URL (?clientID=0&param=4)

• name <String>

  parameter to search for

Extract translate and scale from a DOM element

• elem <Object>

  DOM element

Create an array of given size filled with a value

• size <Number>

  size of the array

• value <Value>

  initial value

Test is an object is equivalen to 'empty'

• obj <Object>

  value to be tested

Test if element is equal to true (used in .every call on an array)

• element <Bool>

  The current element being processed in the array

• index <Number>

  The index of the current element being processed in the array

• array <Array>

  The array every was called upon

Debug log function: send parameters to server for printout if mutiple paramters, sent as one array

• obj <Object>

  data to be printed

Overload Math.seed and Math.random to be deterministic, for distributed work

• s <Number>

  seed

Reorder elements at given level in the DOM

• elem <Element>

  DOM element to reorder

Utility function to test if a string or number represents a true value. Used for parsing JSON values

• value <Object>

  value to test

Search for a video tag and switch its state

• elemId <String>

  video element to search

Do a HTTP GET request to the server to retrieve a file content

• filename <String>

  URL of the file to be read

• callback <Function>

  called when data is received: callback(err, data)

• type <String>

  type of data: TEXT, JSON, CSV, or SVG

Remove of children of a DOM element

• node <Element | String>

  id or node to be processed

Detect the current browser

Initializes global settings: random generator, ...

• data_seed <Date>

  seed number

Pretty print in browser and send to server

• msgObject <Object>

  data to be printed

Smallest transparent image, put in a image tag source

Smallest white image, put in a image tag source

Encode a string to base64

• string <String>

  content to be encoded

Convert a string to Uint8Array typed array

• string <String>

  string to be converted