Global

Members

(constant) LEGENDHEIGHT

Description:

• Draw the legend floating above the 3d display

Source:

• 3d.js , line 375

(constant) MIN_WIDTH

Description:

• set the size of the nodes proportional to the selected metric

Source:

• prsm.js , line 5214

(constant) SHORTLABELLEN

Description:

• shorten the label if necessary and add an ellipsis

Source:

• utils.js , line 823

(constant) TITLELISTLEN

Description:

• Add this title to the local record of maps used The list is stored as an object so that it is easy to add [room, title] pairs and easy to modify the title of an existing room

Source:

• prsm.js , line 3088

inAddMode :string|boolean

Source:

• prsm.js , line 155

Type:

• string | boolean

(constant) maxScale

Description:

• save the map as a PNG image file

Source:

• files.js , line 1687

(constant) portrait

Description:

• Hack to get window size when orientation changes. Should use screen.orientation, but this is not implemented by Safari

Source:

• prsm.js , line 1082

(constant) resizeBox

Description:

• ImageHandler works differently. The image is read from a file and put into a element as a dataURI. When the user is satisfied, indicated by clicking outside the image, it is drawn on the main canvas.

  Selecting the file is handled within the selectTool fn, not here, because of the restriction that file dialogs can only be opended from direct user action.

Source:

• paint.js , line 886

(constant) rgbIsLight

Description:

• Determine whether the RGB color is light or not http://www.w3.org/TR/AERT#color-contrast

Source:

• utils.js , line 712

Methods

DOMtoCanvasX ()

Description:

• allow for the canvas being translated, returning a coordinate adjusted for the current translation and zoom, so that it is relative to the origin at the centre with scale = 1.

Source:

• paint.js , line 1136

addColumn ()

Description:

• user has clicked the button to add a column for a user-defined attribute

Source:

• table.js , line 1560

addContextMenu (elem, menu)

Description:

• Create a context menu that pops up when elem is right clicked

Source:

• utils.js , line 483

Parameters:

addEventListeners ()

Description:

• Set up all the permanent event listeners

Source:

• prsm.js , line 217

addLabel (item, cancelAction, callback)

Description:

• A factor is being created: get its label from the user

Source:

• prsm.js , line 2628

Parameters:

(async) addRollbackIcon (e)

Description:

• add a button for rolling back if there is state data corresponding to this log record

Source:

• prsm.js , line 5362

Parameters:

addVec (v1, v2) → {array}

Description:

• v1 + v2

Source:

• trophic.js , line 142

Parameters:

Returns:

Type

array

alertMsg (msg, status opt , dontFade opt )

Description:

• show alert messages at the bottom of the window

Source:

• utils.js , line 765

Parameters:

analyse ()

Description:

• Hide factors and links to show only those closest to the selected factors and/or those up/downstream and/or those on paths between the selected factors

Source:

• prsm.js , line 4830

anon ()

Description:

• anonymise a map by removing all user names

Source:

• merge.js , line 412

antMarch (left, top, width, height)

Description:

• draw 'marching ants' around a rectangle

Source:

• paint.js , line 1068

Parameters:

applyOptions (ctx, options)

Description:

• apply the canvas options to the context

Source:

• paint.js , line 1302

Parameters:

applySampleToLink (event)

Description:

• Apply the sample's format to the selected links

Source:

• prsm.js , line 3862

Parameters:

arrayBufferToString (contents)

Description:

• convert an ArrayBuffer to String

Source:

• files.js , line 242

Parameters:

Returns:

arrowMove (direction)

Description:

• move the selected object by ARROWINCR in the given direction

Source:

• background.js , line 778

Parameters:

asleep (isSleeping)

Description:

• Set the awareness local state to show whether this client is sleeping (no mouse movement for 15 minutes)

Source:

• prsm.js , line 5509

Parameters:

autoLayout ()

Description:

• Choose and apply a layout algorithm

Source:

• prsm.js , line 4361

betweenness (graph) → {object|null}

Description:

• Calculate betweenness centrality for all nodes in the graph, using caching

Source:

• betweenness.js , line 60

Parameters:

Returns:

Type

object | null

betweenness1 (graph) → {object}

Description:

• Calculate betweenness centrality using Brandes' algorithm

Source:

• betweenness.js , line 100

Parameters:

Returns:

Type

object

bringToFront (obj)

Description:

• bring the given object to the front of the canvas

Source:

• background.js , line 726

Parameters:

buttonIsDisabled (id)

Description:

• Returns true if the button is not disabled

Source:

• prsm.js , line 3562

Parameters:

Returns:

cancelAdd (callback)

Description:

• User has pressed 'cancel' - abandon adding a node and hide the dialog

Source:

• prsm.js , line 2599

Parameters:

cancelAlertMsg ()

Description:

• cancel the alert message

Source:

• utils.js , line 797

cancelEdit (item, callback opt )

Description:

• User has pressed 'cancel' - abandon the edit and hide the dialog

Source:

• prsm.js , line 2609

Parameters:

cancelHiddenStyles ()

Description:

• Unset the indicators on the Settings Factor and Link tabs that show that Factors/Links with these styles are hidden Assumes that the factors and links have already been unhidden - this just removes the UI indicators

Source:

• prsm.js , line 5188

cancelLoading ()

Description:

• After the Factor tab is loaded, cancel the Loading... dots

Source:

• table.js , line 727

cancelViewOnly ()

Description:

• cancel View Only mode (only available via the console)

Source:

• prsm.js , line 1117

changeCursor (newCursorStyle)

Description:

• Change the cursor style for the net pane and nav bar

Source:

• prsm.js , line 3030

Parameters:

