Global

Members

(constant) MIN_WIDTH

Description:

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

Source:

• prsm.js, line 4533

(constant) SHORTLABELLEN

Description:

• shorten the label if necessary and add an ellipsis

Source:

• utils.js, line 756

inAddMode :string|boolean

Source:

• prsm.js, line 155

Type:

• string | boolean

legendData

Description:

• Draw the legend floating above the 3d display

Source:

• 3d.js, line 365

(constant) makeColor

Description:

• closure to generate a sequence of colours (as rgb strings, e.g. 'rgb(246,121,16)') based on https://krazydad.com/tutorials/makecolors.php

Source:

• utils.js, line 838

(constant) maxScale

Description:

• save the map as a PNG image file

Source:

• files.js, line 874

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 913

(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 828

startzoom

Description:

• zoom using a pinch/zoom gesture on a tablet note the starting point

Source:

• prsm.js, line 2978

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 1081

addColumn()

Description:

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

Source:

• table.js, line 1476

addContextMenu(elem, menu)

Description:

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

Source:

• utils.js, line 425

Parameters:

addEventListeners()

Description:

• Set up all the permanent event listeners

Source:

• prsm.js, line 216

addLabel(item, cancelAction, callback)

Description:

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

Source:

• prsm.js, line 2324

Parameters:

addRollbackIcon(e)

Description:

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

Source:

• prsm.js, line 4678

Parameters:

addVec(v1, v2) → {array}

Description:

• v1 + v2

Source:

• trophic.js, line 140

Parameters:

Returns:

Type

array

alertMsg(msg, statusopt, dontFadeopt)

Description:

• show alert messages at the bottom of the window

Source:

• utils.js, line 704

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 4188

anon()

Description:

• anonymise a map by removing all user names

Source:

• merge.js, line 360

antMarch(left, top, width, height)

Description:

• draw 'marching ants' around a rectangle

Source:

• paint.js, line 1010

Parameters:

applyOptions(ctx, options)

Description:

• apply the canvas options to the context

Source:

• paint.js, line 1247

Parameters:

arrayBufferToString(contents)

Description:

• convert an ArrayBuffer to String

Source:

• files.js, line 215

Parameters:

Returns:

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 4847

Parameters:

autoLayout()

Description:

• Choose and apply a layout algorithm

Source:

• prsm.js, line 3772

buttonIsDisabled(id)

Description:

• Returns true if the button is not disabled

Source:

• prsm.js, line 3195

Parameters:

Returns:

cancelAdd(callback)

Description:

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

Source:

• prsm.js, line 2295

Parameters:

cancelEdit(item, callbackopt)

Description:

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

Source:

• prsm.js, line 2305

Parameters:

cancelLoading()

Description:

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

Source:

• table.js, line 675

cancelViewOnly()

Description:

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

Source:

• prsm.js, line 948

changeCursor(newCursorStyle)

Description:

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

Source:

• prsm.js, line 2710

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 2812

Parameters:

checkKey(e)

Description:

• catch and branch to a handler for special Key commands Delete, ^z (undo) and ^y (redo)

Source:

• background.js, line 1391

Parameters:

circleIntersectsRect(circle, rect)

Description:

• tests whether any part of the circle overlaps the rectangle

Source:

• background.js, line 2184

Parameters:

Returns:

clean(source, propsToRemove)

Description:

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

Source:

• utils.js, line 243

Parameters:

cleanArray(arr, propsToRemove)

Description:

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

Source:

• utils.js, line 255

Parameters:

clearLegend()

Description:

• remove the legend from the map

Source:

• styles.js, line 798

clearMap()

Description:

• clear the map by destroying all nodes and edges

Source:

• prsm.js, line 1848

clearPopUp()

Description:

• Hide the editing dialog box

Source:

• prsm.js, line 2277

clearStatusBar()

Description:

• remove any previous message from the status bar

Source:

• utils.js, line 748

closeFilter()

Description:

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

Source:

• table.js, line 1622

closeOptionsDialogs()

Description:

• remove any option dialog that is open

Source:

• background.js, line 506

closeOptionsDialogs()

Description:

• remove any option dialog that is open

Source:

• paint.js, line 183

clusterByAttribute(attribute)

Source:

• cluster.js, line 52

Parameters:

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 701

Parameters:

collapseNotes(table, field)

Description:

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

Source:

• table.js, line 725

Parameters:

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

Description:

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

Source:

• table.js, line 1445

Parameters:

Returns:

Type

HTMLElement

configSamples()

Description:

• assemble configurations by merging the specifics into the default

Source:

• styles.js, line 338

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 339

Parameters:

convertDashes(val)

Description:

• Convert from dashed menu selection to style object properties

Source:

• utils.js, line 345

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 170

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 155

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 1300

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 1370

Parameters:

convertNode(node)

Description:

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

Source:

• 3d.js, line 147

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 916

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 995

Parameters:

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 1904

Parameters:

copyHistoryToClipboard(event)

Description:

• copy the contents of the history log to the clipboard

Source:

• prsm.js, line 2154

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 1635

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 2119

Parameters:

createTitleDropDown()

Description:

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

Source:

• prsm.js, line 2779

deepCopy(obj)

Description:

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

Source:

• utils.js, line 177

Parameters:

deleteActiveObjects()

Description:

• makes the active object invisible (unless it is a group, which is actually deleted) this allows 'undo' to re-instate the object, by making it visible

Source:

• background.js, line 1409

deleteColumn(column)

Description:

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

Source:

• table.js, line 1494

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 3210

deselectTool()

Description:

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

Source:

• background.js, line 486

deselectTool()

Description:

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

Source:

• paint.js, line 172

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

Description:

• create a zero matrix with v as the leading diagonal

Source:

• trophic.js, line 185

Parameters:

Returns:

Type

Array.<array>

diffMaps()

Description:

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

Source:

• merge.js, line 216

display(backColor)

Description:

• Display the map as a 3D network

Source:

• 3d.js, line 200

Parameters:

displayHelp()

Description:

• display help page in a separate window

Source:

• utils.js, line 1125

displayNetPane(msg)

Description:

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

Source:

• prsm.js, line 881

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 373

doSearch()

Description:

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

Source:

• prsm.js, line 3365

dragElement(el, header)

Description:

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

Source:

• utils.js, line 366

Parameters:

draw()

Description:

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

Source:

• prsm.js, line 1024

drawBadges(ctx)

Description:

• draw badges (icons) around Factors and Links

Source:

• prsm.js, line 2003

Parameters:

drawGrid(grid_size)

Description:

• draw a grid on the drawing canvas

Source:

• background.js, line 385

Parameters:

drawGrid(netctx)

Description:

• draw a faint evenly spaced grid over the drawing area

Source:

• paint.js, line 1132

Parameters:

drawMinimap(ratioopt)

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 1668

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 2698

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 316

Parameters:

Returns:

editEdge(item, point, cancelAction, callback)

Description:

• Draw a dialog box for user to edit an edge

Source:

• prsm.js, line 2574

Parameters:

editLinkStyle(styleElement, groupId)

Description:

• open the dialog to edit a link style

Source:

• styles.js, line 556

Parameters:

editNode(item, point, cancelAction, callback)

Description:

• Draw a dialog box for user to edit a node

Source:

• prsm.js, line 2372

Parameters:

editNodeStyle(styleElement, groupId)

Description:

• open the dialog to edit a node style

Source:

• styles.js, line 402

Parameters:

elem(id)

Description:

• return the HTML element with the id

Source:

• utils.js, line 44

Parameters:

eraser()

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 2128

Returns:

exactTime()

Source:

• utils.js, line 1077

Returns:

exportDOT()

Description:

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

Source:

• files.js, line 1252

exportExcel()

Description:

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

Source:

• files.js, line 1117

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 1226

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 999

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 309

Parameters:

Returns:

Type

Integer

fit()

Description:

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

Source:

• prsm.js, line 2941

follow(event)

Description:

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

Source:

• prsm.js, line 5074

Parameters:

followUser()

Description:

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

Source:

• prsm.js, line 5096

generateName()

Description:

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

Source:

• utils.js, line 678

generateRoom()

Description:

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

Source:

• prsm.js, line 855

getArrows(prop)

Description:

• Convert from style object properties to arrow menu selection

Source:

• styles.js, line 685

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 826

Returns:

getContext(canvas) → {CanvasRenderingContext2D}

Description:

• return the context for the provided canvas

Source:

• paint.js, line 101

Parameters:

Returns:

Type

CanvasRenderingContext2D

getDashes(bDashes, bWidth)

Description:

• convert from style object properties to dashed border menu selection

Source:

• utils.js, line 331

Parameters:

getLastPath()

Description:

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

Source:

• background.js, line 1291

Returns:

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 1068

Parameters:

getRadioVal(name)

Source:

• prsm.js, line 4113

Parameters:

Returns:

getRandomData(nNodes)

Description:

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

Source:

• prsm.js, line 869

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 61

getSelectedAndFixedNodes()

Description:

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

Source:

• prsm.js, line 4138

Returns:

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

Description:

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

Source:

• table.js, line 1429

Parameters:

Returns:

Type

number

get_trophic_levels(a) → {array}

Description:

• This is the Trophic Levels Algorithm

Source:

• trophic.js, line 279

Parameters:

Returns:

Type

array

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 3068

ghostFactor(pos)

Description:

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

Source:

• prsm.js, line 2337

Parameters:

groupTitle(field, collapse)

Description:

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

Source:

• table.js, line 686

Parameters:

Returns:

headerTickToggle(e, id)

Description:

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

Source:

• table.js, line 754

Parameters:

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 921

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 1055

Parameters:

hideNotes()

Description:

• Hide the Node or Edge Data panel

Source:

• prsm.js, line 3604

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 389

htmlEntities(str)

Description:

• replace special characters with their HTML entity codes

Source:

• utils.js, line 737

Parameters:

humanSize(bytes, si) → {string}

Source:

• utils.js, line 1094

Parameters:

Returns:

Type

string

in_degree(a) → {array}

Description:

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

Source:

• trophic.js, line 110

Parameters:

Returns:

Type

array

initDraw()

Description:

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

Source:

• background.js, line 97

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

Description:

• Initialise the dialog for creating nodes/edges

Source:

• prsm.js, line 2248

Parameters:

initSample(wrapper, sampleData)

Description:

• create the sample network

Source:

• styles.js, line 365

Parameters:

initialiseFactorTable() → {Tabulator}

Description:

• define the Factor table

Source:

• table.js, line 352

Returns:

Type

Tabulator

initialiseLinkTable() → {Tabulator}

Description:

• define the Link table

Source:

• table.js, line 1075

Returns:

Type

Tabulator

initials(name)

Description:

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

Source:

• utils.js, line 765

Parameters:

initiateClone()

Description:

• load cloned data from localStorage

Source:

• prsm.js, line 813

inline(label)

Description:

• replace all white space with single space characters

Source:

• merge.js, line 354

Parameters:

Returns:

intersect(circle, shape)

Description:

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

Source:

• background.js, line 2162

Parameters:

Returns:

invertColor(color)

Description:

• return the inverse/complementary colour

Source:

• utils.js, line 830

Parameters:

Returns:

isEmpty(obj)

Description:

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

Source:

• utils.js, line 135

Parameters:

Returns:

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 1107

Parameters:

Returns:

keepPaneInWindow(pane)

Description:

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

Source:

• prsm.js, line 3408

Parameters:

legend(warn)

Description:

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

Source:

• styles.js, line 701

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 862

Parameters:

Returns:

linkEditCancel()

Description:

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

Source:

• styles.js, line 625

linkEditSave()

Description:

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

Source:

• styles.js, line 582

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 651

linkEditUpdateStyleSample(group)

Description:

• update the style sample to show changes to style

Source:

• styles.js, line 612

Parameters:

linkEditorHide()

Description:

• hide the link style editor dialog

Source:

• styles.js, line 634

linkEditorShow()

Description:

• show the link style editor dialog

Source:

• styles.js, line 640

listFactors(factors, suppressType)

Description:

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

Source:

• prsm.js, line 2873

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 2898

Parameters:

listen(id, event, callback, options)

Description:

• attach an event listener

Source:

• utils.js, line 36

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 492

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 325

Parameters:

Returns:

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 574

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 143

Parameters:

loadGML(gml)

Description:

• Parse and load a GML file

Source:

• files.js, line 407

Parameters:

loadGraphML(graphML)

Description:

• parse and load a graphML file

Source:

• files.js, line 358

Parameters:

loadPRSMfile(str)

Description:

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

Source:

• files.js, line 223

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 2532

Parameters:

logHistory(action)

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 1903

Parameters:

makeOptionsDialog(tool)

Description:

• Create an HTMLElement that will hold the options dialog

Source:

• background.js, line 726

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 2719

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 1864

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

Description:

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

Source:

• trophic.js, line 162

Parameters:

Returns:

Type

Array.<array>

mouseDespatch(event)

Description:

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

Source:

• paint.js, line 195

Parameters:

nodeEditCancel()

Description:

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

Source:

• styles.js, line 491

nodeEditSave()

Description:

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

Source:

• styles.js, line 455

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 518

nodeEditUpdateStyleSample(group)

Description:

• update the style sample to show changes to style

Source:

• styles.js, line 479

Parameters:

nodeEditorHide()

Description:

• hide the node style editor dialog

Source:

• styles.js, line 501

nodeEditorShow()

Description:

• show the node style editor dialog

Source:

• styles.js, line 507

nodeIdToLabel(id)

Description:

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

Source:

• merge.js, line 343

Parameters:

Returns:

nodeList(v)

Description:

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

Source:

• trophic.js, line 327

Parameters:

noteFilter(data, params)

Description:

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

Source:

• table.js, line 1598

Parameters:

Returns:

object_equals(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 203

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 269

Parameters:

openNotesWindow()

Description:

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

Source:

• prsm.js, line 3598

out_degree(a) → {array}

Description:

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

Source:

• trophic.js, line 100

Parameters:

Returns:

Type

array

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 3115

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 3037

positionNotes(panel)

Description:

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

Source:

• prsm.js, line 3745

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 2265

Parameters:

progressBar(sliderEl)

Description:

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

Source:

• prsm.js, line 365

Parameters:

quillAccessor(note)

Description:

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

Source:

• table.js, line 851

Parameters:

Returns:

quillEditor(cell, onRendered, success)

Description:

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

Source:

• table.js, line 865

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 833

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 659

Returns:

Type

Object

reApplySampleToLinks(groupIds, forceopt)

Description:

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

Source:

• styles.js, line 669

Parameters:

reApplySampleToNodes(groupIds, forceopt)

Description:

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

Source:

• styles.js, line 538

Parameters:

readSingleFile(e)

Description:

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

Source:

• files.js, line 94

Parameters:

rebase(v)

Description:

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

Source:

• trophic.js, line 196

Parameters:

recalculateStats()

Description:

• Ask the web worker to recalculate network statistics

Source:

• prsm.js, line 2844

receiveEvent(event)

Description:

• Despatch to deal with event

Source:

• prsm.js, line 4882

Parameters:

recreateClusteringMenu(obj)

Description:

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

Source:

• prsm.js, line 4639

Parameters:

redraw()

Description:

• redraw the objects on the canvas and the grid

Source:

• background.js, line 112

redraw()

Description:

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

Source:

• paint.js, line 1102

refreshFromMap(keys)

Description:

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

Source:

• background.js, line 141

Parameters:

refreshSampleLinks()

Description:

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

Source:

• prsm.js, line 3546

refreshSampleNodes()

Description:

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

Source:

• prsm.js, line 3526

removeAvatar(ava)

Description:

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

Source:

• prsm.js, line 5059

Parameters:

removeFactorCursor()

Description:

• remove the factor cursor if it exists

Source:

• prsm.js, line 3103

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 2823

renameUser()

Description:

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

Source:

• prsm.js, line 5106

resizeCanvas()

Description:

• resize the drawing canvas when the window changes size

Source:

• background.js, line 68

rgbIsLight(r, g, b, differencePoint) → {boolean}

Description:

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

Source:

• utils.js, line 652

Parameters:

Returns:

Type

boolean

rgba()

Description:

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

Source:

• utils.js, line 808

rollback(event)

Description:

• Restores the state of the map to a previous one

Source:

• prsm.js, line 4698

Parameters:

Returns:

round(v, places)

Description:

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

Source:

• trophic.js, line 267

Parameters:

roundTripTimer()

Description:

• measure the time taken to send an update to another Y.doc responds to updates sent as 'pkt' objects every 20 seconds (see above)

Source:

• prsm.js, line 4820

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 1662

Parameters:

saveEdge(item, callback)

Description:

• save the edge format details that have been edited

Source:

• prsm.js, line 2645

Parameters:

saveLabel(node, callback)

Description:

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

Source:

• prsm.js, line 2353

Parameters:

saveNode(item, callback)

Description:

• save the node format details that have been edited

Source:

• prsm.js, line 2490

Parameters:

savePRSMfile()

Description:

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

Source:

• files.js, line 766

saveState()

Description:

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

Source:

• prsm.js, line 1929

Returns:

saveStr(str, extn)

Description:

• Save the string to a local file

Source:

• files.js, line 865

Parameters:

saveUserName(name)

Description:

• Save a new user name into local storage

Source:

• prsm.js, line 984

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 3314

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 3327

selectClustering(e)

Description:

• User has chosen a clustering option

Source:

• prsm.js, line 4607

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 434

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 135

Parameters:

selectUsersItems()

Description:

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

Source:

• prsm.js, line 4071

selectedLabels() → {String}

Description:

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

Source:

• prsm.js, line 2907

Returns:

Type

String

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 4155

setButtonDisabledStatus(id, state)

Description:

• Change the visible state of a button

Source:

• prsm.js, line 3203

Parameters:

setButtonDisabledStatus(id, state)

Description:

• Change the visible state of a button

Source:

• table.js, line 1523

Parameters:

setButtonStatus(settings)

Description:

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

Source:

• files.js, line 839

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 1648

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 797

Parameters:

Returns:

Type

object

setEndOfContenteditable(contentEditableElement)

Description:

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

Source:

• utils.js, line 1065

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 318

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 1051

Parameters:

setFixed()

Description:

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

Source:

• prsm.js, line 3577

setMapTitle(title)

Description:

• Format the map title

Source:

• prsm.js, line 2738

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 785

Parameters:

Returns:

Type

object

setParams(obj, params)

Description:

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

Source:

• background.js, line 1700

Parameters:

Returns:

setRadioVal(name, value)

Source:

• prsm.js, line 4126

Parameters:

setUpAwareness()

Description:

• set up user monitoring (awareness)

Source:

• prsm.js, line 4770

setUpBackground()

Description:

• Initialise the canvas and toolbox

Source:

• background.js, line 59

setUpCanvas(id) → {HTMLCanvasElement}

Description:

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

Source:

• paint.js, line 85

Parameters:

Returns:

Type

HTMLCanvasElement

setUpFilter()

Description:

• Display a dialog box to get the filter parameters

Source:

• table.js, line 1535

setUpPage()

Description:

• create all the DOM elements on the web page

Source:

• prsm.js, line 328

setUpPaint()

Description:

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

Source:

• paint.js, line 67

setUpSamples()

Description:

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

Source:

• styles.js, line 59

setUpShareDialog()

Description:

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

Source:

• prsm.js, line 3219

setUpShareDialog()

Description:

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

Source:

• table.js, line 279

setUpTabs()

Description:

• add event listeners for the Factor and Link tabs

Source:

• table.js, line 87

setUpToolbox()

Description:

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

Source:

• background.js, line 413

setUpToolbox()

Description:

• add listeners for when the tool buttons are clicked

Source:

• paint.js, line 115

setUpTutorial()

Description:

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

Source:

• prsm.js, line 1000

setUpUserName()

Description:

• retrieve or generate user's name

Source:

• prsm.js, line 971

setvh()

Description:

• to handle iOS weirdness in fixing the vh unit (see https://css-tricks.com/the-trick-to-viewport-units-on-mobile/)

Source:

• prsm.js, line 959

showAvatars()

Description:

• Place a circle at the top left of the net pane to represent each user who is online Also create a cursor (a div) for each of the users

Source:

• prsm.js, line 4929

showClusterLinks()

Description:

• Create links to cluster nodes and hide links that are now inside clustered nodes

Source:

• cluster.js, line 204

showGhostFactor(userId, addingFactor)

Description:

• show a ghost box where another user is adding a factor addingFactor is an object with properties: state: adding', or 'done' to indicate that the ghost box should be removed pos: a position (of the Add Factor dialog); 'done' name: the name of the other user

Source:

• prsm.js, line 5124

Parameters:

showHistory()

Description:

• display the history log in a window

Source:

• prsm.js, line 4660

showNavButtons()

Description:

• restore all the Nav Bar buttons when leaving view only mode (e.g. when going back online)

Source:

• prsm.js, line 938

showNodeData()

Description:

• Show the notes box, the fixed node check box and the node statistics

Source:

• prsm.js, line 3616

showNodeOrEdgeData()

Description:

• Display a panel to show info about the selected edge or node

Source:

• prsm.js, line 3589

showNotesSwitch(e)

Description:

• Globally either display or don't display notes when a factor or link is selected

Source:

• prsm.js, line 3563

Parameters:

showOtherMouse()

Description:

• Display another user's mouse pointers (if they are inside the canvas)

Source:

• prsm.js, line 4912

showPressed(el, action)

Description:

• Add or remove the CSS style showing that the button has been pressed

Source:

• prsm.js, line 3166

Parameters:

showSelected()

Description:

• show the nodes and links selected in the status bar

Source:

• prsm.js, line 2919

snapToGrid(node)

Description:

• Move the node to the nearest spot that it on the grid

Source:

• prsm.js, line 2108

Parameters:

solve(A, B)

Description:

• solve Ax=B by Gauss-Jordan elimination method adapted from https://www.npmjs.com/package/linear-equation-system

Source:

• trophic.js, line 208

Parameters:

splitText(txt, width)

Description:

• divide txt into lines to make it roughly square, with a maximum width of width characters, but not breaking words and respecting embedded line breaks (\n).

Source:

• utils.js, line 275

Parameters:

standardize_color(str)

Description:

• return the hex value for the CSS color in str (which may be a color name, e.g. white, or a hex number or any other legal CSS color value)

Source:

• utils.js, line 817

Parameters:

start(start)

Description:

• initialise the step counter and display the first step

Source:

• tutorial.js, line 53

Parameters:

startY()

Description:

• create a new shared document and connect to the WebSocket provider

Source:

• 3d.js, line 49

startY()

Description:

• create a new shared document and start the WebSocket provider

Source:

• prsm.js, line 396

startY()

Description:

• create a new shared document and connect to the WebSocket provider

Source:

• table.js, line 114

statusMsg(msg)

Description:

• show status message at the bottom of the window

Source:

• utils.js, line 695

Parameters:

stepFinish()

Description:

• destroy the tutorial dialog, remove the border around the item being explained, and and call stepStart() to display the next one

Source:

• tutorial.js, line 190

stepStart()

Description:

• create a tutorial element and position it

Source:

• tutorial.js, line 60

stepsEnd()

Description:

• called on exit

Source:

• tutorial.js, line 201

stopEdit()

Description:

• cancel adding node and links

Source:

• prsm.js, line 3151

strip(obj, allowed)

Description:

• return a copy of an object that only includes the properties that are in allowed

Source:

• utils.js, line 265

Parameters:

stripNL(str)

Description:

• Replace all \n, \r with a space

Source:

• utils.js, line 1118

Parameters:

Returns:

styleEdgeNames()

Source:

• table.js, line 1288

Returns:

styleNodeNames()

Source:

• table.js, line 782

Returns:

subVec(v1, v2) → {array}

Description:

• v1 - v2

Source:

• trophic.js, line 129

Parameters:

Returns:

Type

array

subtract(a, b)

Description:

• subtract matrix b from a

Source:

• trophic.js, line 150

Parameters:

sumVec(v) → {number}

Description:

• returns the summation of the values in the vector

Source:

• trophic.js, line 118

Parameters:

Returns:

Type

number

svg(icon)

Description:

• return the SVG code for the given icon (see Bootstrap Icons)

Source:

• table.js, line 792

Parameters:

tickToggle(e, cell)

Description:

• Toggle the value of a cell in a TickCross column

Source:

• table.js, line 746

Parameters:

timeAndDate(utc, full)

Description:

• Returns a nicely formatted Date (or time if the date is today), given a Time value (from Date() )

Source:

• utils.js, line 1028

Parameters:

timekey(time) → {string}

Description:

• Generate a key for a time slot in the history log

Source:

• prsm.js, line 1894

Parameters:

Returns:

Type

string

timestamp()

Description:

• return an object with the current time as an integer date and the current user's name

Source:

• prsm.js, line 1884

titleDropDown(title)

Description:

• Add this title to the local record of maps used

Source:

• prsm.js, line 2765

Parameters:

toggleDeleteButton()

Description:

• un fade the delete button to show that it can be used when something is selected

Source:

• prsm.js, line 1871

togglePanel()

Description:

• show or hide the side panel

Source:

• prsm.js, line 3391

toolHandler(tool) → {object}

Description:

• return the correct instance of toolHandler for the given tool

Source:

• background.js, line 533

Parameters:

Returns:

Type

object

toolHandler(tool) → {object}

Description:

• return the correct instance of toolHandler for the given tool

Source:

• paint.js, line 1070

Parameters:

Returns:

Type

object

traceUsers(event)

Description:

• display the awareness events

Source:

• prsm.js, line 4857

Parameters:

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

Description:

• swap cell values across the leading diagonal

Source:

• trophic.js, line 87

Parameters:

Returns:

Type

Array.<array>

trophic(data)

Description:

• shift the positions of nodes according to the trophic 'height' (actually, here, the x coordinate)

Source:

• trophic.js, line 379

Parameters:

Returns:

unFollow()

Description:

• User was following another user, but has now clicked off the avatar, so stop following

Source:

• prsm.js, line 5086

unSelect()

Description:

• unselect all nodes and edges

Source:

• prsm.js, line 2830

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

Description:

• convert a directed adjacency matrix to an undirected one mirror the elements above the leading diagonal to below it

Source:

• trophic.js, line 45

Parameters: