[
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Button Template",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 16,
"offset": 15
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 16,
"offset": 15
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 16,
"offset": 15
}
}
},
"tags": [],
"loc": {
"start": {
"line": 8,
"column": 0
},
"end": {
"line": 10,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 12,
"column": 0
},
"end": {
"line": 222,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/components/buttontemplate.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [],
"params": [
{
"title": "param",
"name": "args",
"lineNumber": 14
},
{
"title": "param",
"name": "options",
"lineNumber": 14
},
{
"title": "param",
"name": "defaults",
"lineNumber": 14
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "ButtonTemplate",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Whether the button is on (pressed) or off (not pressed)",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "boolean"
}
},
{
"title": "example",
"description": "button.state = true;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 141,
"column": 2
},
"end": {
"line": 145,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 146,
"column": 2
},
"end": {
"line": 148,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/components/buttontemplate.js"
},
"augments": [],
"examples": [
{
"description": "button.state = true;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "state",
"kind": "member",
"memberof": "ButtonTemplate",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "ButtonTemplate",
"kind": "class"
},
{
"name": "state",
"kind": "member",
"scope": "instance"
}
],
"namespace": "ButtonTemplate#state"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Change the button to its alternate state (off=>on, on=>off), or flip it to a specified state.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 94,
"offset": 93
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 94,
"offset": 93
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 94,
"offset": 93
}
}
},
"tags": [
{
"title": "param",
"description": "{boolean} (Optional) State to flip to.",
"lineNumber": 2,
"type": null,
"name": "value"
},
{
"title": "example",
"description": "button.flip();",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 163,
"column": 2
},
"end": {
"line": 167,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 168,
"column": 2
},
"end": {
"line": 180,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/components/buttontemplate.js"
},
"augments": [],
"examples": [
{
"description": "button.flip();"
}
],
"params": [
{
"title": "param",
"name": "value",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{boolean} (Optional) State to flip to.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "flip",
"kind": "function",
"memberof": "ButtonTemplate",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "ButtonTemplate",
"kind": "class"
},
{
"name": "flip",
"kind": "function",
"scope": "instance"
}
],
"namespace": "ButtonTemplate#flip"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Turn the button's state to true.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 33,
"offset": 32
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 33,
"offset": 32
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 33,
"offset": 32
}
}
},
"tags": [
{
"title": "example",
"description": "button.turnOn();",
"lineNumber": 2
}
],
"loc": {
"start": {
"line": 182,
"column": 2
},
"end": {
"line": 185,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 186,
"column": 2
},
"end": {
"line": 200,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/components/buttontemplate.js"
},
"augments": [],
"examples": [
{
"description": "button.turnOn();"
}
],
"params": [
{
"title": "param",
"name": "emitting",
"lineNumber": 186
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "turnOn",
"kind": "function",
"memberof": "ButtonTemplate",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "ButtonTemplate",
"kind": "class"
},
{
"name": "turnOn",
"kind": "function",
"scope": "instance"
}
],
"namespace": "ButtonTemplate#turnOn"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Turn the button's state to false.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 34,
"offset": 33
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 34,
"offset": 33
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 34,
"offset": 33
}
}
},
"tags": [
{
"title": "example",
"description": "button.turnOff();",
"lineNumber": 2
}
],
"loc": {
"start": {
"line": 202,
"column": 2
},
"end": {
"line": 205,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 206,
"column": 2
},
"end": {
"line": 220,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/components/buttontemplate.js"
},
"augments": [],
"examples": [
{
"description": "button.turnOff();"
}
],
"params": [
{
"title": "param",
"name": "emitting",
"lineNumber": 206
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "turnOff",
"kind": "function",
"memberof": "ButtonTemplate",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "ButtonTemplate",
"kind": "class"
},
{
"name": "turnOff",
"kind": "function",
"scope": "instance"
}
],
"namespace": "ButtonTemplate#turnOff"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "ButtonTemplate",
"kind": "class"
}
],
"namespace": "ButtonTemplate"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The slider's current value. If set manually, will update the interface and trigger the output event.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 101,
"offset": 100
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 101,
"offset": 100
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 101,
"offset": 100
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "slider.value = 10;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 185,
"column": 2
},
"end": {
"line": 189,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 190,
"column": 2
},
"end": {
"line": 192,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/components/slidertemplate.js"
},
"augments": [],
"examples": [
{
"description": "slider.value = 10;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "value",
"kind": "member",
"memberof": "SliderTemplate",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "value",
"kind": "member",
"scope": "instance"
}
],
"namespace": "#value"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Lower limit of the sliders's output range",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "slider.min = 1000;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 199,
"column": 2
},
"end": {
"line": 203,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 204,
"column": 2
},
"end": {
"line": 206,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/components/slidertemplate.js"
},
"augments": [],
"examples": [
{
"description": "slider.min = 1000;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "min",
"kind": "member",
"memberof": "SliderTemplate",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "min",
"kind": "member",
"scope": "instance"
}
],
"namespace": "#min"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Upper limit of the slider's output range",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 41,
"offset": 40
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 41,
"offset": 40
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 41,
"offset": 40
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "slider.max = 1000;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 211,
"column": 2
},
"end": {
"line": 215,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 216,
"column": 2
},
"end": {
"line": 218,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/components/slidertemplate.js"
},
"augments": [],
"examples": [
{
"description": "slider.max = 1000;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "max",
"kind": "member",
"memberof": "SliderTemplate",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "max",
"kind": "member",
"scope": "instance"
}
],
"namespace": "#max"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The increment that the slider's value changes by.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "slider.step = 5;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 223,
"column": 2
},
"end": {
"line": 227,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 228,
"column": 2
},
"end": {
"line": 230,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/components/slidertemplate.js"
},
"augments": [],
"examples": [
{
"description": "slider.step = 5;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "step",
"kind": "member",
"memberof": "SliderTemplate",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "step",
"kind": "member",
"scope": "instance"
}
],
"namespace": "#step"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Absolute mode (slider's value jumps to mouse click position) or relative mode (mouse drag changes value relative to its current position). Default: \"relative\".",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 160,
"offset": 159
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 160,
"offset": 159
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 160,
"offset": 159
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "string"
}
},
{
"title": "example",
"description": "slider.mode = \"relative\";",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 235,
"column": 2
},
"end": {
"line": 239,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 240,
"column": 2
},
"end": {
"line": 242,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/components/slidertemplate.js"
},
"augments": [],
"examples": [
{
"description": "slider.mode = \"relative\";"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "mode",
"kind": "member",
"memberof": "SliderTemplate",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "mode",
"kind": "member",
"scope": "instance"
}
],
"namespace": "#mode"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Interface",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 10,
"offset": 9
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 10,
"offset": 9
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 10,
"offset": 9
}
}
},
"tags": [],
"loc": {
"start": {
"line": 11,
"column": 0
},
"end": {
"line": 13,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 14,
"column": 0
},
"end": {
"line": 306,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/core/interface.js"
},
"augments": [
{
"title": "augments",
"name": "EventEmitter"
}
],
"examples": [],
"params": [
{
"title": "param",
"name": "args",
"lineNumber": 16
},
{
"title": "param",
"name": "options",
"lineNumber": 16
},
{
"title": "param",
"name": "defaults",
"lineNumber": 16
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Interface",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Resize the interface",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
}
}
},
"tags": [
{
"title": "param",
"description": "{number} New width in pixels",
"lineNumber": 2,
"type": null,
"name": "width"
},
{
"title": "param",
"description": "{number} New height in pixels",
"lineNumber": 3,
"type": null,
"name": "height"
},
{
"title": "example",
"description": "button.resize(100,100);",
"lineNumber": 5
}
],
"loc": {
"start": {
"line": 257,
"column": 2
},
"end": {
"line": 264,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 265,
"column": 2
},
"end": {
"line": 273,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/core/interface.js"
},
"augments": [],
"examples": [
{
"description": "button.resize(100,100);"
}
],
"params": [
{
"title": "param",
"name": "width",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} New width in pixels",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 29,
"offset": 28
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 29,
"offset": 28
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 29,
"offset": 28
}
}
}
},
{
"title": "param",
"name": "height",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} New height in pixels",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 30,
"offset": 29
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 30,
"offset": 29
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 30,
"offset": 29
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "resize",
"kind": "function",
"memberof": "Interface",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Interface",
"kind": "class"
},
{
"name": "resize",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Interface#resize"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Remove the interface from the page and cancel its event listener(s).",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 69,
"offset": 68
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 69,
"offset": 68
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 69,
"offset": 68
}
}
},
"tags": [
{
"title": "example",
"description": "button.destroy();",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 281,
"column": 2
},
"end": {
"line": 286,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 287,
"column": 2
},
"end": {
"line": 295,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/core/interface.js"
},
"augments": [],
"examples": [
{
"description": "button.destroy();"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "destroy",
"kind": "function",
"memberof": "Interface",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Interface",
"kind": "class"
},
{
"name": "destroy",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Interface#destroy"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Interface",
"kind": "class"
}
],
"namespace": "Interface"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Circular button with optional aftertouch.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
}
}
},
"tags": [
{
"title": "description",
"description": "Circular button with optional aftertouch.",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"button\"></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var button = new Nexus.Button('#target')",
"lineNumber": 7
},
{
"title": "example",
"description": "var button = new Nexus.Button('#target',{\n 'size': [80,80],\n 'mode': 'aftertouch',\n 'state': false\n})",
"lineNumber": 10
},
{
"title": "output",
"description": "change\nFires any time the interface's value changes. <br>\nIn <b>button mode</b>, <b>toggle mode</b>, and <b>impulse mode</b>, the output data is a boolean describing the state of the button.<br>\nIn <b>aftertouch mode</b>, the output data is an object containing x (0-1) and y (0-1) positions of aftertouch.",
"lineNumber": 17
},
{
"title": "outputexample",
"description": "button.on('change',function(v) {\n // v is the value of the button\n console.log(v);\n})",
"lineNumber": 23
}
],
"loc": {
"start": {
"line": 6,
"column": 0
},
"end": {
"line": 35,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 37,
"column": 0
},
"end": {
"line": 120,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/button.js"
},
"augments": [
{
"title": "augments",
"name": "ButtonTemplate"
}
],
"examples": [
{
"description": "var button = new Nexus.Button('#target')"
},
{
"description": "var button = new Nexus.Button('#target',{\n 'size': [80,80],\n 'mode': 'aftertouch',\n 'state': false\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Button",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Interaction mode: supports \"button\", \"aftertouch\", \"impulse\", or \"toggle\"",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 74,
"offset": 73
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 74,
"offset": 73
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 74,
"offset": 73
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "string"
}
},
{
"title": "example",
"description": "button.mode = 'toggle';",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 53,
"column": 4
},
"end": {
"line": 57,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 58,
"column": 4
},
"end": {
"line": 58,
"column": 35
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/button.js"
},
"augments": [],
"examples": [
{
"description": "button.mode = 'toggle';"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "mode",
"memberof": "Button",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Button",
"kind": "class"
},
{
"name": "mode",
"scope": "instance"
}
],
"namespace": "Button#mode"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Button",
"kind": "class"
}
],
"namespace": "Button"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Dial with radial or linear interaction.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
},
"tags": [
{
"title": "description",
"description": "Dial with radial or linear interaction.",
"lineNumber": 4
},
{
"title": "demo",
"description": "<span nexus-ui=\"dial\"></span>",
"lineNumber": 6
},
{
"title": "example",
"description": "var dial = new Nexus.Dial('#target')",
"lineNumber": 8
},
{
"title": "example",
"description": "var dial = new Nexus.Dial('#target',{\n 'size': [75,75],\n 'interaction': 'radial', // \"radial\", \"vertical\", or \"horizontal\"\n 'mode': 'relative', // \"absolute\" or \"relative\"\n 'min': 0,\n 'max': 1,\n 'step': 0,\n 'value': 0\n})",
"lineNumber": 11
},
{
"title": "output",
"description": "change\nFires any time the interface's value changes. <br>\nThe event data is the number value of the interface.",
"lineNumber": 22
},
{
"title": "outputexample",
"description": "dial.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 27
},
{
"title": "tutorial",
"description": "Dial\nygGMxq",
"lineNumber": 32
}
],
"loc": {
"start": {
"line": 9,
"column": 0
},
"end": {
"line": 45,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 47,
"column": 0
},
"end": {
"line": 379,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/dial.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var dial = new Nexus.Dial('#target')"
},
{
"description": "var dial = new Nexus.Dial('#target',{\n 'size': [75,75],\n 'interaction': 'radial', // \"radial\", \"vertical\", or \"horizontal\"\n 'mode': 'relative', // \"absolute\" or \"relative\"\n 'min': 0,\n 'max': 1,\n 'step': 0,\n 'value': 0\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Dial",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Dial's value. When set, it will automatically be adjust to fit min/max/step settings of the interface.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 103,
"offset": 102
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 103,
"offset": 102
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 103,
"offset": 102
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "dial.value = 10;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 301,
"column": 4
},
"end": {
"line": 305,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 306,
"column": 4
},
"end": {
"line": 308,
"column": 5
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/dial.js"
},
"augments": [],
"examples": [
{
"description": "dial.value = 10;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "value",
"kind": "member",
"memberof": "Dial",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Dial",
"kind": "class"
},
{
"name": "value",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Dial#value"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Lower limit of the dial's output range",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "dial.min = 1000;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 316,
"column": 4
},
"end": {
"line": 320,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 321,
"column": 4
},
"end": {
"line": 323,
"column": 5
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/dial.js"
},
"augments": [],
"examples": [
{
"description": "dial.min = 1000;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "min",
"kind": "member",
"memberof": "Dial",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Dial",
"kind": "class"
},
{
"name": "min",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Dial#min"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Upper limit of the dial's output range",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "dial.max = 1000;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 328,
"column": 4
},
"end": {
"line": 332,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 333,
"column": 4
},
"end": {
"line": 335,
"column": 5
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/dial.js"
},
"augments": [],
"examples": [
{
"description": "dial.max = 1000;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "max",
"kind": "member",
"memberof": "Dial",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Dial",
"kind": "class"
},
{
"name": "max",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Dial#max"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The increment that the dial's value changes by.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "dial.step = 5;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 340,
"column": 4
},
"end": {
"line": 344,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 345,
"column": 4
},
"end": {
"line": 347,
"column": 5
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/dial.js"
},
"augments": [],
"examples": [
{
"description": "dial.step = 5;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "step",
"kind": "member",
"memberof": "Dial",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Dial",
"kind": "class"
},
{
"name": "step",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Dial#step"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Absolute mode (dial's value jumps to mouse click position) or relative mode (mouse drag changes value relative to its current position). Default: \"relative\".",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 158,
"offset": 157
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 158,
"offset": 157
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 158,
"offset": 157
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "string"
}
},
{
"title": "example",
"description": "dial.mode = \"relative\";",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 352,
"column": 4
},
"end": {
"line": 356,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 357,
"column": 4
},
"end": {
"line": 359,
"column": 5
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/dial.js"
},
"augments": [],
"examples": [
{
"description": "dial.mode = \"relative\";"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "mode",
"kind": "member",
"memberof": "Dial",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Dial",
"kind": "class"
},
{
"name": "mode",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Dial#mode"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Normalized value of the dial.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 30,
"offset": 29
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 30,
"offset": 29
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 30,
"offset": 29
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "dial.normalized = 0.5;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 365,
"column": 2
},
"end": {
"line": 369,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 370,
"column": 2
},
"end": {
"line": 372,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/dial.js"
},
"augments": [],
"examples": [
{
"description": "dial.normalized = 0.5;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "normalized",
"kind": "member",
"memberof": "Dial",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Dial",
"kind": "class"
},
{
"name": "normalized",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Dial#normalized"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Dial",
"kind": "class"
}
],
"namespace": "Dial"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Interactive linear ramp visualization.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
}
}
},
"tags": [
{
"title": "description",
"description": "Interactive linear ramp visualization.",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"envelope\"></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var envelope = new Nexus.Envelope('#target')",
"lineNumber": 7
},
{
"title": "example",
"description": "var envelope = new Nexus.Envelope('#target',{\n 'size': [300,150],\n 'noNewPoints': false,\n 'points': [\n {\n x: 0.1,\n y: 0.4\n },\n {\n x: 0.35,\n y: 0.6\n },\n {\n x: 0.65,\n y: 0.2\n },\n {\n x: 0.9,\n y: 0.4\n },\n ]\n})",
"lineNumber": 10
},
{
"title": "output",
"description": "change\nFires any time a node is moved. <br>\nThe event data is an array of point locations. Each item in the array is an object containing <i>x</i> and <i>y</i> properties describing the location of a point on the envelope.",
"lineNumber": 34
},
{
"title": "outputexample",
"description": "envelope.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 39
}
],
"loc": {
"start": {
"line": 81,
"column": 0
},
"end": {
"line": 125,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 127,
"column": 0
},
"end": {
"line": 479,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/envelope.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var envelope = new Nexus.Envelope('#target')"
},
{
"description": "var envelope = new Nexus.Envelope('#target',{\n 'size': [300,150],\n 'noNewPoints': false,\n 'points': [\n {\n x: 0.1,\n y: 0.4\n },\n {\n x: 0.35,\n y: 0.6\n },\n {\n x: 0.65,\n y: 0.2\n },\n {\n x: 0.9,\n y: 0.4\n },\n ]\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Envelope",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Sort the this.points array from left-most point to right-most point. You should not regularly need to use this, however it may be useful if the points get unordered.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 166,
"offset": 165
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 166,
"offset": 165
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 166,
"offset": 165
}
}
},
"tags": [],
"loc": {
"start": {
"line": 357,
"column": 2
},
"end": {
"line": 359,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 360,
"column": 2
},
"end": {
"line": 364,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/envelope.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "sortPoints",
"kind": "function",
"memberof": "Envelope",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Envelope",
"kind": "class"
},
{
"name": "sortPoints",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Envelope#sortPoints"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Add a breakpoint on the envelope.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 34,
"offset": 33
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 34,
"offset": 33
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 34,
"offset": 33
}
}
},
"tags": [
{
"title": "param",
"description": "{number} x location of the point, normalized (0-1)",
"lineNumber": 2,
"type": null,
"name": "x"
},
{
"title": "param",
"description": "{number} y location of the point, normalized (0-1)",
"lineNumber": 3,
"type": null,
"name": "y"
}
],
"loc": {
"start": {
"line": 367,
"column": 2
},
"end": {
"line": 371,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 372,
"column": 2
},
"end": {
"line": 395,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/envelope.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "x",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} x location of the point, normalized (0-1)",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 51,
"offset": 50
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 51,
"offset": 50
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 51,
"offset": 50
}
}
}
},
{
"title": "param",
"name": "y",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} y location of the point, normalized (0-1)",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 51,
"offset": 50
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 51,
"offset": 50
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 51,
"offset": 50
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "addPoint",
"kind": "function",
"memberof": "Envelope",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Envelope",
"kind": "class"
},
{
"name": "addPoint",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Envelope#addPoint"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Find the level at a certain x location on the envelope.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
}
}
},
"tags": [
{
"title": "param",
"description": "{number} The x location to find the level of, normalized 0-1",
"lineNumber": 2,
"type": null,
"name": "x"
}
],
"loc": {
"start": {
"line": 398,
"column": 2
},
"end": {
"line": 401,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 402,
"column": 2
},
"end": {
"line": 418,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/envelope.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "x",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} The x location to find the level of, normalized 0-1",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 61,
"offset": 60
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 61,
"offset": 60
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 61,
"offset": 60
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "scan",
"kind": "function",
"memberof": "Envelope",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Envelope",
"kind": "class"
},
{
"name": "scan",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Envelope#scan"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Move a breakpoint on the envelope.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 35,
"offset": 34
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 35,
"offset": 34
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 35,
"offset": 34
}
}
},
"tags": [
{
"title": "param",
"description": "{number} The index of the breakpoint to move",
"lineNumber": 2,
"type": null,
"name": "index"
},
{
"title": "param",
"description": "{number} New x location, normalized 0-1",
"lineNumber": 3,
"type": null,
"name": "x"
},
{
"title": "param",
"description": "{number} New y location, normalized 0-1",
"lineNumber": 4,
"type": null,
"name": "y"
}
],
"loc": {
"start": {
"line": 421,
"column": 2
},
"end": {
"line": 426,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 427,
"column": 2
},
"end": {
"line": 433,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/envelope.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "index",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} The index of the breakpoint to move",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
}
}
}
},
{
"title": "param",
"name": "x",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} New x location, normalized 0-1",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
}
},
{
"title": "param",
"name": "y",
"lineNumber": 4,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} New y location, normalized 0-1",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "movePoint",
"kind": "function",
"memberof": "Envelope",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Envelope",
"kind": "class"
},
{
"name": "movePoint",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Envelope#movePoint"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Move a breakpoint on the envelope by a certain amount.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 55,
"offset": 54
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 55,
"offset": 54
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 55,
"offset": 54
}
}
},
"tags": [
{
"title": "param",
"description": "{number} The index of the breakpoint to move",
"lineNumber": 2,
"type": null,
"name": "index"
},
{
"title": "param",
"description": "{number} X displacement, normalized 0-1",
"lineNumber": 3,
"type": null,
"name": "xOffset"
},
{
"title": "param",
"description": "{number} Y displacement, normalized 0-1",
"lineNumber": 4,
"type": null,
"name": "yOffset"
}
],
"loc": {
"start": {
"line": 436,
"column": 2
},
"end": {
"line": 441,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 442,
"column": 2
},
"end": {
"line": 448,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/envelope.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "index",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} The index of the breakpoint to move",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
}
}
}
},
{
"title": "param",
"name": "xOffset",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} X displacement, normalized 0-1",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
}
},
{
"title": "param",
"name": "yOffset",
"lineNumber": 4,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} Y displacement, normalized 0-1",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "adjustPoint",
"kind": "function",
"memberof": "Envelope",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Envelope",
"kind": "class"
},
{
"name": "adjustPoint",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Envelope#adjustPoint"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Remove a breakpoint from the envelope.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
}
}
},
"tags": [
{
"title": "param",
"description": "{number} Index of the breakpoint to remove",
"lineNumber": 2,
"type": null,
"name": "index"
}
],
"loc": {
"start": {
"line": 451,
"column": 2
},
"end": {
"line": 454,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 455,
"column": 2
},
"end": {
"line": 460,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/envelope.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "index",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} Index of the breakpoint to remove",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 43,
"offset": 42
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 43,
"offset": 42
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 43,
"offset": 42
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "destroyPoint",
"kind": "function",
"memberof": "Envelope",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Envelope",
"kind": "class"
},
{
"name": "destroyPoint",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Envelope#destroyPoint"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Remove all existing breakpoints and add an entirely new set of breakpoints.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 76,
"offset": 75
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 76,
"offset": 75
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 76,
"offset": 75
}
}
},
"tags": [
{
"title": "param",
"description": "{array} An array of objects with x/y properties (normalized 0-1). Each object in the array specifices the x/y location of a new breakpoint to be added.",
"lineNumber": 2,
"type": null,
"name": "allPoints"
}
],
"loc": {
"start": {
"line": 463,
"column": 2
},
"end": {
"line": 466,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 467,
"column": 2
},
"end": {
"line": 477,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/envelope.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "allPoints",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{array} An array of objects with x/y properties (normalized 0-1). Each object in the array specifices the x/y location of a new breakpoint to be added.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 152,
"offset": 151
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 152,
"offset": 151
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 152,
"offset": 151
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "setPoints",
"kind": "function",
"memberof": "Envelope",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Envelope",
"kind": "class"
},
{
"name": "setPoints",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Envelope#setPoints"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Envelope",
"kind": "class"
}
],
"namespace": "Envelope"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Stereo decibel meter",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
}
}
},
"tags": [
{
"title": "description",
"description": "Stereo decibel meter",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"meter\"></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var meter = new Nexus.Meter('#target')\nmeter.connect(myWebAudioNode)",
"lineNumber": 7
},
{
"title": "example",
"description": "var meter = new Nexus.Meter('#target', {\n size: [75,75]\n})\nmeter.connect(myWebAudioNode)",
"lineNumber": 11
},
{
"title": "output",
"description": " \nNo events",
"lineNumber": 17
}
],
"loc": {
"start": {
"line": 7,
"column": 0
},
"end": {
"line": 28,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 30,
"column": 0
},
"end": {
"line": 181,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/meter.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var meter = new Nexus.Meter('#target')\nmeter.connect(myWebAudioNode)"
},
{
"description": "var meter = new Nexus.Meter('#target', {\n size: [75,75]\n})\nmeter.connect(myWebAudioNode)"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Meter",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Equivalent to \"patching in\" an audio node to visualize.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
}
}
},
"tags": [
{
"title": "param",
"description": "{AudioNode} The audio node to visualize",
"lineNumber": 2,
"type": null,
"name": "node"
},
{
"title": "param",
"description": "{number} (optional) The number of channels in the source node to watch. If not specified, the interface will look for a .channelCount property on the input node. If it does not exist, the interface will default to 1 channel.",
"lineNumber": 3,
"type": null,
"name": "channels"
},
{
"title": "example",
"description": "meter.connect( Tone.Master, 2 );",
"lineNumber": 4
}
],
"loc": {
"start": {
"line": 121,
"column": 2
},
"end": {
"line": 126,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 127,
"column": 2
},
"end": {
"line": 155,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/meter.js"
},
"augments": [],
"examples": [
{
"description": "meter.connect( Tone.Master, 2 );"
}
],
"params": [
{
"title": "param",
"name": "node",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{AudioNode} The audio node to visualize",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
}
},
{
"title": "param",
"name": "channels",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} (optional) The number of channels in the source node to watch. If not specified, the interface will look for a .channelCount property on the input node. If it does not exist, the interface will default to 1 channel.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 225,
"offset": 224
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 225,
"offset": 224
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 225,
"offset": 224
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "connect",
"kind": "function",
"memberof": "Meter",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Meter",
"kind": "class"
},
{
"name": "connect",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Meter#connect"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Stop visualizing the source node and disconnect it.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
}
}
},
"tags": [],
"loc": {
"start": {
"line": 157,
"column": 2
},
"end": {
"line": 159,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 160,
"column": 2
},
"end": {
"line": 171,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/meter.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "disconnect",
"kind": "function",
"memberof": "Meter",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Meter",
"kind": "class"
},
{
"name": "disconnect",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Meter#disconnect"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Meter",
"kind": "class"
}
],
"namespace": "Meter"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Multislider",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
}
}
},
"tags": [
{
"title": "description",
"description": "Multislider",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"multislider\"></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var multislider = new Nexus.Multislider('#target')",
"lineNumber": 7
},
{
"title": "example",
"description": "var multislider = new Nexus.Multislider('#target',{\n 'size': [200,100],\n 'numberOfSliders': 5,\n 'min': 0,\n 'max': 1,\n 'step': 0,\n 'candycane': 3,\n 'values': [0.9,0.8,0.7,0.6,0.5,0.4,0.3,0.2,0.1],\n 'smoothing': 0,\n 'mode': 'bar' // 'bar' or 'line'\n})",
"lineNumber": 10
},
{
"title": "output",
"description": "change\nFires any time the interface's value changes. <br>\nThe event data is an object containing <i>index</i> and <i>value</i> properties",
"lineNumber": 23
},
{
"title": "outputexample",
"description": "multislider.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 28
}
],
"loc": {
"start": {
"line": 7,
"column": 0
},
"end": {
"line": 40,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 42,
"column": 0
},
"end": {
"line": 443,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/multislider.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var multislider = new Nexus.Multislider('#target')"
},
{
"description": "var multislider = new Nexus.Multislider('#target',{\n 'size': [200,100],\n 'numberOfSliders': 5,\n 'min': 0,\n 'max': 1,\n 'step': 0,\n 'candycane': 3,\n 'values': [0.9,0.8,0.7,0.6,0.5,0.4,0.3,0.2,0.1],\n 'smoothing': 0,\n 'mode': 'bar' // 'bar' or 'line'\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Multislider",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Applies a simple low-pass filter to the multislider as it is interacted with. A smoothing of 0 will be no smoothing. A smoothing of 1 will smooth 1 slider on each side of the interaction. A smoothing of 2 will smooth 2 sliders on each side, and so on.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 252,
"offset": 251
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 252,
"offset": 251
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 252,
"offset": 251
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Number"
}
}
],
"loc": {
"start": {
"line": 78,
"column": 4
},
"end": {
"line": 81,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 82,
"column": 4
},
"end": {
"line": 82,
"column": 45
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/multislider.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "smoothing",
"memberof": "Multislider",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Multislider",
"kind": "class"
},
{
"name": "smoothing",
"scope": "instance"
}
],
"namespace": "Multislider#smoothing"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Get the number of sliders",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Number"
}
}
],
"loc": {
"start": {
"line": 358,
"column": 2
},
"end": {
"line": 361,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 362,
"column": 2
},
"end": {
"line": 364,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/multislider.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "numberOfSliders",
"kind": "member",
"memberof": "Multislider",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Multislider",
"kind": "class"
},
{
"name": "numberOfSliders",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Multislider#numberOfSliders"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Lower limit of the multislider's output range",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "multislider.min = 1000;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 366,
"column": 2
},
"end": {
"line": 370,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 371,
"column": 2
},
"end": {
"line": 373,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/multislider.js"
},
"augments": [],
"examples": [
{
"description": "multislider.min = 1000;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "min",
"kind": "member",
"memberof": "Multislider",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Multislider",
"kind": "class"
},
{
"name": "min",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Multislider#min"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Upper limit of the multislider's output range",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "multislider.max = 1000;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 380,
"column": 2
},
"end": {
"line": 384,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 385,
"column": 2
},
"end": {
"line": 387,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/multislider.js"
},
"augments": [],
"examples": [
{
"description": "multislider.max = 1000;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "max",
"kind": "member",
"memberof": "Multislider",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Multislider",
"kind": "class"
},
{
"name": "max",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Multislider#max"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The increment that the multislider's value changes by.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 55,
"offset": 54
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 55,
"offset": 54
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 55,
"offset": 54
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "multislider.step = 5;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 394,
"column": 2
},
"end": {
"line": 398,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 399,
"column": 2
},
"end": {
"line": 401,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/multislider.js"
},
"augments": [],
"examples": [
{
"description": "multislider.step = 5;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "step",
"kind": "member",
"memberof": "Multislider",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Multislider",
"kind": "class"
},
{
"name": "step",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Multislider#step"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Set the value of an individual slider",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
}
}
},
"tags": [
{
"title": "param",
"description": "{number} Slider index",
"lineNumber": 2,
"type": null,
"name": "index"
},
{
"title": "param",
"description": "{number} New slider value",
"lineNumber": 3,
"type": null,
"name": "value"
},
{
"title": "example",
"description": "// Set the first slider to value 0.5\nmultislider.setSlider(0,0.5)",
"lineNumber": 4
}
],
"loc": {
"start": {
"line": 408,
"column": 2
},
"end": {
"line": 415,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 416,
"column": 2
},
"end": {
"line": 423,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/multislider.js"
},
"augments": [],
"examples": [
{
"description": "// Set the first slider to value 0.5\nmultislider.setSlider(0,0.5)"
}
],
"params": [
{
"title": "param",
"name": "index",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} Slider index",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 22,
"offset": 21
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 22,
"offset": 21
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 22,
"offset": 21
}
}
}
},
{
"title": "param",
"name": "value",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} New slider value",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "setSlider",
"kind": "function",
"memberof": "Multislider",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Multislider",
"kind": "class"
},
{
"name": "setSlider",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Multislider#setSlider"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Set the value of all sliders at once. If the size of the input array does not match the current number of sliders, the value array will repeat until all sliders have been set. I.e. an input array of length 1 will set all sliders to that value.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 244,
"offset": 243
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 244,
"offset": 243
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 244,
"offset": 243
}
}
},
"tags": [
{
"title": "param",
"description": "{Array} All slider values",
"lineNumber": 2,
"type": null,
"name": "values"
},
{
"title": "example",
"description": "multislider.setAllSliders([0.2,0.3,0.4,0.5,0.6])",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 425,
"column": 2
},
"end": {
"line": 430,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 431,
"column": 2
},
"end": {
"line": 442,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/multislider.js"
},
"augments": [],
"examples": [
{
"description": "multislider.setAllSliders([0.2,0.3,0.4,0.5,0.6])"
}
],
"params": [
{
"title": "param",
"name": "values",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{Array} All slider values",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "setAllSliders",
"kind": "function",
"memberof": "Multislider",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Multislider",
"kind": "class"
},
{
"name": "setAllSliders",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Multislider#setAllSliders"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Multislider",
"kind": "class"
}
],
"namespace": "Multislider"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The current values of the slider. NOTE: Use this only to get the current values. Setting this array will not update the multislider. To set the multislider's values, use setSlider() or setAllSliders()",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 201,
"offset": 200
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 201,
"offset": 200
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 201,
"offset": 200
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Array"
}
}
],
"loc": {
"start": {
"line": 67,
"column": 4
},
"end": {
"line": 70,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 71,
"column": 4
},
"end": {
"line": 71,
"column": 36
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/multislider.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "vs",
"kind": "constant",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "vs",
"kind": "constant"
}
],
"namespace": "vs"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Number interface which is controllable by dragging or typing.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 62,
"offset": 61
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 62,
"offset": 61
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 62,
"offset": 61
}
}
},
"tags": [
{
"title": "description",
"description": "Number interface which is controllable by dragging or typing.",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"number\"></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var number = new Nexus.Number('#target')",
"lineNumber": 7
},
{
"title": "example",
"description": "var number = new Nexus.Number('#target',{\n 'size': [60,30],\n 'value': 0,\n 'min': 0,\n 'max': 20000,\n 'step': 1\n})",
"lineNumber": 10
},
{
"title": "output",
"description": "change\nFires any time the interface's value changes. <br>\nThe event data is the number value of the interface.",
"lineNumber": 19
},
{
"title": "outputexample",
"description": "number.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 24
}
],
"loc": {
"start": {
"line": 8,
"column": 0
},
"end": {
"line": 38,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 41,
"column": 0
},
"end": {
"line": 262,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/number.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var number = new Nexus.Number('#target')"
},
{
"description": "var number = new Nexus.Number('#target',{\n 'size': [60,30],\n 'value': 0,\n 'min': 0,\n 'max': 20000,\n 'step': 1\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Number",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Connect this number interface to a dial or slider",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
}
}
},
"tags": [
{
"title": "param",
"description": "Element to connect to.",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Interface"
},
"name": "element"
},
{
"title": "example",
"description": "number.link(slider)",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 181,
"column": 2
},
"end": {
"line": 185,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 186,
"column": 2
},
"end": {
"line": 205,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/number.js"
},
"augments": [],
"examples": [
{
"description": "number.link(slider)"
}
],
"params": [
{
"title": "param",
"name": "destination",
"lineNumber": 186
},
{
"title": "param",
"name": "element",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Element to connect to.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 23,
"offset": 22
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 23,
"offset": 22
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 23,
"offset": 22
}
}
},
"type": {
"type": "NameExpression",
"name": "Interface"
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "link",
"kind": "function",
"memberof": "Number",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Number",
"kind": "class"
},
{
"name": "link",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Number#link"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The interface's current value. If set manually, will update the interface and trigger the output event.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 104,
"offset": 103
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 104,
"offset": 103
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 104,
"offset": 103
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "number.value = 10;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 212,
"column": 2
},
"end": {
"line": 216,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 217,
"column": 2
},
"end": {
"line": 219,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/number.js"
},
"augments": [],
"examples": [
{
"description": "number.value = 10;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "value",
"kind": "member",
"memberof": "Number",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Number",
"kind": "class"
},
{
"name": "value",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Number#value"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Lower limit of the number's output range",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 41,
"offset": 40
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 41,
"offset": 40
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 41,
"offset": 40
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "number.min = 1000;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 226,
"column": 2
},
"end": {
"line": 230,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 231,
"column": 2
},
"end": {
"line": 233,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/number.js"
},
"augments": [],
"examples": [
{
"description": "number.min = 1000;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "min",
"kind": "member",
"memberof": "Number",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Number",
"kind": "class"
},
{
"name": "min",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Number#min"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Upper limit of the number's output range",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 41,
"offset": 40
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 41,
"offset": 40
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 41,
"offset": 40
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "number.max = 1000;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 238,
"column": 2
},
"end": {
"line": 242,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 243,
"column": 2
},
"end": {
"line": 245,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/number.js"
},
"augments": [],
"examples": [
{
"description": "number.max = 1000;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "max",
"kind": "member",
"memberof": "Number",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Number",
"kind": "class"
},
{
"name": "max",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Number#max"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The increment that the number's value changes by.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "number.step = 5;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 250,
"column": 2
},
"end": {
"line": 254,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 255,
"column": 2
},
"end": {
"line": 257,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/number.js"
},
"augments": [],
"examples": [
{
"description": "number.step = 5;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "step",
"kind": "member",
"memberof": "Number",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Number",
"kind": "class"
},
{
"name": "step",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Number#step"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Number",
"kind": "class"
}
],
"namespace": "Number"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Visualizes a waveform's stream of values.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
}
}
},
"tags": [
{
"title": "description",
"description": "Visualizes a waveform's stream of values.",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"oscilloscope\"></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var oscilloscope = new Nexus.Oscilloscope('#target')\noscilloscope.connect(myWebAudioNode)",
"lineNumber": 7
},
{
"title": "example",
"description": "var oscilloscope = new Nexus.Oscilloscope('#target',{\n 'size': [300,150]\n})\noscilloscope.connect(myWebAudioNode)",
"lineNumber": 11
},
{
"title": "output",
"description": " \nNo events",
"lineNumber": 17
}
],
"loc": {
"start": {
"line": 6,
"column": 0
},
"end": {
"line": 27,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 29,
"column": 0
},
"end": {
"line": 162,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/oscilloscope.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var oscilloscope = new Nexus.Oscilloscope('#target')\noscilloscope.connect(myWebAudioNode)"
},
{
"description": "var oscilloscope = new Nexus.Oscilloscope('#target',{\n 'size': [300,150]\n})\noscilloscope.connect(myWebAudioNode)"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Oscilloscope",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Equivalent to \"patching in\" an audio node to visualize.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
}
}
},
"tags": [
{
"title": "param",
"description": "{AudioNode} The audio node to visualize",
"lineNumber": 2,
"type": null,
"name": "node"
},
{
"title": "example",
"description": "oscilloscope.connect( Tone.Master );",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 114,
"column": 2
},
"end": {
"line": 118,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 120,
"column": 2
},
"end": {
"line": 137,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/oscilloscope.js"
},
"augments": [],
"examples": [
{
"description": "oscilloscope.connect( Tone.Master );"
}
],
"params": [
{
"title": "param",
"name": "node",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{AudioNode} The audio node to visualize",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "connect",
"kind": "function",
"memberof": "Oscilloscope",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Oscilloscope",
"kind": "class"
},
{
"name": "connect",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Oscilloscope#connect"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Stop visualizing the source node and disconnect it.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
}
}
},
"tags": [],
"loc": {
"start": {
"line": 139,
"column": 2
},
"end": {
"line": 141,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 142,
"column": 2
},
"end": {
"line": 152,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/oscilloscope.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "disconnect",
"kind": "function",
"memberof": "Oscilloscope",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Oscilloscope",
"kind": "class"
},
{
"name": "disconnect",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Oscilloscope#disconnect"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Oscilloscope",
"kind": "class"
}
],
"namespace": "Oscilloscope"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Stereo crossfader.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 19,
"offset": 18
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 19,
"offset": 18
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 19,
"offset": 18
}
}
},
"tags": [
{
"title": "description",
"description": "Stereo crossfader.",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"pan\"></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var pan = new Nexus.Pan('#target')",
"lineNumber": 7
},
{
"title": "output",
"description": "change\nFires any time the interface's value changes. <br>\nThe event data is an object containing the interface's <i>value</i> (-1 to 1), as well as <i>L</i> and <i>R</i> amplitude values (0-1) for left and right speakers, calculated by a square-root crossfade algorithm.",
"lineNumber": 10
},
{
"title": "outputexample",
"description": "pan.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 15
}
],
"loc": {
"start": {
"line": 9,
"column": 0
},
"end": {
"line": 30,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 32,
"column": 0
},
"end": {
"line": 217,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/pan.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var pan = new Nexus.Pan('#target')"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Pan",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The position of crossfader, from -1 (left) to 1 (right). Setting this value updates the interface and triggers the output event.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 129,
"offset": 128
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 129,
"offset": 128
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 129,
"offset": 128
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"loc": {
"start": {
"line": 194,
"column": 2
},
"end": {
"line": 197,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 198,
"column": 2
},
"end": {
"line": 200,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/pan.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "value",
"kind": "member",
"memberof": "Pan",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Pan",
"kind": "class"
},
{
"name": "value",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Pan#value"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Pan",
"kind": "class"
}
],
"namespace": "Pan"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Interface for moving a sound around an array of speakers. Speaker locations can be customized. The interface calculates the closeness of the sound source to each speaker and returns that distance as a numeric value.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 216,
"offset": 215
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 216,
"offset": 215
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 216,
"offset": 215
}
}
},
"tags": [
{
"title": "description",
"description": "Interface for moving a sound around an array of speakers. Speaker locations can be customized. The interface calculates the closeness of the sound source to each speaker and returns that distance as a numeric value.",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"pan2D\"></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var pan2d = new Nexus.Pan2d('#target')",
"lineNumber": 7
},
{
"title": "example",
"description": "var pan2d = new Nexus.Pan2D('#target',{\n 'size': [200,200],\n 'range': 0.5, // detection radius of each speaker\n 'mode': 'absolute', // 'absolute' or 'relative' sound movement\n 'speakers': [ // the speaker [x,y] positions\n [0.5,0.2],\n [0.75,0.25],\n [0.8,0.5],\n [0.75,0.75],\n [0.5,0.8],\n [0.25,0.75]\n [0.2,0.5],\n [0.25,0.25]\n ]\n})",
"lineNumber": 10
},
{
"title": "output",
"description": "change\nFires any time the \"source\" node's position changes. <br>\nThe event data is an array of the amplitudes (0-1), representing the level of each speaker (as calculated by its distance to the audio source).",
"lineNumber": 27
},
{
"title": "outputexample",
"description": "pan2d.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 32
}
],
"loc": {
"start": {
"line": 9,
"column": 0
},
"end": {
"line": 46,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 48,
"column": 0
},
"end": {
"line": 275,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/pan2d.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var pan2d = new Nexus.Pan2d('#target')"
},
{
"description": "var pan2d = new Nexus.Pan2D('#target',{\n 'size': [200,200],\n 'range': 0.5, // detection radius of each speaker\n 'mode': 'absolute', // 'absolute' or 'relative' sound movement\n 'speakers': [ // the speaker [x,y] positions\n [0.5,0.2],\n [0.75,0.25],\n [0.8,0.5],\n [0.75,0.75],\n [0.5,0.8],\n [0.25,0.75]\n [0.2,0.5],\n [0.25,0.25]\n ]\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Pan2D",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Absolute or relative mouse interaction. In \"absolute\" mode, the source node will jump to your mouse position on mouse click. In \"relative\" mode, it does not.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 158,
"offset": 157
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 158,
"offset": 157
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 158,
"offset": 157
}
}
},
"tags": [],
"loc": {
"start": {
"line": 77,
"column": 4
},
"end": {
"line": 79,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 80,
"column": 4
},
"end": {
"line": 80,
"column": 35
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/pan2d.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "mode",
"memberof": "Pan2D",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Pan2D",
"kind": "class"
},
{
"name": "mode",
"scope": "instance"
}
],
"namespace": "Pan2D#mode"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "An array of speaker locations. Update this with .moveSpeaker() or .moveAllSpeakers()",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 85,
"offset": 84
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 85,
"offset": 84
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 85,
"offset": 84
}
}
},
"tags": [],
"loc": {
"start": {
"line": 89,
"column": 4
},
"end": {
"line": 91,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 92,
"column": 4
},
"end": {
"line": 92,
"column": 43
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/pan2d.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "speakers",
"memberof": "Pan2D",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Pan2D",
"kind": "class"
},
{
"name": "speakers",
"scope": "instance"
}
],
"namespace": "Pan2D#speakers"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Rewrite: The maximum distance from a speaker that the source node can be for it to be heard from that speaker. A low range (0.1) will result in speakers only playing when the sound is very close it. Default is 0.5 (half of the interface).",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 239,
"offset": 238
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 239,
"offset": 238
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 239,
"offset": 238
}
}
},
"tags": [],
"loc": {
"start": {
"line": 94,
"column": 4
},
"end": {
"line": 96,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 97,
"column": 4
},
"end": {
"line": 97,
"column": 37
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/pan2d.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "range",
"memberof": "Pan2D",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Pan2D",
"kind": "class"
},
{
"name": "range",
"scope": "instance"
}
],
"namespace": "Pan2D#range"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The current levels for each speaker. This is calculated when a source node or speaker node is moved through interaction or programatically.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 140,
"offset": 139
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 140,
"offset": 139
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 140,
"offset": 139
}
}
},
"tags": [],
"loc": {
"start": {
"line": 99,
"column": 4
},
"end": {
"line": 101,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 102,
"column": 4
},
"end": {
"line": 102,
"column": 21
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/pan2d.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "levels",
"memberof": "Pan2D",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Pan2D",
"kind": "class"
},
{
"name": "levels",
"scope": "instance"
}
],
"namespace": "Pan2D#levels"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Move the audio source node and trigger the output event.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 57,
"offset": 56
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 57,
"offset": 56
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 57,
"offset": 56
}
}
},
"tags": [
{
"title": "param",
"description": "{number} New x location, normalized 0-1",
"lineNumber": 2,
"type": null,
"name": "x"
},
{
"title": "param",
"description": "{number} New y location, normalized 0-1",
"lineNumber": 3,
"type": null,
"name": "y"
}
],
"loc": {
"start": {
"line": 232,
"column": 2
},
"end": {
"line": 236,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 237,
"column": 2
},
"end": {
"line": 247,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/pan2d.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "x",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} New x location, normalized 0-1",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
}
},
{
"title": "param",
"name": "y",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} New y location, normalized 0-1",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "moveSource",
"kind": "function",
"memberof": "Pan2D",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Pan2D",
"kind": "class"
},
{
"name": "moveSource",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Pan2D#moveSource"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Move a speaker node and trigger the output event.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
}
}
},
"tags": [
{
"title": "param",
"description": "{number} Index of the speaker to move",
"lineNumber": 2,
"type": null,
"name": "index"
},
{
"title": "param",
"description": "{number} New x location, normalized 0-1",
"lineNumber": 3,
"type": null,
"name": "x"
},
{
"title": "param",
"description": "{number} New y location, normalized 0-1",
"lineNumber": 4,
"type": null,
"name": "y"
}
],
"loc": {
"start": {
"line": 249,
"column": 2
},
"end": {
"line": 254,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 255,
"column": 2
},
"end": {
"line": 264,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/pan2d.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "index",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} Index of the speaker to move",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
}
}
}
},
{
"title": "param",
"name": "x",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} New x location, normalized 0-1",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
}
},
{
"title": "param",
"name": "y",
"lineNumber": 4,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} New y location, normalized 0-1",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "moveSpeaker",
"kind": "function",
"memberof": "Pan2D",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Pan2D",
"kind": "class"
},
{
"name": "moveSpeaker",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Pan2D#moveSpeaker"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Pan2D",
"kind": "class"
}
],
"namespace": "Pan2D"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Set all speaker locations",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
}
}
},
"tags": [
{
"title": "param",
"description": "{Array} Array of speaker locations. Each item in the array should be an array of normalized x and y coordinates.\n\nsetSpeakers(locations) {\n\n}",
"lineNumber": 2,
"type": null,
"name": "locations"
}
],
"loc": {
"start": {
"line": 266,
"column": 2
},
"end": {
"line": 273,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 255,
"column": 2
},
"end": {
"line": 264,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/pan2d.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "locations",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{Array} Array of speaker locations. Each item in the array should be an array of normalized x and y coordinates.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 113,
"offset": 112
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 113,
"offset": 112
},
"indent": []
}
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "setSpeakers(locations) {",
"position": {
"start": {
"line": 3,
"column": 1,
"offset": 114
},
"end": {
"line": 3,
"column": 25,
"offset": 138
},
"indent": []
}
}
],
"position": {
"start": {
"line": 3,
"column": 1,
"offset": 114
},
"end": {
"line": 3,
"column": 25,
"offset": 138
},
"indent": []
}
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "}",
"position": {
"start": {
"line": 5,
"column": 1,
"offset": 140
},
"end": {
"line": 5,
"column": 2,
"offset": 141
},
"indent": []
}
}
],
"position": {
"start": {
"line": 5,
"column": 1,
"offset": 140
},
"end": {
"line": 5,
"column": 2,
"offset": 141
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 2,
"offset": 141
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [],
"namespace": ""
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Piano keyboard interface",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 25,
"offset": 24
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 25,
"offset": 24
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 25,
"offset": 24
}
}
},
"tags": [
{
"title": "description",
"description": "Piano keyboard interface",
"lineNumber": 3
},
{
"title": "demo",
"description": "<div nexus-ui=\"piano\"></div>",
"lineNumber": 5
},
{
"title": "example",
"description": "var piano = new Nexus.Piano('#target')",
"lineNumber": 7
},
{
"title": "example",
"description": "var piano = new Nexus.Piano('#target',{\n 'size': [500,125],\n 'mode': 'button', // 'button', 'toggle', or 'impulse'\n 'lowNote': 24,\n 'highNote': 60\n})",
"lineNumber": 10
},
{
"title": "output",
"description": "change\nFires any time a new key is pressed or released <br>\nThe event data is an object containing <i>note</i> and <i>state</i> properties.",
"lineNumber": 18
},
{
"title": "outputexample",
"description": "piano.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 23
}
],
"loc": {
"start": {
"line": 132,
"column": 0
},
"end": {
"line": 160,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 162,
"column": 0
},
"end": {
"line": 434,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/piano.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var piano = new Nexus.Piano('#target')"
},
{
"description": "var piano = new Nexus.Piano('#target',{\n 'size': [500,125],\n 'mode': 'button', // 'button', 'toggle', or 'impulse'\n 'lowNote': 24,\n 'highNote': 60\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Piano",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Define the pitch range (lowest and highest note) of the piano keyboard.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 72,
"offset": 71
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 72,
"offset": 71
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 72,
"offset": 71
}
}
},
"tags": [
{
"title": "param",
"description": "{number} MIDI note value of the lowest note on the keyboard",
"lineNumber": 2,
"type": null,
"name": "low"
},
{
"title": "param",
"description": "{number} MIDI note value of the highest note on the keyboard",
"lineNumber": 3,
"type": null,
"name": "high"
}
],
"loc": {
"start": {
"line": 404,
"column": 2
},
"end": {
"line": 408,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 409,
"column": 2
},
"end": {
"line": 414,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/piano.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "low",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} MIDI note value of the lowest note on the keyboard",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 60,
"offset": 59
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 60,
"offset": 59
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 60,
"offset": 59
}
}
}
},
{
"title": "param",
"name": "high",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} MIDI note value of the highest note on the keyboard",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 61,
"offset": 60
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 61,
"offset": 60
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 61,
"offset": 60
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "setRange",
"kind": "function",
"memberof": "Piano",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Piano",
"kind": "class"
},
{
"name": "setRange",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Piano#setRange"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Turn a key on or off using its MIDI note value;",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
}
}
},
"tags": [
{
"title": "param",
"description": "{number} MIDI note value of the key to change",
"lineNumber": 2,
"type": null,
"name": "note"
},
{
"title": "param",
"description": "{boolean} Whether the note should turn on or off",
"lineNumber": 3,
"type": null,
"name": "on"
}
],
"loc": {
"start": {
"line": 416,
"column": 2
},
"end": {
"line": 420,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 421,
"column": 2
},
"end": {
"line": 423,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/piano.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "note",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} MIDI note value of the key to change",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
}
}
}
},
{
"title": "param",
"name": "on",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{boolean} Whether the note should turn on or off",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 49,
"offset": 48
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 49,
"offset": 48
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 49,
"offset": 48
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "toggleKey",
"kind": "function",
"memberof": "Piano",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Piano",
"kind": "class"
},
{
"name": "toggleKey",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Piano#toggleKey"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Turn a key on or off using its key index on the piano interface.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 65,
"offset": 64
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 65,
"offset": 64
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 65,
"offset": 64
}
}
},
"tags": [
{
"title": "param",
"description": "{number} Index of the key to change",
"lineNumber": 2,
"type": null,
"name": "index"
},
{
"title": "param",
"description": "{boolean} Whether the note should turn on or off",
"lineNumber": 3,
"type": null,
"name": "on"
}
],
"loc": {
"start": {
"line": 425,
"column": 2
},
"end": {
"line": 429,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 430,
"column": 2
},
"end": {
"line": 432,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/piano.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "index",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} Index of the key to change",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
}
}
}
},
{
"title": "param",
"name": "on",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{boolean} Whether the note should turn on or off",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 49,
"offset": 48
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 49,
"offset": 48
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 49,
"offset": 48
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "toggleIndex",
"kind": "function",
"memberof": "Piano",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Piano",
"kind": "class"
},
{
"name": "toggleIndex",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Piano#toggleIndex"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Piano",
"kind": "class"
}
],
"namespace": "Piano"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Two-dimensional touch slider.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 30,
"offset": 29
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 30,
"offset": 29
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 30,
"offset": 29
}
}
},
"tags": [
{
"title": "description",
"description": "Two-dimensional touch slider.",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"position\"></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var position = new Nexus.Position('#target')",
"lineNumber": 7
},
{
"title": "example",
"description": "var position = new Nexus.Position('#target',{\n 'size': [200,200],\n 'mode': 'absolute', // \"absolute\" or \"relative\"\n 'x': 0.5, // initial x value\n 'minX': 0,\n 'maxX': 1,\n 'stepX': 0,\n 'y': 0.5, // initial y value\n 'minY': 0,\n 'maxY': 1,\n 'stepY': 0\n})",
"lineNumber": 10
},
{
"title": "output",
"description": "change\nFires any time the interface's value changes. <br>\nThe event data is an object with x and y properties containing the x and y values of the interface.",
"lineNumber": 24
},
{
"title": "outputexample",
"description": "position.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 29
}
],
"loc": {
"start": {
"line": 9,
"column": 0
},
"end": {
"line": 44,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 46,
"column": 0
},
"end": {
"line": 301,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/position.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var position = new Nexus.Position('#target')"
},
{
"description": "var position = new Nexus.Position('#target',{\n 'size': [200,200],\n 'mode': 'absolute', // \"absolute\" or \"relative\"\n 'x': 0.5, // initial x value\n 'minX': 0,\n 'maxX': 1,\n 'stepX': 0,\n 'y': 0.5, // initial y value\n 'minY': 0,\n 'maxY': 1,\n 'stepY': 0\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Position",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The interface's x value. When set, it will automatically adjust to fit min/max/step settings of the interface.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 111,
"offset": 110
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 111,
"offset": 110
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 111,
"offset": 110
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "object"
}
},
{
"title": "example",
"description": "position.x = 0.5;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 155,
"column": 2
},
"end": {
"line": 159,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 161,
"column": 2
},
"end": {
"line": 163,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/position.js"
},
"augments": [],
"examples": [
{
"description": "position.x = 0.5;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "x",
"kind": "member",
"memberof": "Position",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Position",
"kind": "class"
},
{
"name": "x",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Position#x"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The interface's y values. When set, it will automatically adjust to fit min/max/step settings of the interface.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 112,
"offset": 111
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 112,
"offset": 111
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 112,
"offset": 111
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "object"
}
},
{
"title": "example",
"description": "position.x = 0.5;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 174,
"column": 2
},
"end": {
"line": 178,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 180,
"column": 2
},
"end": {
"line": 182,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/position.js"
},
"augments": [],
"examples": [
{
"description": "position.x = 0.5;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "y",
"kind": "member",
"memberof": "Position",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Position",
"kind": "class"
},
{
"name": "y",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Position#y"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The lower limit of value on the x axis",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "object"
}
}
],
"loc": {
"start": {
"line": 202,
"column": 2
},
"end": {
"line": 205,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 206,
"column": 2
},
"end": {
"line": 208,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/position.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "minX",
"kind": "member",
"memberof": "Position",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Position",
"kind": "class"
},
{
"name": "minX",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Position#minX"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The lower limit of value on the y axis",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "object"
}
}
],
"loc": {
"start": {
"line": 215,
"column": 2
},
"end": {
"line": 218,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 219,
"column": 2
},
"end": {
"line": 221,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/position.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "minY",
"kind": "member",
"memberof": "Position",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Position",
"kind": "class"
},
{
"name": "minY",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Position#minY"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The upper limit of value on the x axis",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "object"
}
}
],
"loc": {
"start": {
"line": 229,
"column": 2
},
"end": {
"line": 232,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 233,
"column": 2
},
"end": {
"line": 235,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/position.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "maxX",
"kind": "member",
"memberof": "Position",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Position",
"kind": "class"
},
{
"name": "maxX",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Position#maxX"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The upper limit of value on the y axis",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "object"
}
}
],
"loc": {
"start": {
"line": 243,
"column": 2
},
"end": {
"line": 246,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 247,
"column": 2
},
"end": {
"line": 249,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/position.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "maxY",
"kind": "member",
"memberof": "Position",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Position",
"kind": "class"
},
{
"name": "maxY",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Position#maxY"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The incremental step of values on the x axis",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "object"
}
}
],
"loc": {
"start": {
"line": 257,
"column": 2
},
"end": {
"line": 260,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 261,
"column": 2
},
"end": {
"line": 263,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/position.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "stepX",
"kind": "member",
"memberof": "Position",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Position",
"kind": "class"
},
{
"name": "stepX",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Position#stepX"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The incremental step of values on the y axis",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "object"
}
}
],
"loc": {
"start": {
"line": 271,
"column": 2
},
"end": {
"line": 274,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 275,
"column": 2
},
"end": {
"line": 277,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/position.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "stepY",
"kind": "member",
"memberof": "Position",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Position",
"kind": "class"
},
{
"name": "stepY",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Position#stepY"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Absolute mode (position's value jumps to mouse click position) or relative mode (mouse drag changes value relative to its current position). Default: \"absolute\".",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 162,
"offset": 161
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 162,
"offset": 161
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 162,
"offset": 161
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "string"
}
},
{
"title": "example",
"description": "position.mode = \"relative\";",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 285,
"column": 2
},
"end": {
"line": 289,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 290,
"column": 2
},
"end": {
"line": 292,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/position.js"
},
"augments": [],
"examples": [
{
"description": "position.mode = \"relative\";"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "mode",
"kind": "member",
"memberof": "Position",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Position",
"kind": "class"
},
{
"name": "mode",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Position#mode"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Position",
"kind": "class"
}
],
"namespace": "Position"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "An array of buttons. By default, selecting one button will deselect all other buttons, but this can be customized using the API below.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 135,
"offset": 134
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 135,
"offset": 134
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 135,
"offset": 134
}
}
},
"tags": [
{
"title": "description",
"description": "An array of buttons. By default, selecting one button will deselect all other buttons, but this can be customized using the API below.",
"lineNumber": 3
},
{
"title": "demo",
"description": "<div nexus-ui=\"RadioButton\"></div>",
"lineNumber": 5
},
{
"title": "example",
"description": "var radiobutton = new Nexus.RadioButton('#target')",
"lineNumber": 7
},
{
"title": "example",
"description": "var radiobutton = new Nexus.RadioButton('#target',{\n 'size': [120,25],\n 'numberOfButtons': 4,\n 'active': -1\n})",
"lineNumber": 10
},
{
"title": "output",
"description": "change\nFires any time the interface's value changes. <br>\nThe event data an <i>integer</i>, the index of the button that is currently on. If no button is selected, the value will be -1.",
"lineNumber": 17
},
{
"title": "outputexample",
"description": "radiobutton.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 22
}
],
"loc": {
"start": {
"line": 7,
"column": 0
},
"end": {
"line": 34,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 36,
"column": 0
},
"end": {
"line": 164,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/radiobutton.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var radiobutton = new Nexus.RadioButton('#target')"
},
{
"description": "var radiobutton = new Nexus.RadioButton('#target',{\n 'size': [120,25],\n 'numberOfButtons': 4,\n 'active': -1\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "RadioButton",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Select one button and deselect all other buttons.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
}
}
},
"tags": [
{
"title": "param",
"description": "{number} The index of the button to select",
"lineNumber": 2,
"type": null,
"name": "index"
}
],
"loc": {
"start": {
"line": 123,
"column": 2
},
"end": {
"line": 126,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 127,
"column": 2
},
"end": {
"line": 133,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/radiobutton.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "index",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} The index of the button to select",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 43,
"offset": 42
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 43,
"offset": 42
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 43,
"offset": 42
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "select",
"kind": "function",
"memberof": "RadioButton",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "RadioButton",
"kind": "class"
},
{
"name": "select",
"kind": "function",
"scope": "instance"
}
],
"namespace": "RadioButton#select"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Deselect all buttons.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 22,
"offset": 21
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 22,
"offset": 21
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 22,
"offset": 21
}
}
},
"tags": [],
"loc": {
"start": {
"line": 135,
"column": 2
},
"end": {
"line": 137,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 138,
"column": 2
},
"end": {
"line": 142,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/radiobutton.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "deselect",
"kind": "function",
"memberof": "RadioButton",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "RadioButton",
"kind": "class"
},
{
"name": "deselect",
"kind": "function",
"scope": "instance"
}
],
"namespace": "RadioButton#deselect"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Update how many buttons are in the interface",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
}
}
},
"tags": [
{
"title": "param",
"description": "How many buttons are in the interface",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "buttons"
}
],
"loc": {
"start": {
"line": 148,
"column": 2
},
"end": {
"line": 151,
"column": 5
}
},
"context": {
"loc": {
"start": {
"line": 152,
"column": 2
},
"end": {
"line": 163,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/radiobutton.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "buttons",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "How many buttons are in the interface",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "numberOfButtons",
"kind": "member",
"memberof": "RadioButton",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "RadioButton",
"kind": "class"
},
{
"name": "numberOfButtons",
"kind": "member",
"scope": "instance"
}
],
"namespace": "RadioButton#numberOfButtons"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "RadioButton",
"kind": "class"
}
],
"namespace": "RadioButton"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Dropdown menu",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 14,
"offset": 13
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 14,
"offset": 13
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 14,
"offset": 13
}
}
},
"tags": [
{
"title": "description",
"description": "Dropdown menu",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"select\"></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var select = new Nexus.Select('#target')",
"lineNumber": 7
},
{
"title": "example",
"description": "var select = new Nexus.Select('#target',{\n 'size': [100,30],\n 'options': ['default','options']\n})",
"lineNumber": 10
},
{
"title": "output",
"description": "change\nFires any time the interface's value changes. <br>\nThe event data is an object containing the text value of the selected option, as well as the numeric index of the selection.",
"lineNumber": 16
},
{
"title": "outputexample",
"description": "select.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 21
}
],
"loc": {
"start": {
"line": 5,
"column": 0
},
"end": {
"line": 32,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 35,
"column": 0
},
"end": {
"line": 185,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/select.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var select = new Nexus.Select('#target')"
},
{
"description": "var select = new Nexus.Select('#target',{\n 'size': [100,30],\n 'options': ['default','options']\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Select",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Update the list of options. This removes all existing options and creates a new list of options.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 97,
"offset": 96
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 97,
"offset": 96
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 97,
"offset": 96
}
}
},
"tags": [
{
"title": "param",
"description": "New array of options",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "array"
},
"name": "options"
}
],
"loc": {
"start": {
"line": 113,
"column": 2
},
"end": {
"line": 116,
"column": 5
}
},
"context": {
"loc": {
"start": {
"line": 118,
"column": 2
},
"end": {
"line": 144,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/select.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "options",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "New array of options",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
}
}
},
"type": {
"type": "NameExpression",
"name": "array"
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "defineOptions",
"kind": "function",
"memberof": "Select",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Select",
"kind": "class"
},
{
"name": "defineOptions",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Select#defineOptions"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The text of the option that is currently selected. If set, will update the interface and trigger the output event.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 115,
"offset": 114
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 115,
"offset": 114
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 115,
"offset": 114
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "String"
}
},
{
"title": "example",
"description": "select.value = \"sawtooth\";",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 147,
"column": 2
},
"end": {
"line": 151,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 152,
"column": 2
},
"end": {
"line": 154,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/select.js"
},
"augments": [],
"examples": [
{
"description": "select.value = \"sawtooth\";"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "value",
"kind": "member",
"memberof": "Select",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Select",
"kind": "class"
},
{
"name": "value",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Select#value"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The numeric index of the option that is currently selected. If set, will update the interface and trigger the output event.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 124,
"offset": 123
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 124,
"offset": 123
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 124,
"offset": 123
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "select.selectedIndex = 2;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 166,
"column": 2
},
"end": {
"line": 170,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 171,
"column": 2
},
"end": {
"line": 173,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/select.js"
},
"augments": [],
"examples": [
{
"description": "select.selectedIndex = 2;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "selectedIndex",
"kind": "member",
"memberof": "Select",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Select",
"kind": "class"
},
{
"name": "selectedIndex",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Select#selectedIndex"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Select",
"kind": "class"
}
],
"namespace": "Select"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Amount of row padding",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 22,
"offset": 21
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 22,
"offset": 21
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 22,
"offset": 21
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"loc": {
"start": {
"line": 33,
"column": 4
},
"end": {
"line": 36,
"column": 7
}
},
"context": {
"loc": {
"start": {
"line": 37,
"column": 4
},
"end": {
"line": 37,
"column": 70
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/sequencer.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "paddingRow",
"memberof": "MatrixCell",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "paddingRow",
"scope": "instance"
}
],
"namespace": "#paddingRow"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Amount of column padding",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 25,
"offset": 24
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 25,
"offset": 24
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 25,
"offset": 24
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"loc": {
"start": {
"line": 39,
"column": 4
},
"end": {
"line": 42,
"column": 7
}
},
"context": {
"loc": {
"start": {
"line": 43,
"column": 4
},
"end": {
"line": 43,
"column": 79
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/sequencer.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "paddingColumn",
"memberof": "MatrixCell",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "paddingColumn",
"scope": "instance"
}
],
"namespace": "#paddingColumn"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Grid of buttons with built-in step sequencer.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
}
}
},
"tags": [
{
"title": "description",
"description": "Grid of buttons with built-in step sequencer.",
"lineNumber": 3
},
{
"title": "demo",
"description": "<div nexus-ui=\"sequencer\" style=\"width:400px;height:200px;\"></div>",
"lineNumber": 5
},
{
"title": "example",
"description": "var sequencer = new Nexus.Sequencer('#target')",
"lineNumber": 7
},
{
"title": "example",
"description": "var sequencer = new Nexus.Sequencer('#target',{\n 'size': [400,200],\n 'mode': 'toggle',\n 'rows': 5,\n 'columns': 10,\n 'paddingRow': 10,\n 'paddingColumn': 20\n})",
"lineNumber": 10
},
{
"title": "output",
"description": "change\nFires whenever a value is received. For example, when clicking a cell from off to on. <br>\nThe event data is an object containing <i>row</i> (number), <i>column</i> (number), and <i>state</i> (boolean) properties.",
"lineNumber": 20
},
{
"title": "outputexample",
"description": "sequencer.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 25
},
{
"title": "output",
"description": "step\nFires any time the sequencer steps to the next column, in sequece mode. <br>\nThe event data is an <i>array</i> containing all values in the column, <i>bottom row first</i>.",
"lineNumber": 30
},
{
"title": "outputexample",
"description": "sequencer.on('step',function(v) {\n console.log(v);\n})",
"lineNumber": 35
}
],
"loc": {
"start": {
"line": 134,
"column": 0
},
"end": {
"line": 173,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 175,
"column": 0
},
"end": {
"line": 452,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/sequencer.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var sequencer = new Nexus.Sequencer('#target')"
},
{
"description": "var sequencer = new Nexus.Sequencer('#target',{\n 'size': [400,200],\n 'mode': 'toggle',\n 'rows': 5,\n 'columns': 10,\n 'paddingRow': 10,\n 'paddingColumn': 20\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Sequencer",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Button interaction mode: see Button",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "string"
}
},
{
"title": "example",
"description": "button.mode = 'toggle';",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 190,
"column": 4
},
"end": {
"line": 194,
"column": 7
}
},
"context": {
"loc": {
"start": {
"line": 195,
"column": 4
},
"end": {
"line": 195,
"column": 35
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/sequencer.js"
},
"augments": [],
"examples": [
{
"description": "button.mode = 'toggle';"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "mode",
"memberof": "Sequencer",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Sequencer",
"kind": "class"
},
{
"name": "mode",
"scope": "instance"
}
],
"namespace": "Sequencer#mode"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The interval object which controls timing and sequence scheduling.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 67,
"offset": 66
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 67,
"offset": 66
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 67,
"offset": 66
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "interval"
}
}
],
"loc": {
"start": {
"line": 197,
"column": 4
},
"end": {
"line": 200,
"column": 7
}
},
"context": {
"loc": {
"start": {
"line": 201,
"column": 4
},
"end": {
"line": 201,
"column": 60
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/sequencer.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "interval",
"memberof": "Sequencer",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Sequencer",
"kind": "class"
},
{
"name": "interval",
"scope": "instance"
}
],
"namespace": "Sequencer#interval"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A Matrix model containing methods for manipulating the sequencer's array of values. To learn how to manipulate the matrix, read about the matrix model.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 152,
"offset": 151
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 152,
"offset": 151
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 152,
"offset": 151
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "matrix"
}
}
],
"loc": {
"start": {
"line": 203,
"column": 4
},
"end": {
"line": 206,
"column": 7
}
},
"context": {
"loc": {
"start": {
"line": 207,
"column": 4
},
"end": {
"line": 207,
"column": 77
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/sequencer.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "matrix",
"memberof": "Sequencer",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Sequencer",
"kind": "class"
},
{
"name": "matrix",
"scope": "instance"
}
],
"namespace": "Sequencer#matrix"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A Counter model which the sequencer steps through. For example, you could use this model to step through the sequencer in reverse, randomly, or in a drunk walk.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 161,
"offset": 160
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 161,
"offset": 160
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 161,
"offset": 160
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "counter"
}
}
],
"loc": {
"start": {
"line": 210,
"column": 4
},
"end": {
"line": 213,
"column": 7
}
},
"context": {
"loc": {
"start": {
"line": 214,
"column": 4
},
"end": {
"line": 214,
"column": 53
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/sequencer.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "stepper",
"memberof": "Sequencer",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Sequencer",
"kind": "class"
},
{
"name": "stepper",
"scope": "instance"
}
],
"namespace": "Sequencer#stepper"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Start sequencing",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 17,
"offset": 16
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 17,
"offset": 16
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 17,
"offset": 16
}
}
},
"tags": [
{
"title": "param",
"description": "Beat tempo in milliseconds",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "ms"
}
],
"loc": {
"start": {
"line": 342,
"column": 2
},
"end": {
"line": 345,
"column": 5
}
},
"context": {
"loc": {
"start": {
"line": 346,
"column": 2
},
"end": {
"line": 352,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/sequencer.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "ms",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Beat tempo in milliseconds",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 27,
"offset": 26
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 27,
"offset": 26
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 27,
"offset": 26
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "start",
"kind": "function",
"memberof": "Sequencer",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Sequencer",
"kind": "class"
},
{
"name": "start",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Sequencer#start"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Stop sequencing",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 16,
"offset": 15
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 16,
"offset": 15
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 16,
"offset": 15
}
}
},
"tags": [],
"loc": {
"start": {
"line": 354,
"column": 2
},
"end": {
"line": 356,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 357,
"column": 2
},
"end": {
"line": 359,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/sequencer.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "stop",
"kind": "function",
"memberof": "Sequencer",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Sequencer",
"kind": "class"
},
{
"name": "stop",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Sequencer#stop"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Manually jump to the next column and trigger the 'change' event. The \"next\" column is determined by your mode of sequencing.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 125,
"offset": 124
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 125,
"offset": 124
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 125,
"offset": 124
}
}
},
"tags": [],
"loc": {
"start": {
"line": 361,
"column": 2
},
"end": {
"line": 363,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 364,
"column": 2
},
"end": {
"line": 368,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/sequencer.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "next",
"kind": "function",
"memberof": "Sequencer",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Sequencer",
"kind": "class"
},
{
"name": "next",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Sequencer#next"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Number of rows in the sequencer",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 32,
"offset": 31
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 32,
"offset": 31
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 32,
"offset": 31
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"loc": {
"start": {
"line": 422,
"column": 2
},
"end": {
"line": 425,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 426,
"column": 2
},
"end": {
"line": 428,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/sequencer.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "rows",
"kind": "member",
"memberof": "Sequencer",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Sequencer",
"kind": "class"
},
{
"name": "rows",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Sequencer#rows"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Number of columns in the sequencer",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 35,
"offset": 34
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 35,
"offset": 34
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 35,
"offset": 34
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"loc": {
"start": {
"line": 437,
"column": 2
},
"end": {
"line": 440,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 441,
"column": 2
},
"end": {
"line": 443,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/sequencer.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "columns",
"kind": "member",
"memberof": "Sequencer",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Sequencer",
"kind": "class"
},
{
"name": "columns",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Sequencer#columns"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Sequencer",
"kind": "class"
}
],
"namespace": "Sequencer"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Horizontal or vertical slider with settable interaction modes.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 63,
"offset": 62
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 63,
"offset": 62
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 63,
"offset": 62
}
}
},
"tags": [
{
"title": "description",
"description": "Horizontal or vertical slider with settable interaction modes.",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"slider\" step=0.2></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var slider = new Nexus.Slider('#target')",
"lineNumber": 7
},
{
"title": "example",
"description": "var slider = new Nexus.Slider('#target',{\n 'size': [120,20],\n 'mode': 'relative', // 'relative' or 'absolute'\n 'min': 0,\n 'max': 1,\n 'step': 0,\n 'value': 0\n})",
"lineNumber": 10
},
{
"title": "output",
"description": "change\nFires when the interface's value changes. <br>\nEvent data: <i>number</i> The number value of the interface.",
"lineNumber": 20
},
{
"title": "outputexample",
"description": "slider.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 25
}
],
"loc": {
"start": {
"line": 8,
"column": 0
},
"end": {
"line": 39,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 41,
"column": 0
},
"end": {
"line": 277,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/slider.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var slider = new Nexus.Slider('#target')"
},
{
"description": "var slider = new Nexus.Slider('#target',{\n 'size': [120,20],\n 'mode': 'relative', // 'relative' or 'absolute'\n 'min': 0,\n 'max': 1,\n 'step': 0,\n 'value': 0\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Slider",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The slider's current value. If set manually, will update the interface and trigger the output event.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 101,
"offset": 100
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 101,
"offset": 100
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 101,
"offset": 100
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "slider.value = 10;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 212,
"column": 2
},
"end": {
"line": 216,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 217,
"column": 2
},
"end": {
"line": 219,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/slider.js"
},
"augments": [],
"examples": [
{
"description": "slider.value = 10;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "value",
"kind": "member",
"memberof": "Slider",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Slider",
"kind": "class"
},
{
"name": "value",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Slider#value"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Lower limit of the sliders's output range",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "slider.min = 1000;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 227,
"column": 2
},
"end": {
"line": 231,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 232,
"column": 2
},
"end": {
"line": 234,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/slider.js"
},
"augments": [],
"examples": [
{
"description": "slider.min = 1000;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "min",
"kind": "member",
"memberof": "Slider",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Slider",
"kind": "class"
},
{
"name": "min",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Slider#min"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Upper limit of the slider's output range",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 41,
"offset": 40
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 41,
"offset": 40
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 41,
"offset": 40
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "slider.max = 1000;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 239,
"column": 2
},
"end": {
"line": 243,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 244,
"column": 2
},
"end": {
"line": 246,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/slider.js"
},
"augments": [],
"examples": [
{
"description": "slider.max = 1000;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "max",
"kind": "member",
"memberof": "Slider",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Slider",
"kind": "class"
},
{
"name": "max",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Slider#max"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The increment that the slider's value changes by.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "slider.step = 5;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 251,
"column": 2
},
"end": {
"line": 255,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 256,
"column": 2
},
"end": {
"line": 258,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/slider.js"
},
"augments": [],
"examples": [
{
"description": "slider.step = 5;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "step",
"kind": "member",
"memberof": "Slider",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Slider",
"kind": "class"
},
{
"name": "step",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Slider#step"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Absolute mode (slider's value jumps to mouse click position) or relative mode (mouse drag changes value relative to its current position). Default: \"relative\".",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 160,
"offset": 159
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 160,
"offset": 159
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 160,
"offset": 159
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "string"
}
},
{
"title": "example",
"description": "slider.mode = \"relative\";",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 263,
"column": 2
},
"end": {
"line": 267,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 268,
"column": 2
},
"end": {
"line": 270,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/slider.js"
},
"augments": [],
"examples": [
{
"description": "slider.mode = \"relative\";"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "mode",
"kind": "member",
"memberof": "Slider",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Slider",
"kind": "class"
},
{
"name": "mode",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Slider#mode"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Slider",
"kind": "class"
}
],
"namespace": "Slider"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Audio spectrum visualization",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 29,
"offset": 28
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 29,
"offset": 28
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 29,
"offset": 28
}
}
},
"tags": [
{
"title": "description",
"description": "Audio spectrum visualization",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"spectrogram\"></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var spectrogram = new Nexus.Spectrogram('#target')\nspectrogram.connect(myWebAudioNode)",
"lineNumber": 7
},
{
"title": "example",
"description": "var spectrogram = new Nexus.Spectrogram('#target',{\n 'size': [300,150]\n})\nspectrogram.connect(myWebAudioNode)",
"lineNumber": 11
},
{
"title": "output",
"description": " \nNo events",
"lineNumber": 17
}
],
"loc": {
"start": {
"line": 6,
"column": 0
},
"end": {
"line": 27,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 29,
"column": 0
},
"end": {
"line": 154,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/spectrogram.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var spectrogram = new Nexus.Spectrogram('#target')\nspectrogram.connect(myWebAudioNode)"
},
{
"description": "var spectrogram = new Nexus.Spectrogram('#target',{\n 'size': [300,150]\n})\nspectrogram.connect(myWebAudioNode)"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Spectrogram",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Equivalent to \"patching in\" an audio node to visualize.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
}
}
},
"tags": [
{
"title": "param",
"description": "{AudioNode} The audio node to visualize",
"lineNumber": 2,
"type": null,
"name": "node"
},
{
"title": "example",
"description": "spectrogram.connect( Tone.Master );",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 108,
"column": 2
},
"end": {
"line": 112,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 113,
"column": 2
},
"end": {
"line": 129,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/spectrogram.js"
},
"augments": [],
"examples": [
{
"description": "spectrogram.connect( Tone.Master );"
}
],
"params": [
{
"title": "param",
"name": "node",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{AudioNode} The audio node to visualize",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "connect",
"kind": "function",
"memberof": "Spectrogram",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Spectrogram",
"kind": "class"
},
{
"name": "connect",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Spectrogram#connect"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Stop visualizing the source node and disconnect it.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
}
}
},
"tags": [],
"loc": {
"start": {
"line": 131,
"column": 2
},
"end": {
"line": 133,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 134,
"column": 2
},
"end": {
"line": 144,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/spectrogram.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "disconnect",
"kind": "function",
"memberof": "Spectrogram",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Spectrogram",
"kind": "class"
},
{
"name": "disconnect",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Spectrogram#disconnect"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Spectrogram",
"kind": "class"
}
],
"namespace": "Spectrogram"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Text button",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
}
}
},
"tags": [
{
"title": "description",
"description": "Text button",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"textButton\"></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var textbutton = new Nexus.TextButton('#target')",
"lineNumber": 7
},
{
"title": "example",
"description": "var textbutton = new Nexus.TextButton('#target',{\n 'size': [150,50],\n 'state': false,\n 'text': 'Play',\n 'alternateText': 'Stop'\n})",
"lineNumber": 10
},
{
"title": "output",
"description": "change\nFires any time the interface's value changes. <br>\nThe event data is a <i>string</i> of the text on the button at the moment it was clicked.",
"lineNumber": 18
},
{
"title": "outputexample",
"description": "textbutton.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 23
}
],
"loc": {
"start": {
"line": 5,
"column": 0
},
"end": {
"line": 33,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 35,
"column": 0
},
"end": {
"line": 154,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/textbutton.js"
},
"augments": [
{
"title": "augments",
"name": "ButtonTemplate"
}
],
"examples": [
{
"description": "var textbutton = new Nexus.TextButton('#target')"
},
{
"description": "var textbutton = new Nexus.TextButton('#target',{\n 'size': [150,50],\n 'state': false,\n 'text': 'Play',\n 'alternateText': 'Stop'\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "TextButton",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The text to display when the button is in its \"on\" state. If set, this puts the button in \"toggle\" mode.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 105,
"offset": 104
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 105,
"offset": 104
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 105,
"offset": 104
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "String"
}
}
],
"loc": {
"start": {
"line": 120,
"column": 2
},
"end": {
"line": 123,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 124,
"column": 2
},
"end": {
"line": 126,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/textbutton.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "alternateText",
"kind": "member",
"memberof": "TextButton",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "TextButton",
"kind": "class"
},
{
"name": "alternateText",
"kind": "member",
"scope": "instance"
}
],
"namespace": "TextButton#alternateText"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The text to display. (If .alternateText exists, then this .text will only be displayed when the button is in its \"off\" state.)",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 127,
"offset": 126
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 127,
"offset": 126
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 127,
"offset": 126
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "String"
}
}
],
"loc": {
"start": {
"line": 139,
"column": 2
},
"end": {
"line": 142,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 143,
"column": 2
},
"end": {
"line": 145,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/textbutton.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "text",
"kind": "member",
"memberof": "TextButton",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "TextButton",
"kind": "class"
},
{
"name": "text",
"kind": "member",
"scope": "instance"
}
],
"namespace": "TextButton#text"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "TextButton",
"kind": "class"
}
],
"namespace": "TextButton"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Device tilt sensor with 2 or 3 axes (depending on your device and browser).",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 76,
"offset": 75
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 76,
"offset": 75
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 76,
"offset": 75
}
}
},
"tags": [
{
"title": "description",
"description": "Device tilt sensor with 2 or 3 axes (depending on your device and browser).",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui='tilt'></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var tilt = new Nexus.Tilt('#target')",
"lineNumber": 7
},
{
"title": "output",
"description": "change\nFires at a regular interval, as long as this interface is active (see the interface's <i>.active</i> property)<br>\nThe event data is an <i>object</i> containing x (number) and y (number) properties which represent the current tilt state of the device.",
"lineNumber": 10
},
{
"title": "outputexample",
"description": "tilt.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 15
}
],
"loc": {
"start": {
"line": 7,
"column": 0
},
"end": {
"line": 28,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 30,
"column": 0
},
"end": {
"line": 309,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/tilt.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var tilt = new Nexus.Tilt('#target')"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Tilt",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Whether the interface is on (emitting values) or off (paused & not emitting values). Setting this property will update it.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 123,
"offset": 122
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 123,
"offset": 122
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 123,
"offset": 122
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "boolean"
}
}
],
"loc": {
"start": {
"line": 291,
"column": 2
},
"end": {
"line": 294,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 296,
"column": 2
},
"end": {
"line": 298,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/tilt.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "active",
"kind": "member",
"memberof": "Tilt",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Tilt",
"kind": "class"
},
{
"name": "active",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Tilt#active"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Tilt",
"kind": "class"
}
],
"namespace": "Tilt"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Binary switch",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 14,
"offset": 13
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 14,
"offset": 13
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 14,
"offset": 13
}
}
},
"tags": [
{
"title": "description",
"description": "Binary switch",
"lineNumber": 3
},
{
"title": "demo",
"description": "<span nexus-ui=\"toggle\"></span>",
"lineNumber": 5
},
{
"title": "example",
"description": "var toggle = new Nexus.Toggle('#target')",
"lineNumber": 7
},
{
"title": "example",
"description": "var toggle = new Nexus.Toggle('#target',{\n 'size': [40,20],\n 'state': false\n})",
"lineNumber": 10
},
{
"title": "output",
"description": "change\nFires any time the interface's value changes. <br>\nParameter: The boolean state of the interface.",
"lineNumber": 16
},
{
"title": "outputexample",
"description": "toggle.on('change',function(v) {\n console.log(v);\n})",
"lineNumber": 21
}
],
"loc": {
"start": {
"line": 7,
"column": 0
},
"end": {
"line": 34,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 35,
"column": 0
},
"end": {
"line": 131,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/toggle.js"
},
"augments": [
{
"title": "augments",
"name": "Interface"
}
],
"examples": [
{
"description": "var toggle = new Nexus.Toggle('#target')"
},
{
"description": "var toggle = new Nexus.Toggle('#target',{\n 'size': [40,20],\n 'state': false\n})"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "Toggle",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Whether the toggle is currently on or off. Setting this property will update the toggle interface and trigger the output event.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 128,
"offset": 127
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 128,
"offset": 127
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 128,
"offset": 127
}
}
},
"tags": [
{
"title": "type",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "boolean"
}
},
{
"title": "example",
"description": "toggle.state = false;",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 106,
"column": 2
},
"end": {
"line": 110,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 111,
"column": 2
},
"end": {
"line": 113,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/toggle.js"
},
"augments": [],
"examples": [
{
"description": "toggle.state = false;"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "state",
"kind": "member",
"memberof": "Toggle",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Toggle",
"kind": "class"
},
{
"name": "state",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Toggle#state"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Switch the toggle state to its opposite state",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
}
}
},
"tags": [
{
"title": "example",
"description": "toggle.flip();",
"lineNumber": 2
}
],
"loc": {
"start": {
"line": 121,
"column": 2
},
"end": {
"line": 125,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 126,
"column": 2
},
"end": {
"line": 129,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/interfaces/toggle.js"
},
"augments": [],
"examples": [
{
"description": "toggle.flip();"
}
],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "flip",
"kind": "function",
"memberof": "Toggle",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Toggle",
"kind": "class"
},
{
"name": "flip",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Toggle#flip"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Toggle",
"kind": "class"
}
],
"namespace": "Toggle"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "NexusUI => created as Nexus",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 28,
"offset": 27
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 28,
"offset": 27
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 28,
"offset": 27
}
}
},
"tags": [],
"loc": {
"start": {
"line": 19,
"column": 0
},
"end": {
"line": 21,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 23,
"column": 0
},
"end": {
"line": 104,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/main.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "context",
"lineNumber": 25
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "NexusUI",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "NexusUI",
"kind": "class"
}
],
"namespace": "NexusUI"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Creates an abstract model of a steppable range slider with start and end values which are constricted by a minimum, maximum, and step size.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 140,
"offset": 139
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 140,
"offset": 139
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 140,
"offset": 139
}
}
},
"tags": [
{
"title": "param",
"description": "minimum",
"lineNumber": 2,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "number"
}
},
"name": "min",
"default": "0"
},
{
"title": "param",
"description": "maximum",
"lineNumber": 3,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "number"
}
},
"name": "max",
"default": "1"
},
{
"title": "param",
"description": null,
"lineNumber": 4,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "number"
}
},
"name": "step",
"default": "0"
},
{
"title": "returns",
"description": "Step",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"loc": {
"start": {
"line": 5,
"column": 0
},
"end": {
"line": 11,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 13,
"column": 0
},
"end": {
"line": 84,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/models/range.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "min",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "minimum",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 8,
"offset": 7
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 8,
"offset": 7
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 8,
"offset": 7
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
},
"default": "0"
},
{
"title": "param",
"name": "max",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "maximum",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 8,
"offset": 7
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 8,
"offset": 7
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 8,
"offset": 7
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
},
"default": "1"
},
{
"title": "param",
"name": "step",
"lineNumber": 4,
"type": {
"type": "NameExpression",
"name": "number"
},
"default": "0"
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Step",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 5,
"offset": 4
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 5,
"offset": 4
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 5,
"offset": 4
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "Range",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} Minimum value of the range",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
}
}
},
"tags": [],
"loc": {
"start": {
"line": 17,
"column": 4
},
"end": {
"line": 19,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 20,
"column": 4
},
"end": {
"line": 20,
"column": 19
}
},
"file": "/Users/tatecarson/webDev/ui/lib/models/range.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "min",
"memberof": "Range",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Range",
"kind": "class"
},
{
"name": "min",
"scope": "instance"
}
],
"namespace": "Range#min"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} Maximum value of the range",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
}
}
},
"tags": [],
"loc": {
"start": {
"line": 22,
"column": 4
},
"end": {
"line": 24,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 25,
"column": 4
},
"end": {
"line": 25,
"column": 19
}
},
"file": "/Users/tatecarson/webDev/ui/lib/models/range.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "max",
"memberof": "Range",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Range",
"kind": "class"
},
{
"name": "max",
"scope": "instance"
}
],
"namespace": "Range#max"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{Step} Start value of the range selection",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
}
}
},
"tags": [],
"loc": {
"start": {
"line": 27,
"column": 4
},
"end": {
"line": 29,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 30,
"column": 4
},
"end": {
"line": 30,
"column": 40
}
},
"file": "/Users/tatecarson/webDev/ui/lib/models/range.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "start",
"memberof": "Range",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Range",
"kind": "class"
},
{
"name": "start",
"scope": "instance"
}
],
"namespace": "Range#start"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{Step} End value of the range selection",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
},
"tags": [],
"loc": {
"start": {
"line": 32,
"column": 4
},
"end": {
"line": 34,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 35,
"column": 4
},
"end": {
"line": 35,
"column": 38
}
},
"file": "/Users/tatecarson/webDev/ui/lib/models/range.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "end",
"memberof": "Range",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Range",
"kind": "class"
},
{
"name": "end",
"scope": "instance"
}
],
"namespace": "Range#end"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} Center of the range selection",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
}
}
},
"tags": [],
"loc": {
"start": {
"line": 38,
"column": 2
},
"end": {
"line": 40,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 41,
"column": 2
},
"end": {
"line": 43,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/models/range.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "center",
"kind": "member",
"memberof": "Range",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Range",
"kind": "class"
},
{
"name": "center",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Range#center"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "{number} Size of the range selection",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 37,
"offset": 36
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 37,
"offset": 36
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 37,
"offset": 36
}
}
},
"tags": [],
"loc": {
"start": {
"line": 54,
"column": 2
},
"end": {
"line": 56,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 57,
"column": 2
},
"end": {
"line": 59,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/models/range.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "size",
"kind": "member",
"memberof": "Range",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Range",
"kind": "class"
},
{
"name": "size",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Range#size"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Move the range selection",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 25,
"offset": 24
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 25,
"offset": 24
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 25,
"offset": 24
}
}
},
"tags": [
{
"title": "param",
"description": "New start value of the range selection",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "start"
},
{
"title": "param",
"description": "New end value of the range selection",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "end"
}
],
"loc": {
"start": {
"line": 70,
"column": 2
},
"end": {
"line": 74,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 75,
"column": 2
},
"end": {
"line": 82,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/models/range.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "start",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "New start value of the range selection",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "end",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "New end value of the range selection",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 37,
"offset": 36
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 37,
"offset": 36
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 37,
"offset": 36
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "move",
"kind": "function",
"memberof": "Range",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Range",
"kind": "class"
},
{
"name": "move",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Range#move"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Range",
"kind": "class"
}
],
"namespace": "Range"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Creates a steppable value with minimum, maximum, and step size. This is used in many interfaces to constrict their values to certain ranges.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 141,
"offset": 140
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 141,
"offset": 140
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 141,
"offset": 140
}
}
},
"tags": [
{
"title": "param",
"description": "minimum",
"lineNumber": 2,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "number"
}
},
"name": "min",
"default": "0"
},
{
"title": "param",
"description": "maximum",
"lineNumber": 3,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "number"
}
},
"name": "max",
"default": "1"
},
{
"title": "param",
"description": null,
"lineNumber": 4,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "number"
}
},
"name": "step",
"default": "0"
},
{
"title": "param",
"description": "initial value",
"lineNumber": 5,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "number"
}
},
"name": "value",
"default": "0"
},
{
"title": "returns",
"description": "Step",
"lineNumber": 6,
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"loc": {
"start": {
"line": 5,
"column": 0
},
"end": {
"line": 12,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 14,
"column": 0
},
"end": {
"line": 66,
"column": 1
}
},
"file": "/Users/tatecarson/webDev/ui/lib/models/step.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "min",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "minimum",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 8,
"offset": 7
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 8,
"offset": 7
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 8,
"offset": 7
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
},
"default": "0"
},
{
"title": "param",
"name": "max",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "maximum",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 8,
"offset": 7
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 8,
"offset": 7
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 8,
"offset": 7
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
},
"default": "1"
},
{
"title": "param",
"name": "step",
"lineNumber": 4,
"type": {
"type": "NameExpression",
"name": "number"
},
"default": "0"
},
{
"title": "param",
"name": "value",
"lineNumber": 5,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "initial value",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 14,
"offset": 13
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 14,
"offset": 13
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 14,
"offset": 13
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
},
"default": "0"
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Step",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 5,
"offset": 4
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 5,
"offset": 4
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 5,
"offset": 4
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "Step",
"kind": "class",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Update with a new value. The value will be auto-adjusted to fit the min/max/step.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 82,
"offset": 81
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 82,
"offset": 81
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 82,
"offset": 81
}
}
},
"tags": [
{
"title": "param",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "value"
}
],
"loc": {
"start": {
"line": 29,
"column": 2
},
"end": {
"line": 32,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 34,
"column": 2
},
"end": {
"line": 48,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/models/step.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "value",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "update",
"kind": "function",
"memberof": "Step",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Step",
"kind": "class"
},
{
"name": "update",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Step#update"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Update with a normalized value 0-1.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
}
}
},
"tags": [
{
"title": "param",
"description": null,
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "value"
}
],
"loc": {
"start": {
"line": 50,
"column": 2
},
"end": {
"line": 53,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 54,
"column": 2
},
"end": {
"line": 57,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/models/step.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "value",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "updateNormal",
"kind": "function",
"memberof": "Step",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Step",
"kind": "class"
},
{
"name": "updateNormal",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Step#updateNormal"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Get a normalized version of this.value . Not settable.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 55,
"offset": 54
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 55,
"offset": 54
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 55,
"offset": 54
}
}
},
"tags": [],
"loc": {
"start": {
"line": 59,
"column": 2
},
"end": {
"line": 61,
"column": 4
}
},
"context": {
"loc": {
"start": {
"line": 62,
"column": 2
},
"end": {
"line": 64,
"column": 3
}
},
"file": "/Users/tatecarson/webDev/ui/lib/models/step.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"name": "normalized",
"kind": "member",
"memberof": "Step",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Step",
"kind": "class"
},
{
"name": "normalized",
"kind": "member",
"scope": "instance"
}
],
"namespace": "Step#normalized"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Step",
"kind": "class"
}
],
"namespace": "Step"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Limit a number to within a minimum and maximum",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 47,
"offset": 46
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 47,
"offset": 46
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 47,
"offset": 46
}
}
},
"tags": [
{
"title": "param",
"description": "Input value",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "value"
},
{
"title": "param",
"description": "Lower limit",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "min"
},
{
"title": "param",
"description": "Upper limit",
"lineNumber": 4,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "max"
},
{
"title": "return",
"description": "The input value constrained within the lower and upper limits",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "Nexus.clip(11,0,10) // returns 10\nNexus.clip(-1,0,10) // returns 0\nNexus.clip(5,0,10) // returns 5",
"lineNumber": 6
}
],
"loc": {
"start": {
"line": 3,
"column": 0
},
"end": {
"line": 13,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 15,
"column": 0
},
"end": {
"line": 17,
"column": 2
}
},
"file": "/Users/tatecarson/webDev/ui/lib/util/math.js"
},
"augments": [],
"examples": [
{
"description": "Nexus.clip(11,0,10) // returns 10\nNexus.clip(-1,0,10) // returns 0\nNexus.clip(5,0,10) // returns 5"
}
],
"params": [
{
"title": "param",
"name": "value",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Input value",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "min",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Lower limit",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "max",
"lineNumber": 4,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Upper limit",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The input value constrained within the lower and upper limits",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 62,
"offset": 61
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 62,
"offset": 61
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 62,
"offset": 61
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "clip",
"kind": "function",
"memberof": "math",
"scope": "static",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "clip",
"kind": "function",
"scope": "static"
}
],
"namespace": ".clip"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Scale a value from one range to another range.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 47,
"offset": 46
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 47,
"offset": 46
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 47,
"offset": 46
}
}
},
"tags": [
{
"title": "param",
"description": "Input value",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "inNum"
},
{
"title": "param",
"description": "Input range minimum",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "inMin"
},
{
"title": "param",
"description": "Input range maximum",
"lineNumber": 4,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "inMax"
},
{
"title": "param",
"description": "Output range minimum",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "outMin"
},
{
"title": "param",
"description": "Output range maximum",
"lineNumber": 6,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "outMax"
},
{
"title": "return",
"description": "The input value scaled to its new range",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "Nexus.scale(0.5,0,1,0,10) // returns 5\nNexus.scale(0.9,0,1,1,0) // returns 0.1",
"lineNumber": 8
}
],
"loc": {
"start": {
"line": 23,
"column": 0
},
"end": {
"line": 34,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 35,
"column": 0
},
"end": {
"line": 40,
"column": 2
}
},
"file": "/Users/tatecarson/webDev/ui/lib/util/math.js"
},
"augments": [],
"examples": [
{
"description": "Nexus.scale(0.5,0,1,0,10) // returns 5\nNexus.scale(0.9,0,1,1,0) // returns 0.1"
}
],
"params": [
{
"title": "param",
"name": "inNum",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Input value",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "inMin",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Input range minimum",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 20,
"offset": 19
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 20,
"offset": 19
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 20,
"offset": 19
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "inMax",
"lineNumber": 4,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Input range maximum",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 20,
"offset": 19
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 20,
"offset": 19
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 20,
"offset": 19
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "outMin",
"lineNumber": 5,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Output range minimum",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "outMax",
"lineNumber": 6,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Output range maximum",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The input value scaled to its new range",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "scale",
"kind": "function",
"memberof": "math",
"scope": "static",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "scale",
"kind": "function",
"scope": "static"
}
],
"namespace": ".scale"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Convert a MIDi note number to a frequency value in equal temperament.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 70,
"offset": 69
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 70,
"offset": 69
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 70,
"offset": 69
}
}
},
"tags": [
{
"title": "param",
"description": "MIDI note value",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "midi"
},
{
"title": "return",
"description": "Frequence value",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "Nexus.mtof(60) // returns the frequency number of Middle C",
"lineNumber": 4
}
],
"loc": {
"start": {
"line": 77,
"column": 0
},
"end": {
"line": 83,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 84,
"column": 0
},
"end": {
"line": 86,
"column": 2
}
},
"file": "/Users/tatecarson/webDev/ui/lib/util/math.js"
},
"augments": [],
"examples": [
{
"description": "Nexus.mtof(60) // returns the frequency number of Middle C"
}
],
"params": [
{
"title": "param",
"name": "midi",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "MIDI note value",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 16,
"offset": 15
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 16,
"offset": 15
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 16,
"offset": 15
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Frequence value",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 16,
"offset": 15
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 16,
"offset": 15
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 16,
"offset": 15
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "mtof",
"kind": "function",
"memberof": "math",
"scope": "static",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "mtof",
"kind": "function",
"scope": "static"
}
],
"namespace": ".mtof"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Interpolate between two numbers",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 32,
"offset": 31
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 32,
"offset": 31
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 32,
"offset": 31
}
}
},
"tags": [
{
"title": "param",
"description": "Interpolation index (0-1)",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "loc"
},
{
"title": "param",
"description": "Lower value",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "min"
},
{
"title": "param",
"description": "Upper value",
"lineNumber": 4,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "max"
},
{
"title": "return",
"description": "Interpolated value",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "Nexus.interp(0.5,2,4) // returns 3\nNexus.interp(0.1,0,10) // returns 1",
"lineNumber": 6
}
],
"loc": {
"start": {
"line": 88,
"column": 0
},
"end": {
"line": 97,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 98,
"column": 0
},
"end": {
"line": 100,
"column": 2
}
},
"file": "/Users/tatecarson/webDev/ui/lib/util/math.js"
},
"augments": [],
"examples": [
{
"description": "Nexus.interp(0.5,2,4) // returns 3\nNexus.interp(0.1,0,10) // returns 1"
}
],
"params": [
{
"title": "param",
"name": "loc",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Interpolation index (0-1)",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "min",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Lower value",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "max",
"lineNumber": 4,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Upper value",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 12,
"offset": 11
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Interpolated value",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 19,
"offset": 18
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 19,
"offset": 18
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 19,
"offset": 18
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "interp",
"kind": "function",
"memberof": "math",
"scope": "static",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "interp",
"kind": "function",
"scope": "static"
}
],
"namespace": ".interp"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Return a random choice from a list of arguments",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
}
}
},
"tags": [
{
"title": "return",
"description": "One random argument",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "various"
}
},
{
"title": "example",
"description": "Nexus.pick(1,2,3,4) // returns 1, 2, 3, or 4\nNexus.pick(function1,function2) // returns either function1 or function2",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 102,
"column": 0
},
"end": {
"line": 108,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 109,
"column": 0
},
"end": {
"line": 111,
"column": 2
}
},
"file": "/Users/tatecarson/webDev/ui/lib/util/math.js"
},
"augments": [],
"examples": [
{
"description": "Nexus.pick(1,2,3,4) // returns 1, 2, 3, or 4\nNexus.pick(function1,function2) // returns either function1 or function2"
}
],
"params": [],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "One random argument",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 20,
"offset": 19
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 20,
"offset": 19
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 20,
"offset": 19
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "various"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "pick",
"kind": "function",
"memberof": "math",
"scope": "static",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "pick",
"kind": "function",
"scope": "static"
}
],
"namespace": ".pick"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Returns an octave multiplier for frequency values",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
}
}
},
"tags": [
{
"title": "param",
"description": "Relative octave number (e.g. -1 for one octave down, 1 for one octave up)",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "num"
},
{
"title": "return",
"description": "Octave multiplier",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "Nexus.octave(-1) // returns 0.5\nNexus.octave(0) // returns 1\nNexus.octave(1) // returns 2\nNexus.octave(2) // returns 4",
"lineNumber": 4
}
],
"loc": {
"start": {
"line": 113,
"column": 0
},
"end": {
"line": 122,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 123,
"column": 0
},
"end": {
"line": 125,
"column": 2
}
},
"file": "/Users/tatecarson/webDev/ui/lib/util/math.js"
},
"augments": [],
"examples": [
{
"description": "Nexus.octave(-1) // returns 0.5\nNexus.octave(0) // returns 1\nNexus.octave(1) // returns 2\nNexus.octave(2) // returns 4"
}
],
"params": [
{
"title": "param",
"name": "num",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Relative octave number (e.g. -1 for one octave down, 1 for one octave up)",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 74,
"offset": 73
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 74,
"offset": 73
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 74,
"offset": 73
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Octave multiplier",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "octave",
"kind": "function",
"memberof": "math",
"scope": "static",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "octave",
"kind": "function",
"scope": "static"
}
],
"namespace": ".octave"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Random integer generator. If no second argument is given, will return random integer from 0 to bound1.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 103,
"offset": 102
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 103,
"offset": 102
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 103,
"offset": 102
}
}
},
"tags": [
{
"title": "param",
"description": "Minimum random value",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "bound1"
},
{
"title": "param",
"description": "Maximum random value",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "bound2"
},
{
"title": "return",
"description": "Random integer between lower and upper boundary",
"lineNumber": 4,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "Nexus.ri(10) // returns random int from 0 to 10\nNexus.ri(20,2000) // returns random int from 20 to 2000",
"lineNumber": 5
}
],
"loc": {
"start": {
"line": 127,
"column": 0
},
"end": {
"line": 135,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 136,
"column": 0
},
"end": {
"line": 144,
"column": 2
}
},
"file": "/Users/tatecarson/webDev/ui/lib/util/math.js"
},
"augments": [],
"examples": [
{
"description": "Nexus.ri(10) // returns random int from 0 to 10\nNexus.ri(20,2000) // returns random int from 20 to 2000"
}
],
"params": [
{
"title": "param",
"name": "bound1",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Minimum random value",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "bound2",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Maximum random value",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Random integer between lower and upper boundary",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "ri",
"kind": "function",
"memberof": "math",
"scope": "static",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "ri",
"kind": "function",
"scope": "static"
}
],
"namespace": ".ri"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Random float number generator. If no second argument is given, will return random float from 0 to bound1.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 106,
"offset": 105
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 106,
"offset": 105
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 106,
"offset": 105
}
}
},
"tags": [
{
"title": "param",
"description": "Minimum random value",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "bound1"
},
{
"title": "param",
"description": "Maximum random value",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "bound2"
},
{
"title": "return",
"description": "Random float between lower and upper boundary",
"lineNumber": 4,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "Nexus.rf(1) // returns random float from 0 to 1\nNexus.rf(1,2) // returns random float from 1 to 2",
"lineNumber": 5
}
],
"loc": {
"start": {
"line": 146,
"column": 0
},
"end": {
"line": 154,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 155,
"column": 0
},
"end": {
"line": 163,
"column": 2
}
},
"file": "/Users/tatecarson/webDev/ui/lib/util/math.js"
},
"augments": [],
"examples": [
{
"description": "Nexus.rf(1) // returns random float from 0 to 1\nNexus.rf(1,2) // returns random float from 1 to 2"
}
],
"params": [
{
"title": "param",
"name": "bound1",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Minimum random value",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "bound2",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Maximum random value",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Random float between lower and upper boundary",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 46,
"offset": 45
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "rf",
"kind": "function",
"memberof": "math",
"scope": "static",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "rf",
"kind": "function",
"scope": "static"
}
],
"namespace": ".rf"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Average an array of numbers",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 28,
"offset": 27
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 28,
"offset": 27
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 28,
"offset": 27
}
}
},
"tags": [
{
"title": "param",
"description": "Array of numbers to average",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Array"
},
"name": "data"
},
{
"title": "return",
"description": "Average of the input data",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "Nexus.average([0,2,4,6,8,10]) // returns 5",
"lineNumber": 4
}
],
"loc": {
"start": {
"line": 174,
"column": 0
},
"end": {
"line": 180,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 181,
"column": 0
},
"end": {
"line": 187,
"column": 2
}
},
"file": "/Users/tatecarson/webDev/ui/lib/util/math.js"
},
"augments": [],
"examples": [
{
"description": "Nexus.average([0,2,4,6,8,10]) // returns 5"
}
],
"params": [
{
"title": "param",
"name": "data",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Array of numbers to average",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 28,
"offset": 27
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 28,
"offset": 27
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 28,
"offset": 27
}
}
},
"type": {
"type": "NameExpression",
"name": "Array"
}
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Average of the input data",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "average",
"kind": "function",
"memberof": "math",
"scope": "static",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "average",
"kind": "function",
"scope": "static"
}
],
"namespace": ".average"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Get the distance from one (x,y) point to another (x,y) point",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 61,
"offset": 60
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 61,
"offset": 60
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 61,
"offset": 60
}
}
},
"tags": [
{
"title": "param",
"description": "x of first point",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "x1"
},
{
"title": "param",
"description": "y of first point",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "y1"
},
{
"title": "param",
"description": "x of second point",
"lineNumber": 4,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "x2"
},
{
"title": "param",
"description": "y of second poiny",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "number"
},
"name": "y2"
},
{
"title": "return",
"description": "Distance",
"lineNumber": 6,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "Nexus.distance(0,0,3,4) // returns 5",
"lineNumber": 7
}
],
"loc": {
"start": {
"line": 189,
"column": 0
},
"end": {
"line": 198,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 199,
"column": 0
},
"end": {
"line": 203,
"column": 2
}
},
"file": "/Users/tatecarson/webDev/ui/lib/util/math.js"
},
"augments": [],
"examples": [
{
"description": "Nexus.distance(0,0,3,4) // returns 5"
}
],
"params": [
{
"title": "param",
"name": "x1",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "x of first point",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 17,
"offset": 16
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 17,
"offset": 16
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 17,
"offset": 16
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "y1",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "y of first point",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 17,
"offset": 16
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 17,
"offset": 16
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 17,
"offset": 16
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "x2",
"lineNumber": 4,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "x of second point",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "param",
"name": "y2",
"lineNumber": 5,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "y of second poiny",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Distance",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 9,
"offset": 8
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 9,
"offset": 8
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 9,
"offset": 8
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "distance",
"kind": "function",
"memberof": "math",
"scope": "static",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "distance",
"kind": "function",
"scope": "static"
}
],
"namespace": ".distance"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Flip a coin, returning either 0 or 1 according to a probability",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 64,
"offset": 63
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 64,
"offset": 63
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 64,
"offset": 63
}
}
},
"tags": [
{
"title": "param",
"description": "Likelihood of returning 1",
"lineNumber": 2,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "number"
}
},
"name": "odds",
"default": "0.5"
},
{
"title": "return",
"description": "1 or 0",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "number"
}
},
{
"title": "example",
"description": "Nexus.coin(0.1) // returns 1 (10% of the time) or 0 (90% of the time)",
"lineNumber": 4
}
],
"loc": {
"start": {
"line": 209,
"column": 0
},
"end": {
"line": 215,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 216,
"column": 0
},
"end": {
"line": 222,
"column": 2
}
},
"file": "/Users/tatecarson/webDev/ui/lib/util/math.js"
},
"augments": [],
"examples": [
{
"description": "Nexus.coin(0.1) // returns 1 (10% of the time) or 0 (90% of the time)"
}
],
"params": [
{
"title": "param",
"name": "odds",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Likelihood of returning 1",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
}
}
},
"type": {
"type": "NameExpression",
"name": "number"
},
"default": "0.5"
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "1 or 0",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 7,
"offset": 6
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 7,
"offset": 6
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 7,
"offset": 6
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "number"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "coin",
"kind": "function",
"memberof": "math",
"scope": "static",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "coin",
"kind": "function",
"scope": "static"
}
],
"namespace": ".coin"
}
]