chordsheetjs 8.2.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 (8) hide show
  1. package/README.md +121 -192
  2. package/lib/bundle.js +30 -6
  3. package/lib/index.js +30 -6
  4. package/lib/index.js.map +1 -1
  5. package/lib/main.d.ts.map +1 -1
  6. package/lib/module.js +27 -6
  7. package/lib/module.js.map +1 -1
  8. package/package.json +5 -5
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
 
@@ -635,13 +629,12 @@ See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
635
629
  **Kind**: instance method of [<code>Comment</code>](#Comment)
636
630
  <a name="Line"></a>
637
631
 
638
- ## Line : [<code>Font</code>](#Font)
632
+ ## Line
639
633
  <p>Represents a line in a chord sheet, consisting of items of type ChordLyricsPair or Tag</p>
640
634
 
641
635
  **Kind**: global class
642
636
 
643
- * [Line](#Line) : [<code>Font</code>](#Font)
644
- * [new Line()](#new_Line_new)
637
+ * [Line](#Line)
645
638
  * [.isEmpty()](#Line+isEmpty) ⇒ <code>boolean</code>
646
639
  * [.addItem(item)](#Line+addItem)
647
640
  * [.hasRenderableItems()](#Line+hasRenderableItems) ⇒ <code>boolean</code>
@@ -650,13 +643,6 @@ See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
650
643
  * [.isChorus()](#Line+isChorus) ⇒ <code>boolean</code>
651
644
  * ~~[.hasContent()](#Line+hasContent) ⇒ <code>boolean</code>~~
652
645
 
653
- <a name="new_Line_new"></a>
654
-
655
- ### new Line()
656
- <p>The chord font that applies to this line. Is derived from the directives:
657
- <code>chordfont</code>, <code>chordsize</code> and <code>chordcolour</code>
658
- See: https://www.chordpro.org/chordpro/directives-props_chord_legacy/</p>
659
-
660
646
  <a name="Line+isEmpty"></a>
661
647
 
662
648
  ### line.isEmpty() ⇒ <code>boolean</code>
@@ -759,16 +745,9 @@ else it returns an array of strings.</p>
759
745
  **Kind**: global class
760
746
 
761
747
  * [Paragraph](#Paragraph)
762
- * [.addLine](#Paragraph+addLine) : [<code>Array.&lt;Line&gt;</code>](#Line)
763
748
  * [.type](#Paragraph+type) ⇒ <code>string</code>
764
749
  * [.hasRenderableItems()](#Paragraph+hasRenderableItems) ⇒ <code>boolean</code>
765
750
 
766
- <a name="Paragraph+addLine"></a>
767
-
768
- ### paragraph.addLine : [<code>Array.&lt;Line&gt;</code>](#Line)
769
- <p>The [Line](#Line) items of which the paragraph consists</p>
770
-
771
- **Kind**: instance property of [<code>Paragraph</code>](#Paragraph)
772
751
  <a name="Paragraph+type"></a>
773
752
 
774
753
  ### paragraph.type ⇒ <code>string</code>
@@ -1662,303 +1641,253 @@ Can be deserialized using [deserialize](deserialize)</p>
1662
1641
  | oneKey | [<code>Key</code>](#Key) \| <code>string</code> | <p>the key</p> |
1663
1642
  | otherKey | [<code>Key</code>](#Key) \| <code>string</code> | <p>the other key</p> |
1664
1643
 
1665
- <a name="Font"></a>
1666
-
1667
- ## Font : <code>string</code> \| <code>null</code>
1668
- <p>The font color</p>
1669
-
1670
- **Kind**: global variable
1671
- <a name="Font+toCssString"></a>
1672
-
1673
- ### font.toCssString() ⇒ <code>string</code>
1674
- <p>Converts the font, size and color to a CSS string.
1675
- If possible, font and size are combined to the <code>font</code> shorthand.
1676
- If <code>font</code> contains double quotes (<code>&quot;</code>) those will be converted to single quotes (<code>'</code>).</p>
1677
-
1678
- **Kind**: instance method of [<code>Font</code>](#Font)
1679
- **Returns**: <code>string</code> - <p>The CSS string</p>
1680
- **Example**
1681
- ```js
1682
- // Returns "font-family: 'Times New Roman'"
1683
- new Font({ font: '"Times New Roman"' }).toCssString()
1684
- ```
1685
- **Example**
1686
- ```js
1687
- // Returns "color: red; font-family: Verdana"
1688
- new Font({ font: 'Verdana', colour: 'red' }).toCssString()
1689
- ```
1690
- **Example**
1691
- ```js
1692
- // Returns "font: 30px Verdana"
1693
- new Font({ font: 'Verdana', size: '30' }).toCssString()
1694
- ```
1695
- **Example**
1696
- ```js
1697
- // Returns "color: blue; font: 30% Verdana"
1698
- new Font({ font: 'Verdana', size: '30%', colour: 'blue' }).toCssString()
1699
- ```
1700
- <a name="FontSize"></a>
1701
-
1702
- ## FontSize : <code>number</code>
1703
- <p>The font size</p>
1704
-
1705
- **Kind**: global variable
1706
- <a name="FontSize+toString"></a>
1707
-
1708
- ### fontSize.toString() ⇒ <code>string</code>
1709
- <p>Stringifies the font size by concatenating size and unit</p>
1710
-
1711
- **Kind**: instance method of [<code>FontSize</code>](#FontSize)
1712
- **Returns**: <code>string</code> - <p>The font size</p>
1713
- **Example**
1714
- ```js
1715
- // Returns "30px"
1716
- new FontSize(30, 'px').toString()
1717
- ```
1718
- **Example**
1719
- ```js
1720
- // Returns "120%"
1721
- new FontSize(120, '%').toString()
1722
- ```
1723
1644
  <a name="ALBUM"></a>
1724
1645
 
1725
1646
  ## ALBUM : <code>string</code>
1726
- <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>
1727
1648
 
1728
- **Kind**: global variable
1649
+ **Kind**: global constant
1729
1650
  <a name="ARTIST"></a>
1730
1651
 
1731
1652
  ## ARTIST : <code>string</code>
1732
- <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>
1733
1654
 
1734
- **Kind**: global variable
1655
+ **Kind**: global constant
1735
1656
  <a name="CAPO"></a>
1736
1657
 
1737
1658
  ## CAPO : <code>string</code>
1738
- <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>
1739
1660
 
1740
- **Kind**: global variable
1661
+ **Kind**: global constant
1741
1662
  <a name="COMMENT"></a>
1742
1663
 
1743
1664
  ## COMMENT : <code>string</code>
1744
- <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>
1745
1666
 
1746
- **Kind**: global variable
1667
+ **Kind**: global constant
1747
1668
  <a name="COMPOSER"></a>
1748
1669
 
1749
1670
  ## COMPOSER : <code>string</code>
1750
- <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>
1751
1672
 
1752
- **Kind**: global variable
1673
+ **Kind**: global constant
1753
1674
  <a name="COPYRIGHT"></a>
1754
1675
 
1755
1676
  ## COPYRIGHT : <code>string</code>
1756
- <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>
1757
1678
 
1758
- **Kind**: global variable
1679
+ **Kind**: global constant
1759
1680
  <a name="DURATION"></a>
1760
1681
 
1761
1682
  ## DURATION : <code>string</code>
1762
- <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>
1763
1684
 
1764
- **Kind**: global variable
1685
+ **Kind**: global constant
1765
1686
  <a name="END_OF_BRIDGE"></a>
1766
1687
 
1767
1688
  ## END\_OF\_BRIDGE : <code>string</code>
1768
- <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>
1769
1690
 
1770
- **Kind**: global variable
1691
+ **Kind**: global constant
1771
1692
  <a name="END_OF_CHORUS"></a>
1772
1693
 
1773
1694
  ## END\_OF\_CHORUS : <code>string</code>
1774
- <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>
1775
1696
 
1776
- **Kind**: global variable
1697
+ **Kind**: global constant
1777
1698
  <a name="END_OF_TAB"></a>
1778
1699
 
1779
1700
  ## END\_OF\_TAB : <code>string</code>
1780
- <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>
1781
1702
 
1782
- **Kind**: global variable
1703
+ **Kind**: global constant
1783
1704
  <a name="END_OF_VERSE"></a>
1784
1705
 
1785
1706
  ## END\_OF\_VERSE : <code>string</code>
1786
- <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>
1787
1708
 
1788
- **Kind**: global variable
1709
+ **Kind**: global constant
1789
1710
  <a name="KEY"></a>
1790
1711
 
1791
1712
  ## KEY : <code>string</code>
1792
- <p>_Key meta directive. Reflects the key as transposed by the capo value
1793
- See https://www.chordpro.org/chordpro/directives-key/</p>
1713
+ <p>Key meta directive. See https://www.chordpro.org/chordpro/directives-key/</p>
1794
1714
 
1795
- **Kind**: global variable
1715
+ **Kind**: global constant
1796
1716
  <a name="_KEY"></a>
1797
1717
 
1798
1718
  ## \_KEY : <code>string</code>
1799
- <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>
1800
1721
 
1801
- **Kind**: global variable
1722
+ **Kind**: global constant
1802
1723
  <a name="LYRICIST"></a>
1803
1724
 
1804
1725
  ## LYRICIST : <code>string</code>
1805
- <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>
1806
1727
 
1807
- **Kind**: global variable
1728
+ **Kind**: global constant
1808
1729
  <a name="START_OF_BRIDGE"></a>
1809
1730
 
1810
1731
  ## START\_OF\_BRIDGE : <code>string</code>
1811
- <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>
1812
1733
 
1813
- **Kind**: global variable
1734
+ **Kind**: global constant
1814
1735
  <a name="START_OF_CHORUS"></a>
1815
1736
 
1816
1737
  ## START\_OF\_CHORUS : <code>string</code>
1817
- <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>
1818
1739
 
1819
- **Kind**: global variable
1740
+ **Kind**: global constant
1820
1741
  <a name="START_OF_TAB"></a>
1821
1742
 
1822
1743
  ## START\_OF\_TAB : <code>string</code>
1823
- <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>
1824
1745
 
1825
- **Kind**: global variable
1746
+ **Kind**: global constant
1826
1747
  <a name="START_OF_VERSE"></a>
1827
1748
 
1828
1749
  ## START\_OF\_VERSE : <code>string</code>
1829
- <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>
1830
1751
 
1831
- **Kind**: global variable
1752
+ **Kind**: global constant
1832
1753
  <a name="SUBTITLE"></a>
1833
1754
 
1834
1755
  ## SUBTITLE : <code>string</code>
1835
- <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>
1836
1757
 
1837
- **Kind**: global variable
1758
+ **Kind**: global constant
1838
1759
  <a name="TEMPO"></a>
1839
1760
 
1840
1761
  ## TEMPO : <code>string</code>
1841
- <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>
1842
1763
 
1843
- **Kind**: global variable
1764
+ **Kind**: global constant
1844
1765
  <a name="TIME"></a>
1845
1766
 
1846
1767
  ## TIME : <code>string</code>
1847
- <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>
1848
1769
 
1849
- **Kind**: global variable
1770
+ **Kind**: global constant
1850
1771
  <a name="TITLE"></a>
1851
1772
 
1852
1773
  ## TITLE : <code>string</code>
1853
- <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>
1854
1775
 
1855
- **Kind**: global variable
1776
+ **Kind**: global constant
1856
1777
  <a name="TRANSPOSE"></a>
1857
1778
 
1858
1779
  ## TRANSPOSE : <code>string</code>
1859
- <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>
1860
1781
 
1861
- **Kind**: global variable
1782
+ **Kind**: global constant
1862
1783
  <a name="NEW_KEY"></a>
1863
1784
 
1864
1785
  ## NEW\_KEY : <code>string</code>
1865
- <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>
1866
1787
 
1867
- **Kind**: global variable
1788
+ **Kind**: global constant
1868
1789
  <a name="YEAR"></a>
1869
1790
 
1870
1791
  ## YEAR : <code>string</code>
1871
- <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>
1872
1793
 
1873
- **Kind**: global variable
1794
+ **Kind**: global constant
1874
1795
  <a name="CHORDFONT"></a>
1875
1796
 
1876
1797
  ## CHORDFONT : <code>string</code>
1877
1798
  <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/</p>
1878
1799
 
1879
- **Kind**: global variable
1800
+ **Kind**: global constant
1880
1801
  <a name="CHORDSIZE"></a>
1881
1802
 
1882
1803
  ## CHORDSIZE : <code>string</code>
1883
1804
  <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/</p>
1884
1805
 
1885
- **Kind**: global variable
1806
+ **Kind**: global constant
1886
1807
  <a name="CHORDCOLOUR"></a>
1887
1808
 
1888
1809
  ## CHORDCOLOUR : <code>string</code>
1889
- <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>
1890
1811
 
1891
- **Kind**: global variable
1812
+ **Kind**: global constant
1892
1813
  <a name="TEXTFONT"></a>
1893
1814
 
1894
1815
  ## TEXTFONT : <code>string</code>
1895
1816
  <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/</p>
1896
1817
 
1897
- **Kind**: global variable
1818
+ **Kind**: global constant
1898
1819
  <a name="TEXTSIZE"></a>
1899
1820
 
1900
1821
  ## TEXTSIZE : <code>string</code>
1901
1822
  <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/</p>
1902
1823
 
1903
- **Kind**: global variable
1824
+ **Kind**: global constant
1904
1825
  <a name="TEXTCOLOUR"></a>
1905
1826
 
1906
1827
  ## TEXTCOLOUR : <code>string</code>
1907
- <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>
1908
1829
 
1909
- **Kind**: global variable
1830
+ **Kind**: global constant
1910
1831
  <a name="TITLEFONT"></a>
1911
1832
 
1912
1833
  ## TITLEFONT : <code>string</code>
1913
1834
  <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/</p>
1914
1835
 
1915
- **Kind**: global variable
1836
+ **Kind**: global constant
1916
1837
  <a name="TITLESIZE"></a>
1917
1838
 
1918
1839
  ## TITLESIZE : <code>string</code>
1919
1840
  <p>Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/</p>
1920
1841
 
1921
- **Kind**: global variable
1842
+ **Kind**: global constant
1922
1843
  <a name="TITLECOLOUR"></a>
1923
1844
 
1924
1845
  ## TITLECOLOUR : <code>string</code>
1925
- <p>Chorus directive. Support repeating an earlier defined section.
1926
- 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>
1927
1847
 
1928
- **Kind**: global variable
1929
- <a name="ALBUM"></a>
1848
+ **Kind**: global constant
1849
+ <a name="CHORUS"></a>
1930
1850
 
1931
- ## ALBUM : <code>string</code>
1932
- <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>
1933
1854
 
1934
1855
  **Kind**: global constant
1935
- <a name="VERSE"></a>
1856
+ <a name="CHORD_STYLE"></a>
1936
1857
 
1937
- ## VERSE : <code>string</code>
1938
- <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>
1939
1861
 
1940
1862
  **Kind**: global constant
1863
+ **See**: https://github.com/bettermusic/ChordSheetJS/issues/352
1941
1864
  <a name="VERSE"></a>
1942
1865
 
1943
1866
  ## VERSE : <code>string</code>
1944
- <p>Used to mark a paragraph as chorus</p>
1867
+ <p>Used to mark a paragraph as verse</p>
1945
1868
 
1946
1869
  **Kind**: global constant
1947
1870
  <a name="CHORUS"></a>
1948
1871
 
1949
1872
  ## CHORUS : <code>string</code>
1950
- <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>
1951
1874
 
1952
1875
  **Kind**: global constant
1953
1876
  <a name="NONE"></a>
1954
1877
 
1955
1878
  ## NONE : <code>string</code>
1956
- <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>
1957
1880
 
1958
1881
  **Kind**: global constant
1959
1882
  <a name="INDETERMINATE"></a>
1960
1883
 
1961
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>
1962
1891
  <p>Used to mark a paragraph as tab</p>
1963
1892
 
1964
1893
  **Kind**: global constant