chordsheetjs 8.1.0 → 8.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/README.md +121 -217
  2. package/lib/bundle.js +22440 -2036
  3. package/lib/index.js +22440 -2036
  4. package/lib/index.js.map +1 -1
  5. package/lib/main.d.ts +63 -82
  6. package/lib/main.d.ts.map +1 -1
  7. package/lib/module.js +22327 -1925
  8. package/lib/module.js.map +1 -1
  9. package/package.json +12 -8
package/README.md CHANGED
@@ -368,7 +368,7 @@ subject to breaking changes between major versions.
368
368
  <dd><p>Represents a chord with the corresponding (partial) lyrics</p></dd>
369
369
  <dt><a href="#Comment">Comment</a></dt>
370
370
  <dd><p>Represents a comment. See https://www.chordpro.org/chordpro/chordpro-file-format-specification/#overview</p></dd>
371
- <dt><a href="#Line">Line</a> : <code><a href="#Font">Font</a></code></dt>
371
+ <dt><a href="#Line">Line</a></dt>
372
372
  <dd><p>Represents a line in a chord sheet, consisting of items of type ChordLyricsPair or Tag</p></dd>
373
373
  <dt><a href="#Metadata">Metadata</a></dt>
374
374
  <dd><p>Stores song metadata. Properties can be accessed using the get() method:</p>
