-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathdata.json
More file actions
3196 lines (3196 loc) · 121 KB
/
data.json
File metadata and controls
3196 lines (3196 loc) · 121 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"project": {
"name": "js-Multigraph",
"description": "Multigraph's JavaScript Implementation",
"url": "http://www.multigraph.org/"
},
"files": {
"src/core/array_data.js": {
"name": "src/core/array_data.js",
"modules": {
"core": 1
},
"classes": {
"ArrayData": 1
},
"fors": {
"ArrayData": 1
},
"namespaces": {}
},
"src/core/axis.js": {
"name": "src/core/axis.js",
"modules": {},
"classes": {
"Axis": 1
},
"fors": {
"Axis": 1
},
"namespaces": {}
},
"src/core/axis_binding.js": {
"name": "src/core/axis_binding.js",
"modules": {},
"classes": {
"axisBinding": 1
},
"fors": {
"axisBinding": 1
},
"namespaces": {}
},
"src/core/axis_title.js": {
"name": "src/core/axis_title.js",
"modules": {},
"classes": {
"AxisTitle": 1
},
"fors": {
"AxisTitle": 1
},
"namespaces": {}
},
"src/core/data.js": {
"name": "src/core/data.js",
"modules": {},
"classes": {
"Data": 1
},
"fors": {
"Data": 1
},
"namespaces": {}
},
"src/core/event_emitter.js": {
"name": "src/core/event_emitter.js",
"modules": {},
"classes": {
"EventEmitter": 1
},
"fors": {
"EventEmitter": 1
},
"namespaces": {}
},
"src/core/graph.js": {
"name": "src/core/graph.js",
"modules": {},
"classes": {
"Graph": 1
},
"fors": {
"Graph": 1
},
"namespaces": {}
},
"src/core/graph_title.js": {
"name": "src/core/graph_title.js",
"modules": {},
"classes": {
"Title": 1
},
"fors": {
"Title": 1
},
"namespaces": {}
},
"src/core/legend.js": {
"name": "src/core/legend.js",
"modules": {},
"classes": {
"Legend": 1
},
"fors": {
"Legend": 1
},
"namespaces": {}
},
"src/core/mixin.js": {
"name": "src/core/mixin.js",
"modules": {},
"classes": {
"Mixin": 1
},
"fors": {
"Mixin": 1
},
"namespaces": {}
},
"src/core/multigraph.js": {
"name": "src/core/multigraph.js",
"modules": {},
"classes": {
"Multigraph": 1
},
"fors": {
"Multigraph": 1
},
"namespaces": {}
},
"src/core/text.js": {
"name": "src/core/text.js",
"modules": {},
"classes": {
"Text": 1
},
"fors": {
"Text": 1
},
"namespaces": {}
},
"src/core/web_service_data.js": {
"name": "src/core/web_service_data.js",
"modules": {},
"classes": {
"WebServiceData": 1
},
"fors": {
"WebServiceData": 1
},
"namespaces": {}
},
"src/core/web_service_data_cache_node.js": {
"name": "src/core/web_service_data_cache_node.js",
"modules": {},
"classes": {
"WebServiceDataCacheNode": 1
},
"fors": {
"WebServiceDataCacheNode": 1
},
"namespaces": {}
},
"src/core/web_service_data_iterator.js": {
"name": "src/core/web_service_data_iterator.js",
"modules": {},
"classes": {
"WebServiceDataIterator": 1
},
"fors": {
"WebServiceDataIterator": 1
},
"namespaces": {}
},
"src/graphics/canvas/axis_title.js": {
"name": "src/graphics/canvas/axis_title.js",
"modules": {
"canvas": 1
},
"classes": {},
"fors": {
"AxisTitle": 1
},
"namespaces": {}
},
"src/graphics/canvas/canvas_mixin.js": {
"name": "src/graphics/canvas/canvas_mixin.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"src/graphics/canvas/graph_title.js": {
"name": "src/graphics/canvas/graph_title.js",
"modules": {},
"classes": {},
"fors": {
"Title": 1
},
"namespaces": {}
},
"src/graphics/canvas/text.js": {
"name": "src/graphics/canvas/text.js",
"modules": {},
"classes": {},
"fors": {
"Text": 1
},
"namespaces": {}
},
"src/graphics/raphael/axis_title.js": {
"name": "src/graphics/raphael/axis_title.js",
"modules": {
"raphael": 1
},
"classes": {},
"fors": {
"AxisTitle": 1
},
"namespaces": {}
},
"src/graphics/raphael/graph_title.js": {
"name": "src/graphics/raphael/graph_title.js",
"modules": {},
"classes": {},
"fors": {
"Title": 1
},
"namespaces": {}
},
"src/graphics/raphael/raphael_mixin.js": {
"name": "src/graphics/raphael/raphael_mixin.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"src/graphics/raphael/text.js": {
"name": "src/graphics/raphael/text.js",
"modules": {},
"classes": {},
"fors": {
"Text": 1
},
"namespaces": {}
},
"src/math/displacement.js": {
"name": "src/math/displacement.js",
"modules": {
"math": 1
},
"classes": {
"Displacement": 1
},
"fors": {
"Displacement": 1
},
"namespaces": {}
}
},
"modules": {
"multigraph": {
"name": "multigraph",
"submodules": {
"core": 1,
"canvas": 1,
"raphael": 1,
"math": 1
},
"classes": {
"ArrayData": 1,
"Axis": 1,
"axisBinding": 1,
"AxisTitle": 1,
"Data": 1,
"EventEmitter": 1,
"Graph": 1,
"Title": 1,
"Legend": 1,
"Mixin": 1,
"Multigraph": 1,
"Text": 1,
"WebServiceData": 1,
"WebServiceDataCacheNode": 1,
"WebServiceDataIterator": 1,
"Displacement": 1
},
"fors": {
"ArrayData": 1,
"Axis": 1,
"axisBinding": 1,
"AxisTitle": 1,
"Data": 1,
"EventEmitter": 1,
"Graph": 1,
"Title": 1,
"Legend": 1,
"Mixin": 1,
"Multigraph": 1,
"Text": 1,
"WebServiceData": 1,
"WebServiceDataCacheNode": 1,
"WebServiceDataIterator": 1,
"Displacement": 1
},
"namespaces": {},
"file": "src/math/displacement.js",
"line": 12
},
"core": {
"name": "core",
"submodules": {},
"classes": {
"ArrayData": 1,
"Axis": 1,
"axisBinding": 1,
"AxisTitle": 1,
"Data": 1,
"EventEmitter": 1,
"Graph": 1,
"Title": 1,
"Legend": 1,
"Mixin": 1,
"Multigraph": 1,
"Text": 1,
"WebServiceData": 1,
"WebServiceDataCacheNode": 1,
"WebServiceDataIterator": 1
},
"fors": {},
"is_submodule": 1,
"namespaces": {},
"module": "multigraph",
"namespace": "",
"file": "src/core/web_service_data_iterator.js",
"line": 11,
"description": "Core functionality for the javascript implementation of multigraph.",
"tag": "main",
"itemtype": "main"
},
"canvas": {
"name": "canvas",
"submodules": {},
"classes": {},
"fors": {},
"is_submodule": 1,
"namespaces": {},
"module": "multigraph",
"namespace": "",
"file": "src/graphics/canvas/axis_title.js",
"line": 4,
"description": "Mixin functions for canvas driver.",
"tag": "main",
"itemtype": "main"
},
"raphael": {
"name": "raphael",
"submodules": {},
"classes": {},
"fors": {},
"is_submodule": 1,
"namespaces": {},
"module": "multigraph",
"namespace": "",
"file": "src/graphics/raphael/axis_title.js",
"line": 4,
"description": "Mixin functions for the raphael driver."
},
"math": {
"name": "math",
"submodules": {},
"classes": {
"Displacement": 1
},
"fors": {},
"is_submodule": 1,
"namespaces": {},
"module": "multigraph",
"namespace": "",
"file": "src/math/displacement.js",
"line": 12,
"description": "The Math module provides utility models and functions which correspond to mathematical concepts.",
"tag": "main",
"itemtype": "main"
}
},
"classes": {
"ArrayData": {
"name": "ArrayData",
"shortname": "ArrayData",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/array_data.js",
"line": 9,
"is_constructor": 1,
"params": [
{
"name": "columns",
"description": "A array of DataVariables",
"type": "Array"
},
{
"name": "stringArray",
"description": "A array of the preparsed DataValues",
"type": "Array"
}
]
},
"Axis": {
"name": "Axis",
"shortname": "Axis",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/axis.js",
"line": 14,
"description": "Axis is a Jermaine model that controls Multigraph axes.",
"is_constructor": 1,
"params": [
{
"name": "Orientation",
"description": "",
"type": "AxisOrientation"
}
]
},
"axisBinding": {
"name": "axisBinding",
"shortname": "axisBinding",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/axis_binding.js",
"line": 9,
"is_constructor": 1
},
"AxisTitle": {
"name": "AxisTitle",
"shortname": "AxisTitle",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/axis_title.js",
"line": 13,
"description": "Axis Title is a Jermaine model that supports the rendering of Axis Titles.",
"is_constructor": 1,
"params": [
{
"name": "axis",
"description": "",
"type": "Axis"
}
]
},
"Data": {
"name": "Data",
"shortname": "Data",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/data.js",
"line": 13,
"is_constructor": 1,
"params": [
{
"name": "columns",
"description": "",
"type": "DataVariable"
}
]
},
"EventEmitter": {
"name": "EventEmitter",
"shortname": "EventEmitter",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/event_emitter.js",
"line": 10,
"description": "EventEmitter is a Jermaine model that supports basic event emitting /\nhandling for Jermaine objects.\n\nEvents are represented as plain old JavaScript objects with at least\nthe following two properties:\n\n **type**\n\n > a string giving the type of the event; this can be any\n arbitrary string. The event type is not restricted to be\n from some predetermined list; applications are free to\n use whatever strings they want for their event types.\n\n **target**\n\n > a reference to the object that emitted the event\n\nEvent objects may also contain arbitrary other properties that are specific to\na particular event type.\n\nAny Jermaine model can declare itself to be an event emitter by saying\n\"this.isA(EventEmitter)\" in its model declaration.\n\nThis adds three methods to the model:\n \n **addListener(eventType, listenerFunction)**\n\n > Registers listenerFunction as a listener for events of type\n eventType (a string). listenerFunction should be a function\n that accepts a single argument which will be a reference to an\n event object as described above. When the object emits the\n event, the listener function will be invoked in the context\n where its \"this\" keyword refers to the object that emitted the\n event (the event target). If listenerFunction is already\n registered as a listener for eventType, this function does\n nothing --- each listener function can be registered only once.\n\n **removeListener(eventType, listenerFunction)**\n\n > Removes the given listenerFunction from the list of listeners\n for this object for events of type eventType.\n\n **emit(event)**\n\n > Causes the object to emit the given event. The argument can be\n either a string, in which case it is assumed to be an event type\n and is converted to an event object with the given 'type'\n property, or an event object with a 'type' property and any\n other desired properties. The emit() method automatically adds\n a 'target' property to the event object, whose value is a\n reference to the object emitting the event.\n\nIn most cases the emit() method is only called from within the\nimplementation of an EventEmitter object, and code external to the\nobject's model will use its addListener() and removeListener() methods\nto process events that the object emits. All three of these methods\nare public methods, though, so it's also possible for code outside of\nan object's implementation to cause it to emit an event, or for the\nobject's own code to listen for and process its own events.\n\nTwo special types of events are always present for every EventEmitter\nobject: the \"listenerAdded\" and \"listenerRemoved\" events. These\nevents make it possible to monitor the addition or removal of event\nlisteners. The \"listenerAdded\" event is emitted whenever a new\nlistener function is added, and the \"listenerRemoved\" event is emitted\nwhenever a listener is removed. Each of these events contain the\nfollowing properties:\n\n **targetType**\n\n > the event type associated with the listener\n being added or removed\n\n **listener**\n\n > the listener function being added or removed",
"is_constructor": 1,
"example": [
"\n var Person = new window.jermaine.Model(function() {\n this.isA(EventEmitter);\n this.hasA(\"name\").which.isA(\"string\");\n this.respondsTo(\"say\", function(something) {\n console.log(this.name() + ' says ' + something);\n this.emit({type : \"say\", message : something});\n });\n });\n var person = new Person().name(\"Mark\");\n\n var sayListener = function(event) {\n console.log(event.target.name() + ' said ' + event.message);\n };\n\n person.say('Hello');\n person.addListener(\"say\", sayListener);\n person.say('Alright');\n person.removeListener(\"say\", sayListener);\n person.say('Goodbye');\n\n\n OUTPUT:\n\n Mark says Hello\n Mark says Alright\n Mark said Alright\n Mark said Goodbye"
]
},
"Graph": {
"name": "Graph",
"shortname": "Graph",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/graph.js",
"line": 10,
"description": "The Graph Jermaine model controls the properties for an individual Graph.",
"is_constructor": 1
},
"Title": {
"name": "Title",
"shortname": "Title",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/graph_title.js",
"line": 13,
"description": "Title is a Jermiane model that controls Graph Titles.",
"is_constructor": 1,
"params": [
{
"name": "text",
"description": "",
"type": "Text"
},
{
"name": "graph",
"description": "",
"type": "Graph"
}
],
"author": "jrfrimme"
},
"Legend": {
"name": "Legend",
"shortname": "Legend",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/legend.js",
"line": 14,
"description": "Legend is a Jermaine model that supports the rendering of Multigraph Legends.\n\nThe methods for this object take a parameter called `graphicsContext`, which is a\ndriver-specific object that stores whatever state/configuration is needed by the\ndriver. Each driver is responsible for creating its own graphicsContext object and\npassing it to these methods, which in turn pass that object on to the driver-specific\nmethods that they call.",
"is_constructor": 1,
"requires": [
"Point",
"RGBColor",
"Plot",
"Icon"
]
},
"Mixin": {
"name": "Mixin",
"shortname": "Mixin",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/mixin.js",
"line": 9,
"description": "The Mixin model provides a convenient way for Jermaine\napplications to \"mix in\" additional functionality to a model,\nfrom outside the model's initial definition.\n\nThe ability to add features (methods and/or attributes) to a\nJermaine model outside its initial definition already exists in\nJermaine -- this Mixin model does not actually add new\nfunctionality to Jermaine; it just provides a convenient\npattern for grouping additional features together and applying\nthem to a model as a group.\n\nThe Mixin model maintains an internal list of functions, called\nmixin functions, and provides an add() method for adding a\nfunction to that list.\n\nThe apply() method calls all of the mixinfunctions that have been\nadded to the list, passing each one the same arguments\nthat were passed to the apply() function itself.\n\nThat's it. That's all the Mixin class does. It's up to you to\nput whatever jermaine-model-extending code you want in the\nmixin functions you add to the Mixin; the Mixin simply serves\nas a place to hold them all, and a convenient way to execute\nthem all at once.",
"author": "mbp"
},
"Multigraph": {
"name": "Multigraph",
"shortname": "Multigraph",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/multigraph.js",
"line": 14,
"description": "The Multigraph Jermaine model is the root class for the js-multigraph project.",
"is_constructor": 1
},
"Text": {
"name": "Text",
"shortname": "Text",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/text.js",
"line": 8,
"description": "Text is a Jermaine model that supports storing and determining metrics of\nstrings in different graphics contexts.",
"is_constructor": 1,
"params": [
{
"name": "string",
"description": "The string stored in the Text model",
"type": "String"
}
]
},
"WebServiceData": {
"name": "WebServiceData",
"shortname": "WebServiceData",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/web_service_data.js",
"line": 9,
"is_constructor": 1,
"extends": "Data"
},
"WebServiceDataCacheNode": {
"name": "WebServiceDataCacheNode",
"shortname": "WebServiceDataCacheNode",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/web_service_data_cache_node.js",
"line": 11,
"description": "A WebServiceDataCacheNode represents a single node in the\ndoubly-linked list holding the data for a WebServiceDataCache.\nThe WebServiceDataCacheNode has an array of data (which may\nactually be null, if the node's data has not yet been loaded),\nnext and prev pointers to the next and previous nodes in the\nlinked list, and coveredMin and coveredMax values that indicate\nthe min and max values of the \"covered\" range of data for this\nnode.\n\nThe \"covered\" range is the interval of the data number line for\nwhich this node is responsible for storing data; Multigraph\nuses range this to avoid requesting the same data twice --- it\nnever requests data for a range already covered by an existing\ncache node.\n\nInitially, when the WebServiceDataCacheNode is created, the\nlimits of the covered range are specified in the constructor.\nLater on, when the node's data is actually populated, the\nlimits are potentially adjusted outward, if the range of data\nreceived is larger than the initially specified covered range.\nSo in all cases, the covered range indicates the range for\nwhich no more data is needed, because it's covered by this\nnode.\n\nNote that the covered range is never adjusted to be smaller.\n\nThe WebServiceDataCacheNode does not actually fetch any data\n--- it is simply a storage container for fetched data; it's up\nto other code outside of this object to fetch and populate the\ndata.",
"is_constructor": 1,
"params": [
{
"name": "coveredMin",
"description": "",
"type": "DataValue"
},
{
"name": "coveredMax",
"description": "",
"type": "DataValue"
}
]
},
"WebServiceDataIterator": {
"name": "WebServiceDataIterator",
"shortname": "WebServiceDataIterator",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "core",
"namespace": "",
"file": "src/core/web_service_data_iterator.js",
"line": 11,
"description": "An iterator for stepping through data values stored in a linked list of\nWebServiceDataCacheNodes. The constructor takes 5 arguments:",
"is_constructor": 1,
"params": [
{
"name": "columnIndices!~YUIDOC_LINE~!",
"description": "JavaScript array of the indices of the columns\n of data to return",
"type": "Array"
},
{
"name": "initialNode!~YUIDOC_LINE~!",
"description": "Pointer to the WebServiceDataCacheNode containing the first\n value to iterate over",
"type": "WebServiceDataCacheNode"
},
{
"name": "initialIndex!~YUIDOC_LINE~!",
"description": "Index, within initialNode, of the first value to iterate over",
"type": "Integer"
},
{
"name": "finalNode!~YUIDOC_LINE~!",
"description": "Pointer to the WebServiceDataCacheNode containing the last\n value to iterate over",
"type": "WebServiceDataCacheNode"
},
{
"name": "finalIndex!~YUIDOC_LINE~!",
"description": "Index, within finalNode, of the last value to iterate over",
"type": "Integer"
}
]
},
"Displacement": {
"name": "Displacement",
"shortname": "Displacement",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "multigraph",
"submodule": "math",
"namespace": "",
"file": "src/math/displacement.js",
"line": 12,
"description": "A Displacement represents a geometric position along a line\nsegment, expressed in terms of two quantities: a relative\nposition called `a`, and an absolute offset called `b`. The\nlength of the line segment is not known in advance --- the idea\nis that the Displacement object encapsulates a rule for\ndetermining a location along ANY line segment. The Displacement\nhas methods which take the line segment length as an argument\nand return the computed final position.\n\nThere are two different position-calcuating methods,\ncorresponding to two different interpretations of the relative\nvalue `a`:\n\n**relative length**:\n `a` is a number between 0 and 1, representing a fraction of\n the total length of the line segment; the relative\n position determined by `a` is the fraction `a` of the\n total length of the segment.\n In this case, the position-calculating method\n `calculateLength(L)` returns the number `a * L + b`, which\n corresponds to moving `a` of the way along the length L,\n then adding `b`:\n\n [--------------------------------X------------]\n |<---- a * L --->|<---- b ------>|\n |<------------------ L -------------------->|\n\n**relative coordinate**:\n `a` is a number between -1 and 1, representing a coordinate\n value in a [-1,1] coordinate system along the line\n segment.\n In this case, the position-calculating method\n `calculateCoordinate(L)` returns the number `(a+1) * L/2 +\n b`. which corresponds to moving to the position\n determined by the `a` coordinate, then adding `b`:\n\n [------------------------------------X--------]\n |<--- (a+1) * L/2 --->|<---- b ----->|\n |<------------------ L -------------------->|",
"is_constructor": 1,
"params": [
{
"name": "a",
"description": "",
"type": "Number"
},
{
"name": "b",
"description": "(OPTIONAL)",
"type": "Integer"
}
]
}
},
"classitems": [
{
"file": "src/core/array_data.js",
"line": 31,
"itemtype": "method",
"name": "getIterator",
"params": [
{
"name": "columnIDs",
"description": "",
"type": "String array"
},
{
"name": "min",
"description": "",
"type": "DataValue"
},
{
"name": "max",
"description": "",
"type": "DataValue"
},
{
"name": "buffer",
"description": "",
"type": "Integer"
}
],
"return": {
"description": "ArrayData"
},
"author": "jrfrimme",
"class": "ArrayData",
"module": "multigraph",
"submodule": "core"
},
{
"file": "src/core/array_data.js",
"line": 46,
"description": "Determines the upper and lower bounds of a column in a dataset.",
"itemtype": "method",
"name": "getBounds",
"params": [
{
"name": "columnNumber",
"description": "Column in the dataset to have its bounds determined.",
"type": "Integer"
}
],
"return": {
"description": "Array in the form: [lowerBound, upperBound].",
"type": "Array"
},
"author": "jrfrimme",
"class": "ArrayData",
"module": "multigraph",
"submodule": "core"
},
{
"file": "src/core/array_data.js",
"line": 71,
"itemtype": "method",
"name": "onReady",
"params": [
{
"name": "callback",
"description": ""
}
],
"class": "ArrayData",
"module": "multigraph",
"submodule": "core"
},
{
"file": "src/core/array_data.js",
"line": 76,
"itemtype": "method",
"name": "getArrayDataIterator",
"static": 1,
"params": [
{
"name": "arrayData",
"description": "",
"type": "ArrayData"
},
{
"name": "columnIDs",
"description": "",
"type": "String array"
},
{
"name": "min",
"description": "",
"type": "DataValue"
},
{
"name": "max",
"description": "",
"type": "DataValue"
},
{
"name": "buffer",
"description": "",
"type": "Integer"
}
],
"throws": [
"{error} Throws error if arrayData is not an array of strings"
],
"return": {
"description": "iter"
},
"author": "jrfrimme",
"class": "ArrayData",
"module": "multigraph",
"submodule": "core"
},
{
"file": "src/core/array_data.js",
"line": 187,
"itemtype": "method",
"name": "textToDataValuesArray",
"static": 1,
"params": [
{
"name": "dataVariableArray",
"description": "",
"type": "Array"
},
{
"name": "text",
"description": "",
"type": "String"
}
],
"return": {
"description": "dataValues",
"type": "Array"
},
"author": "jrfrimme",
"todo": [
"If the number of comma-separated values on the current line is not the same as the number of columns in the metadata",
"should throw an error."
],
"class": "ArrayData",
"module": "multigraph",
"submodule": "core"
},
{
"file": "src/core/array_data.js",
"line": 224,
"itemtype": "method",
"name": "textToStringArray",
"static": 1,
"params": [
{
"name": "text",
"description": "",
"type": "String"
}
],
"return": {
"description": "stringValues",
"type": "Array"
},
"author": "jrfrimme",
"class": "ArrayData",
"module": "multigraph",
"submodule": "core"
},
{
"file": "src/core/array_data.js",
"line": 267,
"description": "Parses an array of strings into an array of DataValues.",
"itemtype": "method",
"name": "textToStringArray",
"static": 1,
"params": [
{
"name": "dataVariableArray",
"description": "plain javascript array of DataVariables",
"type": "Array"
},
{
"name": "stringArray",
"description": "plain javascript array of strings",
"type": "Array"
}
],
"return": {
"description": "plain javascript array of DataValue instances",
"type": "Array"
},
"author": "jrfrimme",
"class": "ArrayData",
"module": "multigraph",
"submodule": "core"
},
{
"file": "src/core/axis.js",
"line": 58,
"description": "Stores the \"min\" value from the mugl file as a string, if there was one.",
"itemtype": "property",
"name": "min",
"type": "{String}",
"author": "jrfrimme",
"class": "Axis",
"module": "multigraph",
"submodule": "core"
},
{
"file": "src/core/axis.js",
"line": 67,
"description": "The current min DataValue for the axis.",
"itemtype": "property",
"name": "dataMin",
"type": "{DataValue}",
"author": "jrfrimme",
"class": "Axis",
"module": "multigraph",
"submodule": "core"
},
{
"file": "src/core/axis.js",
"line": 77,
"description": "Convenience method for checking to see if dataMin has been set or not",
"itemtype": "method",
"name": "hasDataMin",
"author": "jrfrimme",
"return": {
"description": "",
"type": "Boolean"
},
"class": "Axis",
"module": "multigraph",
"submodule": "core"
},
{
"file": "src/core/axis.js",
"line": 94,
"description": "Stores the \"max\" value from the mugl file as a string, if there was one.",
"itemtype": "property",
"name": "max",
"type": "{String}",
"author": "jrfrimme",
"class": "Axis",