lcars-library-node
Version:
NodeJS module for creating a library for the LCARS dashboard system
1,535 lines (1,534 loc) • 73.5 kB
JSON
{
"project": {
"name": "lcars-library-node",
"description": "NodeJS module for creating a library for the LCARS dashboard system",
"version": "0.0.0",
"url": "https://github.com/RefugeSystems/lcars-library-node#readme"
},
"files": {
"library\\configuration\\storage.js": {
"name": "library\\configuration\\storage.js",
"modules": {},
"classes": {
"Storage": 1
},
"fors": {},
"namespaces": {}
},
"library\\connections\\_user.js": {
"name": "library\\connections\\_user.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"library\\connections\\authentication.js": {
"name": "library\\connections\\authentication.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"library\\connections\\exception.js": {
"name": "library\\connections\\exception.js",
"modules": {
"Connections": 1
},
"classes": {
"Exception": 1
},
"fors": {},
"namespaces": {}
},
"library\\connections\\external.js": {
"name": "library\\connections\\external.js",
"modules": {},
"classes": {
"External": 1
},
"fors": {},
"namespaces": {}
},
"library\\connections\\session.js": {
"name": "library\\connections\\session.js",
"modules": {},
"classes": {
"Session": 1
},
"fors": {},
"namespaces": {}
},
"library\\connections\\terminal.js": {
"name": "library\\connections\\terminal.js",
"modules": {},
"classes": {
"Terminal": 1
},
"fors": {},
"namespaces": {}
},
"library\\connections\\user.js": {
"name": "library\\connections\\user.js",
"modules": {},
"classes": {
"User": 1
},
"fors": {},
"namespaces": {}
},
"library\\elements\\edge.js": {
"name": "library\\elements\\edge.js",
"modules": {},
"classes": {
"Edge": 1
},
"fors": {},
"namespaces": {}
},
"library\\elements\\element.js": {
"name": "library\\elements\\element.js",
"modules": {},
"classes": {
"Distress": 1,
"Element": 1
},
"fors": {},
"namespaces": {}
},
"library\\elements\\event.js": {
"name": "library\\elements\\event.js",
"modules": {},
"classes": {
"Event": 1
},
"fors": {},
"namespaces": {}
},
"library\\elements\\index.js": {
"name": "library\\elements\\index.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"library\\elements\\modification.js": {
"name": "library\\elements\\modification.js",
"modules": {
"Elements": 1
},
"classes": {
"Modification": 1
},
"fors": {},
"namespaces": {}
},
"library\\elements\\page.js": {
"name": "library\\elements\\page.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"library\\space\\circulation.js": {
"name": "library\\space\\circulation.js",
"modules": {},
"classes": {
"Circulation": 1
},
"fors": {},
"namespaces": {}
},
"library\\space\\search.js": {
"name": "library\\space\\search.js",
"modules": {},
"classes": {
"Search": 1
},
"fors": {},
"namespaces": {}
},
"library\\space\\set.js": {
"name": "library\\space\\set.js",
"modules": {},
"classes": {
"Set": 1
},
"fors": {},
"namespaces": {}
},
"library\\util\\random.js": {
"name": "library\\util\\random.js",
"modules": {},
"classes": {
"Random": 1
},
"fors": {},
"namespaces": {}
},
"library\\library.js": {
"name": "library\\library.js",
"modules": {},
"classes": {
"LCARSLibrary": 1
},
"fors": {},
"namespaces": {}
},
"library\\x-beta.js": {
"name": "library\\x-beta.js",
"modules": {},
"classes": {
"LCARSServer": 1
},
"fors": {},
"namespaces": {}
}
},
"modules": {
"Connections": {
"name": "Connections",
"submodules": {},
"elements": {},
"classes": {
"Storage": 1,
"User": 1,
"Exception": 1,
"External": 1,
"Session": 1,
"Terminal": 1
},
"fors": {},
"namespaces": {},
"tag": "module",
"file": "library\\connections\\terminal.js",
"line": 2
},
"Elements": {
"name": "Elements",
"submodules": {},
"elements": {},
"classes": {
"Edge": 1,
"Distress": 1,
"Element": 1,
"Event": 1,
"Modification": 1,
"Set": 1,
"Circulation": 1,
"Search": 1,
"Random": 1,
"LCARSLibrary": 1,
"LCARSServer": 1
},
"fors": {},
"namespaces": {},
"tag": "module",
"file": "library\\x-beta.js",
"line": 3,
"itemtype": "main"
}
},
"classes": {
"Storage": {
"name": "Storage",
"shortname": "Storage",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Connections",
"file": "library\\configuration\\storage.js",
"line": 3,
"is_constructor": 1,
"params": [
{
"name": "definition",
"description": "",
"type": "Object"
}
]
},
"User": {
"name": "User",
"shortname": "User",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Connections",
"file": "library\\connections\\user.js",
"line": 7,
"is_constructor": 1,
"params": [
{
"name": "details",
"description": "",
"type": "Object"
}
]
},
"Exception": {
"name": "Exception",
"shortname": "Exception",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Connections",
"file": "library\\connections\\exception.js",
"line": 5,
"is_constructor": 1,
"params": [
{
"name": "session",
"description": "",
"type": "Object"
},
{
"name": "origin",
"description": "ID of the element from which the event occurred.",
"type": "String"
},
{
"name": "description",
"description": "",
"type": "Object"
}
]
},
"External": {
"name": "External",
"shortname": "External",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Connections",
"namespace": "",
"file": "library\\connections\\external.js",
"line": 2,
"description": "A connection to another LCARS Library for additional elements and links.",
"is_constructor": 1,
"params": [
{
"name": "commonName",
"description": "Used in defining URLs in a reusable format between libraries.",
"type": "String"
},
{
"name": "address",
"description": "The literal address, generally either an IP or a Fully Qualified Domain Name (FQDN).",
"type": "String"
},
{
"name": "description",
"description": "",
"type": "String"
},
{
"name": "socket",
"description": "",
"type": "Socket"
},
{
"name": "options",
"description": "",
"type": "Object"
}
]
},
"Session": {
"name": "Session",
"shortname": "Session",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Connections",
"namespace": "",
"file": "library\\connections\\session.js",
"line": 5,
"description": "Representation of message access request to retrieve information\nfrom the library and process any needed session information.",
"is_constructor": 1,
"params": [
{
"name": "description",
"description": "",
"type": "Object"
},
{
"name": "description",
"description": "",
"type": "WebSocket | Socket | Request"
}
]
},
"Terminal": {
"name": "Terminal",
"shortname": "Terminal",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Connections",
"namespace": "",
"file": "library\\connections\\terminal.js",
"line": 2,
"is_constructor": 1,
"params": [
{
"name": "connection",
"description": "",
"type": "WebSocket"
},
{
"name": "library",
"description": "",
"type": "Library"
}
]
},
"Edge": {
"name": "Edge",
"shortname": "Edge",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Elements",
"namespace": "",
"file": "library\\elements\\edge.js",
"line": 5,
"is_constructor": 1,
"params": [
{
"name": "session",
"description": "",
"type": "Object"
},
{
"name": "source",
"description": "",
"type": "String"
},
{
"name": "target",
"description": "",
"type": "String"
},
{
"name": "description",
"description": "",
"type": "Object"
}
]
},
"Distress": {
"name": "Distress",
"shortname": "Distress",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Elements",
"namespace": "",
"file": "library\\elements\\element.js",
"line": 5,
"is_constructor": 1
},
"Element": {
"name": "Element",
"shortname": "Element",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Elements",
"namespace": "",
"file": "library\\elements\\element.js",
"line": 38,
"is_constructor": 1,
"params": [
{
"name": "session",
"description": "",
"type": "Object"
},
{
"name": "description",
"description": "",
"type": "Object"
}
]
},
"Event": {
"name": "Event",
"shortname": "Event",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Elements",
"namespace": "",
"file": "library\\elements\\event.js",
"line": 5,
"is_constructor": 1,
"params": [
{
"name": "session",
"description": "",
"type": "Object"
},
{
"name": "origin",
"description": "ID of the element from which the event occurred.",
"type": "String"
},
{
"name": "description",
"description": "",
"type": "Object"
}
]
},
"Modification": {
"name": "Modification",
"shortname": "Modification",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Elements",
"namespace": "",
"file": "library\\elements\\modification.js",
"line": 6,
"is_constructor": 1,
"params": [
{
"name": "session",
"description": "",
"type": "Object"
},
{
"name": "origin",
"description": "ID of the element from which the event occurred.",
"type": "String"
},
{
"name": "description",
"description": "",
"type": "Object"
}
]
},
"Set": {
"name": "Set",
"shortname": "Set",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Elements",
"namespace": "",
"file": "library\\space\\set.js",
"line": 12,
"description": "Represents the set of links that connect elements. Various collections serve different\npurposes for how they connect and can inherit from one another.",
"is_constructor": 1,
"params": [
{
"name": "session",
"description": "",
"type": "Object"
},
{
"name": "description",
"description": "",
"type": "Object"
}
]
},
"Circulation": {
"name": "Circulation",
"shortname": "Circulation",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Elements",
"namespace": "",
"file": "library\\space\\circulation.js",
"line": 5,
"description": "Pushes an event around between elements and checks their status.",
"is_constructor": 1,
"params": [
{
"name": "event",
"description": "",
"type": "Event"
},
{
"name": "collections",
"description": "",
"type": "Array"
}
]
},
"Search": {
"name": "Search",
"shortname": "Search",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Elements",
"namespace": "",
"file": "library\\space\\search.js",
"line": 2,
"is_constructor": 1,
"static": 1
},
"Random": {
"name": "Random",
"shortname": "Random",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Elements",
"namespace": "",
"file": "library\\util\\random.js",
"line": 2,
"description": "Provides static references to randomization functions.",
"is_constructor": 1,
"static": 1
},
"LCARSLibrary": {
"name": "LCARSLibrary",
"shortname": "LCARSLibrary",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Elements",
"namespace": "",
"file": "library\\library.js",
"line": 4,
"is_constructor": 1,
"params": [
{
"name": "configuration",
"description": "",
"type": "Object"
}
]
},
"LCARSServer": {
"name": "LCARSServer",
"shortname": "LCARSServer",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Elements",
"namespace": "",
"file": "library\\x-beta.js",
"line": 3,
"description": "General Library Access/Retrieval Server for the LCARS Library\n\nThe library serves as an endpoint for specific collections as designated by the\nconfiguration. A websocket is used to synchronize collections being provided to\nvarious registrations, allowing for multiple displays to synchronize displayed\ndata.",
"is_constructor": 1,
"params": [
{
"name": "handler",
"description": "",
"type": "Handler"
}
]
}
},
"elements": {},
"classitems": [
{
"file": "library\\connections\\_user.js",
"line": 19,
"itemtype": "property",
"name": "username",
"type": "String",
"class": "User"
},
{
"file": "library\\connections\\_user.js",
"line": 25,
"itemtype": "property",
"name": "id",
"type": "String",
"class": "User"
},
{
"file": "library\\connections\\_user.js",
"line": 31,
"description": "Field values for arbitrary data.",
"itemtype": "property",
"name": "data",
"type": "Object",
"class": "User"
},
{
"file": "library\\connections\\_user.js",
"line": 53,
"description": "Return an identifier for a User.",
"itemtype": "method",
"name": "userID",
"static": 1,
"access": "private",
"tagname": "",
"return": {
"description": "A string for identifying an event.",
"type": "String"
},
"class": "User"
},
{
"file": "library\\connections\\authentication.js",
"line": 145,
"description": "Middleware for validating user access to the requested resource.",
"itemtype": "method",
"name": "authorization",
"type": "Middleware",
"class": "Exception"
},
{
"file": "library\\connections\\exception.js",
"line": 23,
"itemtype": "property",
"name": "id",
"type": "String",
"class": "Exception",
"module": "Connections"
},
{
"file": "library\\connections\\exception.js",
"line": 30,
"description": "Serves as a general descriptor for the exception.",
"itemtype": "property",
"name": "code",
"type": "String",
"class": "Exception",
"module": "Connections"
},
{
"file": "library\\connections\\exception.js",
"line": 37,
"itemtype": "property",
"name": "session",
"type": "String",
"class": "Exception",
"module": "Connections"
},
{
"file": "library\\connections\\exception.js",
"line": 44,
"itemtype": "property",
"name": "request",
"type": "String",
"class": "Exception",
"module": "Connections"
},
{
"file": "library\\connections\\exception.js",
"line": 51,
"itemtype": "property",
"name": "error",
"type": "Object",
"class": "Exception",
"module": "Connections"
},
{
"file": "library\\connections\\exception.js",
"line": 58,
"itemtype": "property",
"name": "message",
"type": "String",
"class": "Exception",
"module": "Connections"
},
{
"file": "library\\connections\\exception.js",
"line": 65,
"description": "When the exception occurred.",
"itemtype": "property",
"name": "occurred",
"type": "Number",
"class": "Exception",
"module": "Connections"
},
{
"file": "library\\connections\\session.js",
"line": 31,
"itemtype": "property",
"name": "id",
"type": "String",
"class": "Session",
"module": "Connections"
},
{
"file": "library\\connections\\session.js",
"line": 38,
"itemtype": "property",
"name": "username",
"type": "String",
"class": "Session",
"module": "Connections"
},
{
"file": "library\\connections\\session.js",
"line": 45,
"description": "Due to the way passport processes requests, the source\nIP isn't available at sign-in. Additionally, this field\nis being moved to an array to track possible multitudes\nof IP addresses.",
"itemtype": "property",
"name": "srcip",
"type": "String",
"deprecated": true,
"class": "Session",
"module": "Connections"
},
{
"file": "library\\connections\\session.js",
"line": 56,
"description": "Tracks IP addresses seen inside this session",
"itemtype": "property",
"name": "ips",
"type": "String",
"class": "Session",
"module": "Connections"
},
{
"file": "library\\connections\\session.js",
"line": 63,
"description": "The passport request string that generated\nthis request.",
"itemtype": "property",
"name": "source",
"type": "String",
"class": "Session",
"module": "Connections"
},
{
"file": "library\\connections\\session.js",
"line": 71,
"description": "When this session was established.",
"itemtype": "property",
"name": "authenticated",
"type": "Number",
"class": "Session",
"module": "Connections"
},
{
"file": "library\\connections\\session.js",
"line": 78,
"description": "The String representing the code for this session.",
"itemtype": "property",
"name": "authenticator",
"type": "String",
"class": "Session",
"module": "Connections"
},
{
"file": "library\\connections\\session.js",
"line": 85,
"description": "String used for looking up this session that should be deleted\nafter fetch.",
"itemtype": "property",
"name": "connector",
"type": "String",
"class": "Session",
"module": "Connections"
},
{
"file": "library\\connections\\session.js",
"line": 93,
"description": "When set, this names the Tower instance to which the user has an\nactive websocket.",
"itemtype": "property",
"name": "connected",
"type": "String",
"class": "Session",
"module": "Connections"
},
{
"file": "library\\connections\\session.js",
"line": 101,
"description": "The last time this session was used.",
"itemtype": "property",
"name": "last",
"type": "Number",
"class": "Session",
"module": "Connections"
},
{
"file": "library\\connections\\session.js",
"line": 108,
"description": "The Refuge user id",
"itemtype": "property",
"name": "user",
"type": "String",
"class": "Session",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 17,
"description": "Full name of user",
"itemtype": "property",
"name": "name",
"type": "String",
"class": "User",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 23,
"description": "URL of profile picture",
"itemtype": "property",
"name": "image",
"type": "String",
"class": "User",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 29,
"description": "User's username.",
"itemtype": "property",
"name": "username",
"type": "String",
"class": "User",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 35,
"description": "User's GMail account for google auth.",
"itemtype": "property",
"name": "gmail",
"type": "String",
"class": "User",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 41,
"description": "User's eMail account for general correspondence.",
"itemtype": "property",
"name": "gmail",
"type": "String",
"class": "User",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 47,
"description": "Describes where to contact the user, type is prepended as\na protocol and is partially defined by parsing the contact\nstring for patterns.",
"itemtype": "property",
"name": "contact",
"type": "String",
"class": "User",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 55,
"description": "The minecraft user for this user",
"itemtype": "property",
"name": "minecraft",
"type": "String",
"class": "User",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 61,
"description": "The steam user for this user",
"itemtype": "property",
"name": "steam",
"type": "String",
"class": "User",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 67,
"description": "BattleNet Tag",
"itemtype": "property",
"name": "battlenet",
"type": "String",
"class": "User",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 73,
"description": "League of Legends Main",
"itemtype": "property",
"name": "pvpnet",
"type": "String",
"class": "User",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 79,
"description": "When this User was last modified wise of properties\nor permissions.",
"proptery": "modified",
"type": "Number",
"class": "User",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 86,
"description": "Map of authorizations by grant for lookup. This is based on the\nauthorizations array and stored for debugging.",
"itemtype": "property",
"name": "authorized",
"type": "Object",
"class": "User",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 93,
"description": "String array of session ObjectId's (This prevents\nother sessions from being exposed in links).",
"itemtype": "property",
"name": "sessions",
"type": "String",
"class": "User",
"module": "Connections"
},
{
"file": "library\\connections\\user.js",
"line": 100,
"description": "List of seen IPs for security purposes.",
"itemtype": "property",
"name": "ips",
"type": "String",
"class": "User",
"module": "Connections"
},
{
"file": "library\\elements\\edge.js",
"line": 30,
"itemtype": "property",
"name": "id",
"type": "String",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 37,
"itemtype": "property",
"name": "name",
"type": "String",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 44,
"description": "Links exist in distinct pages that may or may not be part of the master page.\nThis allows resources to be expressed in different manners and for those manners to inherit\na page or not.",
"itemtype": "property",
"name": "page",
"type": "String",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 54,
"description": "When true, this link is considered limited to the set and not the master list.",
"itemtype": "property",
"name": "private",
"type": "Boolean",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 61,
"description": "When determining if an element is \"in distress\" or not, the contribution of all supporting\nelements is considered during an update.\n\nThis must result in a number to be considered valid and is passed the status of the \"source\"\nand \"target\" as 0: Functional, 1: Warning, 2: Exception, or 3: Deactivated .",
"itemtype": "property",
"name": "contribution",
"type": "String",
"optional": 1,
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 73,
"description": "Markdown style string describing the element.",
"itemtype": "property",
"name": "description",
"type": "String",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 80,
"itemtype": "property",
"name": "type",
"type": "String",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 87,
"itemtype": "property",
"name": "subtype",
"type": "String",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 94,
"description": "When true, this edge is no longer used when calculating support/dependency\ntrees or event propagation, but it will still appear in searches and show in\nexploratory graphs and searches.",
"itemtype": "property",
"name": "removed",
"type": "Boolean",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 103,
"itemtype": "property",
"name": "source",
"type": "String",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 110,
"itemtype": "property",
"name": "target",
"type": "String",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 117,
"itemtype": "property",
"name": "fields",
"type": "Object",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 124,
"itemtype": "property",
"name": "creater",
"type": "String",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 131,
"itemtype": "property",
"name": "created",
"type": "Number",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 138,
"itemtype": "property",
"name": "modifier",
"type": "String",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\edge.js",
"line": 145,
"itemtype": "property",
"name": "modified",
"type": "Number",
"class": "Edge",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 12,
"description": "Above this status, this element is considered okay. Below this\nvalue, but above {{#crossLink \"Distress/exception:property}}{{/crossLink}}\nthe element is considered to be in distress.\n\nTypically this should be viewed as a \"percent supported\", but this scheme\ncan be adjusted by setting link contributions to perform differently.",
"itemtype": "property",
"name": "functional",
"type": "Number",
"default": "70",
"class": "Distress",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 24,
"description": "Above this number and below {{#crossLink \"Distress/functional:property}}{{/crossLink}}\nthe element is considered to be in distress. Below this value, the element is\nconsidered to have encountered an exception.\n\nTypically this should be viewed as a \"percent supported\", but this scheme\ncan be adjusted by setting link contributions to perform differently.",
"itemtype": "property",
"name": "exception",
"type": "Number",
"default": "30",
"class": "Distress",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 69,
"itemtype": "property",
"name": "id",
"type": "String",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 76,
"itemtype": "property",
"name": "name",
"type": "String",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 83,
"description": "Markdown style string describing the element.",
"itemtype": "property",
"name": "description",
"type": "String",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 90,
"itemtype": "property",
"name": "status",
"type": "Number",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 97,
"itemtype": "property",
"name": "distress",
"type": "Number",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 104,
"itemtype": "property",
"name": "type",
"type": "String",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 111,
"itemtype": "property",
"name": "subtype",
"type": "String",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 118,
"description": "Indicates if the element should be considered active.\n\nThis does _NOT_ affect it's availability for querying or graph linking,\nthis is simply an extension of the status.\n\nAn example would be taking a server offline for maintenance.\n\nSee {{#crossLink Element/removed:property}}{{/crossLink}} for making an\nelement unavailable to searches and linking.",
"itemtype": "property",
"name": "active",
"type": "Boolean",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 133,
"description": "When true, this element is no longer used when calculating support/dependency\ntrees or event propagation, but it will still appear in searches and show in\nexploratory graphs and searches.",
"itemtype": "property",
"name": "removed",
"type": "Boolean",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 142,
"itemtype": "property",
"name": "distress",
"type": "Distress",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 149,
"itemtype": "property",
"name": "fields",
"type": "Object",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 156,
"itemtype": "property",
"name": "creater",
"type": "String",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 163,
"itemtype": "property",
"name": "created",
"type": "Number",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 170,
"itemtype": "property",
"name": "modifier",
"type": "String",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\element.js",
"line": 177,
"itemtype": "property",
"name": "modified",
"type": "Number",
"class": "Element",
"module": "Elements"
},
{
"file": "library\\elements\\event.js",
"line": 24,
"itemtype": "property",
"name": "id",
"type": "String",
"class": "Event",
"module": "Elements"
},
{
"file": "library\\elements\\event.js",
"line": 31,
"itemtype": "property",
"name": "label",
"type": "String",
"class": "Event",
"module": "Elements"
},
{
"file": "library\\elements\\event.js",
"line": 38,
"description": "Markdown style string describing the event.",
"itemtype": "property",
"name": "description",
"type": "String",
"class": "Event",
"module": "Elements"
},
{
"file": "library\\elements\\event.js",
"line": 45,
"itemtype": "property",
"name": "type",
"type": "String",
"class": "Event",
"module": "Elements"
},
{
"file": "library\\elements\\event.js",
"line": 52,
"itemtype": "property",
"name": "subtype",
"type": "String",
"class": "Event",
"module": "Elements"
},
{
"file": "library\\elements\\event.js",
"line": 59,
"description": "Array of Element IDs that this event has touched.",
"itemtype": "property",
"name": "touched",
"type": "Array | String",
"class": "Event",
"module": "Elements"
},
{
"file": "library\\elements\\event.js",
"line": 66,
"itemtype": "property",
"name": "occurred",
"type": "Number",
"class": "Event",
"module": "Elements"
},
{
"file": "library\\elements\\event.js",
"line": 73,
"description": "The session, if any, from which this event originated.\n\nOnly defined for user initiated events. Undefined indicates a system event.",
"itemtype": "property",
"name": "session",
"type": "String",
"class": "Event",
"module": "Elements"
},
{
"file": "library\\elements\\event.js",
"line": 82,
"description": "Indicated the ID of the element from which this event is considered to have\noriginated.",
"itemtype": "property",
"name": "origin",
"type": "String",
"class": "Event",
"module": "Elements"
},
{
"file": "library\\elements\\page.js",
"line": 25,
"itemtype": "property",
"name": "id",
"type": "String",
"class": "Set",
"module": "Elements"
},
{
"file": "library\\elements\\page.js",
"line": 32,
"itemtype": "property",
"name": "name",
"type": "String",
"class": "Set",
"module": "Elements"
},
{
"file": "library\\elements\\page.js",
"line": 39,
"description": "When true, edges in this page are considered limited to the page and not the master list.",
"itemtype": "property",
"name": "private",
"type": "Boolean",
"class": "Set",
"module": "Elements"
},
{
"file": "library\\elements\\page.js",
"line": 46,
"description": "Markdown style string describing the purpose of the set.",
"itemtype": "property",
"name": "description",
"type": "String",
"class": "Set",
"module": "Elements"
},
{
"file": "library\\elements\\page.js",
"line": 53,
"description": "Custom fields to use to tag the set for informational purposes.",
"itemtype": "property",
"name": "fields",
"type": "Object",
"class": "Set",
"module": "Elements"
},
{
"file": "library\\elements\\page.js",
"line": 60,
"description": "Array of page IDs that should be considered a subgroup of this page.",
"itemtype": "property",
"name": "touched",
"type": "Array | String",
"class": "Set",
"module": "Elements"
},
{
"file": "library\\elements\\page.js",
"line": 67,
"itemtype": "property",
"name": "creater",
"type": "String",
"class": "Set",
"module": "Elements"
},
{
"file": "library\\elements\\page.js",
"line": 74,
"itemtype": "property",
"name": "created",
"type": "Number",
"class": "Set",
"module": "Elements"
},
{
"file": "library\\elements\\page.js",
"line": 81,
"itemtype": "property",
"name": "modifier",
"type": "String",
"class": "Set",
"module": "Elements"
},
{
"file": "library\\elements\\page.js",
"line": 88,
"itemtype": "property",
"name": "modified",
"type": "Number",
"class": "Set",
"module": "Elements"
},
{
"file": "library\\space\\circulation.js",
"line": 18,
"description": "Note: When calculating distress, contribution by links is not required and should default to\n 100 / {The Number of Support Links}, ie. That link's percent of the support.",
"params": [
{
"name": "element",
"description": "",
"type": "Element"
},
{
"name": "collections",
"description": "",
"type": "Array"
},
{
"name": "callback",
"description": "",