changeRoom (event)

Description:

• User has clicked one of the previous map titles - confirm and change to the web page for that room

Source:

• prsm.js , line 3139

Parameters:

checkComplete (graph) → {boolean}

Description:

• Check whether all edges are connected to existing nodes

Source:

• betweenness.js , line 37

Parameters:

Returns:

Type

boolean

circleIntersectsRect (circle, rect) → {boolean}

Description:

• tests whether any part of the circle overlaps the rectangle

Source:

• background.js , line 2409

Parameters:

Returns:

Type

boolean

clean (source, propsToRemove)

Description:

• return a copy of an object, with the properties in the object propsToRemove removed

Source:

• utils.js , line 250

Parameters:

cleanArray (arr, propsToRemove)

Description:

• remove the given properties from all the objects in the array

Source:

• utils.js , line 262

Parameters:

cleanLocalStorage (preserve)

Description:

• remove any crud in Local storage

Source:

• utils.js , line 1303

Parameters:

clearLegend ()

Description:

• remove the legend from the map

Source:

• styles.js , line 876

clearMap ()

Description:

• clear the map by destroying all nodes and edges and background objects

Source:

• prsm.js , line 2077

clearPopUp ()

Description:

• Hide the editing dialog box

Source:

• prsm.js , line 2581

clearStatusBar ()

Description:

• remove any previous message from the status bar

Source:

• utils.js , line 815

closeFilter ()

Description:

• Close the filter dialog and remove the filter (i.e. display all rows)

Source:

• table.js , line 1715

closeOptionsDialogs ()

Description:

• remove any option dialog that is open and currently displayed

Source:

• background.js , line 566

closeOptionsDialogs ()

Description:

• remove any option dialog that is open

Source:

• paint.js , line 207

cluster (attribute) → {void}

Description:

• Cluster nodes according to the selected attribute.

  This is the public entrypoint used by the UI to apply clustering.

Source:

• cluster.js , line 46

Parameters:

Returns:

Type

void

clusterByAttribute (attribute)

Source:

• cluster.js , line 73

Parameters:

clusterByColor () → {void}

Description:

• Cluster nodes by their background color.

  Groups nodes that share the same standardized background color and creates a cluster node placed at the members' centroid.

Source:

• cluster.js , line 104

Returns:

Type

void

clusterByLouvain () → {void}

Description:

• Clusters the nodes in the graph using the Louvain method.

Source:

• cluster.js , line 162

Returns:

Type

void

clusterByStyle () → {void}

Description:

• Cluster nodes by their visual style group.

  Groups nodes by their grp value (visual style) and creates cluster nodes using the style's configured color and label.

Source:

• cluster.js , line 136

Returns:

Type

void

clusterGroups (groups, makeProps)

Description:

• Generic grouping-based clustering routine. Builds cluster nodes for each entry in groups using the provided makeProps(key, members) function which must return { id, label, color }.

Source:

• cluster.js , line 213

Parameters:

clusterImage (color)

Description:

• Return a data url for an image to represent a cluster shaded with the given colour

Source:

• cluster.js , line 247

Parameters:

Returns:

collapseColGroup (table, field)

Description:

• hides (or shows) all but the first column in the column group and replaces the column group header

Source:

• table.js , line 762

Parameters:

collapseNotes (table, field)

Description:

• reduce (and shorten the notes text) or expand the width of the Notes column

Source:

• table.js , line 786

Parameters:

colorEditor (cell, onRendered, success) → {HTMLElement}

Description:

• Use the browser standard color picker to edit the cell colour

Source:

• table.js , line 1528

Parameters:

Returns:

Type

HTMLElement

connected (a)

Description:

• check that all nodes are connected to at least one other node i.e. every row includes at least one 1

Source:

• trophic.js , line 69

Parameters:

connectedComponents (data)

Description:

• given a complete set of edges, returns a list of lists of edges, each list being the edges of a connected component

Source:

• trophic.js , line 345

Parameters:

convertDashes (val)

Description:

• Convert from dashed menu selection to style object properties

Source:

• utils.js , line 385

Parameters:

convertData () → {object}

Description:

• Convert the map data from PRSM format to 3d display format Avoid cluster nodes Add lists of links and neighbours to each node

Source:

• 3d.js , line 178

Returns:

Type

object

convertEdge (edge)

Description:

• Convert an edge from the normal PRSM format to the one required by the 3d display

Source:

• 3d.js , line 163

Parameters:

Returns:

convertEdge (edge) → {object}

Description:

• spread some deep values to the top level to suit the requirements of the Tabulator package better NB: any such converted values cannot then be edited without special attention (in updateEdgeCellData)

Source:

• table.js , line 1381

Parameters:

Returns:

Type

object

convertEdgeBack (edge, field, value)

Description:

• Convert the properties of the edge back into the format required by vis-network

Source:

• table.js , line 1451

Parameters:

convertNode (node)

Description:

• Convert a node from the normal PRSM format to the one required by the 3d display

Source:

• 3d.js , line 149

Parameters:

Returns:

convertNode (node) → {object}

Description:

• spread some deep values to the top level to suit the requirements of the Tabulator package better NB: any such converted values cannot then be edited without special attention (in updateEdgeCellData)

Source:

• table.js , line 981

Parameters:

Returns:

Type

object

convertNodeBack (node, field, value)

Description:

• Convert the properties of the node back into the format required by vis-network

Source:

• table.js , line 1062

Parameters:

(async) copyAsText (text) → {Promise.<boolean>}

Description:

• copy the given text to the clipboard

Source:

• background.js , line 2135

Parameters:

Returns:

Type

Promise.<boolean>

copyBackgroundToClipboard (event)