@@ -452,99 +452,93 @@ Inherits from [ChordSheetParser](#ChordSheetParser)</p></dd>
452
452
  <p>The only function considered public API is <code>Key.distance</code></p></dd>
453
453
  </dl>
454
454
 
455
- ## Members
455
+ ## Constants
456
456
 
457
457
  <dl>
458
- <dt><a href="#Font">Font</a> : <code>string</code> | <code>null</code></dt>
459
- <dd><p>The font color</p></dd>
460
- <dt><a href="#FontSize">FontSize</a> : <code>number</code></dt>
461
- <dd><p>The font size</p></dd>
462
458
  <dt><a href="#ALBUM">ALBUM</a> : <code>string</code></dt>
463
- <dd><p>Artist meta directive. See https://www.chordpro.org/chordpro/directives-artist/</p></dd>
459
+ <dd><p>Album meta directive. See https://www.chordpro.org/chordpro/directives-album/</p></dd>
464
460
  <dt><a href="#ARTIST">ARTIST</a> : <code>string</code></dt>
465
- <dd><p>Capo meta directive. See https://www.chordpro.org/chordpro/directives-capo/</p></dd>
461
+ <dd><p>Artist meta directive. See https://www.chordpro.org/chordpro/directives-artist/</p></dd>
466
462
  <dt><a href="#CAPO">CAPO</a> : <code>string</code></dt>
467
- <dd><p>Comment directive. See https://www.chordpro.org/chordpro/directives-comment/</p></dd>
463
+ <dd><p>Capo meta directive. See https://www.chordpro.org/chordpro/directives-capo/</p></dd>
468
464
  <dt><a href="#COMMENT">COMMENT</a> : <code>string</code></dt>
469
- <dd><p>Composer meta directive. See https://www.chordpro.org/chordpro/directives-composer/</p></dd>
465
+ <dd><p>Comment directive. See https://www.chordpro.org/chordpro/directives-comment/</p></dd>
470
466
  <dt><a href="#COMPOSER">COMPOSER</a> : <code>string</code></dt>
471
- <dd><p>Copyright meta directive. See https://www.chordpro.org/chordpro/directives-copyright/</p></dd>
467
+ <dd><p>Composer meta directive. See https://www.chordpro.org/chordpro/directives-composer/</p></dd>
472
468
  <dt><a href="#COPYRIGHT">COPYRIGHT</a> : <code>string</code></dt>
473
- <dd><p>Duration meta directive. See https://www.chordpro.org/chordpro/directives-duration/</p></dd>
469
+ <dd><p>Copyright meta directive. See https://www.chordpro.org/chordpro/directives-copyright/</p></dd>
474
470
  <dt><a href="#DURATION">DURATION</a> : <code>string</code></dt>
475
- <dd><p>End of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/</p></dd>
471
+ <dd><p>Duration meta directive. See https://www.chordpro.org/chordpro/directives-duration/</p></dd>
476
472
  <dt><a href="#END_OF_BRIDGE">END_OF_BRIDGE</a> : <code>string</code></dt>
477
- <dd><p>End of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
473
+ <dd><p>End of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/</p></dd>
478
474
  <dt><a href="#END_OF_CHORUS">END_OF_CHORUS</a> : <code>string</code></dt>
479
- <dd><p>End of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/</p></dd>
475
+ <dd><p>End of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
480
476
  <dt><a href="#END_OF_TAB">END_OF_TAB</a> : <code>string</code></dt>
481
- <dd><p>End of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/</p></dd>
477
+ <dd><p>End of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/</p></dd>
482
478
  <dt><a href="#END_OF_VERSE">END_OF_VERSE</a> : <code>string</code></dt>
483
- <dd><p>Key meta directive. See https://www.chordpro.org/chordpro/directives-key/</p></dd>
479
+ <dd><p>End of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/</p></dd>
484
480
  <dt><a href="#KEY">KEY</a> : <code>string</code></dt>
481
+ <dd><p>Key meta directive. See https://www.chordpro.org/chordpro/directives-key/</p></dd>
482
+ <dt><a href="#_KEY">_KEY</a> : <code>string</code></dt>
485
483
  <dd><p>_Key meta directive. Reflects the key as transposed by the capo value
486
484
  See https://www.chordpro.org/chordpro/directives-key/</p></dd>
487
- <dt><a href="#_KEY">_KEY</a> : <code>string</code></dt>
488
- <dd><p>Lyricist meta directive. See https://www.chordpro.org/chordpro/directives-lyricist/</p></dd>
489
485
  <dt><a href="#LYRICIST">LYRICIST</a> : <code>string</code></dt>
490
- <dd><p>Start of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/</p></dd>
486
+ <dd><p>Lyricist meta directive. See https://www.chordpro.org/chordpro/directives-lyricist/</p></dd>
491
487
  <dt><a href="#START_OF_BRIDGE">START_OF_BRIDGE</a> : <code>string</code></dt>
492
- <dd><p>Start of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
488
+ <dd><p>Start of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/</p></dd>
493
489
  <dt><a href="#START_OF_CHORUS">START_OF_CHORUS</a> : <code>string</code></dt>
494
- <dd><p>Start of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/</p></dd>
490
+ <dd><p>Start of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
495
491
  <dt><a href="#START_OF_TAB">START_OF_TAB</a> : <code>string</code></dt>
496
- <dd><p>Start of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/</p></dd>
492
+ <dd><p>Start of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/</p></dd>
497
493
  <dt><a href="#START_OF_VERSE">START_OF_VERSE</a> : <code>string</code></dt>
498
- <dd><p>Subtitle meta directive. See https://www.chordpro.org/chordpro/directives-subtitle/</p></dd>
494
+ <dd><p>Start of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/</p></dd>
499
495
  <dt><a href="#SUBTITLE">SUBTITLE</a> : <code>string</code></dt>
500
- <dd><p>Tempo meta directive. See https://www.chordpro.org/chordpro/directives-tempo/</p></dd>
496
+ <dd><p>Subtitle meta directive. See https://www.chordpro.org/chordpro/directives-subtitle/</p></dd>
501
497
  <dt><a href="#TEMPO">TEMPO</a> : <code>string</code></dt>
502
- <dd><p>Time meta directive. See https://www.chordpro.org/chordpro/directives-time/</p></dd>
498
+ <dd><p>Tempo meta directive. See https://www.chordpro.org/chordpro/directives-tempo/</p></dd>
503
499
  <dt><a href="#TIME">TIME</a> : <code>string</code></dt>
504
- <dd><p>Title meta directive. See https://www.chordpro.org/chordpro/directives-title/</p></dd>
500
+ <dd><p>Time meta directive. See https://www.chordpro.org/chordpro/directives-time/</p></dd>
505
501
  <dt><a href="#TITLE">TITLE</a> : <code>string</code></dt>
506
- <dd><p>Transpose meta directive. See: https://www.chordpro.org/chordpro/directives-transpose/</p></dd>
502
+ <dd><p>Title meta directive. See https://www.chordpro.org/chordpro/directives-title/</p></dd>
507
503
  <dt><a href="#TRANSPOSE">TRANSPOSE</a> : <code>string</code></dt>
508
- <dd><p>New Key meta directive. See: https://github.com/PraiseCharts/ChordChartJS/issues/53</p></dd>
504
+ <dd><p>Transpose meta directive. See: https://www.chordpro.org/chordpro/directives-transpose/</p></dd>
509
505
  <dt><a href="#NEW_KEY">NEW_KEY</a> : <code>string</code></dt>
510
- <dd><p>Year meta directive. See https://www.chordpro.org/chordpro/directives-year/</p></dd>
506
+ <dd><p>New Key meta directive. See: https://github.com/PraiseCharts/ChordChartJS/issues/53</p></dd>
511
507
  <dt><a href="#YEAR">YEAR</a> : <code>string</code></dt>
512
- <dd><p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/</p></dd>
508
+ <dd><p>Year meta directive. See https://www.chordpro.org/chordpro/directives-year/</p></dd>
513
509
  <dt><a href="#CHORDFONT">CHORDFONT</a> : <code>string</code></dt>
514
510
  <dd><p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/</p></dd>
515
511
  <dt><a href="#CHORDSIZE">CHORDSIZE</a> : <code>string</code></dt>
516
512
  <dd><p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/</p></dd>
517
513
  <dt><a href="#CHORDCOLOUR">CHORDCOLOUR</a> : <code>string</code></dt>
518
- <dd><p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/</p></dd>
514
+ <dd><p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/</p></dd>
519
515
  <dt><a href="#TEXTFONT">TEXTFONT</a> : <code>string</code></dt>
520
516
  <dd><p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/</p></dd>
521
517
  <dt><a href="#TEXTSIZE">TEXTSIZE</a> : <code>string</code></dt>
522
518
  <dd><p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/</p></dd>
523
519
  <dt><a href="#TEXTCOLOUR">TEXTCOLOUR</a> : <code>string</code></dt>
524
- <dd><p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/</p></dd>
520
+ <dd><p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/</p></dd>
525
521
  <dt><a href="#TITLEFONT">TITLEFONT</a> : <code>string</code></dt>
526
522
  <dd><p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/</p></dd>
527
523
  <dt><a href="#TITLESIZE">TITLESIZE</a> : <code>string</code></dt>
528
524
  <dd><p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/</p></dd>
529
525
  <dt><a href="#TITLECOLOUR">TITLECOLOUR</a> : <code>string</code></dt>
526
+ <dd><p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/</p></dd>
527
+ <dt><a href="#CHORUS">CHORUS</a> : <code>string</code></dt>
530
528
  <dd><p>Chorus directive. Support repeating an earlier defined section.
531
529
  See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
532
- </dl>
533
-
534
- ## Constants
535
-
536
- <dl>
537
- <dt><a href="#ALBUM">ALBUM</a> : <code>string</code></dt>
538
- <dd><p>Album meta directive. See https://www.chordpro.org/chordpro/directives-album/</p></dd>
530
+ <dt><a href="#CHORD_STYLE">CHORD_STYLE</a> : <code>string</code></dt>
531
+ <dd><p>Chord type directive. Determines the type of chords used in the rendered chord sheet.
532
+ Possible values are 'symbol', 'numeral' and 'number'</p></dd>
539
533
  <dt><a href="#VERSE">VERSE</a> : <code>string</code></dt>
540
534
  <dd><p>Used to mark a paragraph as verse</p></dd>
541
- <dt><a href="#VERSE">VERSE</a> : <code>string</code></dt>
542
- <dd><p>Used to mark a paragraph as chorus</p></dd>
543
535
  <dt><a href="#CHORUS">CHORUS</a> : <code>string</code></dt>
544
- <dd><p>Used to mark a paragraph as not containing a line marked with a type</p></dd>
536
+ <dd><p>Used to mark a paragraph as chorus</p></dd>
545
537
  <dt><a href="#NONE">NONE</a> : <code>string</code></dt>
546
- <dd><p>Used to mark a paragraph as containing lines with both verse and chorus type</p></dd>
538
+ <dd><p>Used to mark a paragraph as not containing a line marked with a type</p></dd>
547
539
  <dt><a href="#INDETERMINATE">INDETERMINATE</a> : <code>string</code></dt>
540
+ <dd><p>Used to mark a paragraph as containing lines with both verse and chorus type</p></dd>
541
+ <dt><a href="#TAB">TAB</a> : <code>string</code></dt>
548
542
  <dd><p>Used to mark a paragraph as tab</p></dd>
549
543
  </dl>
550
544
 
@@ -555,8 +549,6 @@ See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
555
549
  <dd><p>Generates basic CSS, scoped within the provided selector, to use with output generated by [HtmlTableFormatter](#HtmlTableFormatter)</p></dd>
556
550
  <dt><a href="#scopedCss">scopedCss(scope)</a> ⇒ <code>string</code></dt>
557
551
  <dd><p>Generates basic CSS, scoped within the provided selector, to use with output generated by [HtmlTableFormatter](#HtmlTableFormatter)</p></dd>
558
- <dt><del><a href="#parseChord">parseChord(chordString)</a> ⇒ <code><a href="#Chord">Chord</a></code> | <code>null</code></del></dt>
559
- <dd><p>Tries to parse a chord string into a chord</p></dd>
560
552
  <dt><a href="#getCapos">getCapos(key)</a> ⇒ <code>Object.&lt;string, string&gt;</code></dt>
561
553
  <dd><p>Returns applicable capos for the provided key</p></dd>
562
554
  <dt><a href="#getKeys">getKeys(key)</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
@@ -637,13 +629,12 @@ See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
637
629
  **Kind**: instance method of [<code>Comment</code>](#Comment)
638
630
  <a name="Line"></a>
639
631
 
640
- ## Line : [<code>Font</code>](#Font)
632
+ ## Line
641
633
  <p>Represents a line in a chord sheet, consisting of items of type ChordLyricsPair or Tag</p>
642
634
 
643
635
  **Kind**: global class
644
636
 
645
- * [Line](#Line) : [<code>Font</code>](#Font)
646
- * [new Line()](#new_Line_new)
637
+ * [Line](#Line)
647
638
  * [.isEmpty()](#Line+isEmpty) ⇒ <code>boolean</code>
648
639
  * [.addItem(item)](#Line+addItem)
649
640
  * [.hasRenderableItems()](#Line+hasRenderableItems) ⇒ <code>boolean</code>
@@ -652,13 +643,6 @@ See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
652
643
  * [.isChorus()](#Line+isChorus) ⇒ <code>boolean</code>
653
644
  * ~~[.hasContent()](#Line+hasContent) ⇒ <code>boolean</code>~~
654
645
 
655
- <a name="new_Line_new"></a>
656
-
657
- ### new Line()
658
- <p>The chord font that applies to this line. Is derived from the directives:
659
- <code>chordfont</code>, <code>chordsize</code> and <code>chordcolour</code>
660
- See: https://www.chordpro.org/chordpro/directives-props_chord_legacy/</p>
661
-
662
646
  <a name="Line+isEmpty"></a>
663
647
 
664
648
  ### line.isEmpty() ⇒ <code>boolean</code>
@@ -761,16 +745,9 @@ else it returns an array of strings.</p>
761
745
  **Kind**: global class
762
746
 
763
747
  * [Paragraph](#Paragraph)
764
- * [.addLine](#Paragraph+addLine) : [<code>Array.&lt;Line&gt;</code>](#Line)
765
748
  * [.type](#Paragraph+type) ⇒ <code>string</code>
766
749
  * [.hasRenderableItems()](#Paragraph+hasRenderableItems) ⇒ <code>boolean</code>
767
750
 
768
- <a name="Paragraph+addLine"></a>
769
-
770
- ### paragraph.addLine : [<code>Array.&lt;Line&gt;</code>](#Line)
771
- <p>The [Line](#Line) items of which the paragraph consists</p>
772
-
773
- **Kind**: instance property of [<code>Paragraph</code>](#Paragraph)
774
751
  <a name="Paragraph+type"></a>
775
752
 
776
753
  ### paragraph.type ⇒ <code>string</code>
@@ -798,7 +775,6 @@ If not, it returns [INDETERMINATE](#INDETERMINATE)</p>
798
775
  * [.bodyParagraphs](#Song+bodyParagraphs) ⇒ [<code>Array.&lt;Paragraph&gt;</code>](#Paragraph)
799
776
  * [.paragraphs](#Song+paragraphs) : [<code>Array.&lt;Paragraph&gt;</code>](#Paragraph)
800
777
  * [.expandedBodyParagraphs](#Song+expandedBodyParagraphs) : [<code>Array.&lt;Paragraph&gt;</code>](#Paragraph)
801
- * ~~[.metaData](#Song+metaData) ⇒~~
802
778
  * [.clone()](#Song+clone) ⇒ [<code>Song</code>](#Song)
803
779
  * [.setKey(key)](#Song+setKey) ⇒ [<code>Song</code>](#Song)
804
780
  * [.setCapo(capo)](#Song+setCapo) ⇒ [<code>Song</code>](#Song)
@@ -848,15 +824,6 @@ if you want to skip the &quot;header lines&quot;: the lines that only contain me
848
824
  <p>The body paragraphs of the song, with any <code>{chorus}</code> tag expanded into the targetted chorus</p>
849
825
 
850
826
  **Kind**: instance property of [<code>Song</code>](#Song)
851
- <a name="Song+metaData"></a>
852
-
853
- ### ~~song.metaData ⇒~~
854
- ***Deprecated***
855
-
856
- <p>The song's metadata. Please use [metadata](metadata) instead.</p>
857
-
858
- **Kind**: instance property of [<code>Song</code>](#Song)
859
- **Returns**: <p>[Metadata](#Metadata) The metadata</p>
860
827
  <a name="Song+clone"></a>
861
828
 
862
829
  ### song.clone() ⇒ [<code>Song</code>](#Song)
@@ -1674,303 +1641,253 @@ Can be deserialized using [deserialize](deserialize)</p>
1674
1641
  | oneKey | [<code>Key</code>](#Key) \| <code>string</code> | <p>the key</p> |
1675
1642
  | otherKey | [<code>Key</code>](#Key) \| <code>string</code> | <p>the other key</p> |
1676
1643
 
1677
- <a name="Font"></a>
1678
-
1679
- ## Font : <code>string</code> \| <code>null</code>
1680
- <p>The font color</p>
1681
-
1682
- **Kind**: global variable
1683
- <a name="Font+toCssString"></a>
1684
-
1685
- ### font.toCssString() ⇒ <code>string</code>
1686
- <p>Converts the font, size and color to a CSS string.
1687
- If possible, font and size are combined to the <code>font</code> shorthand.
1688
- If <code>font</code> contains double quotes (<code>&quot;</code>) those will be converted to single quotes (<code>'</code>).</p>
1689
-
1690
- **Kind**: instance method of [<code>Font</code>](#Font)
1691
- **Returns**: <code>string</code> - <p>The CSS string</p>
1692
- **Example**
1693
- ```js
1694
- // Returns "font-family: 'Times New Roman'"
1695
- new Font({ font: '"Times New Roman"' }).toCssString()
1696
- ```
1697
- **Example**
1698
- ```js
1699
- // Returns "color: red; font-family: Verdana"
1700
- new Font({ font: 'Verdana', colour: 'red' }).toCssString()
1701
- ```
1702
- **Example**
1703
- ```js
1704
- // Returns "font: 30px Verdana"
1705
- new Font({ font: 'Verdana', size: '30' }).toCssString()
1706
- ```
1707
- **Example**
1708
- ```js
1709
- // Returns "color: blue; font: 30% Verdana"
1710
- new Font({ font: 'Verdana', size: '30%', colour: 'blue' }).toCssString()
1711
- ```
1712
- <a name="FontSize"></a>
1713
-
1714
- ## FontSize : <code>number</code>
1715
- <p>The font size</p>
1716
-
1717
- **Kind**: global variable
1718
- <a name="FontSize+toString"></a>
1719
-
1720
- ### fontSize.toString() ⇒ <code>string</code>
1721
- <p>Stringifies the font size by concatenating size and unit</p>
1722
-
1723
- **Kind**: instance method of [<code>FontSize</code>](#FontSize)
1724
- **Returns**: <code>string</code> - <p>The font size</p>
1725
- **Example**
1726
- ```js
1727
- // Returns "30px"
1728
- new FontSize(30, 'px').toString()
1729
- ```
1730
- **Example**
1731
- ```js
1732
- // Returns "120%"
1733
- new FontSize(120, '%').toString()
1734
- ```
1735
1644
  <a name="ALBUM"></a>
1736
1645
 
1737
1646
  ## ALBUM : <code>string</code>
1738
- <p>Artist meta directive. See https://www.chordpro.org/chordpro/directives-artist/</p>
1647
+ <p>Album meta directive. See https://www.chordpro.org/chordpro/directives-album/</p>
1739
1648
 
1740
- **Kind**: global variable
1649
+ **Kind**: global constant
1741
1650
  <a name="ARTIST"></a>
1742
1651
 
1743
1652
  ## ARTIST : <code>string</code>
1744
- <p>Capo meta directive. See https://www.chordpro.org/chordpro/directives-capo/</p>
1653
+ <p>Artist meta directive. See https://www.chordpro.org/chordpro/directives-artist/</p>
1745
1654
 
1746
- **Kind**: global variable
1655
+ **Kind**: global constant
1747
1656
  <a name="CAPO"></a>
1748
1657
 
1749
1658
  ## CAPO : <code>string</code>
1750
- <p>Comment directive. See https://www.chordpro.org/chordpro/directives-comment/</p>
1659
+ <p>Capo meta directive. See https://www.chordpro.org/chordpro/directives-capo/</p>
1751
1660
 
1752
- **Kind**: global variable
1661
+ **Kind**: global constant
1753
1662
  <a name="COMMENT"></a>
1754
1663
 
1755
1664
  ## COMMENT : <code>string</code>
1756
- <p>Composer meta directive. See https://www.chordpro.org/chordpro/directives-composer/</p>
1665
+ <p>Comment directive. See https://www.chordpro.org/chordpro/directives-comment/</p>
1757
1666
 
1758
- **Kind**: global variable
1667
+ **Kind**: global constant
1759
1668
  <a name="COMPOSER"></a>
1760
1669
 
1761
1670
  ## COMPOSER : <code>string</code>
1762
- <p>Copyright meta directive. See https://www.chordpro.org/chordpro/directives-copyright/</p>
1671
+ <p>Composer meta directive. See https://www.chordpro.org/chordpro/directives-composer/</p>
1763
1672
 
1764
- **Kind**: global variable
1673
+ **Kind**: global constant
1765
1674
  <a name="COPYRIGHT"></a>
1766
1675
 
1767
1676
  ## COPYRIGHT : <code>string</code>
1768
- <p>Duration meta directive. See https://www.chordpro.org/chordpro/directives-duration/</p>
1677
+ <p>Copyright meta directive. See https://www.chordpro.org/chordpro/directives-copyright/</p>
1769
1678
 
1770
- **Kind**: global variable
1679
+ **Kind**: global constant
1771
1680
  <a name="DURATION"></a>
1772
1681
 
1773
1682
  ## DURATION : <code>string</code>
1774
- <p>End of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/</p>
1683
+ <p>Duration meta directive. See https://www.chordpro.org/chordpro/directives-duration/</p>
1775
1684
 
1776
- **Kind**: global variable
1685
+ **Kind**: global constant
1777
1686
  <a name="END_OF_BRIDGE"></a>
1778
1687
 
1779
1688
  ## END\_OF\_BRIDGE : <code>string</code>
1780
- <p>End of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/</p>
1689
+ <p>End of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/</p>
1781
1690
 
1782
- **Kind**: global variable
1691
+ **Kind**: global constant
1783
1692
  <a name="END_OF_CHORUS"></a>
1784
1693
 
1785
1694
  ## END\_OF\_CHORUS : <code>string</code>
1786
- <p>End of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/</p>
1695
+ <p>End of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/</p>
1787
1696
 
1788
- **Kind**: global variable
1697
+ **Kind**: global constant
1789
1698
  <a name="END_OF_TAB"></a>
1790
1699
 
1791
1700
  ## END\_OF\_TAB : <code>string</code>
1792
- <p>End of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/</p>
1701
+ <p>End of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/</p>
1793
1702
 
1794
- **Kind**: global variable
1703
+ **Kind**: global constant
1795
1704
  <a name="END_OF_VERSE"></a>
1796
1705
 
1797
1706
  ## END\_OF\_VERSE : <code>string</code>
1798
- <p>Key meta directive. See https://www.chordpro.org/chordpro/directives-key/</p>
1707
+ <p>End of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/</p>
1799
1708
 
1800
- **Kind**: global variable
1709
+ **Kind**: global constant
1801
1710
  <a name="KEY"></a>
1802
1711
 
1803
1712
  ## KEY : <code>string</code>
1804
- <p>_Key meta directive. Reflects the key as transposed by the capo value
1805
- See https://www.chordpro.org/chordpro/directives-key/</p>
1713
+ <p>Key meta directive. See https://www.chordpro.org/chordpro/directives-key/</p>
1806
1714
 
1807
- **Kind**: global variable
1715
+ **Kind**: global constant
1808
1716
  <a name="_KEY"></a>
1809
1717
 
1810
1718
  ## \_KEY : <code>string</code>
1811
- <p>Lyricist meta directive. See https://www.chordpro.org/chordpro/directives-lyricist/</p>
1719
+ <p>_Key meta directive. Reflects the key as transposed by the capo value
1720
+ See https://www.chordpro.org/chordpro/directives-key/</p>
1812
1721
 
1813
- **Kind**: global variable
1722
+ **Kind**: global constant
1814
1723
  <a name="LYRICIST"></a>
1815
1724
 
1816
1725
  ## LYRICIST : <code>string</code>
1817
- <p>Start of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/</p>
1726
+ <p>Lyricist meta directive. See https://www.chordpro.org/chordpro/directives-lyricist/</p>
1818
1727
 
1819
- **Kind**: global variable
1728
+ **Kind**: global constant
1820
1729
  <a name="START_OF_BRIDGE"></a>
1821
1730
 
1822
1731
  ## START\_OF\_BRIDGE : <code>string</code>
1823
- <p>Start of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/</p>
1732
+ <p>Start of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/</p>
1824
1733
 
1825
- **Kind**: global variable
1734
+ **Kind**: global constant
1826
1735
  <a name="START_OF_CHORUS"></a>
1827
1736
 
1828
1737
  ## START\_OF\_CHORUS : <code>string</code>
1829
- <p>Start of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/</p>
1738
+ <p>Start of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/</p>
1830
1739
 
1831
- **Kind**: global variable
1740
+ **Kind**: global constant
1832
1741
  <a name="START_OF_TAB"></a>
1833
1742
 
1834
1743
  ## START\_OF\_TAB : <code>string</code>
1835
- <p>Start of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/</p>
1744
+ <p>Start of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/</p>
1836
1745
 
1837
- **Kind**: global variable
1746
+ **Kind**: global constant
1838
1747
  <a name="START_OF_VERSE"></a>
1839
1748
 
1840
1749
  ## START\_OF\_VERSE : <code>string</code>
1841
- <p>Subtitle meta directive. See https://www.chordpro.org/chordpro/directives-subtitle/</p>
1750
+ <p>Start of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/</p>
1842
1751
 
1843
- **Kind**: global variable
1752
+ **Kind**: global constant
1844
1753
  <a name="SUBTITLE"></a>
1845
1754
 
1846
1755
  ## SUBTITLE : <code>string</code>
1847
- <p>Tempo meta directive. See https://www.chordpro.org/chordpro/directives-tempo/</p>
1756
+ <p>Subtitle meta directive. See https://www.chordpro.org/chordpro/directives-subtitle/</p>
1848
1757
 
1849
- **Kind**: global variable
1758
+ **Kind**: global constant
1850
1759
  <a name="TEMPO"></a>
1851
1760
 
1852
1761
  ## TEMPO : <code>string</code>
1853
- <p>Time meta directive. See https://www.chordpro.org/chordpro/directives-time/</p>
1762
+ <p>Tempo meta directive. See https://www.chordpro.org/chordpro/directives-tempo/</p>
1854
1763
 
1855
- **Kind**: global variable
1764
+ **Kind**: global constant
1856
1765
  <a name="TIME"></a>
1857
1766
 
1858
1767
  ## TIME : <code>string</code>
1859
- <p>Title meta directive. See https://www.chordpro.org/chordpro/directives-title/</p>
1768
+ <p>Time meta directive. See https://www.chordpro.org/chordpro/directives-time/</p>
1860
1769
 
1861
- **Kind**: global variable
1770
+ **Kind**: global constant
1862
1771
  <a name="TITLE"></a>
1863
1772
 
1864
1773
  ## TITLE : <code>string</code>
1865
- <p>Transpose meta directive. See: https://www.chordpro.org/chordpro/directives-transpose/</p>
1774
+ <p>Title meta directive. See https://www.chordpro.org/chordpro/directives-title/</p>
1866
1775
 
1867
- **Kind**: global variable
1776
+ **Kind**: global constant
1868
1777
  <a name="TRANSPOSE"></a>
1869
1778
 
1870
1779
  ## TRANSPOSE : <code>string</code>
1871
- <p>New Key meta directive. See: https://github.com/PraiseCharts/ChordChartJS/issues/53</p>
1780
+ <p>Transpose meta directive. See: https://www.chordpro.org/chordpro/directives-transpose/</p>
1872
1781
 
1873
- **Kind**: global variable
1782
+ **Kind**: global constant
1874
1783
  <a name="NEW_KEY"></a>
1875
1784
 
1876
1785
  ## NEW\_KEY : <code>string</code>
1877
- <p>Year meta directive. See https://www.chordpro.org/chordpro/directives-year/</p>
1786
+ <p>New Key meta directive. See: https://github.com/PraiseCharts/ChordChartJS/issues/53</p>
1878
1787
 
1879
- **Kind**: global variable
1788
+ **Kind**: global constant
1880
1789
  <a name="YEAR"></a>
1881
1790
 
1882
1791
  ## YEAR : <code>string</code>
1883
- <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/</p>
1792
+ <p>Year meta directive. See https://www.chordpro.org/chordpro/directives-year/</p>
1884
1793
 
1885
- **Kind**: global variable
1794
+ **Kind**: global constant
1886
1795
  <a name="CHORDFONT"></a>
1887
1796
 
1888
1797
  ## CHORDFONT : <code>string</code>
1889
1798
  <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/</p>
1890
1799
 
1891
- **Kind**: global variable
1800
+ **Kind**: global constant
1892
1801
  <a name="CHORDSIZE"></a>
1893
1802
 
1894
1803
  ## CHORDSIZE : <code>string</code>
1895
1804
  <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/</p>
1896
1805
 
1897
- **Kind**: global variable
1806
+ **Kind**: global constant
1898
1807
  <a name="CHORDCOLOUR"></a>
1899
1808
 
1900
1809
  ## CHORDCOLOUR : <code>string</code>
1901
- <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/</p>
1810
+ <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/</p>
1902
1811
 
1903
- **Kind**: global variable
1812
+ **Kind**: global constant
1904
1813
  <a name="TEXTFONT"></a>
1905
1814
 
1906
1815
  ## TEXTFONT : <code>string</code>
1907
1816
  <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/</p>
1908
1817
 
1909
- **Kind**: global variable
1818
+ **Kind**: global constant
1910
1819
  <a name="TEXTSIZE"></a>
1911
1820
 
1912
1821
  ## TEXTSIZE : <code>string</code>
1913
1822
  <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/</p>
1914
1823
 
1915
- **Kind**: global variable
1824
+ **Kind**: global constant
1916
1825
  <a name="TEXTCOLOUR"></a>
1917
1826
 
1918
1827
  ## TEXTCOLOUR : <code>string</code>
1919
- <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/</p>
1828
+ <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/</p>
1920
1829
 
1921
- **Kind**: global variable
1830
+ **Kind**: global constant
1922
1831
  <a name="TITLEFONT"></a>
1923
1832
 
1924
1833
  ## TITLEFONT : <code>string</code>
1925
1834
  <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/</p>
1926
1835
 
1927
- **Kind**: global variable
1836
+ **Kind**: global constant
1928
1837
  <a name="TITLESIZE"></a>
1929
1838
 
1930
1839
  ## TITLESIZE : <code>string</code>
1931
1840
  <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/</p>
1932
1841
 
1933
- **Kind**: global variable
1842
+ **Kind**: global constant
1934
1843
  <a name="TITLECOLOUR"></a>
1935
1844
 
1936
1845
  ## TITLECOLOUR : <code>string</code>
1937
- <p>Chorus directive. Support repeating an earlier defined section.
1938
- See https://www.chordpro.org/chordpro/directives-env_chorus/</p>
1846
+ <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/</p>
1939
1847
 
1940
- **Kind**: global variable
1941
- <a name="ALBUM"></a>
1848
+ **Kind**: global constant
1849
+ <a name="CHORUS"></a>
1942
1850
 
1943
- ## ALBUM : <code>string</code>
1944
- <p>Album meta directive. See https://www.chordpro.org/chordpro/directives-album/</p>
1851
+ ## CHORUS : <code>string</code>
1852
+ <p>Chorus directive. Support repeating an earlier defined section.
1853
+ See https://www.chordpro.org/chordpro/directives-env_chorus/</p>
1945
1854
 
1946
1855
  **Kind**: global constant
1947
- <a name="VERSE"></a>
1856
+ <a name="CHORD_STYLE"></a>
1948
1857
 
1949
- ## VERSE : <code>string</code>
1950
- <p>Used to mark a paragraph as verse</p>
1858
+ ## CHORD\_STYLE : <code>string</code>
1859
+ <p>Chord type directive. Determines the type of chords used in the rendered chord sheet.
1860
+ Possible values are 'symbol', 'numeral' and 'number'</p>
1951
1861
 
1952
1862
  **Kind**: global constant
1863
+ **See**: https://github.com/bettermusic/ChordSheetJS/issues/352
1953
1864
  <a name="VERSE"></a>
1954
1865
 
1955
1866
  ## VERSE : <code>string</code>
1956
- <p>Used to mark a paragraph as chorus</p>
1867
+ <p>Used to mark a paragraph as verse</p>
1957
1868
 
1958
1869
  **Kind**: global constant
1959
1870
  <a name="CHORUS"></a>
1960
1871
 
1961
1872
  ## CHORUS : <code>string</code>
1962
- <p>Used to mark a paragraph as not containing a line marked with a type</p>
1873
+ <p>Used to mark a paragraph as chorus</p>
1963
1874
 
1964
1875
  **Kind**: global constant
1965
1876
  <a name="NONE"></a>
1966
1877
 
1967
1878
  ## NONE : <code>string</code>
1968
- <p>Used to mark a paragraph as containing lines with both verse and chorus type</p>
1879
+ <p>Used to mark a paragraph as not containing a line marked with a type</p>
1969
1880
 
1970
1881
  **Kind**: global constant
1971
1882
  <a name="INDETERMINATE"></a>
1972
1883
 
1973
1884
  ## INDETERMINATE : <code>string</code>
1885
+ <p>Used to mark a paragraph as containing lines with both verse and chorus type</p>
1886
+
1887
+ **Kind**: global constant
1888
+ <a name="TAB"></a>
1889
+
1890
+ ## TAB : <code>string</code>
1974
1891
  <p>Used to mark a paragraph as tab</p>
1975
1892
 
1976
1893
  **Kind**: global constant
@@ -1998,19 +1915,6 @@ See https://www.chordpro.org/chordpro/directives-env_chorus/</p>
1998
1915
  | --- | --- |
1999
1916
  | scope | <p>the CSS scope to use, for example <code>.chordSheetViewer</code></p> |
2000
1917
 
2001
- <a name="parseChord"></a>
2002
-
2003
- ## ~~parseChord(chordString) ⇒ [<code>Chord</code>](#Chord) \| <code>null</code>~~
2004
- ***Deprecated***
2005
-
2006
- <p>Tries to parse a chord string into a chord</p>
2007
-
2008
- **Kind**: global function
2009
-
2010
- | Param | Description |
2011
- | --- | --- |
2012
- | chordString | <p>the chord string, eg Esus4/G# or 1sus4/#3</p> |
2013
-
2014
1918
  <a name="getCapos"></a>
2015
1919
 
2016
1920
  ## getCapos(key) ⇒ <code>Object.&lt;string, string&gt;</code>