chordsheetjs 8.4.1 → 8.5.1

package/README.md

@@ -473,6 +473,8 @@ Inherits from [ChordSheetParser](#ChordSheetParser)</p></dd>
 <dd><p>End of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/</p></dd>
 <dt><a href="#END_OF_CHORUS">END_OF_CHORUS</a> : <code>string</code></dt>
 <dd><p>End of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
+<dt><a href="#END_OF_GRID">END_OF_GRID</a> : <code>string</code></dt>
+<dd><p>End of grid directive. See https://www.chordpro.org/chordpro/directives-env_grid/</p></dd>
 <dt><a href="#END_OF_TAB">END_OF_TAB</a> : <code>string</code></dt>
 <dd><p>End of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/</p></dd>
 <dt><a href="#END_OF_VERSE">END_OF_VERSE</a> : <code>string</code></dt>
@@ -488,6 +490,8 @@ See https://www.chordpro.org/chordpro/directives-key/</p></dd>
 <dd><p>Start of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/</p></dd>
 <dt><a href="#START_OF_CHORUS">START_OF_CHORUS</a> : <code>string</code></dt>
 <dd><p>Start of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
+<dt><a href="#START_OF_GRID">START_OF_GRID</a> : <code>string</code></dt>
+<dd><p>Start of grid directive. See https://www.chordpro.org/chordpro/directives-env_grid/</p></dd>
 <dt><a href="#START_OF_TAB">START_OF_TAB</a> : <code>string</code></dt>
 <dd><p>Start of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/</p></dd>
 <dt><a href="#START_OF_VERSE">START_OF_VERSE</a> : <code>string</code></dt>
@@ -529,17 +533,21 @@ See https://www.chordpro.org/chordpro/directives-key/</p></dd>
 See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
 <dt><a href="#CHORD_STYLE">CHORD_STYLE</a> : <code>string</code></dt>
 <dd><p>Chord type directive. Determines the type of chords used in the rendered chord sheet.
-Possible values are 'symbol', 'numeral' and 'number'</p></dd>
-<dt><a href="#VERSE">VERSE</a> : <code>string</code></dt>
-<dd><p>Used to mark a paragraph as verse</p></dd>
+Possible values are 'solfege', 'symbol', 'numeral' and 'number'</p></dd>
+<dt><a href="#BRIDGE">BRIDGE</a> : <code>string</code></dt>
+<dd><p>Used to mark a paragraph as bridge</p></dd>
 <dt><a href="#CHORUS">CHORUS</a> : <code>string</code></dt>
 <dd><p>Used to mark a paragraph as chorus</p></dd>
-<dt><a href="#NONE">NONE</a> : <code>string</code></dt>
-<dd><p>Used to mark a paragraph as not containing a line marked with a type</p></dd>
+<dt><a href="#GRID">GRID</a> : <code>string</code></dt>
+<dd><p>Used to mark a paragraph as grid</p></dd>
 <dt><a href="#INDETERMINATE">INDETERMINATE</a> : <code>string</code></dt>
 <dd><p>Used to mark a paragraph as containing lines with both verse and chorus type</p></dd>
+<dt><a href="#NONE">NONE</a> : <code>string</code></dt>
+<dd><p>Used to mark a paragraph as not containing a line marked with a type</p></dd>
 <dt><a href="#TAB">TAB</a> : <code>string</code></dt>
 <dd><p>Used to mark a paragraph as tab</p></dd>
+<dt><a href="#VERSE">VERSE</a> : <code>string</code></dt>
+<dd><p>Used to mark a paragraph as verse</p></dd>
 </dl>
 
 ## Functions
@@ -639,8 +647,11 @@ Possible values are 'symbol', 'numeral' and 'number'</p></dd>
     * [.addItem(item)](#Line+addItem)
     * [.hasRenderableItems()](#Line+hasRenderableItems) ⇒ <code>boolean</code>
     * [.clone()](#Line+clone) ⇒ [<code>Line</code>](#Line)
-    * [.isVerse()](#Line+isVerse) ⇒ <code>boolean</code>
+    * [.isBridge()](#Line+isBridge) ⇒ <code>boolean</code>
     * [.isChorus()](#Line+isChorus) ⇒ <code>boolean</code>
+    * [.isGrid()](#Line+isGrid) ⇒ <code>boolean</code>
+    * [.isTab()](#Line+isTab) ⇒ <code>boolean</code>
+    * [.isVerse()](#Line+isVerse) ⇒ <code>boolean</code>
     * ~~[.hasContent()](#Line+hasContent) ⇒ <code>boolean</code>~~
 
 <a name="Line+isEmpty"></a>
@@ -672,10 +683,10 @@ Possible values are 'symbol', 'numeral' and 'number'</p></dd>
 <p>Returns a deep copy of the line and all of its items</p>
 
 **Kind**: instance method of [<code>Line</code>](#Line)  
-<a name="Line+isVerse"></a>
+<a name="Line+isBridge"></a>
 
-### line.isVerse() ⇒ <code>boolean</code>
-<p>Indicates whether the line type is [VERSE](#VERSE)</p>
+### line.isBridge() ⇒ <code>boolean</code>
+<p>Indicates whether the line type is [BRIDGE](#BRIDGE)</p>
 
 **Kind**: instance method of [<code>Line</code>](#Line)  
 <a name="Line+isChorus"></a>
@@ -683,6 +694,24 @@ Possible values are 'symbol', 'numeral' and 'number'</p></dd>
 ### line.isChorus() ⇒ <code>boolean</code>
 <p>Indicates whether the line type is [CHORUS](#CHORUS)</p>
 
+**Kind**: instance method of [<code>Line</code>](#Line)  
+<a name="Line+isGrid"></a>
+
+### line.isGrid() ⇒ <code>boolean</code>
+<p>Indicates whether the line type is [GRID](#GRID)</p>
+
+**Kind**: instance method of [<code>Line</code>](#Line)  
+<a name="Line+isTab"></a>
+
+### line.isTab() ⇒ <code>boolean</code>
+<p>Indicates whether the line type is [TAB](#TAB)</p>
+
+**Kind**: instance method of [<code>Line</code>](#Line)  
+<a name="Line+isVerse"></a>
+
+### line.isVerse() ⇒ <code>boolean</code>
+<p>Indicates whether the line type is [VERSE](#VERSE)</p>
+
 **Kind**: instance method of [<code>Line</code>](#Line)  
 <a name="Line+hasContent"></a>
 
@@ -1376,6 +1405,9 @@ Inherits from [ChordSheetParser](#ChordSheetParser)</p>
         * [.toChordSymbol([referenceKey])](#Chord+toChordSymbol) ⇒ [<code>Chord</code>](#Chord)
         * [.toChordSymbolString([referenceKey])](#Chord+toChordSymbolString) ⇒ <code>string</code>
         * [.isChordSymbol()](#Chord+isChordSymbol) ⇒ <code>boolean</code>
+        * [.toChordSolfege([referenceKey])](#Chord+toChordSolfege) ⇒ [<code>Chord</code>](#Chord)
+        * [.toChordSolfegeString([referenceKey])](#Chord+toChordSolfegeString) ⇒ <code>string</code>
+        * [.isChordSolfege()](#Chord+isChordSolfege) ⇒ <code>boolean</code>
         * [.toNumeric([referenceKey])](#Chord+toNumeric) ⇒ [<code>Chord</code>](#Chord)
         * [.toNumeral([referenceKey])](#Chord+toNumeral) ⇒ [<code>Chord</code>](#Chord)
         * [.toNumeralString([referenceKey])](#Chord+toNumeralString) ⇒ <code>string</code>
@@ -1431,6 +1463,41 @@ When the chord is already a chord symbol, it will return a string version of the
 ### chord.isChordSymbol() ⇒ <code>boolean</code>
 <p>Determines whether the chord is a chord symbol</p>
 
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+<a name="Chord+toChordSolfege"></a>
+
+### chord.toChordSolfege([referenceKey]) ⇒ [<code>Chord</code>](#Chord)
+<p>Converts the chord to a chord solfege, using the supplied key as a reference.
+For example, a numeric chord <code>#4</code> with reference key <code>Mi</code> will return the chord symbol <code>La#</code>.
+When the chord is already a chord solfege, it will return a clone of the object.</p>
+
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: [<code>Chord</code>](#Chord) - <p>the chord solfege</p>  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [referenceKey] | [<code>Key</code>](#Key) \| <code>string</code> \| <code>null</code> | <code></code> | <p>the reference key. The key is required when converting a numeric or numeral.</p> |
+
+<a name="Chord+toChordSolfegeString"></a>
+
+### chord.toChordSolfegeString([referenceKey]) ⇒ <code>string</code>
+<p>Converts the chord to a chord solfege string, using the supplied key as a reference.
+For example, a numeric chord <code>#4</code> with reference key <code>E</code> will return the chord solfege <code>A#</code>.
+When the chord is already a chord solfege, it will return a string version of the chord.</p>
+
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: <code>string</code> - <p>the chord solfege string</p>  
+**See**: {toChordSolfege}  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [referenceKey] | [<code>Key</code>](#Key) \| <code>string</code> \| <code>null</code> | <code></code> | <p>the reference key. The key is required when converting a numeric or numeral.</p> |
+
+<a name="Chord+isChordSolfege"></a>
+
+### chord.isChordSolfege() ⇒ <code>boolean</code>
+<p>Determines whether the chord is a chord solfege</p>
+
 **Kind**: instance method of [<code>Chord</code>](#Chord)  
 <a name="Chord+toNumeric"></a>
 
@@ -1516,6 +1583,10 @@ For example, a chord symbol A# with reference key E will return the numeric chor
 ### chord.normalize([key], [options]) ⇒ [<code>Chord</code>](#Chord)
 <p>Normalizes the chord root and bass notes:</p>
 <ul>
+<li>Fab becomes Mi</li>
+<li>Dob becomes Si</li>
+<li>Si# becomes Do</li>
+<li>Mi# becomes Fa</li>
 <li>Fb becomes E</li>
 <li>Cb becomes B</li>
 <li>B# becomes C</li>
@@ -1694,6 +1765,12 @@ Can be deserialized using [deserialize](deserialize)</p>
 ## END\_OF\_CHORUS : <code>string</code>
 <p>End of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/</p>
 
+**Kind**: global constant  
+<a name="END_OF_GRID"></a>
+
+## END\_OF\_GRID : <code>string</code>
+<p>End of grid directive. See https://www.chordpro.org/chordpro/directives-env_grid/</p>
+
 **Kind**: global constant  
 <a name="END_OF_TAB"></a>
 
@@ -1737,6 +1814,12 @@ See https://www.chordpro.org/chordpro/directives-key/</p>
 ## START\_OF\_CHORUS : <code>string</code>
 <p>Start of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/</p>
 
+**Kind**: global constant  
+<a name="START_OF_GRID"></a>
+
+## START\_OF\_GRID : <code>string</code>
+<p>Start of grid directive. See https://www.chordpro.org/chordpro/directives-env_grid/</p>
+
 **Kind**: global constant  
 <a name="START_OF_TAB"></a>
 
@@ -1857,14 +1940,14 @@ See https://www.chordpro.org/chordpro/directives-env_chorus/</p>
 
 ## CHORD\_STYLE : <code>string</code>
 <p>Chord type directive. Determines the type of chords used in the rendered chord sheet.
-Possible values are 'symbol', 'numeral' and 'number'</p>
+Possible values are 'solfege', 'symbol', 'numeral' and 'number'</p>
 
 **Kind**: global constant  
 **See**: https://github.com/bettermusic/ChordSheetJS/issues/352  
-<a name="VERSE"></a>
+<a name="BRIDGE"></a>
 
-## VERSE : <code>string</code>
-<p>Used to mark a paragraph as verse</p>
+## BRIDGE : <code>string</code>
+<p>Used to mark a paragraph as bridge</p>
 
 **Kind**: global constant  
 <a name="CHORUS"></a>
@@ -1873,10 +1956,10 @@ Possible values are 'symbol', 'numeral' and 'number'</p>
 <p>Used to mark a paragraph as chorus</p>
 
 **Kind**: global constant  
-<a name="NONE"></a>
+<a name="GRID"></a>
 
-## NONE : <code>string</code>
-<p>Used to mark a paragraph as not containing a line marked with a type</p>
+## GRID : <code>string</code>
+<p>Used to mark a paragraph as grid</p>
 
 **Kind**: global constant  
 <a name="INDETERMINATE"></a>
@@ -1884,12 +1967,24 @@ Possible values are 'symbol', 'numeral' and 'number'</p>
 ## INDETERMINATE : <code>string</code>
 <p>Used to mark a paragraph as containing lines with both verse and chorus type</p>
 
+**Kind**: global constant  
+<a name="NONE"></a>
+
+## NONE : <code>string</code>
+<p>Used to mark a paragraph as not containing a line marked with a type</p>
+
 **Kind**: global constant  
 <a name="TAB"></a>
 
 ## TAB : <code>string</code>
 <p>Used to mark a paragraph as tab</p>
 
+**Kind**: global constant  
+<a name="VERSE"></a>
+
+## VERSE : <code>string</code>
+<p>Used to mark a paragraph as verse</p>
+
 **Kind**: global constant  
 <a name="scopedCss"></a>