Description:

• Copy the selected objects to the clipboard NB this doesn't yet work in Firefox, as they haven't implemented the Clipboard API and Permissions yet.

Source:

• background.js , line 2106

Parameters:

copyHistoryToClipboard (event)

Description:

• copy the contents of the history log to the clipboard

Source:

• prsm.js , line 2439

Parameters:

copyTable ()

Description:

• Copy the all or filtered rows of the table to the clipboard If some rows are selected, only those will be copied (see the clipboardCopyRowRange option in the table definitions)

Source:

• table.js , line 1728

copyToClipboard (event)

Description:

• Copy the selected nodes and links to the clipboard NB this doesn't yet work in Firefox, as they haven't implemented the Clipboard API and Permissions yet.

Source:

• prsm.js , line 2402

Parameters:

createTitleDropDown ()

Description:

• Create a drop down list of previous maps used for user selection

Source:

• prsm.js , line 3106

deepCopy (obj)

Description:

• returns a deep copy of the object original replaced by new built-in

Source:

• utils.js , line 181

Parameters:

deleteActiveObjects ()

Description:

• makes the active objects invisible this allows 'undo' to re-instate the objects, by making them visible

Source:

• background.js , line 1588

deleteColumn (column)

Description:

• delete the column from the table and mark the data as deleted

Source:

• table.js , line 1578

Parameters:

deleteNode ()

Description:

• Delete the selected node, plus all the edges that connect to it (so no edge is left dangling)

Source:

• prsm.js , line 3577

deselectTool ()

Description:

• unmark the selected tool, unselect the active object, close the option dialog and set tool to null

Source:

• background.js , line 544

deselectTool ()

Description:

• unmark the selected tool, close the option dialog and set tool to null

Source:

• paint.js , line 196

diag (v) → {Array.<array>}

Description:

• create a zero matrix with v as the leading diagonal

Source:

• trophic.js , line 187

Parameters:

Returns:

Type

Array.<array>

diffMaps ()

Description:

• Print to console the differences between the given map and the current map

Source:

• merge.js , line 244

display (backColor)

Description:

• Display the map as a 3D network

Source:

• 3d.js , line 210

Parameters:

displayHelp ()

Description:

• display help page in a separate window

Source:

• utils.js , line 1296

displayNetPane (msg)

Description:

• Once any existing map has been loaded, fit it to the pane and reveal it

Source:

• prsm.js , line 1044

Parameters:

displayWhatsNew ()

Description:

• show the What's New modal dialog unless this is a new user or user has already seen this dialog for this (Major.Minor) version

Source:

• prsm.js , line 419

doSearch ()

Description:

• do the search using the string in the search bar and, when found, focus on that node

Source:

• prsm.js , line 3755

dragElement (el, header)

Description:

• allow user to drag the element that has a header element that acts as the handle

Source:

• utils.js , line 406

Parameters:

draw ()

Description:

• draw the network, after setting the vis-network options

Source:

• prsm.js , line 1192

drawBadges (ctx)

Description:

• draw badges (icons) around Factors and Links

Source:

• prsm.js , line 2279

Parameters:

drawGrid (netctx)

Description:

• draw a faint evenly spaced grid over the drawing area

Source:

• paint.js , line 1187

Parameters:

drawMinimap (ratio opt )

Description:

• Draw the minimap, which is a scaled down version of the network with a 'radar' overlay showing the current view

Source:

• prsm.js , line 1875

Parameters:

duplEdge (from, to)

Description:

• if there is already a link from the 'from' node to the 'to' node, return it

Source:

• prsm.js , line 3018

Parameters:

edgeListToAdjMatrix (v, nodes)

Description:

• convert a vector of objects, each an edge referencing from and to nodes to an adjacency matrix. nodes is a list of nodes that acts as the index for the adj. matrix.

Source:

• trophic.js , line 322

Parameters:

Returns:

editEdge (item, point, cancelAction, callback)

Description:

• Draw a dialog box for user to edit an edge

Source:

• prsm.js , line 2891

Parameters:

editLinkStyle (styleElement, groupId)

Description:

• open the dialog to edit a link style

Source:

• styles.js , line 603

Parameters:

editNode (item, point, cancelAction, callback)

Description:

• Draw a dialog box for user to edit a node

Source:

• prsm.js , line 2676

Parameters:

editNodeStyle (styleElement, groupId)

Description:

• open the dialog to edit a node style

Source:

• styles.js , line 415

Parameters:

elem (id)

Description:

• return the HTML element with the id

Source:

• utils.js , line 35

Parameters:

encodeHTMLEntities (text)

Description:

• encode characters such as & to HTML entities such as & to make the string XML compliant. Only deals with common entities.

Source:

• utils.js , line 1279

Parameters:

Returns:

eqArray (a, b) → {boolean}

Description:

• Check whether two arrays of IDs are the same

Source:

• betweenness.js , line 87

Parameters:

Returns:

Type

boolean

eraser () → {array}

Description:

• Simulate the effect of the v1 eraser by deleting all rects and textboxes that are overlapped by the white circles produced by the v1 eraser

Source:

• background.js , line 2353

Returns:

Type

array

exactTime ()

Source:

• utils.js , line 1220

Returns:

expandStylesObject ()

Description:

• assemble styles by merging the specifics into the default

Source:

• styles.js , line 203

exportDOT ()

Description:

• Save the map as GraphViz file See https://graphviz.org/doc/info/lang.html

Source:

• files.js , line 2098

exportExcel ()

Description:

• Save the map in an Excel workbook, with two sheets: Factors and Links

Source:

• files.js , line 1946

exportGEXF ()

Description:

