1 | <!DOCTYPE html>
|
2 | <html lang="en">
|
3 | <head>
|
4 | <meta charset="utf-8">
|
5 | <title>JSDoc: Global</title>
|
6 |
|
7 | <script src="scripts/prettify/prettify.js"> </script>
|
8 | <script src="scripts/prettify/lang-css.js"> </script>
|
9 | |
10 |
|
11 |
|
12 | <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
13 | <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
14 | </head>
|
15 |
|
16 | <body>
|
17 |
|
18 | <div id="main">
|
19 |
|
20 | <h1 class="page-title">Global</h1>
|
21 |
|
22 |
|
23 |
|
24 |
|
25 |
|
26 |
|
27 | <section>
|
28 |
|
29 | <header>
|
30 |
|
31 | <h2></h2>
|
32 |
|
33 |
|
34 | </header>
|
35 |
|
36 | <article>
|
37 | <div class="container-overview">
|
38 |
|
39 |
|
40 |
|
41 |
|
42 |
|
43 |
|
44 | <dl class="details">
|
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 | </dl>
|
78 |
|
79 |
|
80 |
|
81 |
|
82 | </div>
|
83 |
|
84 |
|
85 |
|
86 |
|
87 |
|
88 |
|
89 |
|
90 |
|
91 |
|
92 |
|
93 |
|
94 |
|
95 |
|
96 |
|
97 | <h3 class="subsection-title">Methods</h3>
|
98 |
|
99 |
|
100 |
|
101 |
|
102 |
|
103 |
|
104 | <h4 class="name" id="convert2Abc"><span class="type-signature"></span>convert2Abc<span class="signature">(data)</span><span class="type-signature"> → {string}</span></h4>
|
105 |
|
106 |
|
107 |
|
108 |
|
109 |
|
110 | <div class="description">
|
111 | Returns a string in abc notation from given data
|
112 | </div>
|
113 |
|
114 |
|
115 |
|
116 |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 |
|
122 | <h5>Parameters:</h5>
|
123 |
|
124 |
|
125 | <table class="params">
|
126 | <thead>
|
127 | <tr>
|
128 |
|
129 | <th>Name</th>
|
130 |
|
131 |
|
132 | <th>Type</th>
|
133 |
|
134 |
|
135 |
|
136 |
|
137 |
|
138 | <th class="last">Description</th>
|
139 | </tr>
|
140 | </thead>
|
141 |
|
142 | <tbody>
|
143 |
|
144 |
|
145 | <tr>
|
146 |
|
147 | <td class="name"><code>data</code></td>
|
148 |
|
149 |
|
150 | <td class="type">
|
151 |
|
152 |
|
153 | <span class="param-type">object</span>
|
154 |
|
155 |
|
156 |
|
157 | </td>
|
158 |
|
159 |
|
160 |
|
161 |
|
162 |
|
163 | <td class="description last">The JSON data that should be transformed to abc</td>
|
164 | </tr>
|
165 |
|
166 |
|
167 | </tbody>
|
168 | </table>
|
169 |
|
170 |
|
171 |
|
172 |
|
173 |
|
174 |
|
175 | <dl class="details">
|
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 | <dt class="tag-source">Source:</dt>
|
203 | <dd class="tag-source"><ul class="dummy"><li>
|
204 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line112">line 112</a>
|
205 | </li></ul></dd>
|
206 |
|
207 |
|
208 |
|
209 |
|
210 |
|
211 |
|
212 |
|
213 | </dl>
|
214 |
|
215 |
|
216 |
|
217 |
|
218 |
|
219 |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 |
|
225 |
|
226 |
|
227 | <h5>Returns:</h5>
|
228 |
|
229 |
|
230 |
|
231 |
|
232 | <dl>
|
233 | <dt>
|
234 | Type
|
235 | </dt>
|
236 | <dd>
|
237 |
|
238 | <span class="param-type">string</span>
|
239 |
|
240 |
|
241 | </dd>
|
242 | </dl>
|
243 |
|
244 |
|
245 |
|
246 |
|
247 |
|
248 |
|
249 |
|
250 |
|
251 |
|
252 |
|
253 | <h4 class="name" id="getAbcKey"><span class="type-signature"></span>getAbcKey<span class="signature">(fifths, mode)</span><span class="type-signature"> → {string}</span></h4>
|
254 |
|
255 |
|
256 |
|
257 |
|
258 |
|
259 | <div class="description">
|
260 | Returns the key for abc notation from given fifths
|
261 | </div>
|
262 |
|
263 |
|
264 |
|
265 |
|
266 |
|
267 |
|
268 |
|
269 |
|
270 |
|
271 | <h5>Parameters:</h5>
|
272 |
|
273 |
|
274 | <table class="params">
|
275 | <thead>
|
276 | <tr>
|
277 |
|
278 | <th>Name</th>
|
279 |
|
280 |
|
281 | <th>Type</th>
|
282 |
|
283 |
|
284 |
|
285 |
|
286 |
|
287 | <th class="last">Description</th>
|
288 | </tr>
|
289 | </thead>
|
290 |
|
291 | <tbody>
|
292 |
|
293 |
|
294 | <tr>
|
295 |
|
296 | <td class="name"><code>fifths</code></td>
|
297 |
|
298 |
|
299 | <td class="type">
|
300 |
|
301 |
|
302 | <span class="param-type">number</span>
|
303 |
|
304 |
|
305 |
|
306 | </td>
|
307 |
|
308 |
|
309 |
|
310 |
|
311 |
|
312 | <td class="description last">The position inside the circle of fifths</td>
|
313 | </tr>
|
314 |
|
315 |
|
316 |
|
317 | <tr>
|
318 |
|
319 | <td class="name"><code>mode</code></td>
|
320 |
|
321 |
|
322 | <td class="type">
|
323 |
|
324 |
|
325 | <span class="param-type">string</span>
|
326 | |
|
327 |
|
328 | <span class="param-type">undefined</span>
|
329 |
|
330 |
|
331 |
|
332 | </td>
|
333 |
|
334 |
|
335 |
|
336 |
|
337 |
|
338 | <td class="description last">The mode (major / minor)</td>
|
339 | </tr>
|
340 |
|
341 |
|
342 | </tbody>
|
343 | </table>
|
344 |
|
345 |
|
346 |
|
347 |
|
348 |
|
349 |
|
350 | <dl class="details">
|
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 | <dt class="tag-source">Source:</dt>
|
378 | <dd class="tag-source"><ul class="dummy"><li>
|
379 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line83">line 83</a>
|
380 | </li></ul></dd>
|
381 |
|
382 |
|
383 |
|
384 |
|
385 |
|
386 |
|
387 |
|
388 | </dl>
|
389 |
|
390 |
|
391 |
|
392 |
|
393 |
|
394 |
|
395 |
|
396 |
|
397 |
|
398 |
|
399 |
|
400 |
|
401 |
|
402 | <h5>Returns:</h5>
|
403 |
|
404 |
|
405 |
|
406 |
|
407 | <dl>
|
408 | <dt>
|
409 | Type
|
410 | </dt>
|
411 | <dd>
|
412 |
|
413 | <span class="param-type">string</span>
|
414 |
|
415 |
|
416 | </dd>
|
417 | </dl>
|
418 |
|
419 |
|
420 |
|
421 |
|
422 |
|
423 |
|
424 |
|
425 |
|
426 |
|
427 |
|
428 | <h4 class="name" id="getAbcNote"><span class="type-signature"></span>getAbcNote<span class="signature">(note)</span><span class="type-signature"> → {string}</span></h4>
|
429 |
|
430 |
|
431 |
|
432 |
|
433 |
|
434 | <div class="description">
|
435 | Returns a note in abc notation from given note object (JSON)
|
436 | </div>
|
437 |
|
438 |
|
439 |
|
440 |
|
441 |
|
442 |
|
443 |
|
444 |
|
445 |
|
446 | <h5>Parameters:</h5>
|
447 |
|
448 |
|
449 | <table class="params">
|
450 | <thead>
|
451 | <tr>
|
452 |
|
453 | <th>Name</th>
|
454 |
|
455 |
|
456 | <th>Type</th>
|
457 |
|
458 |
|
459 |
|
460 |
|
461 |
|
462 | <th class="last">Description</th>
|
463 | </tr>
|
464 | </thead>
|
465 |
|
466 | <tbody>
|
467 |
|
468 |
|
469 | <tr>
|
470 |
|
471 | <td class="name"><code>note</code></td>
|
472 |
|
473 |
|
474 | <td class="type">
|
475 |
|
476 |
|
477 | <span class="param-type">object</span>
|
478 |
|
479 |
|
480 |
|
481 | </td>
|
482 |
|
483 |
|
484 |
|
485 |
|
486 |
|
487 | <td class="description last">The note that should be transformed to abc</td>
|
488 | </tr>
|
489 |
|
490 |
|
491 | </tbody>
|
492 | </table>
|
493 |
|
494 |
|
495 |
|
496 |
|
497 |
|
498 |
|
499 | <dl class="details">
|
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 | <dt class="tag-source">Source:</dt>
|
527 | <dd class="tag-source"><ul class="dummy"><li>
|
528 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line93">line 93</a>
|
529 | </li></ul></dd>
|
530 |
|
531 |
|
532 |
|
533 |
|
534 |
|
535 |
|
536 |
|
537 | </dl>
|
538 |
|
539 |
|
540 |
|
541 |
|
542 |
|
543 |
|
544 |
|
545 |
|
546 |
|
547 |
|
548 |
|
549 |
|
550 |
|
551 | <h5>Returns:</h5>
|
552 |
|
553 |
|
554 |
|
555 |
|
556 | <dl>
|
557 | <dt>
|
558 | Type
|
559 | </dt>
|
560 | <dd>
|
561 |
|
562 | <span class="param-type">string</span>
|
563 |
|
564 |
|
565 | </dd>
|
566 | </dl>
|
567 |
|
568 |
|
569 |
|
570 |
|
571 |
|
572 |
|
573 |
|
574 |
|
575 |
|
576 |
|
577 | <h4 class="name" id="getAbcString"><span class="type-signature"></span>getAbcString<span class="signature">(input)</span><span class="type-signature"> → {string}</span></h4>
|
578 |
|
579 |
|
580 |
|
581 |
|
582 |
|
583 | <div class="description">
|
584 | Returns the abc notation string from given input
|
585 | </div>
|
586 |
|
587 |
|
588 |
|
589 |
|
590 |
|
591 |
|
592 |
|
593 |
|
594 |
|
595 | <h5>Parameters:</h5>
|
596 |
|
597 |
|
598 | <table class="params">
|
599 | <thead>
|
600 | <tr>
|
601 |
|
602 | <th>Name</th>
|
603 |
|
604 |
|
605 | <th>Type</th>
|
606 |
|
607 |
|
608 |
|
609 |
|
610 |
|
611 | <th class="last">Description</th>
|
612 | </tr>
|
613 | </thead>
|
614 |
|
615 | <tbody>
|
616 |
|
617 |
|
618 | <tr>
|
619 |
|
620 | <td class="name"><code>input</code></td>
|
621 |
|
622 |
|
623 | <td class="type">
|
624 |
|
625 |
|
626 | <span class="param-type">object</span>
|
627 |
|
628 |
|
629 |
|
630 | </td>
|
631 |
|
632 |
|
633 |
|
634 |
|
635 |
|
636 | <td class="description last">The parsed input from input file</td>
|
637 | </tr>
|
638 |
|
639 |
|
640 | </tbody>
|
641 | </table>
|
642 |
|
643 |
|
644 |
|
645 |
|
646 |
|
647 |
|
648 | <dl class="details">
|
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 | <dt class="tag-source">Source:</dt>
|
676 | <dd class="tag-source"><ul class="dummy"><li>
|
677 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line29">line 29</a>
|
678 | </li></ul></dd>
|
679 |
|
680 |
|
681 |
|
682 |
|
683 |
|
684 |
|
685 |
|
686 | </dl>
|
687 |
|
688 |
|
689 |
|
690 |
|
691 |
|
692 |
|
693 |
|
694 |
|
695 |
|
696 |
|
697 |
|
698 |
|
699 |
|
700 | <h5>Returns:</h5>
|
701 |
|
702 |
|
703 |
|
704 |
|
705 | <dl>
|
706 | <dt>
|
707 | Type
|
708 | </dt>
|
709 | <dd>
|
710 |
|
711 | <span class="param-type">string</span>
|
712 |
|
713 |
|
714 | </dd>
|
715 | </dl>
|
716 |
|
717 |
|
718 |
|
719 |
|
720 |
|
721 |
|
722 |
|
723 |
|
724 |
|
725 |
|
726 |
|
727 | </article>
|
728 |
|
729 | </section>
|
730 |
|
731 |
|
732 |
|
733 |
|
734 | </div>
|
735 |
|
736 | <nav>
|
737 | <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#convert2Abc">convert2Abc</a></li><li><a href="global.html#getAbcKey">getAbcKey</a></li><li><a href="global.html#getAbcNote">getAbcNote</a></li><li><a href="global.html#getAbcString">getAbcString</a></li></ul>
|
738 | </nav>
|
739 |
|
740 | <br class="clear">
|
741 |
|
742 | <footer>
|
743 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 07 2016 18:36:08 GMT+0200 (Mitteleuropäische Sommerzeit)
|
744 | </footer>
|
745 |
|
746 | <script> prettyPrint(); </script>
|
747 | <script src="scripts/linenumber.js"> </script>
|
748 | </body>
|
749 | </html> |
\ | No newline at end of file |