• Save the map as a GEXF format file, for input to Gephi etc. See https://gexf.net/index.html

Source:

• files.js , line 2207

exportGML ()

Description:

• Save the map as a GML file See https://web.archive.org/web/20190303094704/http://www.fim.uni-passau.de:80/fileadmin/files/lehrstuhl/brandenburg/projekte/gml/gml-technical-report.pdf for the format

Source:

• files.js , line 2068

exportNotes ()

Description:

• save a local file containing all the node and edge notes, plus the map description, as a Word document

Source:

• files.js , line 1825

factorSizeToPercent (size) → {Integer}

Description:

• Convert a factor size into a percent (with any size below 30 as zero), for the input range slider

Source:

• utils.js , line 348

Parameters:

Returns:

Type

Integer

fit ()

Description:

• rescale and redraw the network so that it fits the pane

Source:

• prsm.js , line 3270

follow (event)

Description:

• User has clicked on an avatar. Start following this avatar

Source:

• prsm.js , line 5748

Parameters:

followUser ()

Description:

• move the map so that the followed cursor is always in the centre of the pane

Source:

• prsm.js , line 5770

(async) genAIEdge ()

Description:

• user has clicked on the sparkles icon in a Link node window return the output from an LLM asked to elaborate on the causal relationship between the two linked factors

Source:

• prsm.js , line 4248

(async) genAINode ()

Description:

• user has clicked on the sparkles icon in a Factor window return the output from an LLM asked to explain the factor

Source:

• prsm.js , line 4047

generateName ()

Description:

• return a random fancy name for an avatar, with a random colour

Source:

• utils.js , line 739

generateRoom ()

Description:

• create a random string of the form AAA-BBB-CCC-DDD

Source:

• prsm.js , line 1018

getArrows (prop)

Description:

• Convert from style object properties to arrow menu selection

Source:

• styles.js , line 749

Parameters:

getButtonStatus ()

Description:

• return an object with the current Network panel setting for saving settings for link radius and up/down stream are not saved

Source:

• files.js , line 1638

Returns:

(async) getClipboardContents () → {Promise.<(string|null)>}

Description:

• retrieve the contents of the clipboard

Source:

• background.js , line 2217

Returns:

Type

Promise.<(string|null)>

getContext (canvas) → { CanvasRenderingContext2D }

Description:

• return the context for the provided canvas

Source:

• paint.js , line 125

Parameters:

Returns:

Type

CanvasRenderingContext2D

getDashes (bDashes, bWidth)

Description:

• convert from style object properties to dashed border menu selection

Source:

• utils.js , line 371

Parameters:

getIds (arr) → {Array}

Description:

• Extract IDs from an array of node or link objects

Source:

• betweenness.js , line 75

Parameters:

Returns:

Type

Array

getLastPath () → {fabric.Path}

Description:

• called after a pencil or marker has been used to retrieve the path object that it created

Source:

• background.js , line 1434

Returns:

Type

fabric.Path

getNodeGroupFromGroupLabel (groupLabel)

Description:

• Given a label for a style, return the style's group id. Assumes that the style label is unique

Source:

• table.js , line 1138

Parameters:

getObjectData (obj, params) → {object}

Description:

• Collect the parameters that would allow the reproduction of the object

Source:

• background.js , line 1886

Parameters:

Returns:

Type

object

getRadioVal (name)

Source:

• prsm.js , line 4749

Parameters:

Returns:

getRandomData (nNodes)

Description:

• randomly create some nodes and edges as a binary tree, mainly used for testing

Source:

• prsm.js , line 1032

Parameters:

getScaleFreeNetwork ()

Description:

• Create a random scale free network, used only for testing and demoing Taken from the vis-network distribution

  Created by Alex on 5/20/2015.

Source:

• utils.js , line 58

getSelectedAndFixedNodes ()

Description:

• Return an array of the node Ids of Factors that are selected or are locked

Source:

• prsm.js , line 4774

Returns:

getWidthOfTitle (text, fontname, fontsize) → {number}

Description:

• return the length of the string in pixels when displayed using given font

Source:

• table.js , line 1512

Parameters:

Returns:

Type

number

ghostCursor ()

Description:

• show a box attached to the cursor to guide where the Factor will be placed when the user clicks.

Source:

• prsm.js , line 3431

ghostFactor (pos)

Description:

• broadcast to other users that a new factor is being added here

Source:

• prsm.js , line 2641

Parameters:

groupTitle (field, collapse)

Description:

• return HTML string for column group header, with embedded collapse/reveal icon

Source:

• table.js , line 746

Parameters:

Returns:

headerTickToggle (e, id)

Description:

• Toggle the displayed state of the checkbox in a TickCross column

Source:

• table.js , line 815

Parameters:

hexToRgba (hex, alpha)

Description:

• covert a hex color string such as #123456 to an rgba string

Source:

• utils.js , line 866

Parameters:

Returns:

hideNavButtons ()

Description:

• in View Only mode, hide all the Nav Bar buttons except the search button and make the map title not editable

Source:

• prsm.js , line 1090

hideNodeAndEdges (node, value)

Description:

• Set the node's hidden property to true, and hide all the connected edges (or the reverse if value is false)

Source:

• table.js , line 1125

Parameters:

hideNotes ()

Description:

• Hide the Node or Edge Data panel

Source:

• prsm.js , line 3972

hideWhatsNew ()

Description:

• hide the What's New dialog when the user has clicked Continue, and note tha the user has seen it

Source:

• prsm.js , line 442

htmlEntities (str)

Description:

• replace special characters with their HTML entity codes

Source:

• utils.js , line 804

Parameters:

humanSize (bytes, isDecimal) → {string}

Description:

• convert a number of bytes to a human-readable string

Source:

• utils.js , line 1237

Parameters:

Returns:

Type

string

in_degree (a) → {array}

Description:

• return a vector of the number of edges into a node

Source:

• trophic.js , line 111

Parameters:

Returns:

Type

array

initAligningGuidelines ()

Description:

• initialize the smart guides that help align objects when moving them

Source:

• background.js , line 1908

initDraw ()

Description:

• set up the fabric context, the grid drawn on it and the tools

Source:

• background.js , line 108

initPopUp (popUpTitle, height, item, cancelAction, saveAction, callback)

Description:

• Initialise the dialog for creating nodes/edges

Source:

• prsm.js , line 2538

Parameters:

initSample (wrapper, sampleData)

Description:

• create the sample network

Source:

• styles.js , line 230

Parameters:

initialiseFactorTable () → {Tabulator}

Description:

• define the Factor table

Source:

• table.js , line 389

Returns:

Type

Tabulator

initialiseLinkTable () → {Tabulator}

Description:

• define the Link table

Source:

• table.js , line 1147

Returns:

Type

Tabulator

initials (name)

Description:

• return the initials of the given name as a string: Nigel Gilbert -> NG

Source:

• utils.js , line 832

Parameters:

initiateClone ()

Description:

• load cloned data from localStorage if there is no clone, returns without doing anything

Source:

• prsm.js , line 958

inline (label)

Description:

• replace all white space with single space characters

Source:

• merge.js , line 406

Parameters:

Returns:

intersect (circle, shape) → {boolean}

Description:

• returns true iff the circle overlaps the shape (tests only rects and text boxes, not lines or pencil)

Source:

• background.js , line 2387

Parameters:

Returns:

Type

boolean

invertColor (color)

Description:

• return the inverse/complementary colour

Source:

• utils.js , line 929

Parameters:

Returns:

isEmpty (obj)

Description:

• return true if obj has no properties, i.e. is {}

Source:

• utils.js , line 137

Parameters:

Returns:

isNotCluster (}) → {Boolean}

Description:

• prevent the editing of an Attribute column for rows corresponding to a cluster

Source:

• table.js , line 737

Parameters:

Returns:

Type

Boolean

isQuillEmpty (quill)

Description:

• test whether the editor has any content (could be an empty string or a Quill insert operation of just a single newline character)

Source:

• utils.js , line 1258

Parameters:

Returns:

jLouvain (nodes, edges, initialPartition opt ) → {Object}

Description:

• jLouvain Community Detection Algorithm

  Usage: const result = jLouvain(nodes, edges, initialPartition);

Source:

• cluster.js , line 461

Parameters:

Returns:

Type

Object

keepPaneInWindow (pane)

Description:

• when the window is resized, make sure that the pane is still visible

Source:

• prsm.js , line 3798

Parameters:

legend (warn)

Description:

• display a legend on the map (but only if the styles have been given names)

Source:

• styles.js , line 763

Parameters:

lightOrDark (color)

Description:

• Determine whether a color is light or dark (so text in a contrasting color can be overlaid) from https://awik.io/determine-color-bright-dark-using-javascript/

Source:

• utils.js , line 975

Parameters:

Returns:

linkEditCancel ()

Description:

• cancel any editing of the style and revert to what it was previously

Source:

• styles.js , line 672

linkEditSave ()

Description:

• save changes to the style made with the edit dialog to the style object

Source:

• styles.js , line 629

linkEditSubmit ()

Description:

• save the edited style and close the style editor. Update the links in the map and the legend to the current style

Source:

• styles.js , line 698

linkEditUpdateStyleSample (group)

Description:

• update the style sample to show changes to style

Source:

• styles.js , line 659

Parameters:

linkEditorHide ()

Description:

• hide the link style editor dialog

Source:

• styles.js , line 681

linkEditorShow ()

Description:

• show the link style editor dialog

Source:

• styles.js , line 687

listFactors (factors, suppressType)

Description:

• return a string listing the labels of the given nodes, with nice connecting words

Source:

• prsm.js , line 3202

Parameters:

listLinks (links)

Description:

• return a string listing the number of Links, or if just one, the starting and ending factors

Source:

• prsm.js , line 3227

Parameters:

listen (id, event, callback, options)

Description:

• attach an event listener

Source:

• utils.js , line 27

Parameters:

loadCSV (csv)

Description:

• Read a comma separated values file consisting of 'From' label and 'to' label, on each row, with a header row (ignored) optional, cols 3 and 4 can include the groups (styles) of the from and to nodes, column 5 can include the style of the edge. All these must be integers between 1 and 9

Source:

• files.js , line 1278

Parameters:

loadDOTfile (graph)

Description:

• parse and load a GraphViz (.DOT or .GV) file uses the vis-network DOT parser, which is pretty hopeless - e.g. it does not manage dotted or dashed node borders and requires some massaging of the parameters it does recognise

Source:

• files.js , line 349

Parameters:

Returns:

loadDrawIOfile (contents)

Description:

• Parse and load a file exported from Draw.io The file must be in XML format, as exported from Draw.io The file should contain a single mxGraphModel element with mxCell elements for nodes and edges. The nodes should have a label and an mxGeometry element with x, y, width and height attributes. Other node cells are ignored, as are nodes holding images The edges should have a source and target attribute.

Source:

• files.js , line 661

Parameters:

loadExcelfile (contents)

Description:

• Reads map data from an Excel file. The file must have two spreadsheets in the workbook, named Factors and Links In the spreadsheet, there must be a header row, and columns for (minimally) Label (and for links, also From and To, with entries with the exact same text as the Labels in the Factor sheet. There may be a Style column, which is used to specify the style for the Factor or Link (numbered from 1 to 9). There may be a Description (or note or Note) column, the contents of which are treated as a Factor or Link note. Any other columns are treated as holding values for additional Attributes.

  Uses https://sheetjs.com/

Source:

• files.js , line 1360

Parameters:

Returns:

loadFile (contents)

Description:

• determine what kind of file it is, parse it and replace any current map with the one read from the file

Source:

• files.js , line 150

Parameters:

loadGEXFfile (gexf)

Description:

• Parse and load a Gephi GEXF file into PRSM format

Source:

• files.js , line 480

Parameters:

loadGML (gml)

Description:

• Parse and load a GML file

Source:

• files.js , line 1193

Parameters:

loadGraphML (graphML)

Description:

• parse and load a graphML file

Source:

• files.js , line 382

Parameters:

loadKumufile (str) → {void}

Description:

• Parse and load a Kumu file The file must be in JSON format, as exported from Kumu.

Source:

• files.js , line 778

Parameters:

Returns:

Type

void

loadPRSMfile (str)

Description:

• Parse and load a PRSM map file, or a JSON file exported from Gephi

Source:

• files.js , line 250

Parameters:

lockNode (item)

Description:

• User is about to edit the node. Make sure that no one else can edit it simultaneously

Source:

• prsm.js , line 2849

Parameters:

logHistory (action, actor, dontSaveState)

Description:

• push a record that action has been taken on to the end of the history log also record current state of the map for possible roll back and note changes have been made to the map

Source:

• prsm.js , line 2136

Parameters:

makeClusterNode (id, label, color) → {object}

Description:

• Create an object to format a new cluster node The font is always black

Source:

• cluster.js , line 275

Parameters:

Returns:

Type

object

makeColor (seed opt ) → {string}

Description:

• return a random color as an rgb string, e.g. 'rgb(246,121,16)' if a seed (number) is provided, the same color will be generated each time for that seed if no seed is provided, a different color will be generated each time

Source:

• utils.js , line 940

Parameters:

Returns:

Type

string

makeGroup ()

Description:

• create a group from the currently selected objects

Source:

• background.js , line 1498

makeNotesPanelResizeable (notePanel)

Description:

• Make the notes panel resizeable by dragging its corner handles

Source:

• prsm.js , line 4103

Parameters:

makeOptionsDialog (tool)

Description:

• Create an HTMLElement that will hold the options dialog

Source:

• background.js , line 808

Parameters:

Returns:

mapTitle (e)

Description:

• User has set or changed the map title: update the UI and broadcast the new title

Source:

• prsm.js , line 3039

Parameters:

markMapSaved ()

Description:

• note that the map has been saved to file and so user does not need to be warned about quitting without saving

Source:

• prsm.js , line 2095

mergeTranspose (a) → {Array.<array>}

Description:

• Add matrix a to its transpose, but normalise the cell values resulting to 0/1

Source:

• trophic.js , line 164

Parameters:

Returns:

Type

Array.<array>

mostFrequentString (arr)

Description:

• Find the most frequent string in an array.

Source:

• utils.js , line 321

Parameters:

Returns:

mouseDespatch (event)

Description:

• all mouse and touch events for the canvas are handled here - despatch to the selected tool

Source:

• paint.js , line 219

Parameters:

nodeEditCancel ()

Description:

• cancel any editing of the style and revert to what it was previously

Source:

• styles.js , line 516

nodeEditSave ()

Description:

• save changes to the style made with the edit dialog to the style object

Source:

• styles.js , line 473

nodeEditSubmit ()

Description:

• save the edited style and close the style editor. Update the nodes in the map and the legend to the current style

Source:

• styles.js , line 543

nodeEditUpdateStyleSample (group)

Description:

• update the style sample to show changes to style

Source:

• styles.js , line 497

Parameters:

nodeEditorHide ()

Description:

• hide the node style editor dialog

Source:

• styles.js , line 526

nodeEditorShow ()

Description:

• show the node style editor dialog

Source:

• styles.js , line 532

nodeIdToLabel (id)

Description:

• find a node with the given id and return its label

Source:

• merge.js , line 395

Parameters:

Returns:

nodeList (v)

Description:

• returns a list of the node Ids mentioned in a vector of edges

Source:

• trophic.js , line 333

Parameters:

noteFilter (data, params)

Description:

• Custom filter for Notes -first converts Quill format to string and then checks the string

Source:

• table.js , line 1691

Parameters:

Returns:

objectEquals (x, y)

Description:

• compare two objects for deep equality fast but doesn't cater for obscure cases adapted from https://stackoverflow.com/questions/1068834/object-comparison-in-javascript

Source:

• utils.js , line 207

Parameters:

onexit (callback)

Description:

• store the cleanup function until needed

Source:

• tutorial.js , line 212

Parameters:

openCluster (clusterNodeId)

Description:

• Hide the cluster node and unhide the nodes it was clustering (and their edges) called by right clicking the cluster node

Source:

• cluster.js , line 358

Parameters:

openNotesWindow ()

Description:

• open another window (popupWindow) in which Notes can be edited

Source:

• prsm.js , line 3962

panCanvas (x, y, zoom)

Description:

• pan the canvas by the given amount

Source:

• background.js , line 100

Parameters:

plusLink ()

Description:

• react to the user pressing the Add Link button handles cases when the button is disabled; has previously been pressed; and the Add Node button is active, as well as the normal case

Source:

• prsm.js , line 3480

plusNode ()

Description:

• react to the user pressing the Add node button handles cases when the button is disabled; has previously been pressed; and the Add link button is active, as well as the normal case

Source:

• prsm.js , line 3400

positionNotes (notesPanel)

Description:

• ensure that the panel is not outside the net pane, nor obscuring the Settings panel

Source:

• prsm.js , line 4307

Parameters:

positionPopUp (point)

Description:

• Position the editing dialog box so that it is to the left of the item being edited, but not outside the window

Source:

• prsm.js , line 2569

Parameters:

progressBar (sliderEl)

Description:

• draw the solid bar to the left of the thumb on a slider

Source:

• prsm.js , line 411

Parameters:

pushnew (array, item) → {Array}

Description:

• Add an item to an array if it doesn't already exist

Source:

• utils.js , line 45

Parameters:

Returns:

Type

Array

quillAccessor (note)

Description:

• Used to convert Quill formatted notes into HTML ready for copying to the clipboard

Source:

• table.js , line 916

Parameters:

Returns:

quillEditor (cell, onRendered, success)

Description:

• start up a Quill editor for the note in this cell

Source:

• table.js , line 930

Parameters:

Returns:

quillFormatter (cell)

Description:

• returns the note for this factor in HTML format, shortening it with ellipses if the column is collapsed

Source:

• table.js , line 894

Parameters:

Returns:

randomColour () → {Object}

Description:

• return a random colour, with a flag to show whether the color is light or dark, to suggest whether text applied should be white or black

Source:

• utils.js , line 720

Returns:

Type

Object

reApplySampleToLinks (groupIds, force opt )

Description:

• update all links in the map with this style to the current style features (don't touch cluster edges)

Source:

• styles.js , line 717

Parameters:

reApplySampleToNodes (groupIds, force opt )

Description:

• update all nodes in the map with this style to the current style features

Source:

• styles.js , line 563

Parameters:

readSingleFile (e)

Description:

• Get the name of a map file to read and load it

Source:

• files.js , line 101

Parameters:

rebase (v)

Description:

• subtract the minimum value of any cell from each cell of the vector

Source:

• trophic.js , line 198

Parameters:

recalculateStats ()

Description:

• Ask the web worker to recalculate network statistics

Source:

• prsm.js , line 3173

receiveEvent (event)

Description:

• Despatch to deal with event

Source:

• prsm.js , line 5547

Parameters:

recreateClusteringMenu (obj)

Description:

• recreate the Clustering drop down menu to include user attributes as clustering options

Source:

• prsm.js , line 5320

Parameters:

redraw ()

Description:

• redraw the objects on the canvas and the grid

Source:

• background.js , line 124

redraw ()

Description:

• redraw the main canvas, using the stored commands in yPointsArray[]

Source:

• paint.js , line 1157

refreshFromMap (keys)

Description:

• add or refresh objects that have the given list of id, using data in yDrawingMap

Source:

• background.js , line 153

Parameters:

refreshSampleLink ()

Description:

• ensure that the styles displayed in the link styles panel display the styles defined in the styles array

Source:

• styles.js , line 734

refreshSampleNode ()

Description:

• ensure that the styles displayed in the node styles panel display the styles defined in the styles array

Source:

• styles.js , line 580

removeAvatar (ava)

Description:

• destroy the avatar - the user is no longer on line

Source:

• prsm.js , line 5733

Parameters:

removeFactorCursor ()

Description:

• remove the factor cursor if it exists

Source:

• prsm.js , line 3468

removeTitleDropDown ()

Description:

• Remove the drop down list of previous maps if user clicks on the net-pane or on a map title.

Source:

• prsm.js , line 3152

renameUser ()

Description:

• User has clicked on their own avatar. Prompt them to change their own name.

Source:

• prsm.js , line 5780

resizeCanvas ()

Description:

• resize the drawing canvas when the window changes size

Source:

• background.js , line 74

rgbToArray (rgb) → {array}

Description:

• convert a color string to an array of numbers e.g. 'rgb(255, 0, 0)' -> [255, 0, 0]

Source:

• utils.js , line 917

Parameters:

Returns:

Type

array

rgba ()

Description:

• convert an rgb(a) string to rgba with given alpha value

Source:

• utils.js , line 895

rollback (event)

Description:

• Restores the state of the map to a previous one

Source:

• prsm.js , line 5383

Parameters:

Returns:

round (v, places)

Description:

• Round the cell values of v to the given number of decimal places

Source:

• trophic.js , line 271

Parameters:

saveChange (obj, params, op)

Description:

• Broadcast the changes to other clients and save the current state of the object on the undo stack

Source:

• background.js , line 1845

Parameters:

saveEdge (item, callback)

Description:

• save the edge format details that have been edited

Source:

• prsm.js , line 2963

Parameters:

saveLabel (node, callback)

Description:

• called when a node has been added. Save the label provided

Source:

• prsm.js , line 2657

Parameters:

saveNode (item, callback)

Description:

• save the node format details that have been edited

Source:

• prsm.js , line 2795

Parameters:

savePRSMfile ()

Description:

• save the current map as a PRSM file (in JSON format)

Source:

• files.js , line 1563

saveState ()

Description:

• Generate a compressed dump of the current state of the map, sufficient to reproduce it

Source:

• prsm.js , line 2164

Returns:

saveStr (str, extn)

Description:

• Save the string to a local file

Source:

• files.js , line 1678

Parameters:

saveUserName (name)

Description:

• Save a new user name into local storage

Source:

• prsm.js , line 1152

Parameters:

search ()

Description:

• Open an input for user to type label of node to search for and generate suggestions when user starts typing

Source:

• prsm.js , line 3713

searchTargets ()

Description:

• generate and display a set of suggestions - nodes with labels that include the substring that the user has typed

Source:

• prsm.js , line 3726

seededRandom () → {number}

Description:

• Generate a seeded random number

Source:

• utils.js , line 119

Returns:

Type

number

selectClustering (e)

Description:

• User has chosen a clustering option

Source:

• prsm.js , line 5288

Parameters:

selectTool (event)

Description:

• When the user clicks a tool icon unselect previous tool, select this one and remember which tool is now selected The undo, redo, delete and image tools are special, because they act immediately when the icon is clicked

Source:

• background.js , line 475

Parameters:

selectTool (event)

Description:

• event listener: when user clicks a tool icon unselect previous tool, select this one and remember which tool is now selected The undo and image tools are special, because they act immediately when the icon is clicked

Source:

• paint.js , line 159

Parameters:

selectUsersItems ()

Description:

• Selects all the nodes and edges that have been created or modified by a user

Source:

• prsm.js , line 4707

selectedLabels () → {String}

Description:

• returns string of currently selected labels of links and factors, nicely formatted

Source:

• prsm.js , line 3236

Returns:

Type

String

sendToBack (obj)

Description:

• send the given object to the back of the canvas

Source:

• background.js , line 717

Parameters:

setAnalysisButtonsFromRemote ()

Description:

• Sets the Analysis radio buttons and Factor selection according to values in global hiddenNodes (which is set when yNetMap is loaded, or when a file is read in)

Source:

• prsm.js , line 4791

setButtonDisabledStatus (id, state)

Description:

• Change the visible state of a button

Source:

• prsm.js , line 3570

Parameters:

setButtonDisabledStatus (id, state)

Description:

• Change the visible state of a button

Source:

• table.js , line 1607

Parameters:

setButtonStatus (settings)

Description:

• Set the Network panel buttons to their values loaded from a file

Source:

• files.js , line 1651

Parameters:

setCanvasBackground (canvas)

Description:

• draw the background on the given canvas (which will be a magnified version of the net pane)

Source:

• prsm.js , line 1855

Parameters:

Returns:

setEdgeHidden (edge, hide) → {object}

Description:

• set this edge to its 'hidden' appearance (very faint), or restore it to its usual appearance

Source:

• utils.js , line 884

Parameters:

Returns:

Type

object

setEndOfContenteditable (contentEditableElement)

Description:

• positions the caret at the end of text in a contenteditable div

Source:

• utils.js , line 1208

Parameters:

setFactorSizeFromPercent (node, percent)

Description:

• Set the factor size according to the input range slider value (less then 5% is treated as the normal size)

Source:

• utils.js , line 357

Parameters:

setFileName (extn)

Description:

• resets lastFileName to a munged version of the map title, with the supplied extension if lastFileName is null, uses the map title, or if no map title, 'network' as the filename

Source:

• files.js , line 1880

Parameters:

setFixed ()

Description:

• User has clicked the padlock. Toggle padlock state and fix the location of the node

Source:

• prsm.js , line 3941

setGroupBorderColor (group)

Description:

• set the border color of the given group to green

Source:

• background.js , line 1556

Parameters:

setIntersection (otherSet) → {Set}

Description:

• Performs intersection operation between called set and otherSet

Source:

• utils.js , line 311

Parameters:

Returns:

Type

Set

setMapTitle (title)

Description:

• Format the map title

Source:

• prsm.js , line 3058

Parameters:

setNodeHidden (node, hide) → {object}

Description:

• set this node to its 'hidden' appearance (very faint), or restore it to its usual appearance

Source:

• utils.js , line 852

Parameters:

Returns:

Type

object

setRadioVal (name, value)

Source:

• prsm.js , line 4762

Parameters:

setUpAwareness ()

Description:

• set up user monitoring (awareness)

Source:

• prsm.js , line 5459

setUpBackground ()

Description:

• Initialise the canvas and toolbox

Source:

• background.js , line 65

setUpCanvas (id) → {HTMLCanvasElement}

Description:

• set up the dimensions of and return the canvas at the id

Source:

• paint.js , line 109

Parameters:

Returns:

Type

HTMLCanvasElement

setUpFilter ()

Description:

• Display a dialog box to get the filter parameters

Source:

• table.js , line 1619

setUpPage ()

Description:

• create all the DOM elements on the web page

Source:

• prsm.js , line 370

setUpPaint ()

Description:

• create the canvases and add listeners for mouse and touch events initialise the array holding drawing commands

Source:

• paint.js , line 66

setUpPinchZoom ()

Description:

• Set up pinch-to-zoom using native touch events

Source:

• prsm.js , line 3307

setUpSamples ()

Description:

• The samples are each a mini vis-network showing just one node or two nodes and a link

Source:

• styles.js , line 60

setUpShareDialog ()

Description:

• set up the modal dialog that opens when the user clicks the Share icon in the nav bar

Source:

• prsm.js , line 3586

setUpShareDialog ()

Description:

• set up the modal dialog that opens when the user clicks the Share icon in the nav bar

Source:

• table.js , line 315

setUpSideDrawer ()

Description:

• set up the side drawer for notes

Source:

• prsm.js , line 2182

setUpTabs ()

Description:

• add event listeners for the Factor and Link tabs

Source:

• table.js , line 110

setUpToolbox ()

Description:

• add event listeners to the tools to receive user clicks to select a tool

Source:

• background.js , line 454

setUpToolbox ()

Description:

• add listeners for when the tool buttons are clicked

Source:

• paint.js , line 139

setUpTutorial ()

Description:

• if this is the user's first time, show them how the user interface works

Source:

• prsm.js , line 1168

setUpUserName ()

Description:

• retrieve or generate user's name

Source:

• prsm.js , line 1139

setvh ()