diff --git a/README.md b/README.md index cbb95fd7..afb127df 100644 --- a/README.md +++ b/README.md @@ -732,6 +732,375 @@ subject to breaking changes between major versions. +**chordsheetjs** + +*** + +# ChordSheetJS [![Code Climate](https://codeclimate.com/github/martijnversluis/ChordSheetJS/badges/gpa.svg)](https://codeclimate.com/github/martijnversluis/ChordSheetJS) [![CI](https://github.com/martijnversluis/ChordSheetJS/actions/workflows/ci.yml/badge.svg)](https://github.com/martijnversluis/ChordSheetJS/actions/workflows/ci.yml?query=branch%3Amaster) [![Release](https://github.com/martijnversluis/ChordSheetJS/actions/workflows/release.yml/badge.svg)](https://github.com/martijnversluis/ChordSheetJS/actions/workflows/release.yml) + +A JavaScript library for parsing and formatting chord sheets + +**Contents** + +- [Installation](#installation) +- [How to ...?](#how-to-) +- [Supported ChordPro directives](#supported-chordpro-directives) +- [API docs](#api-docs) +- [Contributing](#_mediacontributingmd) + +## Installation + +### Package managers + +`ChordSheetJS` is on npm, to install run: + +```bash +npm install chordsheetjs +``` + +Load with `import`: + +```javascript +import ChordSheetJS from 'chordsheetjs'; +``` + +or `require()`: + +```javascript +var ChordSheetJS = require('chordsheetjs').default; +``` + +### Standalone bundle file + +If you're not using a build tool, you can download and use the `bundle.js` from the +[latest release](https://github.com/martijnversluis/ChordSheetJS/releases/latest): + +```html + + +``` + +## How to ...? + +### Parse chord sheet + +#### Regular chord sheets + +```javascript +const chordSheet = ` + Am C/G F C +Let it be, let it be, let it be, let it be +C G F C/E Dm C +Whisper words of wisdom, let it be`.substring(1); + +const parser = new ChordSheetJS.ChordsOverWordsParser(); +const song = parser.parse(chordSheet); +``` + +#### Ultimate Guitar chord sheets + +```javascript +const chordSheet = ` +[Chorus] + Am C/G F C +Let it be, let it be, let it be, let it be +C G F C/E Dm C +Whisper words of wisdom, let it be`.substring(1); + +const parser = new ChordSheetJS.UltimateGuitarParser(); +const song = parser.parse(chordSheet); +``` + +#### Chord pro format + +```javascript +const chordSheet = ` +{title: Let it be} +{subtitle: ChordSheetJS example version} + +{start_of_chorus: Chorus} +Let it [Am]be, let it [C/G]be, let it [F]be, let it [C]be +[C]Whisper words of [G]wisdom, let it [F]be [C/E] [Dm] [C] +{end_of_chorus}`.substring(1); + +const parser = new ChordSheetJS.ChordProParser(); +const song = parser.parse(chordSheet); +``` + +### Display a parsed sheet + +#### Plain text format + +```javascript +const formatter = new ChordSheetJS.TextFormatter(); +const disp = formatter.format(song); +``` + +#### HTML format + +##### Table-based layout + +```javascript +const formatter = new ChordSheetJS.HtmlTableFormatter(); +const disp = formatter.format(song); +``` + +##### Div-based layout + +```javascript +const formatter = new ChordSheetJS.HtmlDivFormatter(); +const disp = formatter.format(song); +``` + +#### Chord pro format + +```javascript +const formatter = new ChordSheetJS.ChordProFormatter(); +const disp = formatter.format(song); +``` + +### Serialize/deserialize + +Chord sheets (`Song`s) can be serialized to plain JavaScript objects, which can be converted to JSON, XML etc by +third-party libraries. The serialized object can also be deserialized back into a `Song`. + +```javascript +const serializedSong = new ChordSheetSerializer().serialize(song); +const deserialized = new ChordSheetSerializer().deserialize(serializedSong); +``` + +### Add styling + +The HTML formatters (HtmlTableFormatter and HtmlDivFormatter) can provide basic CSS to help with styling the output: + +```javascript +HtmlTableFormatter.cssString(); +// .paragraph { +// margin-bottom: 1em; +// } + +HtmlTableFormatter.cssString('.chordSheetViewer'); +// .chordSheetViewer .paragraph { +// margin-bottom: 1em; +// } + +HtmlTableFormatter.cssObject(); +// '.paragraph': { +// marginBottom: '1em' +// } +``` + +### Parsing and modifying chords + +```javascript +import { Chord } from 'chordsheetjs'; +``` + +#### Parse + +```javascript +const chord = Chord.parse('Ebsus4/Bb'); +``` + +Parse numeric chords (Nashville system): + +```javascript +const chord = Chord.parse('b1sus4/#3'); +``` + +#### Display with #toString + +Use #toString() to convert the chord to a chord string (eg Dsus/F#) + +```javascript +const chord = Chord.parse('Ebsus4/Bb'); +chord.toString(); // --> "Ebsus4/Bb" +``` + +#### Clone + +```javascript +var chord2 = chord.clone(); +``` + +#### Normalize + +Normalizes keys B#, E#, Cb and Fb to C, F, B and E + +```javascript +const chord = Chord.parse('E#/B#'); +normalizedChord = chord.normalize(); +normalizedChord.toString(); // --> "F/C" +``` + +#### ~~Switch modifier~~ + +***Deprecated*** + +Convert # to b and vice versa + +```javascript +const chord = parseChord('Eb/Bb'); +const chord2 = chord.switchModifier(); +chord2.toString(); // --> "D#/A#" +``` + +#### Use specific modifier + +Set the chord to a specific modifier (# or b) + +```javascript +const chord = Chord.parse('Eb/Bb'); +const chord2 = chord.useModifier('#'); +chord2.toString(); // --> "D#/A#" +``` + +```javascript +const chord = Chord.parse('Eb/Bb'); +const chord2 = chord.useModifier('b'); +chord2.toString(); // --> "Eb/Bb" +``` + +#### Transpose up + +```javascript +const chord = Chord.parse('Eb/Bb'); +const chord2 = chord.transposeUp(); +chord2.toString(); // -> "E/B" +``` + +#### Transpose down + +```javascript +const chord = Chord.parse('Eb/Bb'); +const chord2 = chord.transposeDown(); +chord2.toString(); // -> "D/A" +``` + +#### Transpose + +```javascript +const chord = Chord.parse('C/E'); +const chord2 = chord.transpose(4); +chord2.toString(); // -> "E/G#" +``` + +```javascript +const chord = Chord.parse('C/E'); +const chord2 = chord.transpose(-4); +chord2.toString(); // -> "Ab/C" +``` + +#### Convert numeric chord to chord symbol + +```javascript +const numericChord = Chord.parse('2/4'); +const chordSymbol = numericChord.toChordSymbol('E'); +chordSymbol.toString(); // -> "F#/A" +``` + +## Supported ChordPro directives + +All directives are parsed and are added to `Song.metadata`. The list below indicates whether formatters actually +use those to change the generated output. + +:heavy_check_mark: = supported + +:clock2: = will be supported in a future version + +:heavy_multiplication_x: = currently no plans to support it in the near future + +### Meta-data directives + +| Directive | Support | +|:---------------- |:------------------:| +| title (short: t) | :heavy_check_mark: | +| subtitle | :heavy_check_mark: | +| artist | :heavy_check_mark: | +| composer | :heavy_check_mark: | +| lyricist | :heavy_check_mark: | +| copyright | :heavy_check_mark: | +| album | :heavy_check_mark: | +| year | :heavy_check_mark: | +| key | :heavy_check_mark: | +| time | :heavy_check_mark: | +| tempo | :heavy_check_mark: | +| duration | :heavy_check_mark: | +| capo | :heavy_check_mark: | +| meta | :heavy_check_mark: | + +### Formatting directives + +| Directive | Support | +|:-------------------------- |:------------------------:| +| comment (short: c) | :heavy_check_mark: | +| comment_italic (short: ci) | :heavy_multiplication_x: | +| comment_box (short: cb) | :heavy_multiplication_x: | +| chorus | :heavy_multiplication_x: | +| image | :heavy_multiplication_x: | + +### Environment directives + +| Directive | Support | +|:---------------------------- |:------------------:| +| start_of_chorus (short: soc) | :heavy_check_mark: | +| end_of_chorus (short: eoc) | :heavy_check_mark: | +| start_of_verse | :heavy_check_mark: | +| end_of_verse | :heavy_check_mark: | +| start_of_tab (short: sot) | :heavy_check_mark: | +| end_of_tab (short: eot) | :heavy_check_mark: | +| start_of_grid | :heavy_check_mark: | +| end_of_grid | :heavy_check_mark: | + +### Chord diagrams + +| Directive | Support | +|:--------- |:------------------:| +| define | :heavy_check_mark: | +| chord | :heavy_check_mark: | + +### Fonts, sizes and colours + +| Directive | Support | +|:----------- |:------------------------:| +| textfont | :heavy_check_mark: | +| textsize | :heavy_check_mark: | +| textcolour | :heavy_check_mark: | +| chordfont | :heavy_check_mark: | +| chordsize | :heavy_check_mark: | +| chordcolour | :heavy_check_mark: | +| tabfont | :heavy_multiplication_x: | +| tabsize | :heavy_multiplication_x: | +| tabcolour | :heavy_multiplication_x: | + +### Output related directives + +| Directive | Support | +|:------------------------------ |:------------------------:| +| new_page (short: np) | :heavy_multiplication_x: | +| new_physical_page (short: npp) | :heavy_multiplication_x: | +| column_break (short: cb) | :heavy_multiplication_x: | +| grid (short: g) | :heavy_multiplication_x: | +| no_grid (short: ng) | :heavy_multiplication_x: | +| titles | :heavy_multiplication_x: | +| columns (short: col) | :heavy_multiplication_x: | + +### Custom extensions + +| Directive | Support | +|:--------- |:------------------:| +| x_ | :heavy_check_mark: | + +## API docs + +Note: all classes, methods and constants that are documented here can be considered public API and will only be +subject to breaking changes between major versions. + + + **chordsheetjs** • [**Docs**](#globalsmd) *** @@ -24002,16 +24371,9118 @@ Used to mark a paragraph as verse [template\_helpers.ts:98](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/template_helpers.ts#L98) -# Classes +# Classes + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / Chord + +## Class: Chord + +Represents a Chord, consisting of a root, suffix (quality) and bass + +### Implements + +- `ChordProperties` + +### Constructors + +#### new Chord() + +> **new Chord**(`__namedParameters`): [`Chord`](#classeschordmd) + +##### Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.base?**: `null` \| `string` \| `number` = `null` + +• **\_\_namedParameters.bass?**: `null` \| [`Key`](#classeskeymd) = `null` + +• **\_\_namedParameters.bassBase?**: `null` \| `string` \| `number` = `null` + +• **\_\_namedParameters.bassModifier?**: `null` \| `Modifier` = `null` + +• **\_\_namedParameters.chordType?**: `null` \| `ChordType` = `null` + +• **\_\_namedParameters.modifier?**: `null` \| `Modifier` = `null` + +• **\_\_namedParameters.root?**: `null` \| [`Key`](#classeskeymd) = `null` + +• **\_\_namedParameters.suffix?**: `null` \| `string` = `null` + +##### Returns + +[`Chord`](#classeschordmd) + +##### Defined in + +[chord.ts:344](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L344) + +### Properties + +#### bass + +> **bass**: `null` \| [`Key`](#classeskeymd) + +##### Implementation of + +`ChordProperties.bass` + +##### Defined in + +[chord.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L24) + +*** + +#### root + +> **root**: `null` \| [`Key`](#classeskeymd) + +##### Implementation of + +`ChordProperties.root` + +##### Defined in + +[chord.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L26) + +*** + +#### suffix + +> **suffix**: `null` \| `string` + +##### Implementation of + +`ChordProperties.suffix` + +##### Defined in + +[chord.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L28) + +### Methods + +#### clone() + +> **clone**(): [`Chord`](#classeschordmd) + +Returns a deep copy of the chord + +##### Returns + +[`Chord`](#classeschordmd) + +##### Defined in + +[chord.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L60) + +*** + +#### equals() + +> **equals**(`otherChord`): `boolean` + +##### Parameters + +• **otherChord**: [`Chord`](#classeschordmd) + +##### Returns + +`boolean` + +##### Defined in + +[chord.ts:374](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L374) + +*** + +#### isChordSolfege() + +> **isChordSolfege**(): `boolean` + +Determines whether the chord is a chord solfege + +##### Returns + +`boolean` + +##### Defined in + +[chord.ts:160](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L160) + +*** + +#### isChordSymbol() + +> **isChordSymbol**(): `boolean` + +Determines whether the chord is a chord symbol + +##### Returns + +`boolean` + +##### Defined in + +[chord.ts:110](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L110) + +*** + +#### isMinor() + +> **isMinor**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[chord.ts:432](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L432) + +*** + +#### isNumeral() + +> **isNumeral**(): `boolean` + +Determines whether the chord is a numeral + +##### Returns + +`boolean` + +##### Defined in + +[chord.ts:246](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L246) + +*** + +#### isNumeric() + +> **isNumeric**(): `boolean` + +Determines whether the chord is numeric + +##### Returns + +`boolean` + +##### Defined in + +[chord.ts:227](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L227) + +*** + +#### makeMinor() + +> **makeMinor**(): [`Chord`](#classeschordmd) + +##### Returns + +[`Chord`](#classeschordmd) + +##### Defined in + +[chord.ts:436](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L436) + +*** + +#### normalize() + +> **normalize**(`key`?, `options`?): [`Chord`](#classeschordmd) + +Normalizes the chord root and bass notes: +- Fab becomes Mi +- Dob becomes Si +- Si# becomes Do +- Mi# becomes Fa +- Fb becomes E +- Cb becomes B +- B# becomes C +- E# becomes F +- 4b becomes 3 +- 1b becomes 7 +- 7# becomes 1 +- 3# becomes 4 + +Besides that it normalizes the suffix if `normalizeSuffix` is `true`. +For example, `sus2` becomes `2`, `sus4` becomes `sus`. +All suffix normalizations can be found in `src/normalize_mappings/suffix-mapping.txt`. + +When the chord is minor, bass notes are normalized off of the relative major +of the root note. For example, `Em/A#` becomes `Em/Bb`. + +##### Parameters + +• **key?**: `null` \| `string` \| [`Key`](#classeskeymd) = `null` + +the key to normalize to + +• **options?** = `{}` + +options + +• **options.normalizeSuffix?**: `undefined` \| `boolean` = `true` + +whether to normalize the chord suffix after transposing + +##### Returns + +[`Chord`](#classeschordmd) + +the normalized chord + +##### Defined in + +[chord.ts:294](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L294) + +*** + +#### set() + +> **set**(`properties`): [`Chord`](#classeschordmd) + +##### Parameters + +• **properties**: `ChordProperties` + +##### Returns + +[`Chord`](#classeschordmd) + +##### Defined in + +[chord.ts:442](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L442) + +*** + +#### toChordSolfege() + +> **toChordSolfege**(`referenceKey`?): [`Chord`](#classeschordmd) + +Converts the chord to a chord solfege, using the supplied key as a reference. +For example, a numeric chord `#4` with reference key `Mi` will return the chord symbol `La#`. +When the chord is already a chord solfege, it will return a clone of the object. + +##### Parameters + +• **referenceKey?**: `null` \| `string` \| [`Key`](#classeskeymd) = `null` + +the reference key. The key is required when converting a +numeric or numeral. + +##### Returns + +[`Chord`](#classeschordmd) + +the chord solfege + +##### Defined in + +[chord.ts:122](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L122) + +*** + +#### toChordSolfegeString() + +> **toChordSolfegeString**(`referenceKey`?): `string` + +Converts the chord to a chord solfege string, using the supplied key as a reference. +For example, a numeric chord `#4` with reference key `E` will return the chord solfege `A#`. +When the chord is already a chord solfege, it will return a string version of the chord. + +##### Parameters + +• **referenceKey?**: `null` \| `string` \| [`Key`](#classeskeymd) = `null` + +the reference key. The key is required when converting a +numeric or numeral. + +##### Returns + +`string` + +the chord solfege string + +##### See + +##### Defined in + +[chord.ts:152](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L152) + +*** + +#### toChordSymbol() + +> **toChordSymbol**(`referenceKey`?): [`Chord`](#classeschordmd) + +Converts the chord to a chord symbol, using the supplied key as a reference. +For example, a numeric chord `#4` with reference key `E` will return the chord symbol `A#`. +When the chord is already a chord symbol, it will return a clone of the object. + +##### Parameters + +• **referenceKey?**: `null` \| `string` \| [`Key`](#classeskeymd) = `null` + +the reference key. The key is required when converting a +numeric or numeral. + +##### Returns + +[`Chord`](#classeschordmd) + +the chord symbol + +##### Defined in + +[chord.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L72) + +*** + +#### toChordSymbolString() + +> **toChordSymbolString**(`referenceKey`?): `string` + +Converts the chord to a chord symbol string, using the supplied key as a reference. +For example, a numeric chord `#4` with reference key `E` will return the chord symbol `A#`. +When the chord is already a chord symbol, it will return a string version of the chord. + +##### Parameters + +• **referenceKey?**: `null` \| `string` \| [`Key`](#classeskeymd) = `null` + +the reference key. The key is required when converting a +numeric or numeral. + +##### Returns + +`string` + +the chord symbol string + +##### See + +##### Defined in + +[chord.ts:102](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L102) + +*** + +#### toNumeral() + +> **toNumeral**(`referenceKey`?): [`Chord`](#classeschordmd) + +Converts the chord to a numeral chord, using the supplied key as a reference. +For example, a chord symbol A# with reference key E will return the numeral chord #IV. + +##### Parameters + +• **referenceKey?**: `null` \| `string` \| [`Key`](#classeskeymd) = `null` + +the reference key. The key is required when converting a chord symbol + +##### Returns + +[`Chord`](#classeschordmd) + +the numeral chord + +##### Defined in + +[chord.ts:194](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L194) + +*** + +#### toNumeralString() + +> **toNumeralString**(`referenceKey`?): `string` + +Converts the chord to a numeral chord string, using the supplied kye as a reference. +For example, a chord symbol A# with reference key E will return the numeral chord #4. + +##### Parameters + +• **referenceKey?**: `null` \| `string` \| [`Key`](#classeskeymd) = `null` + +the reference key. The key is required when converting a chord symbol + +##### Returns + +`string` + +the numeral chord string + +##### See + +##### Defined in + +[chord.ts:219](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L219) + +*** + +#### toNumeric() + +> **toNumeric**(`referenceKey`?): [`Chord`](#classeschordmd) + +Converts the chord to a numeric chord, using the supplied key as a reference. +For example, a chord symbol A# with reference key E will return the numeric chord #4. + +##### Parameters + +• **referenceKey?**: `null` \| `string` \| [`Key`](#classeskeymd) = `null` + +the reference key. The key is required when converting a chord symbol + +##### Returns + +[`Chord`](#classeschordmd) + +the numeric chord + +##### Defined in + +[chord.ts:170](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L170) + +*** + +#### toNumericString() + +> **toNumericString**(`referenceKey`?): `string` + +Converts the chord to a numeric chord string, using the supplied kye as a reference. +For example, a chord symbol A# with reference key E will return the numeric chord #4. + +##### Parameters + +• **referenceKey?**: `null` \| `string` \| [`Key`](#classeskeymd) = `null` + +the reference key. The key is required when converting a chord symbol + +##### Returns + +`string` + +the numeric chord string + +##### See + +##### Defined in + +[chord.ts:238](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L238) + +*** + +#### toString() + +> **toString**(`configuration`?): `string` + +Converts the chord to a string, eg `Esus4/G#` or `1sus4/#3` + +##### Parameters + +• **configuration?** = `{}` + +options + +• **configuration.useUnicodeModifier?**: `undefined` \| `boolean` = `false` + +Whether or not to use unicode modifiers. +This will make `#` (sharp) look like `♯` and `b` (flat) look like `♭` + +##### Returns + +`string` + +the chord string + +##### Defined in + +[chord.ts:257](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L257) + +*** + +#### transpose() + +> **transpose**(`delta`): [`Chord`](#classeschordmd) + +Transposes the chord by the specified number of semitones + +##### Parameters + +• **delta**: `number` + +de number of semitones + +##### Returns + +[`Chord`](#classeschordmd) + +the new, transposed chord + +##### Defined in + +[chord.ts:340](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L340) + +*** + +#### transposeDown() + +> **transposeDown**(): [`Chord`](#classeschordmd) + +Transposes the chord down by 1 semitone. Eg. A# becomes A, E becomes Eb + +##### Returns + +[`Chord`](#classeschordmd) + +the new, transposed chord + +##### Defined in + +[chord.ts:331](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L331) + +*** + +#### transposeUp() + +> **transposeUp**(): [`Chord`](#classeschordmd) + +Transposes the chord up by 1 semitone. Eg. A becomes A#, Eb becomes E + +##### Returns + +[`Chord`](#classeschordmd) + +the new, transposed chord + +##### Defined in + +[chord.ts:323](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L323) + +*** + +#### useModifier() + +> **useModifier**(`newModifier`): [`Chord`](#classeschordmd) + +Switches to the specified modifier + +##### Parameters + +• **newModifier**: `Modifier` + +the modifier to use: `'#'` or `'b'` + +##### Returns + +[`Chord`](#classeschordmd) + +the new, changed chord + +##### Defined in + +[chord.ts:315](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L315) + +*** + +#### determineBass() + +> `static` **determineBass**(`__namedParameters`): `null` \| [`Key`](#classeskeymd) + +##### Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.bass**: `null` \| [`Key`](#classeskeymd) + +• **\_\_namedParameters.bassBase**: `null` \| `string` \| `number` + +• **\_\_namedParameters.bassModifier**: `null` \| `Modifier` + +• **\_\_namedParameters.chordType**: `null` \| `ChordType` + +##### Returns + +`null` \| [`Key`](#classeskeymd) + +##### Defined in + +[chord.ts:407](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L407) + +*** + +#### determineRoot() + +> `static` **determineRoot**(`__namedParameters`): `null` \| [`Key`](#classeskeymd) + +##### Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.base**: `null` \| `string` \| `number` + +• **\_\_namedParameters.chordType**: `null` \| `ChordType` + +• **\_\_namedParameters.modifier**: `null` \| `Modifier` + +• **\_\_namedParameters.root**: `null` \| [`Key`](#classeskeymd) + +• **\_\_namedParameters.suffix**: `null` \| `string` + +##### Returns + +`null` \| [`Key`](#classeskeymd) + +##### Defined in + +[chord.ts:380](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L380) + +*** + +#### parse() + +> `static` **parse**(`chordString`): `null` \| [`Chord`](#classeschordmd) + +Tries to parse a chord string into a chord +Any leading or trailing whitespace is removed first, so a chord like ` \n E/G# \r ` is valid. + +##### Parameters + +• **chordString**: `string` + +the chord string, eg `Esus4/G#` or `1sus4/#3`. + +##### Returns + +`null` \| [`Chord`](#classeschordmd) + +##### Defined in + +[chord.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L36) + +*** + +#### parseOrFail() + +> `static` **parseOrFail**(`chordString`): [`Chord`](#classeschordmd) + +##### Parameters + +• **chordString**: `string` + +##### Returns + +[`Chord`](#classeschordmd) + +##### Defined in + +[chord.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L44) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / ChordDefinition + +## Class: ChordDefinition + +Represents a chord definition. + +Definitions are made using the `{chord}` or `{define}` directive. +A chord definitions overrides a previous chord definition for the exact same chord. + +### See + + - https://chordpro.org/chordpro/directives-define/ + - https://chordpro.org/chordpro/directives-chord/ + +### Constructors + +#### new ChordDefinition() + +> **new ChordDefinition**(`name`, `baseFret`, `frets`, `fingers`?): [`ChordDefinition`](#classeschorddefinitionmd) + +##### Parameters + +• **name**: `string` + +• **baseFret**: `number` + +• **frets**: `Fret`[] + +• **fingers?**: `number`[] + +##### Returns + +[`ChordDefinition`](#classeschorddefinitionmd) + +##### Defined in + +[chord\_sheet/chord\_pro/chord\_definition.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L48) + +### Properties + +#### baseFret + +> **baseFret**: `number` + +Defines the offset for the chord, which is the position of the topmost finger. +The offset must be 1 or higher. + +##### Defined in + +[chord\_sheet/chord\_pro/chord\_definition.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L25) + +*** + +#### fingers + +> **fingers**: `number`[] + +defines finger settings. This part may be omitted. + +For the frets and the fingers positions, there must be exactly as many positions as there are strings, +which is 6 by default. For the fingers positions, values corresponding to open or damped strings are ignored. +Finger settings may be numeric (0 .. 9) or uppercase letters (A .. Z). +Note that the values -, x, X, and N are used to designate a string without finger setting. + +##### Defined in + +[chord\_sheet/chord\_pro/chord\_definition.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L46) + +*** + +#### frets + +> **frets**: `Fret`[] + +Defines the string positions. +Strings are enumerated from left (lowest) to right (highest), as they appear in the chord diagrams. +Fret positions are relative to the offset minus one, so with base-fret 1 (the default), +the topmost fret position is 1. With base-fret 3, fret position 1 indicates the 3rd position. +`0` (zero) denotes an open string. Use `-1`, `N` or `x` to denote a non-sounding string. + +##### Defined in + +[chord\_sheet/chord\_pro/chord\_definition.ts:35](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L35) + +*** + +#### name + +> **name**: `string` + +The chord name, e.g. `C`, `Dm`, `G7`. + +##### Defined in + +[chord\_sheet/chord\_pro/chord\_definition.ts:18](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L18) + +### Methods + +#### clone() + +> **clone**(): [`ChordDefinition`](#classeschorddefinitionmd) + +##### Returns + +[`ChordDefinition`](#classeschorddefinitionmd) + +##### Defined in + +[chord\_sheet/chord\_pro/chord\_definition.ts:74](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L74) + +*** + +#### parse() + +> `static` **parse**(`chordDefinition`): [`ChordDefinition`](#classeschorddefinitionmd) + +Parses a chord definition in the form of: +- base-fret frets … +- base-fret frets … fingers … + +##### Parameters + +• **chordDefinition**: `string` + +##### Returns + +[`ChordDefinition`](#classeschorddefinitionmd) + +##### See + +https://chordpro.org/chordpro/directives-define/#common-usage + +##### Defined in + +[chord\_sheet/chord\_pro/chord\_definition.ts:63](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L63) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / ChordLyricsPair + +## Class: ChordLyricsPair + +Represents a chord with the corresponding (partial) lyrics + +### Constructors + +#### new ChordLyricsPair() + +> **new ChordLyricsPair**(`chords`, `lyrics`, `annotation`): [`ChordLyricsPair`](#classeschordlyricspairmd) + +Initialises a ChordLyricsPair + +##### Parameters + +• **chords**: `string` = `''` + +The chords + +• **lyrics**: `null` \| `string` = `null` + +The lyrics + +• **annotation**: `null` \| `string` = `null` + +The annotation + +##### Returns + +[`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Defined in + +[chord\_sheet/chord\_lyrics\_pair.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L21) + +### Properties + +#### annotation + +> **annotation**: `null` \| `string` + +##### Defined in + +[chord\_sheet/chord\_lyrics\_pair.ts:13](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L13) + +*** + +#### chords + +> **chords**: `string` + +##### Defined in + +[chord\_sheet/chord\_lyrics\_pair.ts:9](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L9) + +*** + +#### lyrics + +> **lyrics**: `null` \| `string` + +##### Defined in + +[chord\_sheet/chord\_lyrics\_pair.ts:11](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L11) + +### Methods + +#### changeChord() + +> **changeChord**(`func`): [`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Parameters + +• **func** + +##### Returns + +[`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Defined in + +[chord\_sheet/chord\_lyrics\_pair.ts:100](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L100) + +*** + +#### clone() + +> **clone**(): [`ChordLyricsPair`](#classeschordlyricspairmd) + +Returns a deep copy of the ChordLyricsPair, useful when programmatically transforming a song + +##### Returns + +[`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Defined in + +[chord\_sheet/chord\_lyrics\_pair.ts:56](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L56) + +*** + +#### isRenderable() + +> **isRenderable**(): `boolean` + +Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet (except for ChordPro sheets) + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/chord\_lyrics\_pair.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L48) + +*** + +#### set() + +> **set**(`__namedParameters`): [`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.annotation?**: `string` + +• **\_\_namedParameters.chords?**: `string` + +• **\_\_namedParameters.lyrics?**: `string` + +##### Returns + +[`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Defined in + +[chord\_sheet/chord\_lyrics\_pair.ts:64](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L64) + +*** + +#### setAnnotation() + +> **setAnnotation**(`annotation`): [`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Parameters + +• **annotation**: `string` + +##### Returns + +[`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Defined in + +[chord\_sheet/chord\_lyrics\_pair.ts:76](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L76) + +*** + +#### setLyrics() + +> **setLyrics**(`lyrics`): [`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Parameters + +• **lyrics**: `string` + +##### Returns + +[`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Defined in + +[chord\_sheet/chord\_lyrics\_pair.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L72) + +*** + +#### toString() + +> **toString**(): `string` + +##### Returns + +`string` + +##### Defined in + +[chord\_sheet/chord\_lyrics\_pair.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L60) + +*** + +#### transpose() + +> **transpose**(`delta`, `key`, `__namedParameters`): [`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Parameters + +• **delta**: `number` + +• **key**: `null` \| `string` \| [`Key`](#classeskeymd) = `null` + +• **\_\_namedParameters** = `...` + +• **\_\_namedParameters.normalizeChordSuffix**: `boolean` + +##### Returns + +[`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Defined in + +[chord\_sheet/chord\_lyrics\_pair.ts:80](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L80) + +*** + +#### useModifier() + +> **useModifier**(`modifier`): [`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Parameters + +• **modifier**: `Modifier` + +##### Returns + +[`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Defined in + +[chord\_sheet/chord\_lyrics\_pair.ts:96](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L96) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / ChordProFormatter + +## Class: ChordProFormatter + +Formats a song into a ChordPro chord sheet + +### Extends + +- [`Formatter`](#classesformattermd) + +### Constructors + +#### new ChordProFormatter() + +> **new ChordProFormatter**(`configuration`?): [`ChordProFormatter`](#classeschordproformattermd) + +Instantiate + +##### Parameters + +• **configuration?**: `Partial`\<`ConfigurationProperties`\> = `{}` + +options + +##### Returns + +[`ChordProFormatter`](#classeschordproformattermd) + +##### Inherited from + +[`Formatter`](#classesformattermd).[`constructor`](#constructors) + +##### Defined in + +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) + +### Properties + +#### configuration + +> **configuration**: `Configuration` + +##### Inherited from + +[`Formatter`](#classesformattermd).[`configuration`](#configuration) + +##### Defined in + +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) + +### Methods + +#### format() + +> **format**(`song`): `string` + +Formats a song into a ChordPro chord sheet. + +##### Parameters + +• **song**: [`Song`](#classessongmd) + +The song to be formatted + +##### Returns + +`string` + +The ChordPro string + +##### Defined in + +[formatter/chord\_pro\_formatter.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L24) + +*** + +#### formatChordLyricsPair() + +> **formatChordLyricsPair**(`chordLyricsPair`): `string` + +##### Parameters + +• **chordLyricsPair**: [`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chord\_pro\_formatter.ts:132](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L132) + +*** + +#### formatChordLyricsPairChords() + +> **formatChordLyricsPairChords**(`chordLyricsPair`): `string` + +##### Parameters + +• **chordLyricsPair**: [`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chord\_pro\_formatter.ts:139](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L139) + +*** + +#### formatChordLyricsPairLyrics() + +> **formatChordLyricsPairLyrics**(`chordLyricsPair`): `string` + +##### Parameters + +• **chordLyricsPair**: [`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chord\_pro\_formatter.ts:158](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L158) + +*** + +#### formatComment() + +> **formatComment**(`comment`): `string` + +##### Parameters + +• **comment**: [`Comment`](#classescommentmd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chord\_pro\_formatter.ts:162](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L162) + +*** + +#### formatExpression() + +> **formatExpression**(`expression`): `string` + +##### Parameters + +• **expression**: `Evaluatable` + +##### Returns + +`string` + +##### Defined in + +[formatter/chord\_pro\_formatter.ts:112](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L112) + +*** + +#### formatExpressionRange() + +> **formatExpressionRange**(`expressionRange`): `string` + +##### Parameters + +• **expressionRange**: `Evaluatable`[] + +##### Returns + +`string` + +##### Defined in + +[formatter/chord\_pro\_formatter.ts:104](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L104) + +*** + +#### formatItem() + +> **formatItem**(`item`, `metadata`): `string` + +##### Parameters + +• **item**: `Item` + +• **metadata**: [`Metadata`](#classesmetadatamd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chord\_pro\_formatter.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L38) + +*** + +#### formatLine() + +> **formatLine**(`line`, `metadata`): `string` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +• **metadata**: [`Metadata`](#classesmetadatamd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chord\_pro\_formatter.ts:32](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L32) + +*** + +#### formatOrEvaluateItem() + +> **formatOrEvaluateItem**(`item`, `metadata`): `string` + +##### Parameters + +• **item**: `Evaluatable` + +• **metadata**: [`Metadata`](#classesmetadatamd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chord\_pro\_formatter.ts:62](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L62) + +*** + +#### formatTag() + +> **formatTag**(`tag`): `string` + +##### Parameters + +• **tag**: [`Tag`](#classestagmd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chord\_pro\_formatter.ts:124](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L124) + +*** + +#### formatTernary() + +> **formatTernary**(`ternary`): `string` + +##### Parameters + +• **ternary**: [`Ternary`](#classesternarymd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chord\_pro\_formatter.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L78) + +*** + +#### formatValueTest() + +> **formatValueTest**(`valueTest`): `string` + +##### Parameters + +• **valueTest**: `null` \| `string` + +##### Returns + +`string` + +##### Defined in + +[formatter/chord\_pro\_formatter.ts:96](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L96) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / ChordProParser + +## Class: ChordProParser + +Parses a ChordPro chord sheet + +### Constructors + +#### new ChordProParser() + +> **new ChordProParser**(): [`ChordProParser`](#classeschordproparsermd) + +##### Returns + +[`ChordProParser`](#classeschordproparsermd) + +### Properties + +#### song? + +> `optional` **song**: [`Song`](#classessongmd) + +##### Defined in + +[parser/chord\_pro\_parser.ts:16](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_pro_parser.ts#L16) + +### Accessors + +#### warnings + +##### Get Signature + +> **get** **warnings**(): `ParserWarning`[] + +All warnings raised during parsing the chord sheet + +###### Member + +###### Returns + +`ParserWarning`[] + +##### Defined in + +[parser/chord\_pro\_parser.ts:23](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_pro_parser.ts#L23) + +### Methods + +#### parse() + +> **parse**(`chordSheet`, `options`?): [`Song`](#classessongmd) + +Parses a ChordPro chord sheet into a song + +##### Parameters + +• **chordSheet**: `string` + +the ChordPro chord sheet + +• **options?**: `ChordProParserOptions` + +Parser options. + +##### Returns + +[`Song`](#classessongmd) + +The parsed song + +##### See + +https://peggyjs.org/documentation.html#using-the-parser + +##### Defined in + +[parser/chord\_pro\_parser.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_pro_parser.ts#L36) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / ChordSheetParser + +## Class: ChordSheetParser + +Parses a normal chord sheet + +ChordSheetParser is deprecated, please use ChordsOverWordsParser. + +ChordsOverWordsParser aims to support any kind of chord, whereas ChordSheetParser lacks +support for many variations. Besides that, some chordpro feature have been ported back +to ChordsOverWordsParser, which adds some interesting functionality. + +### Extended by + +- [`UltimateGuitarParser`](#classesultimateguitarparsermd) + +### Constructors + +#### new ChordSheetParser() + +> **new ChordSheetParser**(`__namedParameters`?, `showDeprecationWarning`?): [`ChordSheetParser`](#classeschordsheetparsermd) + +Instantiate a chord sheet parser +ChordSheetParser is deprecated, please use ChordsOverWordsParser. + +##### Parameters + +• **\_\_namedParameters?** = `{}` + +• **\_\_namedParameters.preserveWhitespace?**: `boolean` = `true` + +• **showDeprecationWarning?**: `boolean` = `true` + +##### Returns + +[`ChordSheetParser`](#classeschordsheetparsermd) + +##### Deprecated + +##### Defined in + +[parser/chord\_sheet\_parser.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L46) + +### Properties + +#### chordLyricsPair + +> **chordLyricsPair**: `null` \| [`ChordLyricsPair`](#classeschordlyricspairmd) = `null` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:31](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L31) + +*** + +#### currentLine + +> **currentLine**: `number` = `0` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:35](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L35) + +*** + +#### lineCount + +> **lineCount**: `number` = `0` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:37](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L37) + +*** + +#### lines + +> **lines**: `string`[] = `[]` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:33](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L33) + +*** + +#### preserveWhitespace + +> **preserveWhitespace**: `boolean` = `true` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:23](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L23) + +*** + +#### processingText + +> **processingText**: `boolean` = `true` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L21) + +*** + +#### song + +> **song**: [`Song`](#classessongmd) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L25) + +*** + +#### songBuilder + +> **songBuilder**: `SongBuilder` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:27](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L27) + +*** + +#### songLine + +> **songLine**: `null` \| [`Line`](#classeslinemd) = `null` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:29](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L29) + +### Methods + +#### addCharacter() + +> **addCharacter**(`chr`, `nextChar`): `void` + +##### Parameters + +• **chr**: `any` + +• **nextChar**: `any` + +##### Returns + +`void` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:160](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L160) + +*** + +#### endOfSong() + +> **endOfSong**(): `void` + +##### Returns + +`void` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:82](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L82) + +*** + +#### ensureChordLyricsPairInitialized() + +> **ensureChordLyricsPairInitialized**(): `void` + +##### Returns + +`void` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:177](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L177) + +*** + +#### hasNextLine() + +> **hasNextLine**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:124](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L124) + +*** + +#### initialize() + +> **initialize**(`document`, `song`): `void` + +##### Parameters + +• **document**: `any` + +• **song**: `null` \| [`Song`](#classessongmd) = `null` + +##### Returns + +`void` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:107](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L107) + +*** + +#### parse() + +> **parse**(`chordSheet`, `options`?): [`Song`](#classessongmd) + +Parses a chord sheet into a song + +##### Parameters + +• **chordSheet**: `string` + +The ChordPro chord sheet + +• **options?** = `{}` + +Optional parser options + +• **options.song?**: [`Song`](#classessongmd) + +The [Song](#classessongmd) to store the song data in + +##### Returns + +[`Song`](#classessongmd) + +The parsed song + +##### Defined in + +[parser/chord\_sheet\_parser.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L70) + +*** + +#### parseLine() + +> **parseLine**(`line`): `void` + +##### Parameters + +• **line**: `any` + +##### Returns + +`void` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:84](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L84) + +*** + +#### parseLyricsWithChords() + +> **parseLyricsWithChords**(`chordsLine`, `lyricsLine`): `void` + +##### Parameters + +• **chordsLine**: `any` + +• **lyricsLine**: `any` + +##### Returns + +`void` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:128](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L128) + +*** + +#### parseNonEmptyLine() + +> **parseNonEmptyLine**(`line`): `void` + +##### Parameters + +• **line**: `any` + +##### Returns + +`void` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:94](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L94) + +*** + +#### processCharacters() + +> **processCharacters**(`chordsLine`, `lyricsLine`): `void` + +##### Parameters + +• **chordsLine**: `any` + +• **lyricsLine**: `any` + +##### Returns + +`void` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:146](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L146) + +*** + +#### readLine() + +> **readLine**(): `string` + +##### Returns + +`string` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:118](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L118) + +*** + +#### shouldAddCharacterToChords() + +> **shouldAddCharacterToChords**(`nextChar`): `any` + +##### Parameters + +• **nextChar**: `any` + +##### Returns + +`any` + +##### Defined in + +[parser/chord\_sheet\_parser.ts:173](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L173) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / ChordSheetSerializer + +## Class: ChordSheetSerializer + +Serializes a song into een plain object, and deserializes the serialized object back into a [Song](#classessongmd) + +### Constructors + +#### new ChordSheetSerializer() + +> **new ChordSheetSerializer**(): [`ChordSheetSerializer`](#classeschordsheetserializermd) + +##### Returns + +[`ChordSheetSerializer`](#classeschordsheetserializermd) + +### Properties + +#### song + +> **song**: [`Song`](#classessongmd) + +##### Defined in + +[chord\_sheet\_serializer.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L40) + +*** + +#### songBuilder + +> **songBuilder**: `SongBuilder` + +##### Defined in + +[chord\_sheet\_serializer.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L42) + +### Methods + +#### deserialize() + +> **deserialize**(`serializedSong`): [`Song`](#classessongmd) + +Deserializes a song that has been serialized using [serialize](#serialize) + +##### Parameters + +• **serializedSong**: `SerializedSong` + +The serialized song + +##### Returns + +[`Song`](#classessongmd) + +The deserialized song + +##### Defined in + +[chord\_sheet\_serializer.ts:151](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L151) + +*** + +#### parseAstComponent() + +> **parseAstComponent**(`astComponent`): `null` \| [`ChordLyricsPair`](#classeschordlyricspairmd) \| [`Tag`](#classestagmd) \| [`Comment`](#classescommentmd) \| [`Ternary`](#classesternarymd) \| [`Literal`](#classesliteralmd) \| [`SoftLineBreak`](#classessoftlinebreakmd) + +##### Parameters + +• **astComponent**: `SerializedComponent` + +##### Returns + +`null` \| [`ChordLyricsPair`](#classeschordlyricspairmd) \| [`Tag`](#classestagmd) \| [`Comment`](#classescommentmd) \| [`Ternary`](#classesternarymd) \| [`Literal`](#classesliteralmd) \| [`SoftLineBreak`](#classessoftlinebreakmd) + +##### Defined in + +[chord\_sheet\_serializer.ts:156](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L156) + +*** + +#### parseChordLyricsPair() + +> **parseChordLyricsPair**(`astComponent`): [`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Parameters + +• **astComponent**: `SerializedChordLyricsPair` + +##### Returns + +[`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Defined in + +[chord\_sheet\_serializer.ts:201](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L201) + +*** + +#### parseChordSheet() + +> **parseChordSheet**(`astComponent`): `void` + +##### Parameters + +• **astComponent**: `SerializedSong` + +##### Returns + +`void` + +##### Defined in + +[chord\_sheet\_serializer.ts:184](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L184) + +*** + +#### parseComment() + +> **parseComment**(`astComponent`): [`Comment`](#classescommentmd) + +##### Parameters + +• **astComponent**: `SerializedComment` + +##### Returns + +[`Comment`](#classescommentmd) + +##### Defined in + +[chord\_sheet\_serializer.ts:234](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L234) + +*** + +#### parseExpression() + +> **parseExpression**(`expression`): (`null` \| `AstType`)[] + +##### Parameters + +• **expression**: (`string` \| `SerializedTernary`)[] + +##### Returns + +(`null` \| `AstType`)[] + +##### Defined in + +[chord\_sheet\_serializer.ts:259](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L259) + +*** + +#### parseLine() + +> **parseLine**(`astComponent`): `void` + +##### Parameters + +• **astComponent**: `SerializedLine` + +##### Returns + +`void` + +##### Defined in + +[chord\_sheet\_serializer.ts:191](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L191) + +*** + +#### parseTag() + +> **parseTag**(`astComponent`): [`Tag`](#classestagmd) + +##### Parameters + +• **astComponent**: `SerializedTag` + +##### Returns + +[`Tag`](#classestagmd) + +##### Defined in + +[chord\_sheet\_serializer.ts:213](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L213) + +*** + +#### parseTernary() + +> **parseTernary**(`astComponent`): [`Ternary`](#classesternarymd) + +##### Parameters + +• **astComponent**: `SerializedTernary` + +##### Returns + +[`Ternary`](#classesternarymd) + +##### Defined in + +[chord\_sheet\_serializer.ts:239](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L239) + +*** + +#### serialize() + +> **serialize**(`song`): `SerializedSong` + +Serializes the chord sheet to a plain object, which can be converted to any format like JSON, XML etc +Can be deserialized using [deserialize](#deserialize) + +##### Parameters + +• **song**: [`Song`](#classessongmd) + +##### Returns + +`SerializedSong` + +object A plain JS object containing all chord sheet data + +##### Defined in + +[chord\_sheet\_serializer.ts:49](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L49) + +*** + +#### serializeChordDefinition() + +> **serializeChordDefinition**(`chordDefinition`): `SerializedChordDefinition` + +##### Parameters + +• **chordDefinition**: [`ChordDefinition`](#classeschorddefinitionmd) + +##### Returns + +`SerializedChordDefinition` + +##### Defined in + +[chord\_sheet\_serializer.ts:91](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L91) + +*** + +#### serializeChordLyricsPair() + +> **serializeChordLyricsPair**(`chordLyricsPair`): `object` + +##### Parameters + +• **chordLyricsPair**: [`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Returns + +`object` + +###### annotation + +> **annotation**: `null` \| `string` = `chordLyricsPair.annotation` + +###### chord + +> **chord**: `null` = `null` + +###### chords + +> **chords**: `string` = `chordLyricsPair.chords` + +###### lyrics + +> **lyrics**: `null` \| `string` = `chordLyricsPair.lyrics` + +###### type + +> **type**: `string` = `CHORD_LYRICS_PAIR` + +##### Defined in + +[chord\_sheet\_serializer.ts:114](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L114) + +*** + +#### serializeComment() + +> **serializeComment**(`comment`): `SerializedComment` + +##### Parameters + +• **comment**: [`Comment`](#classescommentmd) + +##### Returns + +`SerializedComment` + +##### Defined in + +[chord\_sheet\_serializer.ts:142](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L142) + +*** + +#### serializeExpression() + +> **serializeExpression**(`expression`): `SerializedComponent`[] + +##### Parameters + +• **expression**: `AstType`[] + +##### Returns + +`SerializedComponent`[] + +##### Defined in + +[chord\_sheet\_serializer.ts:138](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L138) + +*** + +#### serializeItem() + +> **serializeItem**(`item`): `SerializedComponent` + +##### Parameters + +• **item**: `AstType` + +##### Returns + +`SerializedComponent` + +##### Defined in + +[chord\_sheet\_serializer.ts:63](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L63) + +*** + +#### serializeLine() + +> **serializeLine**(`line`): `SerializedLine` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +##### Returns + +`SerializedLine` + +##### Defined in + +[chord\_sheet\_serializer.ts:56](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L56) + +*** + +#### serializeLiteral() + +> **serializeLiteral**(`literal`): `string` + +##### Parameters + +• **literal**: [`Literal`](#classesliteralmd) + +##### Returns + +`string` + +##### Defined in + +[chord\_sheet\_serializer.ts:134](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L134) + +*** + +#### serializeTag() + +> **serializeTag**(`tag`): `SerializedTag` + +##### Parameters + +• **tag**: [`Tag`](#classestagmd) + +##### Returns + +`SerializedTag` + +##### Defined in + +[chord\_sheet\_serializer.ts:100](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L100) + +*** + +#### serializeTernary() + +> **serializeTernary**(`ternary`): `object` + +##### Parameters + +• **ternary**: [`Ternary`](#classesternarymd) + +##### Returns + +`object` + +##### Defined in + +[chord\_sheet\_serializer.ts:124](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L124) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / ChordsOverWordsFormatter + +## Class: ChordsOverWordsFormatter + +Formats a song into a plain text chord sheet + +### Extends + +- [`Formatter`](#classesformattermd) + +### Constructors + +#### new ChordsOverWordsFormatter() + +> **new ChordsOverWordsFormatter**(`configuration`?): [`ChordsOverWordsFormatter`](#classeschordsoverwordsformattermd) + +Instantiate + +##### Parameters + +• **configuration?**: `Partial`\<`ConfigurationProperties`\> = `{}` + +options + +##### Returns + +[`ChordsOverWordsFormatter`](#classeschordsoverwordsformattermd) + +##### Inherited from + +[`Formatter`](#classesformattermd).[`constructor`](#constructors) + +##### Defined in + +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) + +### Properties + +#### configuration + +> **configuration**: `Configuration` + +##### Inherited from + +[`Formatter`](#classesformattermd).[`configuration`](#configuration) + +##### Defined in + +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) + +*** + +#### song + +> **song**: [`Song`](#classessongmd) + +##### Defined in + +[formatter/chords\_over\_words\_formatter.ts:18](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L18) + +### Methods + +#### chordLyricsPairLength() + +> **chordLyricsPairLength**(`chordLyricsPair`, `line`): `number` + +##### Parameters + +• **chordLyricsPair**: [`ChordLyricsPair`](#classeschordlyricspairmd) + +• **line**: [`Line`](#classeslinemd) + +##### Returns + +`number` + +##### Defined in + +[formatter/chords\_over\_words\_formatter.ts:88](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L88) + +*** + +#### format() + +> **format**(`song`): `string` + +Formats a song into a plain text chord sheet + +##### Parameters + +• **song**: [`Song`](#classessongmd) + +The song to be formatted + +##### Returns + +`string` + +the chord sheet + +##### Defined in + +[formatter/chords\_over\_words\_formatter.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L25) + +*** + +#### formatHeader() + +> **formatHeader**(): `string` + +##### Returns + +`string` + +##### Defined in + +[formatter/chords\_over\_words\_formatter.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L34) + +*** + +#### formatItemBottom() + +> **formatItemBottom**(`item`, `metadata`, `line`): `string` + +##### Parameters + +• **item**: `Item` + +• **metadata**: [`Metadata`](#classesmetadatamd) + +• **line**: [`Line`](#classeslinemd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chords\_over\_words\_formatter.ts:145](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L145) + +*** + +#### formatItemTop() + +> **formatItemTop**(`item`, `_metadata`, `line`): `string` + +##### Parameters + +• **item**: `Item` + +• **\_metadata**: [`Metadata`](#classesmetadatamd) + +• **line**: [`Line`](#classeslinemd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chords\_over\_words\_formatter.ts:101](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L101) + +*** + +#### formatLine() + +> **formatLine**(`line`, `metadata`): `string` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +• **metadata**: [`Metadata`](#classesmetadatamd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chords\_over\_words\_formatter.ts:68](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L68) + +*** + +#### formatLineBottom() + +> **formatLineBottom**(`line`, `metadata`): `null` \| `string` + +##### Parameters + +• **line**: `any` + +• **metadata**: `any` + +##### Returns + +`null` \| `string` + +##### Defined in + +[formatter/chords\_over\_words\_formatter.ts:126](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L126) + +*** + +#### formatLineTop() + +> **formatLineTop**(`line`, `metadata`): `null` \| `string` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +• **metadata**: [`Metadata`](#classesmetadatamd) + +##### Returns + +`null` \| `string` + +##### Defined in + +[formatter/chords\_over\_words\_formatter.ts:80](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L80) + +*** + +#### formatLineWithFormatter() + +> **formatLineWithFormatter**(`line`, `formatter`, `metadata`): `string` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +• **formatter** + +• **metadata**: [`Metadata`](#classesmetadatamd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chords\_over\_words\_formatter.ts:134](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L134) + +*** + +#### formatParagraph() + +> **formatParagraph**(`paragraph`, `metadata`): `string` + +##### Parameters + +• **paragraph**: [`Paragraph`](#classesparagraphmd) + +• **metadata**: [`Metadata`](#classesmetadatamd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chords\_over\_words\_formatter.ts:55](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L55) + +*** + +#### formatParagraphs() + +> **formatParagraphs**(): `string` + +##### Returns + +`string` + +##### Defined in + +[formatter/chords\_over\_words\_formatter.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L42) + +*** + +#### renderChord() + +> **renderChord**(`item`, `line`): `string` + +##### Parameters + +• **item**: [`ChordLyricsPair`](#classeschordlyricspairmd) + +• **line**: [`Line`](#classeslinemd) + +##### Returns + +`string` + +##### Defined in + +[formatter/chords\_over\_words\_formatter.ts:114](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L114) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / ChordsOverWordsParser + +## Class: ChordsOverWordsParser + +Parses a chords over words sheet into a song + +It support "regular" chord sheets: + + Am C/G F C + Let it be, let it be, let it be, let it be + C G F C/E Dm C + Whisper words of wisdom, let it be + +Additionally, some chordpro features have been "ported back". For example, you can use chordpro directives: + + {title: Let it be} + {key: C} + Chorus 1: + Am + Let it be + +For convenience, you can leave out the brackets: + + title: Let it be + Chorus 1: + Am + Let it be + +You can even use a markdown style frontmatter separator to separate the header from the song: + + title: Let it be + key: C + --- + Chorus 1: + Am C/G F C + Let it be, let it be, let it be, let it be + C G F C/E Dm C + Whisper words of wisdom, let it be + +`ChordsOverWordsParser` is the better version of `ChordSheetParser`, which is deprecated. + +### Constructors + +#### new ChordsOverWordsParser() + +> **new ChordsOverWordsParser**(): [`ChordsOverWordsParser`](#classeschordsoverwordsparsermd) + +##### Returns + +[`ChordsOverWordsParser`](#classeschordsoverwordsparsermd) + +### Properties + +#### song? + +> `optional` **song**: [`Song`](#classessongmd) + +##### Defined in + +[parser/chords\_over\_words\_parser.ts:51](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chords_over_words_parser.ts#L51) + +### Accessors + +#### warnings + +##### Get Signature + +> **get** **warnings**(): `ParserWarning`[] + +All warnings raised during parsing the chord sheet + +###### Member + +###### Returns + +`ParserWarning`[] + +##### Defined in + +[parser/chords\_over\_words\_parser.ts:58](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chords_over_words_parser.ts#L58) + +### Methods + +#### parse() + +> **parse**(`chordSheet`, `options`?): [`Song`](#classessongmd) + +Parses a chords over words sheet into a song + +##### Parameters + +• **chordSheet**: `string` + +the chords over words sheet + +• **options?**: `ChordsOverWordsParserOptions` + +Parser options. + +##### Returns + +[`Song`](#classessongmd) + +The parsed song + +##### See + +https://peggyjs.org/documentation.html#using-the-parser + +##### Defined in + +[parser/chords\_over\_words\_parser.ts:71](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chords_over_words_parser.ts#L71) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / Comment + +## Class: Comment + +Represents a comment. See https://www.chordpro.org/chordpro/chordpro-file-format-specification/#overview + +### Constructors + +#### new Comment() + +> **new Comment**(`content`): [`Comment`](#classescommentmd) + +##### Parameters + +• **content**: `string` + +##### Returns + +[`Comment`](#classescommentmd) + +##### Defined in + +[chord\_sheet/comment.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/comment.ts#L7) + +### Properties + +#### content + +> **content**: `string` + +##### Defined in + +[chord\_sheet/comment.ts:5](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/comment.ts#L5) + +### Methods + +#### clone() + +> **clone**(): [`Comment`](#classescommentmd) + +Returns a deep copy of the Comment, useful when programmatically transforming a song + +##### Returns + +[`Comment`](#classescommentmd) + +##### Defined in + +[chord\_sheet/comment.ts:23](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/comment.ts#L23) + +*** + +#### isRenderable() + +> **isRenderable**(): `boolean` + +Indicates whether a Comment should be visible in a formatted chord sheet (except for ChordPro sheets) + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/comment.ts:15](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/comment.ts#L15) + +*** + +#### toString() + +> **toString**(): `string` + +##### Returns + +`string` + +##### Defined in + +[chord\_sheet/comment.ts:27](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/comment.ts#L27) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / Composite + +## Class: Composite + +### Extends + +- `Evaluatable` + +### Constructors + +#### new Composite() + +> **new Composite**(`expressions`, `variable`): [`Composite`](#classescompositemd) + +##### Parameters + +• **expressions**: `Evaluatable`[] + +• **variable**: `null` \| `string` = `null` + +##### Returns + +[`Composite`](#classescompositemd) + +##### Overrides + +`Evaluatable.constructor` + +##### Defined in + +[chord\_sheet/chord\_pro/composite.ts:9](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/composite.ts#L9) + +### Properties + +#### column + +> **column**: `null` \| `number` = `null` + +##### Inherited from + +`Evaluatable.column` + +##### Defined in + +[chord\_sheet/ast\_component.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L6) + +*** + +#### expressions + +> **expressions**: `Evaluatable`[] = `[]` + +##### Defined in + +[chord\_sheet/chord\_pro/composite.ts:5](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/composite.ts#L5) + +*** + +#### line + +> **line**: `null` \| `number` = `null` + +##### Inherited from + +`Evaluatable.line` + +##### Defined in + +[chord\_sheet/ast\_component.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L4) + +*** + +#### offset + +> **offset**: `null` \| `number` = `null` + +##### Inherited from + +`Evaluatable.offset` + +##### Defined in + +[chord\_sheet/ast\_component.ts:8](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L8) + +*** + +#### variable + +> **variable**: `null` \| `string` + +##### Defined in + +[chord\_sheet/chord\_pro/composite.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/composite.ts#L7) + +### Methods + +#### clone() + +> **clone**(): [`Composite`](#classescompositemd) + +##### Returns + +[`Composite`](#classescompositemd) + +##### Overrides + +`Evaluatable.clone` + +##### Defined in + +[chord\_sheet/chord\_pro/composite.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/composite.ts#L25) + +*** + +#### evaluate() + +> **evaluate**(`metadata`, `metadataSeparator`): `string` + +##### Parameters + +• **metadata**: [`Metadata`](#classesmetadatamd) + +• **metadataSeparator**: `string` + +##### Returns + +`string` + +##### Overrides + +`Evaluatable.evaluate` + +##### Defined in + +[chord\_sheet/chord\_pro/composite.ts:15](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/composite.ts#L15) + +*** + +#### isRenderable() + +> **isRenderable**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/chord\_pro/composite.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/composite.ts#L21) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / Formatter + +## Class: Formatter + +Base class for all formatters, taking care of receiving a configuration wrapping that inside a Configuration object + +### Extended by + +- [`ChordProFormatter`](#classeschordproformattermd) +- [`ChordsOverWordsFormatter`](#classeschordsoverwordsformattermd) +- [`HtmlFormatter`](#classeshtmlformattermd) +- [`TextFormatter`](#classestextformattermd) + +### Constructors + +#### new Formatter() + +> **new Formatter**(`configuration`?): [`Formatter`](#classesformattermd) + +Instantiate + +##### Parameters + +• **configuration?**: `Partial`\<`ConfigurationProperties`\> = `{}` + +options + +##### Returns + +[`Formatter`](#classesformattermd) + +##### Defined in + +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) + +### Properties + +#### configuration + +> **configuration**: `Configuration` + +##### Defined in + +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / HtmlDivFormatter + +## Class: HtmlDivFormatter + +Formats a song into HTML. It uses DIVs to align lyrics with chords, which makes it useful for responsive web pages. + +### Extends + +- [`HtmlFormatter`](#classeshtmlformattermd) + +### Constructors + +#### new HtmlDivFormatter() + +> **new HtmlDivFormatter**(`configuration`?): [`HtmlDivFormatter`](#classeshtmldivformattermd) + +Instantiate + +##### Parameters + +• **configuration?**: `Partial`\<`ConfigurationProperties`\> = `{}` + +options + +##### Returns + +[`HtmlDivFormatter`](#classeshtmldivformattermd) + +##### Inherited from + +[`HtmlFormatter`](#classeshtmlformattermd).[`constructor`](#constructors) + +##### Defined in + +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) + +### Properties + +#### configuration + +> **configuration**: `Configuration` + +##### Inherited from + +[`HtmlFormatter`](#classeshtmlformattermd).[`configuration`](#configuration) + +##### Defined in + +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) + +### Accessors + +#### cssObject + +##### Get Signature + +> **get** **cssObject**(): `CSS` + +Basic CSS, in object style à la useStyles, to use with the HTML output +For a CSS string see [cssString](#cssstring) + +Example: + + '.paragraph': { + marginBottom: '1em' + } + +###### Returns + +`CSS` + +the CSS object + +##### Inherited from + +[`HtmlFormatter`](#classeshtmlformattermd).[`cssObject`](#cssobject) + +##### Defined in + +[formatter/html\_formatter.ts:66](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L66) + +*** + +#### defaultCss + +##### Get Signature + +> **get** **defaultCss**(): `CSS` + +###### Returns + +`CSS` + +##### Overrides + +[`HtmlFormatter`](#classeshtmlformattermd).[`defaultCss`](#defaultcss) + +##### Defined in + +[formatter/html\_div\_formatter.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_div_formatter.ts#L44) + +*** + +#### template + +##### Get Signature + +> **get** **template**(): `Template` + +###### Returns + +`Template` + +##### Overrides + +[`HtmlFormatter`](#classeshtmlformattermd).[`template`](#template) + +##### Defined in + +[formatter/html\_div\_formatter.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_div_formatter.ts#L40) + +### Methods + +#### cssString() + +> **cssString**(`scope`): `string` + +Generates basic CSS, optionally scoped within the provided selector, to use with the HTML output + +For example, execute cssString('.chordSheetViewer') will result in CSS like: + + .chordSheetViewer .paragraph { + margin-bottom: 1em; + } + +##### Parameters + +• **scope**: `string` = `''` + +the CSS scope to use, for example `.chordSheetViewer` + +##### Returns + +`string` + +the CSS string + +##### Inherited from + +[`HtmlFormatter`](#classeshtmlformattermd).[`cssString`](#cssstring) + +##### Defined in + +[formatter/html\_formatter.ts:50](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L50) + +*** + +#### format() + +> **format**(`song`): `string` + +Formats a song into HTML. + +##### Parameters + +• **song**: [`Song`](#classessongmd) + +The song to be formatted + +##### Returns + +`string` + +The HTML string + +##### Inherited from + +[`HtmlFormatter`](#classeshtmlformattermd).[`format`](#format) + +##### Defined in + +[formatter/html\_formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L26) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / HtmlFormatter + +## Class: `abstract` HtmlFormatter + +Acts as a base class for HTML formatters + +### Extends + +- [`Formatter`](#classesformattermd) + +### Extended by + +- [`HtmlDivFormatter`](#classeshtmldivformattermd) +- [`HtmlTableFormatter`](#classeshtmltableformattermd) + +### Constructors + +#### new HtmlFormatter() + +> **new HtmlFormatter**(`configuration`?): [`HtmlFormatter`](#classeshtmlformattermd) + +Instantiate + +##### Parameters + +• **configuration?**: `Partial`\<`ConfigurationProperties`\> = `{}` + +options + +##### Returns + +[`HtmlFormatter`](#classeshtmlformattermd) + +##### Inherited from + +[`Formatter`](#classesformattermd).[`constructor`](#constructors) + +##### Defined in + +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) + +### Properties + +#### configuration + +> **configuration**: `Configuration` + +##### Inherited from + +[`Formatter`](#classesformattermd).[`configuration`](#configuration) + +##### Defined in + +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) + +### Accessors + +#### cssObject + +##### Get Signature + +> **get** **cssObject**(): `CSS` + +Basic CSS, in object style à la useStyles, to use with the HTML output +For a CSS string see [cssString](#cssstring) + +Example: + + '.paragraph': { + marginBottom: '1em' + } + +###### Returns + +`CSS` + +the CSS object + +##### Defined in + +[formatter/html\_formatter.ts:66](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L66) + +*** + +#### defaultCss + +##### Get Signature + +> **get** `abstract` **defaultCss**(): `CSS` + +###### Returns + +`CSS` + +##### Defined in + +[formatter/html\_formatter.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L70) + +*** + +#### template + +##### Get Signature + +> **get** `abstract` **template**(): `Template` + +###### Returns + +`Template` + +##### Defined in + +[formatter/html\_formatter.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L72) + +### Methods + +#### cssString() + +> **cssString**(`scope`): `string` + +Generates basic CSS, optionally scoped within the provided selector, to use with the HTML output + +For example, execute cssString('.chordSheetViewer') will result in CSS like: + + .chordSheetViewer .paragraph { + margin-bottom: 1em; + } + +##### Parameters + +• **scope**: `string` = `''` + +the CSS scope to use, for example `.chordSheetViewer` + +##### Returns + +`string` + +the CSS string + +##### Defined in + +[formatter/html\_formatter.ts:50](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L50) + +*** + +#### format() + +> **format**(`song`): `string` + +Formats a song into HTML. + +##### Parameters + +• **song**: [`Song`](#classessongmd) + +The song to be formatted + +##### Returns + +`string` + +The HTML string + +##### Defined in + +[formatter/html\_formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L26) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / HtmlTableFormatter + +## Class: HtmlTableFormatter + +Formats a song into HTML. It uses TABLEs to align lyrics with chords, which makes the HTML for things like +PDF conversion. + +### Extends + +- [`HtmlFormatter`](#classeshtmlformattermd) + +### Constructors + +#### new HtmlTableFormatter() + +> **new HtmlTableFormatter**(`configuration`?): [`HtmlTableFormatter`](#classeshtmltableformattermd) + +Instantiate + +##### Parameters + +• **configuration?**: `Partial`\<`ConfigurationProperties`\> = `{}` + +options + +##### Returns + +[`HtmlTableFormatter`](#classeshtmltableformattermd) + +##### Inherited from + +[`HtmlFormatter`](#classeshtmlformattermd).[`constructor`](#constructors) + +##### Defined in + +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) + +### Properties + +#### configuration + +> **configuration**: `Configuration` + +##### Inherited from + +[`HtmlFormatter`](#classeshtmlformattermd).[`configuration`](#configuration) + +##### Defined in + +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) + +### Accessors + +#### cssObject + +##### Get Signature + +> **get** **cssObject**(): `CSS` + +Basic CSS, in object style à la useStyles, to use with the HTML output +For a CSS string see [cssString](#cssstring) + +Example: + + '.paragraph': { + marginBottom: '1em' + } + +###### Returns + +`CSS` + +the CSS object + +##### Inherited from + +[`HtmlFormatter`](#classeshtmlformattermd).[`cssObject`](#cssobject) + +##### Defined in + +[formatter/html\_formatter.ts:66](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L66) + +*** + +#### defaultCss + +##### Get Signature + +> **get** **defaultCss**(): `CSS` + +###### Returns + +`CSS` + +##### Overrides + +[`HtmlFormatter`](#classeshtmlformattermd).[`defaultCss`](#defaultcss) + +##### Defined in + +[formatter/html\_table\_formatter.ts:45](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_table_formatter.ts#L45) + +*** + +#### template + +##### Get Signature + +> **get** **template**(): `Template` + +###### Returns + +`Template` + +##### Overrides + +[`HtmlFormatter`](#classeshtmlformattermd).[`template`](#template) + +##### Defined in + +[formatter/html\_table\_formatter.ts:41](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_table_formatter.ts#L41) + +### Methods + +#### cssString() + +> **cssString**(`scope`): `string` + +Generates basic CSS, optionally scoped within the provided selector, to use with the HTML output + +For example, execute cssString('.chordSheetViewer') will result in CSS like: + + .chordSheetViewer .paragraph { + margin-bottom: 1em; + } + +##### Parameters + +• **scope**: `string` = `''` + +the CSS scope to use, for example `.chordSheetViewer` + +##### Returns + +`string` + +the CSS string + +##### Inherited from + +[`HtmlFormatter`](#classeshtmlformattermd).[`cssString`](#cssstring) + +##### Defined in + +[formatter/html\_formatter.ts:50](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L50) + +*** + +#### format() + +> **format**(`song`): `string` + +Formats a song into HTML. + +##### Parameters + +• **song**: [`Song`](#classessongmd) + +The song to be formatted + +##### Returns + +`string` + +The HTML string + +##### Inherited from + +[`HtmlFormatter`](#classeshtmlformattermd).[`format`](#format) + +##### Defined in + +[formatter/html\_formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L26) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / Key + +## Class: Key + +Represents a key, such as Eb (symbol), #3 (numeric) or VII (numeral). + +The only function considered public API is `Key.distance` + +### Implements + +- `KeyProperties` + +### Constructors + +#### new Key() + +> **new Key**(`__namedParameters`): [`Key`](#classeskeymd) + +##### Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.grade?**: `null` \| `number` = `null` + +• **\_\_namedParameters.minor**: `boolean` + +• **\_\_namedParameters.modifier**: `null` \| `Modifier` + +• **\_\_namedParameters.number?**: `null` \| `number` = `null` + +• **\_\_namedParameters.originalKeyString?**: `null` \| `string` = `null` + +• **\_\_namedParameters.preferredModifier**: `null` \| `Modifier` = `null` + +• **\_\_namedParameters.referenceKeyGrade?**: `null` \| `number` = `null` + +• **\_\_namedParameters.type**: `ChordType` + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:249](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L249) + +### Properties + +#### grade + +> **grade**: `null` \| `number` + +##### Implementation of + +`KeyProperties.grade` + +##### Defined in + +[key.ts:51](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L51) + +*** + +#### minor + +> **minor**: `boolean` = `false` + +##### Implementation of + +`KeyProperties.minor` + +##### Defined in + +[key.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L70) + +*** + +#### modifier + +> **modifier**: `null` \| `Modifier` + +##### Implementation of + +`KeyProperties.modifier` + +##### Defined in + +[key.ts:55](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L55) + +*** + +#### number + +> **number**: `null` \| `number` = `null` + +##### Implementation of + +`KeyProperties.number` + +##### Defined in + +[key.ts:53](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L53) + +*** + +#### originalKeyString + +> **originalKeyString**: `null` \| `string` = `null` + +##### Defined in + +[key.ts:74](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L74) + +*** + +#### preferredModifier + +> **preferredModifier**: `null` \| `Modifier` + +##### Implementation of + +`KeyProperties.preferredModifier` + +##### Defined in + +[key.ts:76](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L76) + +*** + +#### referenceKeyGrade + +> **referenceKeyGrade**: `null` \| `number` = `null` + +##### Implementation of + +`KeyProperties.referenceKeyGrade` + +##### Defined in + +[key.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L72) + +*** + +#### type + +> **type**: `ChordType` + +##### Implementation of + +`KeyProperties.type` + +##### Defined in + +[key.ts:57](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L57) + +### Accessors + +#### effectiveGrade + +##### Get Signature + +> **get** **effectiveGrade**(): `number` + +###### Returns + +`number` + +##### Defined in + +[key.ts:285](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L285) + +*** + +#### minorSign + +##### Get Signature + +> **get** **minorSign**(): `""` \| `"m"` + +###### Returns + +`""` \| `"m"` + +##### Defined in + +[key.ts:519](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L519) + +*** + +#### note + +##### Get Signature + +> **get** **note**(): `string` + +###### Returns + +`string` + +##### Defined in + +[key.ts:490](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L490) + +*** + +#### relativeMajor + +##### Get Signature + +> **get** **relativeMajor**(): [`Key`](#classeskeymd) + +###### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:301](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L301) + +*** + +#### relativeMinor + +##### Get Signature + +> **get** **relativeMinor**(): [`Key`](#classeskeymd) + +###### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:305](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L305) + +*** + +#### unicodeModifier + +##### Get Signature + +> **get** **unicodeModifier**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Defined in + +[key.ts:59](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L59) + +### Methods + +#### canBeFlat() + +> **canBeFlat**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[key.ts:595](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L595) + +*** + +#### canBeSharp() + +> **canBeSharp**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[key.ts:603](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L603) + +*** + +#### changeGrade() + +> **changeGrade**(`delta`): [`Key`](#classeskeymd) + +##### Parameters + +• **delta**: `any` + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:558](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L558) + +*** + +#### clone() + +> **clone**(): [`Key`](#classeskeymd) + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:317](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L317) + +*** + +#### distanceTo() + +> **distanceTo**(`otherKey`): `number` + +##### Parameters + +• **otherKey**: `string` \| [`Key`](#classeskeymd) + +##### Returns + +`number` + +##### Defined in + +[key.ts:280](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L280) + +*** + +#### equals() + +> **equals**(`otherKey`): `boolean` + +##### Parameters + +• **otherKey**: [`Key`](#classeskeymd) + +##### Returns + +`boolean` + +##### Defined in + +[key.ts:410](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L410) + +*** + +#### is() + +> **is**(`type`): `boolean` + +##### Parameters + +• **type**: `ChordType` + +##### Returns + +`boolean` + +##### Defined in + +[key.ts:390](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L390) + +*** + +#### isChordSolfege() + +> **isChordSolfege**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[key.ts:402](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L402) + +*** + +#### isChordSymbol() + +> **isChordSymbol**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[key.ts:398](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L398) + +*** + +#### isMinor() + +> **isMinor**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[key.ts:293](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L293) + +*** + +#### isNumeral() + +> **isNumeral**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[key.ts:406](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L406) + +*** + +#### isNumeric() + +> **isNumeric**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[key.ts:394](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L394) + +*** + +#### makeMinor() + +> **makeMinor**(): [`Key`](#classeskeymd) + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:297](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L297) + +*** + +#### normalize() + +> **normalize**(): [`Key`](#classeskeymd) + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:630](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L630) + +*** + +#### normalizeEnharmonics() + +> **normalizeEnharmonics**(`key`): [`Key`](#classeskeymd) + +##### Parameters + +• **key**: `null` \| `string` \| [`Key`](#classeskeymd) + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:644](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L644) + +*** + +#### setGrade() + +> **setGrade**(`newGrade`): [`Key`](#classeskeymd) + +##### Parameters + +• **newGrade**: `number` + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:611](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L611) + +*** + +#### toChordSolfege() + +> **toChordSolfege**(`key`): [`Key`](#classeskeymd) + +##### Parameters + +• **key**: `string` \| [`Key`](#classeskeymd) + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:362](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L362) + +*** + +#### toChordSolfegeString() + +> **toChordSolfegeString**(`key`): `string` + +##### Parameters + +• **key**: [`Key`](#classeskeymd) + +##### Returns + +`string` + +##### Defined in + +[key.ts:386](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L386) + +*** + +#### toChordSymbol() + +> **toChordSymbol**(`key`): [`Key`](#classeskeymd) + +##### Parameters + +• **key**: `string` \| [`Key`](#classeskeymd) + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:342](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L342) + +*** + +#### toChordSymbolString() + +> **toChordSymbolString**(`key`): `string` + +##### Parameters + +• **key**: [`Key`](#classeskeymd) + +##### Returns + +`string` + +##### Defined in + +[key.ts:382](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L382) + +*** + +#### toMajor() + +> **toMajor**(): [`Key`](#classeskeymd) + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:309](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L309) + +*** + +#### toNumeral() + +> **toNumeral**(`key`): [`Key`](#classeskeymd) + +##### Parameters + +• **key**: `null` \| `string` \| [`Key`](#classeskeymd) = `null` + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:456](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L456) + +*** + +#### toNumeralString() + +> **toNumeralString**(`key`): `string` + +##### Parameters + +• **key**: `null` \| [`Key`](#classeskeymd) = `null` + +##### Returns + +`string` + +##### Defined in + +[key.ts:476](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L476) + +*** + +#### toNumeric() + +> **toNumeric**(`key`): [`Key`](#classeskeymd) + +##### Parameters + +• **key**: `null` \| `string` \| [`Key`](#classeskeymd) = `null` + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:431](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L431) + +*** + +#### toNumericString() + +> **toNumericString**(`key`): `string` + +##### Parameters + +• **key**: `null` \| [`Key`](#classeskeymd) = `null` + +##### Returns + +`string` + +##### Defined in + +[key.ts:452](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L452) + +*** + +#### toString() + +> **toString**(`__namedParameters`): `string` + +Returns a string representation of an object. + +##### Parameters + +• **\_\_namedParameters** = `{}` + +• **\_\_namedParameters.showMinor**: `undefined` \| `boolean` = `true` + +• **\_\_namedParameters.useUnicodeModifier**: `undefined` \| `boolean` = `false` + +##### Returns + +`string` + +##### Defined in + +[key.ts:480](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L480) + +*** + +#### transpose() + +> **transpose**(`delta`): [`Key`](#classeskeymd) + +##### Parameters + +• **delta**: `number` + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:544](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L544) + +*** + +#### transposeDown() + +> **transposeDown**(): [`Key`](#classeskeymd) + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:582](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L582) + +*** + +#### transposeUp() + +> **transposeUp**(): [`Key`](#classeskeymd) + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:568](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L568) + +*** + +#### useModifier() + +> **useModifier**(`newModifier`): [`Key`](#classeskeymd) + +##### Parameters + +• **newModifier**: `null` \| `Modifier` + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:625](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L625) + +*** + +#### distance() + +> `static` **distance**(`oneKey`, `otherKey`): `number` + +Calculates the distance in semitones between one key and another. + +##### Parameters + +• **oneKey**: `string` \| [`Key`](#classeskeymd) + +the key + +• **otherKey**: `string` \| [`Key`](#classeskeymd) + +the other key + +##### Returns + +`number` + +the distance in semitones + +##### Defined in + +[key.ts:245](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L245) + +*** + +#### equals() + +> `static` **equals**(`oneKey`, `otherKey`): `boolean` + +##### Parameters + +• **oneKey**: `null` \| [`Key`](#classeskeymd) + +• **otherKey**: `null` \| [`Key`](#classeskeymd) + +##### Returns + +`boolean` + +##### Defined in + +[key.ts:419](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L419) + +*** + +#### getNumberFromKey() + +> `static` **getNumberFromKey**(`keyString`, `keyType`): `number` + +##### Parameters + +• **keyString**: `string` + +• **keyType**: `ChordType` + +##### Returns + +`number` + +##### Defined in + +[key.ts:152](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L152) + +*** + +#### isMinor() + +> `static` **isMinor**(`key`, `keyType`, `minor`): `boolean` + +##### Parameters + +• **key**: `string` + +• **keyType**: `ChordType` + +• **minor**: `undefined` \| `string` \| `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[key.ts:193](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L193) + +*** + +#### keyWithModifier() + +> `static` **keyWithModifier**(`key`, `modifier`, `type`): `string` + +##### Parameters + +• **key**: `string` + +• **modifier**: `null` \| `Modifier` + +• **type**: `ChordType` + +##### Returns + +`string` + +##### Defined in + +[key.ts:161](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L161) + +*** + +#### parse() + +> `static` **parse**(`keyString`): `null` \| [`Key`](#classeskeymd) + +##### Parameters + +• **keyString**: `null` \| `string` + +##### Returns + +`null` \| [`Key`](#classeskeymd) + +##### Defined in + +[key.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L78) + +*** + +#### parseAsType() + +> `static` **parseAsType**(`trimmed`, `keyType`): `null` \| [`Key`](#classeskeymd) + +##### Parameters + +• **trimmed**: `string` + +• **keyType**: `ChordType` + +##### Returns + +`null` \| [`Key`](#classeskeymd) + +##### Defined in + +[key.ts:93](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L93) + +*** + +#### parseOrFail() + +> `static` **parseOrFail**(`keyString`): [`Key`](#classeskeymd) + +##### Parameters + +• **keyString**: `null` \| `string` + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:209](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L209) + +*** + +#### resolve() + +> `static` **resolve**(`__namedParameters`): `null` \| [`Key`](#classeskeymd) + +##### Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.key**: `string` \| `number` + +• **\_\_namedParameters.keyType**: `ChordType` + +• **\_\_namedParameters.minor**: `string` \| `boolean` + +• **\_\_namedParameters.modifier**: `null` \| `Modifier` + +##### Returns + +`null` \| [`Key`](#classeskeymd) + +##### Defined in + +[key.ts:108](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L108) + +*** + +#### shiftGrade() + +> `static` **shiftGrade**(`grade`): `any` + +##### Parameters + +• **grade**: `number` + +##### Returns + +`any` + +##### Defined in + +[key.ts:617](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L617) + +*** + +#### toGrade() + +> `static` **toGrade**(`key`, `modifier`, `type`, `isMinor`): `null` \| `number` + +##### Parameters + +• **key**: `string` + +• **modifier**: `ModifierMaybe` + +• **type**: `ChordType` + +• **isMinor**: `boolean` + +##### Returns + +`null` \| `number` + +##### Defined in + +[key.ts:176](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L176) + +*** + +#### toString() + +> `static` **toString**(`keyStringOrObject`): `string` + +##### Parameters + +• **keyStringOrObject**: `string` \| [`Key`](#classeskeymd) + +##### Returns + +`string` + +##### Defined in + +[key.ts:235](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L235) + +*** + +#### wrap() + +> `static` **wrap**(`keyStringOrObject`): `null` \| [`Key`](#classeskeymd) + +##### Parameters + +• **keyStringOrObject**: `null` \| `string` \| [`Key`](#classeskeymd) + +##### Returns + +`null` \| [`Key`](#classeskeymd) + +##### Defined in + +[key.ts:217](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L217) + +*** + +#### wrapOrFail() + +> `static` **wrapOrFail**(`keyStringOrObject`): [`Key`](#classeskeymd) + +##### Parameters + +• **keyStringOrObject**: `null` \| `string` \| [`Key`](#classeskeymd) = `null` + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[key.ts:225](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L225) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / Line + +## Class: Line + +Represents a line in a chord sheet, consisting of items of type ChordLyricsPair or Tag + +### Constructors + +#### new Line() + +> **new Line**(`__namedParameters`): [`Line`](#classeslinemd) + +##### Parameters + +• **\_\_namedParameters** = `...` + +• **\_\_namedParameters.items**: `Item`[] + +• **\_\_namedParameters.type**: `LineType` + +##### Returns + +[`Line`](#classeslinemd) + +##### Defined in + +[chord\_sheet/line.ts:62](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L62) + +### Properties + +#### chordFont + +> **chordFont**: `Font` + +The chord font that applies to this line. Is derived from the directives: +`chordfont`, `chordsize` and `chordcolour` +See: https://www.chordpro.org/chordpro/directives-props_chord_legacy/ + +##### Defined in + +[chord\_sheet/line.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L60) + +*** + +#### currentChordLyricsPair + +> **currentChordLyricsPair**: [`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Defined in + +[chord\_sheet/line.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L38) + +*** + +#### items + +> **items**: `Item`[] = `[]` + +The items ([ChordLyricsPair](#classeschordlyricspairmd) or [Tag](#classestagmd) or [Comment](#classescommentmd)) of which the line consists + +##### Defined in + +[chord\_sheet/line.ts:29](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L29) + +*** + +#### key + +> **key**: `null` \| `string` = `null` + +##### Defined in + +[chord\_sheet/line.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L40) + +*** + +#### lineNumber + +> **lineNumber**: `null` \| `number` = `null` + +##### Defined in + +[chord\_sheet/line.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L44) + +*** + +#### textFont + +> **textFont**: `Font` + +The text font that applies to this line. Is derived from the directives: +`textfont`, `textsize` and `textcolour` +See: https://www.chordpro.org/chordpro/directives-props_text_legacy/ + +##### Defined in + +[chord\_sheet/line.ts:52](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L52) + +*** + +#### transposeKey + +> **transposeKey**: `null` \| `string` = `null` + +##### Defined in + +[chord\_sheet/line.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L42) + +*** + +#### type + +> **type**: `LineType` = `NONE` + +The line type, This is set by the ChordProParser when it read tags like {start_of_chorus} or {start_of_verse} +Values can be [VERSE](#variablesversemd), [CHORUS](#variableschorusmd) or [NONE](#variablesnonemd) + +##### Defined in + +[chord\_sheet/line.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L36) + +### Accessors + +#### \_tag + +##### Get Signature + +> **get** **\_tag**(): `null` \| [`Tag`](#classestagmd) + +###### Returns + +`null` \| [`Tag`](#classestagmd) + +##### Defined in + +[chord\_sheet/line.ts:223](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L223) + +### Methods + +#### addChordLyricsPair() + +> **addChordLyricsPair**(`chords`, `lyrics`): [`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Parameters + +• **chords**: `null` \| `string` \| [`ChordLyricsPair`](#classeschordlyricspairmd) = `null` + +• **lyrics**: `null` = `null` + +##### Returns + +[`ChordLyricsPair`](#classeschordlyricspairmd) + +##### Defined in + +[chord\_sheet/line.ts:174](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L174) + +*** + +#### addComment() + +> **addComment**(`content`): [`Comment`](#classescommentmd) + +##### Parameters + +• **content**: `string` \| [`Comment`](#classescommentmd) + +##### Returns + +[`Comment`](#classescommentmd) + +##### Defined in + +[chord\_sheet/line.ts:207](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L207) + +*** + +#### addItem() + +> **addItem**(`item`): `void` + +Adds an item ([ChordLyricsPair](#classeschordlyricspairmd) or [Tag](#classestagmd)) to the line + +##### Parameters + +• **item**: `Item` + +The item to be added + +##### Returns + +`void` + +##### Defined in + +[chord\_sheet/line.ts:83](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L83) + +*** + +#### addTag() + +> **addTag**(`nameOrTag`, `value`): [`Tag`](#classestagmd) + +##### Parameters + +• **nameOrTag**: `string` \| [`Tag`](#classestagmd) + +• **value**: `null` \| `string` = `null` + +##### Returns + +[`Tag`](#classestagmd) + +##### Defined in + +[chord\_sheet/line.ts:201](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L201) + +*** + +#### chords() + +> **chords**(`chr`): `void` + +##### Parameters + +• **chr**: `string` + +##### Returns + +`void` + +##### Defined in + +[chord\_sheet/line.ts:191](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L191) + +*** + +#### clone() + +> **clone**(): [`Line`](#classeslinemd) + +Returns a deep copy of the line and all of its items + +##### Returns + +[`Line`](#classeslinemd) + +##### Defined in + +[chord\_sheet/line.ts:107](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L107) + +*** + +#### ensureChordLyricsPair() + +> **ensureChordLyricsPair**(): `void` + +##### Returns + +`void` + +##### Defined in + +[chord\_sheet/line.ts:185](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L185) + +*** + +#### ~~hasContent()~~ + +> **hasContent**(): `boolean` + +Indicates whether the line contains items that are renderable. Please use [hasRenderableItems](#hasrenderableitems) + +##### Returns + +`boolean` + +##### Deprecated + +##### Defined in + +[chord\_sheet/line.ts:170](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L170) + +*** + +#### hasRenderableItems() + +> **hasRenderableItems**(): `boolean` + +Indicates whether the line contains items that are renderable + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/line.ts:99](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L99) + +*** + +#### isBridge() + +> **isBridge**(): `boolean` + +Indicates whether the line type is BRIDGE + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/line.ts:129](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L129) + +*** + +#### isChorus() + +> **isChorus**(): `boolean` + +Indicates whether the line type is [CHORUS](#variableschorusmd) + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/line.ts:137](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L137) + +*** + +#### isEmpty() + +> **isEmpty**(): `boolean` + +Indicates whether the line contains any items + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/line.ts:71](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L71) + +*** + +#### isGrid() + +> **isGrid**(): `boolean` + +Indicates whether the line type is GRID + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/line.ts:145](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L145) + +*** + +#### isNotEmpty() + +> **isNotEmpty**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/line.ts:75](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L75) + +*** + +#### isSectionEnd() + +> **isSectionEnd**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/line.ts:241](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L241) + +*** + +#### isSectionStart() + +> **isSectionStart**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/line.ts:237](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L237) + +*** + +#### isTab() + +> **isTab**(): `boolean` + +Indicates whether the line type is [TAB](#variablestabmd) + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/line.ts:153](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L153) + +*** + +#### isVerse() + +> **isVerse**(): `boolean` + +Indicates whether the line type is [VERSE](#variablesversemd) + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/line.ts:161](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L161) + +*** + +#### lyrics() + +> **lyrics**(`chr`): `void` + +##### Parameters + +• **chr**: `string` + +##### Returns + +`void` + +##### Defined in + +[chord\_sheet/line.ts:196](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L196) + +*** + +#### mapItems() + +> **mapItems**(`func`): [`Line`](#classeslinemd) + +##### Parameters + +• **func**: `null` \| `MapItemFunc` + +##### Returns + +[`Line`](#classeslinemd) + +##### Defined in + +[chord\_sheet/line.ts:111](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L111) + +*** + +#### set() + +> **set**(`properties`): [`Line`](#classeslinemd) + +##### Parameters + +• **properties** + +• **properties.items?**: `Item`[] + +• **properties.type?**: `LineType` + +##### Returns + +[`Line`](#classeslinemd) + +##### Defined in + +[chord\_sheet/line.ts:213](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L213) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / Literal + +## Class: Literal + +### Extends + +- `Evaluatable` + +### Constructors + +#### new Literal() + +> **new Literal**(`string`): [`Literal`](#classesliteralmd) + +##### Parameters + +• **string**: `string` + +##### Returns + +[`Literal`](#classesliteralmd) + +##### Overrides + +`Evaluatable.constructor` + +##### Defined in + +[chord\_sheet/chord\_pro/literal.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/literal.ts#L6) + +### Properties + +#### column + +> **column**: `null` \| `number` = `null` + +##### Inherited from + +`Evaluatable.column` + +##### Defined in + +[chord\_sheet/ast\_component.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L6) + +*** + +#### line + +> **line**: `null` \| `number` = `null` + +##### Inherited from + +`Evaluatable.line` + +##### Defined in + +[chord\_sheet/ast\_component.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L4) + +*** + +#### offset + +> **offset**: `null` \| `number` = `null` + +##### Inherited from + +`Evaluatable.offset` + +##### Defined in + +[chord\_sheet/ast\_component.ts:8](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L8) + +*** + +#### string + +> **string**: `string` + +##### Defined in + +[chord\_sheet/chord\_pro/literal.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/literal.ts#L4) + +### Methods + +#### clone() + +> **clone**(): [`Literal`](#classesliteralmd) + +##### Returns + +[`Literal`](#classesliteralmd) + +##### Overrides + +`Evaluatable.clone` + +##### Defined in + +[chord\_sheet/chord\_pro/literal.ts:19](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/literal.ts#L19) + +*** + +#### evaluate() + +> **evaluate**(): `string` + +##### Returns + +`string` + +##### Overrides + +`Evaluatable.evaluate` + +##### Defined in + +[chord\_sheet/chord\_pro/literal.ts:11](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/literal.ts#L11) + +*** + +#### isRenderable() + +> **isRenderable**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/chord\_pro/literal.ts:15](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/literal.ts#L15) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / Metadata + +## Class: Metadata + +Stores song metadata. Properties can be accessed using the get() method: + +const metadata = new Metadata({ author: 'John' }); +metadata.get('author') // => 'John' + +See [Metadata#get](#get) + +### Extends + +- `MetadataAccessors` + +### Constructors + +#### new Metadata() + +> **new Metadata**(`metadata`): [`Metadata`](#classesmetadatamd) + +##### Parameters + +• **metadata**: `Record`\<`string`, `string` \| `string`[]\> = `{}` + +##### Returns + +[`Metadata`](#classesmetadatamd) + +##### Overrides + +`MetadataAccessors.constructor` + +##### Defined in + +[chord\_sheet/metadata.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L28) + +### Properties + +#### metadata + +> **metadata**: `Record`\<`string`, `string` \| `string`[]\> = `{}` + +##### Defined in + +[chord\_sheet/metadata.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L26) + +### Accessors + +#### album + +##### Get Signature + +> **get** **album**(): `null` \| `string` \| `string`[] + +###### Returns + +`null` \| `string` \| `string`[] + +##### Inherited from + +`MetadataAccessors.album` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L38) + +*** + +#### artist + +##### Get Signature + +> **get** **artist**(): `null` \| `string` \| `string`[] + +###### Returns + +`null` \| `string` \| `string`[] + +##### Inherited from + +`MetadataAccessors.artist` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L44) + +*** + +#### capo + +##### Get Signature + +> **get** **capo**(): `null` \| `string` \| `string`[] + +###### Returns + +`null` \| `string` \| `string`[] + +##### Inherited from + +`MetadataAccessors.capo` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L28) + +*** + +#### composer + +##### Get Signature + +> **get** **composer**(): `null` \| `string` \| `string`[] + +###### Returns + +`null` \| `string` \| `string`[] + +##### Inherited from + +`MetadataAccessors.composer` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L46) + +*** + +#### copyright + +##### Get Signature + +> **get** **copyright**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.copyright` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L40) + +*** + +#### duration + +##### Get Signature + +> **get** **duration**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.duration` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:30](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L30) + +*** + +#### key + +##### Get Signature + +> **get** **key**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.key` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:22](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L22) + +*** + +#### lyricist + +##### Get Signature + +> **get** **lyricist**(): `null` \| `string` \| `string`[] + +###### Returns + +`null` \| `string` \| `string`[] + +##### Inherited from + +`MetadataAccessors.lyricist` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L42) + +*** + +#### subtitle + +##### Get Signature + +> **get** **subtitle**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.subtitle` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L26) + +*** + +#### tempo + +##### Get Signature + +> **get** **tempo**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.tempo` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:32](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L32) + +*** + +#### time + +##### Get Signature + +> **get** **time**(): `null` \| `string` \| `string`[] + +###### Returns + +`null` \| `string` \| `string`[] + +##### Inherited from + +`MetadataAccessors.time` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L34) + +*** + +#### title + +##### Get Signature + +> **get** **title**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.title` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L24) + +*** + +#### year + +##### Get Signature + +> **get** **year**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.year` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L36) + +### Methods + +#### add() + +> **add**(`key`, `value`): `void` + +##### Parameters + +• **key**: `string` + +• **value**: `string` + +##### Returns + +`void` + +##### Defined in + +[chord\_sheet/metadata.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L46) + +*** + +#### calculateKeyFromCapo() + +> **calculateKeyFromCapo**(): `null` \| `string` + +##### Returns + +`null` \| `string` + +##### Defined in + +[chord\_sheet/metadata.ts:178](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L178) + +*** + +#### clone() + +> **clone**(): [`Metadata`](#classesmetadatamd) + +Returns a deep clone of this Metadata object + +##### Returns + +[`Metadata`](#classesmetadatamd) + +the cloned Metadata object + +##### Defined in + +[chord\_sheet/metadata.ts:174](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L174) + +*** + +#### contains() + +> **contains**(`key`): `boolean` + +##### Parameters + +• **key**: `string` + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/metadata.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L42) + +*** + +#### get() + +> **get**(`prop`): `null` \| `string` \| `string`[] + +Reads a metadata value by key. This method supports simple value lookup, as well as fetching single array values. + +This method deprecates direct property access, eg: metadata['author'] + +Examples: + +const metadata = new Metadata({ lyricist: 'Pete', author: ['John', 'Mary'] }); +metadata.get('lyricist') // => 'Pete' +metadata.get('author') // => ['John', 'Mary'] +metadata.get('author.1') // => 'John' +metadata.get('author.2') // => 'Mary' + +Using a negative index will start counting at the end of the list: + +const metadata = new Metadata({ lyricist: 'Pete', author: ['John', 'Mary'] }); +metadata.get('author.-1') // => 'Mary' +metadata.get('author.-2') // => 'John' + +##### Parameters + +• **prop**: `string` + +the property name + +##### Returns + +`null` \| `string` \| `string`[] + +the metadata value(s). If there is only one value, it will return a String, +else it returns an array of strings. + +##### Defined in + +[chord\_sheet/metadata.ts:109](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L109) + +*** + +#### getArrayItem() + +> **getArrayItem**(`prop`): `null` \| `string` + +##### Parameters + +• **prop**: `string` + +##### Returns + +`null` \| `string` + +##### Defined in + +[chord\_sheet/metadata.ts:150](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L150) + +*** + +#### getMetadata() + +> **getMetadata**(`name`): `null` \| `string` \| `string`[] + +##### Parameters + +• **name**: `string` + +##### Returns + +`null` \| `string` \| `string`[] + +##### Overrides + +`MetadataAccessors.getMetadata` + +##### Defined in + +[chord\_sheet/metadata.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L78) + +*** + +#### getSingleMetadata() + +> **getSingleMetadata**(`name`): `null` \| `string` + +##### Parameters + +• **name**: `string` + +##### Returns + +`null` \| `string` + +##### Overrides + +`MetadataAccessors.getSingleMetadata` + +##### Defined in + +[chord\_sheet/metadata.ts:82](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L82) + +*** + +#### merge() + +> **merge**(`metadata`): [`Metadata`](#classesmetadatamd) + +##### Parameters + +• **metadata**: `Record`\<`string`, `string` \| `string`[]\> + +##### Returns + +[`Metadata`](#classesmetadatamd) + +##### Defined in + +[chord\_sheet/metadata.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L36) + +*** + +#### parseArrayKey() + +> **parseArrayKey**(`prop`): `null` \| [`string`, `number`] + +##### Parameters + +• **prop**: `string` + +##### Returns + +`null` \| [`string`, `number`] + +##### Defined in + +[chord\_sheet/metadata.ts:138](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L138) + +*** + +#### set() + +> **set**(`key`, `value`): `void` + +##### Parameters + +• **key**: `string` + +• **value**: `null` \| `string` + +##### Returns + +`void` + +##### Defined in + +[chord\_sheet/metadata.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L70) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / Paragraph + +## Class: Paragraph + +Represents a paragraph of lines in a chord sheet + +### Constructors + +#### new Paragraph() + +> **new Paragraph**(): [`Paragraph`](#classesparagraphmd) + +##### Returns + +[`Paragraph`](#classesparagraphmd) + +### Properties + +#### lines + +> **lines**: [`Line`](#classeslinemd)[] = `[]` + +The [Line](#classeslinemd) items of which the paragraph consists + +##### Member + +##### Defined in + +[chord\_sheet/paragraph.ts:16](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L16) + +### Accessors + +#### contents + +##### Get Signature + +> **get** **contents**(): `string` + +Returns the paragraph contents as one string where lines are separated by newlines + +###### Returns + +`string` + +##### Defined in + +[chord\_sheet/paragraph.ts:52](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L52) + +*** + +#### label + +##### Get Signature + +> **get** **label**(): `null` \| `string` + +Returns the label of the paragraph. The label is the value of the first section delimiter tag +in the first line. + +###### Returns + +`null` \| `string` + +##### Defined in + +[chord\_sheet/paragraph.ts:68](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L68) + +*** + +#### type + +##### Get Signature + +> **get** **type**(): `LineType` + +Tries to determine the common type for all lines. If the types for all lines are equal, it returns that type. +If not, it returns [INDETERMINATE](#variablesindeterminatemd) + +###### Returns + +`LineType` + +##### Defined in + +[chord\_sheet/paragraph.ts:87](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L87) + +### Methods + +#### addLine() + +> **addLine**(`line`): `void` + +##### Parameters + +• **line**: `any` + +##### Returns + +`void` + +##### Defined in + +[chord\_sheet/paragraph.ts:18](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L18) + +*** + +#### hasRenderableItems() + +> **hasRenderableItems**(): `boolean` + +Indicates whether the paragraph contains lines with renderable items. + +##### Returns + +`boolean` + +##### See + +[Line.hasRenderableItems](#hasrenderableitems) + +##### Defined in + +[chord\_sheet/paragraph.ts:103](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L103) + +*** + +#### isEmpty() + +> **isEmpty**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/paragraph.ts:107](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L107) + +*** + +#### isLiteral() + +> **isLiteral**(): `boolean` + +Indicates whether the paragraph only contains literals. If true, [contents](#contents) can be used to retrieve +the paragraph contents as one string where lines are separated by newlines. + +##### Returns + +`boolean` + +##### See + +[contents](#contents) + +##### Defined in + +[chord\_sheet/paragraph.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L28) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / SoftLineBreak + +## Class: SoftLineBreak + +### Constructors + +#### new SoftLineBreak() + +> **new SoftLineBreak**(): [`SoftLineBreak`](#classessoftlinebreakmd) + +##### Returns + +[`SoftLineBreak`](#classessoftlinebreakmd) + +### Methods + +#### clone() + +> **clone**(): [`SoftLineBreak`](#classessoftlinebreakmd) + +##### Returns + +[`SoftLineBreak`](#classessoftlinebreakmd) + +##### Defined in + +[chord\_sheet/soft\_line\_break.ts:2](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/soft_line_break.ts#L2) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / Song + +## Class: Song + +Represents a song in a chord sheet. Currently a chord sheet can only have one song. + +### Extends + +- `MetadataAccessors` + +### Constructors + +#### new Song() + +> **new Song**(`metadata`): [`Song`](#classessongmd) + +Creates a new {Song} instance + +##### Parameters + +• **metadata** = `{}` + +{Object|Metadata} predefined metadata + +##### Returns + +[`Song`](#classessongmd) + +##### Overrides + +`MetadataAccessors.constructor` + +##### Defined in + +[chord\_sheet/song.ts:54](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L54) + +### Properties + +#### \_bodyLines + +> **\_bodyLines**: `null` \| [`Line`](#classeslinemd)[] = `null` + +##### Defined in + +[chord\_sheet/song.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L44) + +*** + +#### \_bodyParagraphs + +> **\_bodyParagraphs**: `null` \| [`Paragraph`](#classesparagraphmd)[] = `null` + +##### Defined in + +[chord\_sheet/song.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L46) + +*** + +#### lines + +> **lines**: [`Line`](#classeslinemd)[] = `[]` + +The [Line](#classeslinemd) items of which the song consists + +##### Member + +##### Defined in + +[chord\_sheet/song.ts:35](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L35) + +*** + +#### metadata + +> **metadata**: [`Metadata`](#classesmetadatamd) + +The song's metadata. When there is only one value for an entry, the value is a string. Else, the value is +an array containing all unique values for the entry. + +##### Defined in + +[chord\_sheet/song.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L42) + +*** + +#### warnings + +> **warnings**: `ParserWarning`[] = `[]` + +##### Defined in + +[chord\_sheet/song.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L48) + +### Accessors + +#### album + +##### Get Signature + +> **get** **album**(): `null` \| `string` \| `string`[] + +###### Returns + +`null` \| `string` \| `string`[] + +##### Inherited from + +`MetadataAccessors.album` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L38) + +*** + +#### artist + +##### Get Signature + +> **get** **artist**(): `null` \| `string` \| `string`[] + +###### Returns + +`null` \| `string` \| `string`[] + +##### Inherited from + +`MetadataAccessors.artist` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L44) + +*** + +#### bodyLines + +##### Get Signature + +> **get** **bodyLines**(): [`Line`](#classeslinemd)[] + +Returns the song lines, skipping the leading empty lines (empty as in not rendering any content). This is useful +if you want to skip the "header lines": the lines that only contain meta data. + +###### Returns + +[`Line`](#classeslinemd)[] + +The song body lines + +##### Defined in + +[chord\_sheet/song.ts:64](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L64) + +*** + +#### bodyParagraphs + +##### Get Signature + +> **get** **bodyParagraphs**(): [`Paragraph`](#classesparagraphmd)[] + +Returns the song paragraphs, skipping the paragraphs that only contain empty lines +(empty as in not rendering any content) + +###### See + +[bodyLines](#bodylines) + +###### Returns + +[`Paragraph`](#classesparagraphmd)[] + +##### Defined in + +[chord\_sheet/song.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L78) + +*** + +#### capo + +##### Get Signature + +> **get** **capo**(): `null` \| `string` \| `string`[] + +###### Returns + +`null` \| `string` \| `string`[] + +##### Inherited from + +`MetadataAccessors.capo` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L28) + +*** + +#### composer + +##### Get Signature + +> **get** **composer**(): `null` \| `string` \| `string`[] + +###### Returns + +`null` \| `string` \| `string`[] + +##### Inherited from + +`MetadataAccessors.composer` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L46) + +*** + +#### copyright + +##### Get Signature + +> **get** **copyright**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.copyright` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L40) + +*** + +#### duration + +##### Get Signature + +> **get** **duration**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.duration` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:30](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L30) + +*** + +#### expandedBodyParagraphs + +##### Get Signature + +> **get** **expandedBodyParagraphs**(): [`Paragraph`](#classesparagraphmd)[] + +The body paragraphs of the song, with any `{chorus}` tag expanded into the targeted chorus + +###### Returns + +[`Paragraph`](#classesparagraphmd)[] + +##### Defined in + +[chord\_sheet/song.ts:156](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L156) + +*** + +#### key + +##### Get Signature + +> **get** **key**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.key` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:22](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L22) + +*** + +#### lyricist + +##### Get Signature + +> **get** **lyricist**(): `null` \| `string` \| `string`[] + +###### Returns + +`null` \| `string` \| `string`[] + +##### Inherited from + +`MetadataAccessors.lyricist` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L42) + +*** + +#### paragraphs + +##### Get Signature + +> **get** **paragraphs**(): [`Paragraph`](#classesparagraphmd)[] + +The [Paragraph](#classesparagraphmd) items of which the song consists + +###### Member + +###### Returns + +[`Paragraph`](#classesparagraphmd)[] + +##### Defined in + +[chord\_sheet/song.ts:148](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L148) + +*** + +#### subtitle + +##### Get Signature + +> **get** **subtitle**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.subtitle` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L26) + +*** + +#### tempo + +##### Get Signature + +> **get** **tempo**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.tempo` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:32](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L32) + +*** + +#### time + +##### Get Signature + +> **get** **time**(): `null` \| `string` \| `string`[] + +###### Returns + +`null` \| `string` \| `string`[] + +##### Inherited from + +`MetadataAccessors.time` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L34) + +*** + +#### title + +##### Get Signature + +> **get** **title**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.title` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L24) + +*** + +#### year + +##### Get Signature + +> **get** **year**(): `null` \| `string` + +###### Returns + +`null` \| `string` + +##### Inherited from + +`MetadataAccessors.year` + +##### Defined in + +[chord\_sheet/metadata\_accessors.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L36) + +### Methods + +#### addLine() + +> **addLine**(`line`): `void` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +##### Returns + +`void` + +##### Defined in + +[chord\_sheet/song.ts:380](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L380) + +*** + +#### changeKey() + +> **changeKey**(`newKey`): [`Song`](#classessongmd) + +Returns a copy of the song with the key set to the specified key. It changes: +- the value for `key` in the [metadata](#metadata) set +- any existing `key` directive +- all chords, those are transposed according to the distance between the current and the new key + +##### Parameters + +• **newKey**: `string` \| [`Key`](#classeskeymd) + +The new key. + +##### Returns + +[`Song`](#classessongmd) + +The changed song + +##### Defined in + +[chord\_sheet/song.ts:304](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L304) + +*** + +#### changeMetadata() + +> **changeMetadata**(`name`, `value`): [`Song`](#classessongmd) + +Returns a copy of the song with the directive value set to the specified value. +- when there is a matching directive in the song, it will update the directive +- when there is no matching directive, it will be inserted +If `value` is `null` it will act as a delete, any directive matching `name` will be removed. + +##### Parameters + +• **name**: `string` + +The directive name + +• **value**: `null` \| `string` + +The value to set, or `null` to remove the directive + +##### Returns + +[`Song`](#classessongmd) + +##### Defined in + +[chord\_sheet/song.ts:357](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L357) + +*** + +#### clone() + +> **clone**(): [`Song`](#classessongmd) + +Returns a deep clone of the song + +##### Returns + +[`Song`](#classessongmd) + +The cloned song + +##### Defined in + +[chord\_sheet/song.ts:186](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L186) + +*** + +#### foreachItem() + +> **foreachItem**(`func`): `void` + +##### Parameters + +• **func**: `EachItemCallback` + +##### Returns + +`void` + +##### Defined in + +[chord\_sheet/song.ts:417](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L417) + +*** + +#### getChordDefinitions() + +> **getChordDefinitions**(): `Record`\<`string`, [`ChordDefinition`](#classeschorddefinitionmd)\> + +Returns all chord definitions from the song. +Definitions are made using the `{chord}` or `{define}` directive. +A chord definitions overrides a previous chord definition for the exact same chord. + +##### Returns + +`Record`\<`string`, [`ChordDefinition`](#classeschorddefinitionmd)\> + +the chord definitions + +##### See + + - https://chordpro.org/chordpro/directives-define/ + - https://chordpro.org/chordpro/directives-chord/ + +##### Defined in + +[chord\_sheet/song.ts:453](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L453) + +*** + +#### getChords() + +> **getChords**(): `string`[] + +Returns all unique chords used in the song + +##### Returns + +`string`[] + +the chords + +##### Defined in + +[chord\_sheet/song.ts:427](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L427) + +*** + +#### getMetadata() + +> **getMetadata**(`name`): `null` \| `string` \| `string`[] + +##### Parameters + +• **name**: `string` + +##### Returns + +`null` \| `string` \| `string`[] + +##### Overrides + +`MetadataAccessors.getMetadata` + +##### Defined in + +[chord\_sheet/song.ts:194](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L194) + +*** + +#### getSingleMetadata() + +> **getSingleMetadata**(`name`): `null` \| `string` + +##### Parameters + +• **name**: `string` + +##### Returns + +`null` \| `string` + +##### Overrides + +`MetadataAccessors.getSingleMetadata` + +##### Defined in + +[chord\_sheet/song.ts:198](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L198) + +*** + +#### linesToParagraphs() + +> **linesToParagraphs**(`lines`): [`Paragraph`](#classesparagraphmd)[] + +##### Parameters + +• **lines**: [`Line`](#classeslinemd)[] + +##### Returns + +[`Paragraph`](#classesparagraphmd)[] + +##### Defined in + +[chord\_sheet/song.ts:164](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L164) + +*** + +#### mapItems() + +> **mapItems**(`func`): [`Song`](#classessongmd) + +Change the song contents inline. Return a new Item to replace it. Return `null` to remove it. + +##### Parameters + +• **func**: `MapItemsCallback` + +the callback function + +##### Returns + +[`Song`](#classessongmd) + +the changed song + +##### Example + +```ts +// transpose all chords: +song.mapItems((item) => { + if (item instanceof ChordLyricsPair) { + return item.transpose(2, 'D'); + } + + return item; +}); +``` + +##### Defined in + +[chord\_sheet/song.ts:398](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L398) + +*** + +#### mapLines() + +> **mapLines**(`func`): [`Song`](#classessongmd) + +Change the song contents inline. Return a new [Line](#classeslinemd) to replace it. Return `null` to remove it. + +##### Parameters + +• **func**: `MapLinesCallback` + +the callback function + +##### Returns + +[`Song`](#classessongmd) + +the changed song + +##### Example + +```ts +// remove lines with only Tags: +song.mapLines((line) => { + if (line.items.every(item => item instanceof Tag)) { + return null; + } + + return line; +}); +``` + +##### Defined in + +[chord\_sheet/song.ts:485](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L485) + +*** + +#### requireCurrentKey() + +> **requireCurrentKey**(): [`Key`](#classeskeymd) + +##### Returns + +[`Key`](#classeskeymd) + +##### Defined in + +[chord\_sheet/song.ts:332](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L332) + +*** + +#### selectRenderableItems() + +> **selectRenderableItems**(`items`): ([`Line`](#classeslinemd) \| [`Paragraph`](#classesparagraphmd))[] + +##### Parameters + +• **items**: ([`Line`](#classeslinemd) \| [`Paragraph`](#classesparagraphmd))[] + +##### Returns + +([`Line`](#classeslinemd) \| [`Paragraph`](#classesparagraphmd))[] + +##### Defined in + +[chord\_sheet/song.ts:86](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L86) + +*** + +#### setCapo() + +> **setCapo**(`capo`): [`Song`](#classessongmd) + +Returns a copy of the song with the key value set to the specified capo. It changes: +- the value for `capo` in the [metadata](#metadata) set +- any existing `capo` directive + +##### Parameters + +• **capo**: `null` \| `number` + +the capo. Passing `null` will: +- remove the current key from [metadata](#metadata) +- remove any `capo` directive + +##### Returns + +[`Song`](#classessongmd) + +The changed song + +##### Defined in + +[chord\_sheet/song.ts:225](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L225) + +*** + +#### setKey() + +> **setKey**(`key`): [`Song`](#classessongmd) + +Returns a copy of the song with the key value set to the specified key. It changes: +- the value for `key` in the [metadata](#metadata) set +- any existing `key` directive + +##### Parameters + +• **key**: `null` \| `string` \| `number` + +the key. Passing `null` will: +- remove the current key from [metadata](#metadata) +- remove any `key` directive + +##### Returns + +[`Song`](#classessongmd) + +The changed song + +##### Defined in + +[chord\_sheet/song.ts:211](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L211) + +*** + +#### setMetadata() + +> **setMetadata**(`name`, `value`): `void` + +##### Parameters + +• **name**: `string` + +• **value**: `string` + +##### Returns + +`void` + +##### Defined in + +[chord\_sheet/song.ts:190](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L190) + +*** + +#### transpose() + +> **transpose**(`delta`, `options`?): [`Song`](#classessongmd) + +Transposes the song by the specified delta. It will: +- transpose all chords, see: [Chord#transpose](#transpose) +- transpose the song key in [metadata](#metadata) +- update any existing `key` directive + +##### Parameters + +• **delta**: `number` + +The number of semitones (positive or negative) to transpose with + +• **options?** = `{}` + +options + +• **options.normalizeChordSuffix?**: `undefined` \| `boolean` = `false` + +whether to normalize the chord suffixes after transposing + +##### Returns + +[`Song`](#classessongmd) + +The transposed song + +##### Defined in + +[chord\_sheet/song.ts:252](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L252) + +*** + +#### transposeDown() + +> **transposeDown**(`options`?): [`Song`](#classessongmd) + +Transposes the song down by one semitone. It will: +- transpose all chords, see: [Chord#transpose](#transpose) +- transpose the song key in [metadata](#metadata) +- update any existing `key` directive + +##### Parameters + +• **options?** = `{}` + +options + +• **options.normalizeChordSuffix?**: `undefined` \| `boolean` = `false` + +whether to normalize the chord suffixes after transposing + +##### Returns + +[`Song`](#classessongmd) + +The transposed song + +##### Defined in + +[chord\_sheet/song.ts:292](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L292) + +*** + +#### transposeUp() + +> **transposeUp**(`options`?): [`Song`](#classessongmd) + +Transposes the song up by one semitone. It will: +- transpose all chords, see: [Chord#transpose](#transpose) +- transpose the song key in [metadata](#metadata) +- update any existing `key` directive + +##### Parameters + +• **options?** = `{}` + +options + +• **options.normalizeChordSuffix?**: `undefined` \| `boolean` = `false` + +whether to normalize the chord suffixes after transposing + +##### Returns + +[`Song`](#classessongmd) + +The transposed song + +##### Defined in + +[chord\_sheet/song.ts:279](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L279) + +*** + +#### useModifier() + +> **useModifier**(`modifier`): [`Song`](#classessongmd) + +Returns a copy of the song with all chords changed to the specified modifier. + +##### Parameters + +• **modifier**: `Modifier` + +the new modifier + +##### Returns + +[`Song`](#classessongmd) + +the changed song + +##### Defined in + +[chord\_sheet/song.ts:322](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L322) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / Tag + +## Class: Tag + +Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-directives/ + +### Extends + +- `AstComponent` + +### Constructors + +#### new Tag() + +> **new Tag**(`name`, `value`, `traceInfo`): [`Tag`](#classestagmd) + +##### Parameters + +• **name**: `string` + +• **value**: `null` \| `string` = `null` + +• **traceInfo**: `null` \| `TraceInfo` = `null` + +##### Returns + +[`Tag`](#classestagmd) + +##### Overrides + +`AstComponent.constructor` + +##### Defined in + +[chord\_sheet/tag.ts:412](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L412) + +### Properties + +#### \_isMetaTag + +> **\_isMetaTag**: `boolean` = `false` + +##### Defined in + +[chord\_sheet/tag.ts:402](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L402) + +*** + +#### \_name + +> **\_name**: `string` = `''` + +##### Defined in + +[chord\_sheet/tag.ts:406](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L406) + +*** + +#### \_originalName + +> **\_originalName**: `string` = `''` + +##### Defined in + +[chord\_sheet/tag.ts:404](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L404) + +*** + +#### \_value + +> **\_value**: `string` = `''` + +##### Defined in + +[chord\_sheet/tag.ts:408](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L408) + +*** + +#### chordDefinition? + +> `optional` **chordDefinition**: [`ChordDefinition`](#classeschorddefinitionmd) + +##### Defined in + +[chord\_sheet/tag.ts:410](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L410) + +*** + +#### column + +> **column**: `null` \| `number` = `null` + +##### Inherited from + +`AstComponent.column` + +##### Defined in + +[chord\_sheet/ast\_component.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L6) + +*** + +#### line + +> **line**: `null` \| `number` = `null` + +##### Inherited from + +`AstComponent.line` + +##### Defined in + +[chord\_sheet/ast\_component.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L4) + +*** + +#### offset + +> **offset**: `null` \| `number` = `null` + +##### Inherited from + +`AstComponent.offset` + +##### Defined in + +[chord\_sheet/ast\_component.ts:8](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L8) + +### Accessors + +#### name + +##### Get Signature + +> **get** **name**(): `string` + +The tag full name. When the original tag used the short name, `name` will return the full name. + +###### Member + +###### Returns + +`string` + +##### Set Signature + +> **set** **name**(`name`): `void` + +###### Parameters + +• **name**: `string` + +###### Returns + +`void` + +##### Defined in + +[chord\_sheet/tag.ts:491](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L491) + +*** + +#### originalName + +##### Get Signature + +> **get** **originalName**(): `string` + +The original tag name that was used to construct the tag. + +###### Member + +###### Returns + +`string` + +##### Defined in + +[chord\_sheet/tag.ts:500](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L500) + +*** + +#### value + +##### Get Signature + +> **get** **value**(): `string` + +The tag value + +###### Member + +###### Returns + +`string` + +##### Set Signature + +> **set** **value**(`value`): `void` + +###### Parameters + +• **value**: `string` + +###### Returns + +`void` + +##### Defined in + +[chord\_sheet/tag.ts:513](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L513) + +### Methods + +#### clone() + +> **clone**(): [`Tag`](#classestagmd) + +Returns a clone of the tag. + +##### Returns + +[`Tag`](#classestagmd) + +The cloned tag + +##### Overrides + +`AstComponent.clone` + +##### Defined in + +[chord\_sheet/tag.ts:555](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L555) + +*** + +#### hasRenderableLabel() + +> **hasRenderableLabel**(): `boolean` + +Check whether this tag's label (if any) should be rendered, as applicable to tags like +`start_of_verse` and `start_of_chorus`. +See https://chordpro.org/chordpro/directives-env_chorus/, https://chordpro.org/chordpro/directives-env_verse/, +https://chordpro.org/chordpro/directives-env_bridge/, https://chordpro.org/chordpro/directives-env_tab/ + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/tag.ts:539](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L539) + +*** + +#### hasValue() + +> **hasValue**(): `boolean` + +Checks whether the tag value is a non-empty string. + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/tag.ts:521](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L521) + +*** + +#### isInlineFontTag() + +> **isInlineFontTag**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/tag.ts:477](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L477) + +*** + +#### isMetaTag() + +> **isMetaTag**(): `boolean` + +Checks whether the tag is either a standard meta tag or a custom meta directive (`{x_some_name}`) + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/tag.ts:547](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L547) + +*** + +#### isRenderable() + +> **isRenderable**(): `boolean` + +Checks whether the tag is usually rendered inline. It currently only applies to comment tags. + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/tag.ts:529](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L529) + +*** + +#### isSectionDelimiter() + +> **isSectionDelimiter**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/tag.ts:465](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L465) + +*** + +#### isSectionEnd() + +> **isSectionEnd**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/tag.ts:473](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L473) + +*** + +#### isSectionStart() + +> **isSectionStart**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/tag.ts:469](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L469) + +*** + +#### set() + +> **set**(`__namedParameters`): [`Tag`](#classestagmd) + +##### Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.value**: `string` + +##### Returns + +[`Tag`](#classestagmd) + +##### Defined in + +[chord\_sheet/tag.ts:563](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L563) + +*** + +#### toString() + +> **toString**(): `string` + +Returns a string representation of an object. + +##### Returns + +`string` + +##### Defined in + +[chord\_sheet/tag.ts:559](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L559) + +*** + +#### parse() + +> `static` **parse**(`tag`): `null` \| [`Tag`](#classestagmd) + +##### Parameters + +• **tag**: `string` \| [`Tag`](#classestagmd) + +##### Returns + +`null` \| [`Tag`](#classestagmd) + +##### Defined in + +[chord\_sheet/tag.ts:437](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L437) + +*** + +#### parseOrFail() + +> `static` **parseOrFail**(`tag`): [`Tag`](#classestagmd) + +##### Parameters + +• **tag**: `string` \| [`Tag`](#classestagmd) + +##### Returns + +[`Tag`](#classestagmd) + +##### Defined in + +[chord\_sheet/tag.ts:455](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L455) + +*** + +#### parseWithRegex() + +> `static` **parseWithRegex**(`tag`, `regex`): `null` \| [`Tag`](#classestagmd) + +##### Parameters + +• **tag**: `string` + +• **regex**: `RegExp` + +##### Returns + +`null` \| [`Tag`](#classestagmd) + +##### Defined in + +[chord\_sheet/tag.ts:445](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L445) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / Ternary + +## Class: Ternary + +### Extends + +- `Evaluatable` + +### Constructors + +#### new Ternary() + +> **new Ternary**(`__namedParameters`): [`Ternary`](#classesternarymd) + +##### Parameters + +• **\_\_namedParameters**: `TernaryProperties` + +##### Returns + +[`Ternary`](#classesternarymd) + +##### Overrides + +`Evaluatable.constructor` + +##### Defined in + +[chord\_sheet/chord\_pro/ternary.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L24) + +### Properties + +#### column + +> **column**: `null` \| `number` = `null` + +##### Inherited from + +`Evaluatable.column` + +##### Defined in + +[chord\_sheet/ast\_component.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L6) + +*** + +#### falseExpression + +> **falseExpression**: `Evaluatable`[] = `[]` + +##### Defined in + +[chord\_sheet/chord\_pro/ternary.ts:22](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L22) + +*** + +#### line + +> **line**: `null` \| `number` = `null` + +##### Inherited from + +`Evaluatable.line` + +##### Defined in + +[chord\_sheet/ast\_component.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L4) + +*** + +#### offset + +> **offset**: `null` \| `number` = `null` + +##### Inherited from + +`Evaluatable.offset` + +##### Defined in + +[chord\_sheet/ast\_component.ts:8](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L8) + +*** + +#### trueExpression + +> **trueExpression**: `Evaluatable`[] = `[]` + +##### Defined in + +[chord\_sheet/chord\_pro/ternary.ts:20](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L20) + +*** + +#### valueTest + +> **valueTest**: `null` \| `string` + +##### Defined in + +[chord\_sheet/chord\_pro/ternary.ts:18](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L18) + +*** + +#### variable + +> **variable**: `null` \| `string` + +##### Defined in + +[chord\_sheet/chord\_pro/ternary.ts:16](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L16) + +### Methods + +#### clone() + +> **clone**(): [`Ternary`](#classesternarymd) + +##### Returns + +[`Ternary`](#classesternarymd) + +##### Overrides + +`Evaluatable.clone` + +##### Defined in + +[chord\_sheet/chord\_pro/ternary.ts:98](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L98) + +*** + +#### evaluate() + +> **evaluate**(`metadata`, `metadataSeparator`?, `upperContext`?): `string` + +Evaluate the meta expression + +##### Parameters + +• **metadata**: [`Metadata`](#classesmetadatamd) + +The metadata object to use for evaluating the expression + +• **metadataSeparator?**: `string` + +The metadata separator to use if necessary + +• **upperContext?**: `null` \| `string` = `null` + +##### Returns + +`string` + +The evaluated expression + +##### Overrides + +`Evaluatable.evaluate` + +##### Defined in + +[chord\_sheet/chord\_pro/ternary.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L48) + +*** + +#### evaluateForTruthyValue() + +> **evaluateForTruthyValue**(`metadata`, `metadataSeparator`, `value`): `string` + +##### Parameters + +• **metadata**: [`Metadata`](#classesmetadatamd) + +• **metadataSeparator**: `string` + +• **value**: `string` \| `string`[] + +##### Returns + +`string` + +##### Defined in + +[chord\_sheet/chord\_pro/ternary.ts:86](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L86) + +*** + +#### evaluateToString() + +> **evaluateToString**(`value`, `metadataSeparator`): `string` + +##### Parameters + +• **value**: `string` \| `string`[] + +• **metadataSeparator**: `string` + +##### Returns + +`string` + +##### Defined in + +[chord\_sheet/chord\_pro/ternary.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L60) + +*** + +#### evaluateWithVariable() + +> **evaluateWithVariable**(`metadata`, `metadataSeparator`): `string` + +##### Parameters + +• **metadata**: [`Metadata`](#classesmetadatamd) + +• **metadataSeparator**: `string` + +##### Returns + +`string` + +##### Defined in + +[chord\_sheet/chord\_pro/ternary.ts:68](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L68) + +*** + +#### isRenderable() + +> **isRenderable**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[chord\_sheet/chord\_pro/ternary.ts:94](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L94) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / TextFormatter + +## Class: TextFormatter + +Formats a song into a plain text chord sheet + +### Extends + +- [`Formatter`](#classesformattermd) + +### Constructors + +#### new TextFormatter() + +> **new TextFormatter**(`configuration`?): [`TextFormatter`](#classestextformattermd) + +Instantiate + +##### Parameters + +• **configuration?**: `Partial`\<`ConfigurationProperties`\> = `{}` + +options + +##### Returns + +[`TextFormatter`](#classestextformattermd) + +##### Inherited from + +[`Formatter`](#classesformattermd).[`constructor`](#constructors) + +##### Defined in + +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) + +### Properties + +#### configuration + +> **configuration**: `Configuration` + +##### Inherited from + +[`Formatter`](#classesformattermd).[`configuration`](#configuration) + +##### Defined in + +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) + +*** + +#### song + +> **song**: [`Song`](#classessongmd) + +##### Defined in + +[formatter/text\_formatter.ts:17](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L17) + +### Methods + +#### chordLyricsPairLength() + +> **chordLyricsPairLength**(`chordLyricsPair`, `line`): `number` + +##### Parameters + +• **chordLyricsPair**: [`ChordLyricsPair`](#classeschordlyricspairmd) + +• **line**: [`Line`](#classeslinemd) + +##### Returns + +`number` + +##### Defined in + +[formatter/text\_formatter.ts:102](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L102) + +*** + +#### format() + +> **format**(`song`): `string` + +Formats a song into a plain text chord sheet + +##### Parameters + +• **song**: [`Song`](#classessongmd) + +The song to be formatted + +##### Returns + +`string` + +the chord sheet + +##### Defined in + +[formatter/text\_formatter.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L24) + +*** + +#### formatHeader() + +> **formatHeader**(): `string` + +##### Returns + +`string` + +##### Defined in + +[formatter/text\_formatter.ts:33](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L33) + +*** + +#### formatItemBottom() + +> **formatItemBottom**(`item`, `metadata`, `line`): `string` + +##### Parameters + +• **item**: `Item` + +• **metadata**: [`Metadata`](#classesmetadatamd) + +• **line**: [`Line`](#classeslinemd) + +##### Returns + +`string` + +##### Defined in + +[formatter/text\_formatter.ts:161](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L161) + +*** + +#### formatItemTop() + +> **formatItemTop**(`item`, `_metadata`, `line`): `string` + +##### Parameters + +• **item**: `Item` + +• **\_metadata**: [`Metadata`](#classesmetadatamd) + +• **line**: [`Line`](#classeslinemd) + +##### Returns + +`string` + +##### Defined in + +[formatter/text\_formatter.ts:129](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L129) + +*** + +#### formatLine() + +> **formatLine**(`line`, `metadata`): `string` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +• **metadata**: [`Metadata`](#classesmetadatamd) + +##### Returns + +`string` + +##### Defined in + +[formatter/text\_formatter.ts:66](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L66) + +*** + +#### formatLineBottom() + +> **formatLineBottom**(`line`, `metadata`): `string` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +• **metadata**: [`Metadata`](#classesmetadatamd) + +##### Returns + +`string` + +##### Defined in + +[formatter/text\_formatter.ts:142](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L142) + +*** + +#### formatLineTop() + +> **formatLineTop**(`line`, `metadata`): `null` \| `string` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +• **metadata**: [`Metadata`](#classesmetadatamd) + +##### Returns + +`null` \| `string` + +##### Defined in + +[formatter/text\_formatter.ts:94](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L94) + +*** + +#### formatLineWithFormatter() + +> **formatLineWithFormatter**(`line`, `formatter`, `metadata`): `string` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +• **formatter** + +• **metadata**: [`Metadata`](#classesmetadatamd) + +##### Returns + +`string` + +##### Defined in + +[formatter/text\_formatter.ts:150](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L150) + +*** + +#### formatParagraph() + +> **formatParagraph**(`paragraph`, `metadata`): `string` + +##### Parameters + +• **paragraph**: [`Paragraph`](#classesparagraphmd) + +• **metadata**: [`Metadata`](#classesmetadatamd) + +##### Returns + +`string` + +##### Defined in + +[formatter/text\_formatter.ts:53](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L53) + +*** + +#### formatParagraphs() + +> **formatParagraphs**(): `string` + +##### Returns + +`string` + +##### Defined in + +[formatter/text\_formatter.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L44) + +*** + +#### formatSubTitle() + +> **formatSubTitle**(`subtitle`): `string` + +##### Parameters + +• **subtitle**: `null` \| `string` + +##### Returns + +`string` + +##### Defined in + +[formatter/text\_formatter.ts:86](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L86) + +*** + +#### formatTitle() + +> **formatTitle**(`title`): `string` + +##### Parameters + +• **title**: `null` \| `string` + +##### Returns + +`string` + +##### Defined in + +[formatter/text\_formatter.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L78) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / UltimateGuitarParser + +## Class: UltimateGuitarParser + +Parses an Ultimate Guitar chord sheet with metadata +Inherits from [ChordSheetParser](#classeschordsheetparsermd) + +### Extends + +- [`ChordSheetParser`](#classeschordsheetparsermd) + +### Constructors + +#### new UltimateGuitarParser() + +> **new UltimateGuitarParser**(`options`?): [`UltimateGuitarParser`](#classesultimateguitarparsermd) + +Instantiate a chord sheet parser + +##### Parameters + +• **options?** = `{}` + +options + +• **options.preserveWhitespace?**: `boolean` = `true` + +whether to preserve trailing whitespace for chords + +##### Returns + +[`UltimateGuitarParser`](#classesultimateguitarparsermd) + +##### Overrides + +[`ChordSheetParser`](#classeschordsheetparsermd).[`constructor`](#constructors) + +##### Defined in + +[parser/ultimate\_guitar\_parser.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L38) + +### Properties + +#### chordLyricsPair + +> **chordLyricsPair**: `null` \| [`ChordLyricsPair`](#classeschordlyricspairmd) = `null` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`chordLyricsPair`](#chordlyricspair) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:31](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L31) + +*** + +#### currentLine + +> **currentLine**: `number` = `0` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`currentLine`](#currentline) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:35](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L35) + +*** + +#### currentSectionType + +> **currentSectionType**: `null` \| `string` = `null` + +##### Defined in + +[parser/ultimate\_guitar\_parser.ts:31](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L31) + +*** + +#### lineCount + +> **lineCount**: `number` = `0` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`lineCount`](#linecount) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:37](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L37) + +*** + +#### lines + +> **lines**: `string`[] = `[]` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`lines`](#lines) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:33](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L33) + +*** + +#### preserveWhitespace + +> **preserveWhitespace**: `boolean` = `true` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`preserveWhitespace`](#preservewhitespace) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:23](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L23) + +*** + +#### processingText + +> **processingText**: `boolean` = `true` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`processingText`](#processingtext) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L21) + +*** + +#### song + +> **song**: [`Song`](#classessongmd) + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`song`](#song) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L25) + +*** + +#### songBuilder + +> **songBuilder**: `SongBuilder` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`songBuilder`](#songbuilder) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:27](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L27) + +*** + +#### songLine + +> **songLine**: `null` \| [`Line`](#classeslinemd) = `null` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`songLine`](#songline) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:29](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L29) + +### Methods + +#### addCharacter() + +> **addCharacter**(`chr`, `nextChar`): `void` + +##### Parameters + +• **chr**: `any` + +• **nextChar**: `any` + +##### Returns + +`void` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`addCharacter`](#addcharacter) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:160](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L160) + +*** + +#### endOfSong() + +> **endOfSong**(): `void` + +##### Returns + +`void` + +##### Overrides + +[`ChordSheetParser`](#classeschordsheetparsermd).[`endOfSong`](#endofsong) + +##### Defined in + +[parser/ultimate\_guitar\_parser.ts:79](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L79) + +*** + +#### endSection() + +> **endSection**(`__namedParameters`): `void` + +##### Parameters + +• **\_\_namedParameters** = `{}` + +• **\_\_namedParameters.addNewLine**: `undefined` \| `boolean` = `true` + +##### Returns + +`void` + +##### Defined in + +[parser/ultimate\_guitar\_parser.ts:100](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L100) + +*** + +#### ensureChordLyricsPairInitialized() + +> **ensureChordLyricsPairInitialized**(): `void` + +##### Returns + +`void` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`ensureChordLyricsPairInitialized`](#ensurechordlyricspairinitialized) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:177](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L177) + +*** + +#### hasNextLine() + +> **hasNextLine**(): `boolean` + +##### Returns + +`boolean` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`hasNextLine`](#hasnextline) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:124](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L124) + +*** + +#### initialize() + +> **initialize**(`document`, `song`): `void` + +##### Parameters + +• **document**: `any` + +• **song**: `null` \| [`Song`](#classessongmd) = `null` + +##### Returns + +`void` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`initialize`](#initialize) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:107](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L107) + +*** + +#### isSectionEnd() + +> **isSectionEnd**(): `boolean` + +##### Returns + +`boolean` + +##### Defined in + +[parser/ultimate\_guitar\_parser.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L72) + +*** + +#### parse() + +> **parse**(`chordSheet`, `options`?): [`Song`](#classessongmd) + +Parses a chord sheet into a song + +##### Parameters + +• **chordSheet**: `string` + +The ChordPro chord sheet + +• **options?** = `{}` + +Optional parser options + +• **options.song?**: [`Song`](#classessongmd) + +The [Song](#classessongmd) to store the song data in + +##### Returns + +[`Song`](#classessongmd) + +The parsed song + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`parse`](#parse) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L70) + +*** + +#### parseLine() + +> **parseLine**(`line`): `void` + +##### Parameters + +• **line**: `any` + +##### Returns + +`void` + +##### Overrides + +[`ChordSheetParser`](#classeschordsheetparsermd).[`parseLine`](#parseline) + +##### Defined in + +[parser/ultimate\_guitar\_parser.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L42) + +*** + +#### parseLyricsWithChords() + +> **parseLyricsWithChords**(`chordsLine`, `lyricsLine`): `void` + +##### Parameters + +• **chordsLine**: `any` + +• **lyricsLine**: `any` + +##### Returns + +`void` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`parseLyricsWithChords`](#parselyricswithchords) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:128](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L128) + +*** + +#### parseNonEmptyLine() + +> **parseNonEmptyLine**(`line`): `void` + +##### Parameters + +• **line**: `any` + +##### Returns + +`void` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`parseNonEmptyLine`](#parsenonemptyline) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:94](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L94) + +*** + +#### processCharacters() + +> **processCharacters**(`chordsLine`, `lyricsLine`): `void` + +##### Parameters + +• **chordsLine**: `any` + +• **lyricsLine**: `any` + +##### Returns + +`void` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`processCharacters`](#processcharacters) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:146](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L146) + +*** + +#### readLine() + +> **readLine**(): `string` + +##### Returns + +`string` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`readLine`](#readline) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:118](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L118) + +*** + +#### shouldAddCharacterToChords() + +> **shouldAddCharacterToChords**(`nextChar`): `any` + +##### Parameters + +• **nextChar**: `any` + +##### Returns + +`any` + +##### Inherited from + +[`ChordSheetParser`](#classeschordsheetparsermd).[`shouldAddCharacterToChords`](#shouldaddcharactertochords) + +##### Defined in + +[parser/chord\_sheet\_parser.ts:173](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L173) + +*** + +#### startNewLine() + +> **startNewLine**(): `void` + +##### Returns + +`void` + +##### Defined in + +[parser/ultimate\_guitar\_parser.ts:113](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L113) + +*** + +#### startSection() + +> **startSection**(`sectionType`, `label`): `void` + +##### Parameters + +• **sectionType**: `"chorus"` \| `"verse"` + +• **label**: `string` + +##### Returns + +`void` + +##### Defined in + +[parser/ultimate\_guitar\_parser.ts:87](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L87) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +# chordsheetjs + +## Classes + +- [Chord](#classeschordmd) +- [ChordDefinition](#classeschorddefinitionmd) +- [ChordLyricsPair](#classeschordlyricspairmd) +- [ChordProFormatter](#classeschordproformattermd) +- [ChordProParser](#classeschordproparsermd) +- [ChordSheetParser](#classeschordsheetparsermd) +- [ChordSheetSerializer](#classeschordsheetserializermd) +- [ChordsOverWordsFormatter](#classeschordsoverwordsformattermd) +- [ChordsOverWordsParser](#classeschordsoverwordsparsermd) +- [Comment](#classescommentmd) +- [Composite](#classescompositemd) +- [Formatter](#classesformattermd) +- [HtmlDivFormatter](#classeshtmldivformattermd) +- [HtmlFormatter](#classeshtmlformattermd) +- [HtmlTableFormatter](#classeshtmltableformattermd) +- [Key](#classeskeymd) +- [Line](#classeslinemd) +- [Literal](#classesliteralmd) +- [Metadata](#classesmetadatamd) +- [Paragraph](#classesparagraphmd) +- [SoftLineBreak](#classessoftlinebreakmd) +- [Song](#classessongmd) +- [Tag](#classestagmd) +- [Ternary](#classesternarymd) +- [TextFormatter](#classestextformattermd) +- [UltimateGuitarParser](#classesultimateguitarparsermd) + +## Variables + +- [ABC](#variablesabcmd) +- [CHORUS](#variableschorusmd) +- [default](#variablesdefaultmd) +- [INDETERMINATE](#variablesindeterminatemd) +- [LILYPOND](#variableslilypondmd) +- [NONE](#variablesnonemd) +- [NUMERAL](#variablesnumeralmd) +- [NUMERIC](#variablesnumericmd) +- [SOLFEGE](#variablessolfegemd) +- [SYMBOL](#variablessymbolmd) +- [TAB](#variablestabmd) +- [templateHelpers](#variablestemplatehelpersmd) +- [VERSE](#variablesversemd) + +# Variables + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / ABC + +## Variable: ABC + +> `const` **ABC**: `"abc"` = `'abc'` + +Used to mark a section as ABC music notation + +### Constant + +### Defined in + +[constants.ts:62](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L62) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / CHORUS + +## Variable: CHORUS + +> `const` **CHORUS**: `"chorus"` = `'chorus'` + +Used to mark a paragraph as chorus + +### Constant + +### Defined in + +[constants.ts:13](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L13) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / INDETERMINATE + +## Variable: INDETERMINATE + +> `const` **INDETERMINATE**: `"indeterminate"` = `'indeterminate'` + +Used to mark a paragraph as containing lines with both verse and chorus type + +### Constant + +### Defined in + +[constants.ts:27](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L27) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / LILYPOND + +## Variable: LILYPOND + +> `const` **LILYPOND**: `"ly"` = `'ly'` + +Used to mark a section as Lilypond notation + +### Constant + +### Defined in + +[constants.ts:55](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L55) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / NONE + +## Variable: NONE + +> `const` **NONE**: `"none"` = `'none'` + +Used to mark a paragraph as not containing a line marked with a type + +### Constant + +### Defined in + +[constants.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L34) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / NUMERAL + +## Variable: NUMERAL + +> `const` **NUMERAL**: `"numeral"` = `'numeral'` + +### Defined in + +[constants.ts:77](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L77) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / NUMERIC + +## Variable: NUMERIC + +> `const` **NUMERIC**: `"numeric"` = `'numeric'` + +### Defined in + +[constants.ts:76](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L76) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / SOLFEGE + +## Variable: SOLFEGE + +> `const` **SOLFEGE**: `"solfege"` = `'solfege'` + +### Defined in + +[constants.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L78) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / SYMBOL + +## Variable: SYMBOL + +> `const` **SYMBOL**: `"symbol"` = `'symbol'` + +### Defined in + +[constants.ts:75](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L75) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / TAB + +## Variable: TAB + +> `const` **TAB**: `"tab"` = `'tab'` + +Used to mark a paragraph as tab + +### Constant + +### Defined in + +[constants.ts:41](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L41) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / VERSE + +## Variable: VERSE + +> `const` **VERSE**: `"verse"` = `'verse'` + +Used to mark a paragraph as verse + +### Constant + +### Defined in + +[constants.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L48) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / default + +## Variable: default + +> **default**: `object` + +### Type declaration + +#### Chord + +> **Chord**: *typeof* [`Chord`](#classeschordmd) + +#### ChordDefinition + +> **ChordDefinition**: *typeof* [`ChordDefinition`](#classeschorddefinitionmd) + +#### ChordLyricsPair + +> **ChordLyricsPair**: *typeof* [`ChordLyricsPair`](#classeschordlyricspairmd) + +#### ChordProFormatter + +> **ChordProFormatter**: *typeof* [`ChordProFormatter`](#classeschordproformattermd) + +#### ChordProParser + +> **ChordProParser**: *typeof* [`ChordProParser`](#classeschordproparsermd) + +#### ChordSheetParser + +> **ChordSheetParser**: *typeof* [`ChordSheetParser`](#classeschordsheetparsermd) + +#### ChordSheetSerializer + +> **ChordSheetSerializer**: *typeof* [`ChordSheetSerializer`](#classeschordsheetserializermd) + +#### ChordsOverWordsFormatter + +> **ChordsOverWordsFormatter**: *typeof* [`ChordsOverWordsFormatter`](#classeschordsoverwordsformattermd) + +#### ChordsOverWordsParser + +> **ChordsOverWordsParser**: *typeof* [`ChordsOverWordsParser`](#classeschordsoverwordsparsermd) + +#### CHORUS + +> **CHORUS**: `string` + +#### Comment + +> **Comment**: *typeof* [`Comment`](#classescommentmd) + +#### Composite + +> **Composite**: *typeof* [`Composite`](#classescompositemd) + +#### HtmlDivFormatter + +> **HtmlDivFormatter**: *typeof* [`HtmlDivFormatter`](#classeshtmldivformattermd) + +#### HtmlTableFormatter + +> **HtmlTableFormatter**: *typeof* [`HtmlTableFormatter`](#classeshtmltableformattermd) + +#### INDETERMINATE + +> **INDETERMINATE**: `string` + +#### Line + +> **Line**: *typeof* [`Line`](#classeslinemd) + +#### Literal + +> **Literal**: *typeof* [`Literal`](#classesliteralmd) + +#### Metadata + +> **Metadata**: *typeof* [`Metadata`](#classesmetadatamd) + +#### NONE + +> **NONE**: `string` + +#### Paragraph + +> **Paragraph**: *typeof* [`Paragraph`](#classesparagraphmd) + +#### SoftLineBreak + +> **SoftLineBreak**: *typeof* [`SoftLineBreak`](#classessoftlinebreakmd) + +#### Song + +> **Song**: *typeof* [`Song`](#classessongmd) + +#### TAB + +> **TAB**: `string` + +#### Tag + +> **Tag**: *typeof* [`Tag`](#classestagmd) + +#### Ternary + +> **Ternary**: *typeof* [`Ternary`](#classesternarymd) + +#### TextFormatter + +> **TextFormatter**: *typeof* [`TextFormatter`](#classestextformattermd) + +#### UltimateGuitarParser + +> **UltimateGuitarParser**: *typeof* [`UltimateGuitarParser`](#classesultimateguitarparsermd) + +#### VERSE + +> **VERSE**: `string` + +### Defined in + +[index.ts:75](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/index.ts#L75) + + + +[**chordsheetjs**](#readmemd) • **Docs** + +*** + +[chordsheetjs](#globalsmd) / templateHelpers + +## Variable: templateHelpers + +> **templateHelpers**: `object` + +### Type declaration + +#### each() + +> **each**: (`collection`, `callback`) => `string` + +##### Parameters + +• **collection**: `any`[] + +• **callback**: `EachCallback` + +##### Returns + +`string` + +#### evaluate() + +> **evaluate**: (`item`, `metadata`, `configuration`) => `string` + +##### Parameters + +• **item**: `Evaluatable` + +• **metadata**: [`Metadata`](#classesmetadatamd) + +• **configuration**: `Configuration` + +##### Returns + +`string` + +#### fontStyleTag() + +> **fontStyleTag**: (`font`) => `string` + +##### Parameters + +• **font**: `Font` + +##### Returns + +`string` + +#### hasChordContents() + +> **hasChordContents**: (`line`) => `boolean` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +##### Returns + +`boolean` + +#### hasTextContents() + +> **hasTextContents**: (`line`) => `boolean` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +##### Returns + +`boolean` + +#### isChordLyricsPair() + +> **isChordLyricsPair**: (`item`) => `boolean` + +##### Parameters + +• **item**: `Item` + +##### Returns + +`boolean` + +#### isComment() + +> **isComment**: (`item`) => `boolean` + +##### Parameters + +• **item**: [`Tag`](#classestagmd) + +##### Returns + +`boolean` + +#### isEvaluatable() + +> **isEvaluatable**: (`item`) => `boolean` + +##### Parameters + +• **item**: `Item` + +##### Returns + +`boolean` + +#### isTag() + +> **isTag**: (`item`) => `boolean` + +##### Parameters + +• **item**: `Item` + +##### Returns + +`boolean` + +#### lineClasses() + +> **lineClasses**: (`line`) => `string` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +##### Returns + +`string` + +#### lineHasContents() + +> **lineHasContents**: (`line`) => `boolean` + +##### Parameters + +• **line**: [`Line`](#classeslinemd) + +##### Returns + +`boolean` + +#### paragraphClasses() + +> **paragraphClasses**: (`paragraph`) => `string` + +##### Parameters + +• **paragraph**: [`Paragraph`](#classesparagraphmd) + +##### Returns + +`string` + +#### renderChord() + +> **renderChord**: (`chordString`, `line`, `song`, `__namedParameters`) => `string` + +##### Parameters + +• **chordString**: `string` + +• **line**: [`Line`](#classeslinemd) + +• **song**: [`Song`](#classessongmd) + +• **\_\_namedParameters**: `RenderChordOptions` = `{}` + +##### Returns + +`string` + +#### stripHTML() + +> **stripHTML**: (`string`) => `string` + +##### Parameters + +• **string**: `string` + +##### Returns + +`string` + +#### when() + +> **when**: (`condition`, `callback`?) => `When` + +##### Parameters + +• **condition**: `any` + +• **callback?**: `WhenCallback` + +##### Returns + +`When` + +### Defined in + +[template\_helpers.ts:98](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/template_helpers.ts#L98) + +# Media - + -[**chordsheetjs**](#readmemd) • **Docs** +## Contributing -*** +I love receiving pull requests from everyone! Please read this short document before you start, -[chordsheetjs](#globalsmd) / Chord +### ⚠️ Gotchas + +#### `README.md` +Are you trying to make changes to `README.md`? Wait! `README.md` is a auto-generated file. + - to make changes in the first part, go to [docs/README.hbs](docs/README.hbs) + - the api docs are generated from JSdoc comment embedded in the code, so changing those + comments will result in API doc changes. + +When your changes are complete, be sure to run `yarn readme` to regenerate `README.md` and commit the updated `README.md` _together_ with the `README.hbs` changes and/or API doc changes. + +### Pull request guidelines + +N.B. I do not expect you to have all required knowledge and experience to meet these guidelines; +I'm happy to help you out! ❤️ +However, the better your PR meets these guidelines the sooner it will get merged. + +- try to use a code style that is consistent with the existing code +- code changes go hand in hand with tests. +- if possible, write a test that proves the bug before writing/changing code to fix it +- if new code you contribute is expected to be public API (called directly by users instead of only used within ChordSheetJS), + you'd make me really happy by adding JSdoc comments. +- write a [good commit message][commit]. If your PR resolves an issue you can [link it to your commit][link_issue]. + +[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html +[link_issue]: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword +### Get started + +Ensure your have NodeJS and Yarn on your machine. The [CI workflow][ci_workflow] lists the NodeJS versions that +are expected to work. + +[ci_workflow]: https://github.com/martijnversluis/ChordSheetJS/blob/master/.github/workflows/ci.yml#L17 +Fork, then clone the repo: + + git clone git@github.com:your-username/ChordSheetJS.git + +ChordSheetJS uses Yarn 4. For that to work, Corepack need to be enabled: + + corepack enable + +⚠️ NB: In my experience this only guaranteed to work when using Node's Yarn. + Yarn installed by an external package manager (like Homebrew) will/might not work. + +Install the required node modules: + + yarn install + +Make sure the tests pass: + + yarn test + +Make your change. Add tests for your change. Make the tests pass: + + yarn test + +Push to your fork and [submit a pull request][pr]. + +[pr]: https://github.com/martijnversluis/ChordSheetJS/compare/# Classes[**chordsheetjs**](#readmemd) • **Docs*****[chordsheetjs](#globalsmd) / Chord ## Class: Chord Represents a Chord, consisting of a root, suffix (quality) and bass @@ -24052,7 +33523,7 @@ Represents a Chord, consisting of a root, suffix (quality) and bass ##### Defined in -[chord.ts:344](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L344) +[chord.ts:344](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L344) ### Properties @@ -24066,7 +33537,7 @@ Represents a Chord, consisting of a root, suffix (quality) and bass ##### Defined in -[chord.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L24) +[chord.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L24) *** @@ -24080,7 +33551,7 @@ Represents a Chord, consisting of a root, suffix (quality) and bass ##### Defined in -[chord.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L26) +[chord.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L26) *** @@ -24094,7 +33565,7 @@ Represents a Chord, consisting of a root, suffix (quality) and bass ##### Defined in -[chord.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L28) +[chord.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L28) ### Methods @@ -24110,7 +33581,7 @@ Returns a deep copy of the chord ##### Defined in -[chord.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L60) +[chord.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L60) *** @@ -24128,7 +33599,7 @@ Returns a deep copy of the chord ##### Defined in -[chord.ts:374](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L374) +[chord.ts:374](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L374) *** @@ -24144,7 +33615,7 @@ Determines whether the chord is a chord solfege ##### Defined in -[chord.ts:160](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L160) +[chord.ts:160](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L160) *** @@ -24160,7 +33631,7 @@ Determines whether the chord is a chord symbol ##### Defined in -[chord.ts:110](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L110) +[chord.ts:110](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L110) *** @@ -24174,7 +33645,7 @@ Determines whether the chord is a chord symbol ##### Defined in -[chord.ts:432](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L432) +[chord.ts:432](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L432) *** @@ -24190,7 +33661,7 @@ Determines whether the chord is a numeral ##### Defined in -[chord.ts:246](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L246) +[chord.ts:246](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L246) *** @@ -24206,7 +33677,7 @@ Determines whether the chord is numeric ##### Defined in -[chord.ts:227](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L227) +[chord.ts:227](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L227) *** @@ -24220,7 +33691,7 @@ Determines whether the chord is numeric ##### Defined in -[chord.ts:436](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L436) +[chord.ts:436](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L436) *** @@ -24271,7 +33742,7 @@ the normalized chord ##### Defined in -[chord.ts:294](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L294) +[chord.ts:294](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L294) *** @@ -24289,7 +33760,7 @@ the normalized chord ##### Defined in -[chord.ts:442](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L442) +[chord.ts:442](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L442) *** @@ -24316,7 +33787,7 @@ the chord solfege ##### Defined in -[chord.ts:122](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L122) +[chord.ts:122](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L122) *** @@ -24345,7 +33816,7 @@ the chord solfege string ##### Defined in -[chord.ts:152](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L152) +[chord.ts:152](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L152) *** @@ -24372,7 +33843,7 @@ the chord symbol ##### Defined in -[chord.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L72) +[chord.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L72) *** @@ -24401,7 +33872,7 @@ the chord symbol string ##### Defined in -[chord.ts:102](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L102) +[chord.ts:102](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L102) *** @@ -24426,7 +33897,7 @@ the numeral chord ##### Defined in -[chord.ts:194](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L194) +[chord.ts:194](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L194) *** @@ -24453,7 +33924,7 @@ the numeral chord string ##### Defined in -[chord.ts:219](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L219) +[chord.ts:219](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L219) *** @@ -24478,7 +33949,7 @@ the numeric chord ##### Defined in -[chord.ts:170](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L170) +[chord.ts:170](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L170) *** @@ -24505,7 +33976,7 @@ the numeric chord string ##### Defined in -[chord.ts:238](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L238) +[chord.ts:238](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L238) *** @@ -24534,7 +34005,7 @@ the chord string ##### Defined in -[chord.ts:257](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L257) +[chord.ts:257](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L257) *** @@ -24558,7 +34029,7 @@ the new, transposed chord ##### Defined in -[chord.ts:340](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L340) +[chord.ts:340](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L340) *** @@ -24576,7 +34047,7 @@ the new, transposed chord ##### Defined in -[chord.ts:331](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L331) +[chord.ts:331](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L331) *** @@ -24594,7 +34065,7 @@ the new, transposed chord ##### Defined in -[chord.ts:323](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L323) +[chord.ts:323](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L323) *** @@ -24618,7 +34089,7 @@ the new, changed chord ##### Defined in -[chord.ts:315](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L315) +[chord.ts:315](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L315) *** @@ -24644,7 +34115,7 @@ the new, changed chord ##### Defined in -[chord.ts:407](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L407) +[chord.ts:407](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L407) *** @@ -24672,7 +34143,7 @@ the new, changed chord ##### Defined in -[chord.ts:380](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L380) +[chord.ts:380](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L380) *** @@ -24695,7 +34166,7 @@ the chord string, eg `Esus4/G#` or `1sus4/#3`. ##### Defined in -[chord.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L36) +[chord.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L36) *** @@ -24713,7 +34184,7 @@ the chord string, eg `Esus4/G#` or `1sus4/#3`. ##### Defined in -[chord.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord.ts#L44) +[chord.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L44) @@ -24757,7 +34228,7 @@ A chord definitions overrides a previous chord definition for the exact same cho ##### Defined in -[chord\_sheet/chord\_pro/chord\_definition.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L48) +[chord\_sheet/chord\_pro/chord\_definition.ts:47](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/chord_definition.ts#L47) ### Properties @@ -24770,7 +34241,7 @@ The offset must be 1 or higher. ##### Defined in -[chord\_sheet/chord\_pro/chord\_definition.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L25) +[chord\_sheet/chord\_pro/chord\_definition.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/chord_definition.ts#L24) *** @@ -24787,7 +34258,7 @@ Note that the values -, x, X, and N are used to designate a string without finge ##### Defined in -[chord\_sheet/chord\_pro/chord\_definition.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L46) +[chord\_sheet/chord\_pro/chord\_definition.ts:45](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/chord_definition.ts#L45) *** @@ -24803,7 +34274,7 @@ the topmost fret position is 1. With base-fret 3, fret position 1 indicates the ##### Defined in -[chord\_sheet/chord\_pro/chord\_definition.ts:35](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L35) +[chord\_sheet/chord\_pro/chord\_definition.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/chord_definition.ts#L34) *** @@ -24815,7 +34286,7 @@ The chord name, e.g. `C`, `Dm`, `G7`. ##### Defined in -[chord\_sheet/chord\_pro/chord\_definition.ts:18](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L18) +[chord\_sheet/chord\_pro/chord\_definition.ts:17](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/chord_definition.ts#L17) ### Methods @@ -24829,33 +34300,7 @@ The chord name, e.g. `C`, `Dm`, `G7`. ##### Defined in -[chord\_sheet/chord\_pro/chord\_definition.ts:74](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L74) - -*** - -#### parse() - -> `static` **parse**(`chordDefinition`): [`ChordDefinition`](#classeschorddefinitionmd) - -Parses a chord definition in the form of: -- base-fret frets … -- base-fret frets … fingers … - -##### Parameters - -• **chordDefinition**: `string` - -##### Returns - -[`ChordDefinition`](#classeschorddefinitionmd) - -##### See - -https://chordpro.org/chordpro/directives-define/#common-usage - -##### Defined in - -[chord\_sheet/chord\_pro/chord\_definition.ts:63](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/chord_definition.ts#L63) +[chord\_sheet/chord\_pro/chord\_definition.ts:54](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/chord_definition.ts#L54) @@ -24897,7 +34342,7 @@ The annotation ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L21) +[chord\_sheet/chord\_lyrics\_pair.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L21) ### Properties @@ -24907,7 +34352,7 @@ The annotation ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:13](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L13) +[chord\_sheet/chord\_lyrics\_pair.ts:13](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L13) *** @@ -24917,7 +34362,7 @@ The annotation ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:9](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L9) +[chord\_sheet/chord\_lyrics\_pair.ts:9](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L9) *** @@ -24927,7 +34372,7 @@ The annotation ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:11](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L11) +[chord\_sheet/chord\_lyrics\_pair.ts:11](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L11) ### Methods @@ -24945,7 +34390,7 @@ The annotation ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:100](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L100) +[chord\_sheet/chord\_lyrics\_pair.ts:100](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L100) *** @@ -24961,7 +34406,7 @@ Returns a deep copy of the ChordLyricsPair, useful when programmatically transfo ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:56](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L56) +[chord\_sheet/chord\_lyrics\_pair.ts:56](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L56) *** @@ -24977,7 +34422,7 @@ Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L48) +[chord\_sheet/chord\_lyrics\_pair.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L48) *** @@ -25001,7 +34446,7 @@ Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:64](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L64) +[chord\_sheet/chord\_lyrics\_pair.ts:64](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L64) *** @@ -25019,7 +34464,7 @@ Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:76](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L76) +[chord\_sheet/chord\_lyrics\_pair.ts:76](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L76) *** @@ -25037,7 +34482,7 @@ Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L72) +[chord\_sheet/chord\_lyrics\_pair.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L72) *** @@ -25051,7 +34496,7 @@ Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L60) +[chord\_sheet/chord\_lyrics\_pair.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L60) *** @@ -25075,7 +34520,7 @@ Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:80](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L80) +[chord\_sheet/chord\_lyrics\_pair.ts:80](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L80) *** @@ -25093,7 +34538,7 @@ Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:96](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_lyrics_pair.ts#L96) +[chord\_sheet/chord\_lyrics\_pair.ts:96](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L96) @@ -25135,7 +34580,7 @@ options ##### Defined in -[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L26) ### Properties @@ -25149,7 +34594,7 @@ options ##### Defined in -[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L7) ### Methods @@ -25173,7 +34618,7 @@ The ChordPro string ##### Defined in -[formatter/chord\_pro\_formatter.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L24) +[formatter/chord\_pro\_formatter.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chord_pro_formatter.ts#L24) *** @@ -25191,7 +34636,7 @@ The ChordPro string ##### Defined in -[formatter/chord\_pro\_formatter.ts:132](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L132) +[formatter/chord\_pro\_formatter.ts:132](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chord_pro_formatter.ts#L132) *** @@ -25209,7 +34654,7 @@ The ChordPro string ##### Defined in -[formatter/chord\_pro\_formatter.ts:139](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L139) +[formatter/chord\_pro\_formatter.ts:139](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chord_pro_formatter.ts#L139) *** @@ -25227,7 +34672,7 @@ The ChordPro string ##### Defined in -[formatter/chord\_pro\_formatter.ts:158](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L158) +[formatter/chord\_pro\_formatter.ts:158](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chord_pro_formatter.ts#L158) *** @@ -25245,7 +34690,7 @@ The ChordPro string ##### Defined in -[formatter/chord\_pro\_formatter.ts:162](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L162) +[formatter/chord\_pro\_formatter.ts:162](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chord_pro_formatter.ts#L162) *** @@ -25263,7 +34708,7 @@ The ChordPro string ##### Defined in -[formatter/chord\_pro\_formatter.ts:112](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L112) +[formatter/chord\_pro\_formatter.ts:112](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chord_pro_formatter.ts#L112) *** @@ -25281,7 +34726,7 @@ The ChordPro string ##### Defined in -[formatter/chord\_pro\_formatter.ts:104](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L104) +[formatter/chord\_pro\_formatter.ts:104](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chord_pro_formatter.ts#L104) *** @@ -25301,7 +34746,7 @@ The ChordPro string ##### Defined in -[formatter/chord\_pro\_formatter.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L38) +[formatter/chord\_pro\_formatter.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chord_pro_formatter.ts#L38) *** @@ -25321,7 +34766,7 @@ The ChordPro string ##### Defined in -[formatter/chord\_pro\_formatter.ts:32](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L32) +[formatter/chord\_pro\_formatter.ts:32](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chord_pro_formatter.ts#L32) *** @@ -25341,7 +34786,7 @@ The ChordPro string ##### Defined in -[formatter/chord\_pro\_formatter.ts:62](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L62) +[formatter/chord\_pro\_formatter.ts:62](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chord_pro_formatter.ts#L62) *** @@ -25359,7 +34804,7 @@ The ChordPro string ##### Defined in -[formatter/chord\_pro\_formatter.ts:124](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L124) +[formatter/chord\_pro\_formatter.ts:124](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chord_pro_formatter.ts#L124) *** @@ -25377,7 +34822,7 @@ The ChordPro string ##### Defined in -[formatter/chord\_pro\_formatter.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L78) +[formatter/chord\_pro\_formatter.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chord_pro_formatter.ts#L78) *** @@ -25395,7 +34840,7 @@ The ChordPro string ##### Defined in -[formatter/chord\_pro\_formatter.ts:96](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chord_pro_formatter.ts#L96) +[formatter/chord\_pro\_formatter.ts:96](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chord_pro_formatter.ts#L96) @@ -25427,7 +34872,7 @@ Parses a ChordPro chord sheet ##### Defined in -[parser/chord\_pro\_parser.ts:16](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_pro_parser.ts#L16) +[parser/chord\_pro\_parser.ts:16](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_pro_parser.ts#L16) ### Accessors @@ -25447,7 +34892,7 @@ All warnings raised during parsing the chord sheet ##### Defined in -[parser/chord\_pro\_parser.ts:23](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_pro_parser.ts#L23) +[parser/chord\_pro\_parser.ts:23](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_pro_parser.ts#L23) ### Methods @@ -25479,7 +34924,7 @@ https://peggyjs.org/documentation.html#using-the-parser ##### Defined in -[parser/chord\_pro\_parser.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_pro_parser.ts#L36) +[parser/chord\_pro\_parser.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_pro_parser.ts#L36) @@ -25528,7 +34973,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L46) +[parser/chord\_sheet\_parser.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L46) ### Properties @@ -25538,7 +34983,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:31](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L31) +[parser/chord\_sheet\_parser.ts:31](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L31) *** @@ -25548,7 +34993,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:35](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L35) +[parser/chord\_sheet\_parser.ts:35](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L35) *** @@ -25558,7 +35003,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:37](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L37) +[parser/chord\_sheet\_parser.ts:37](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L37) *** @@ -25568,7 +35013,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:33](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L33) +[parser/chord\_sheet\_parser.ts:33](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L33) *** @@ -25578,7 +35023,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:23](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L23) +[parser/chord\_sheet\_parser.ts:23](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L23) *** @@ -25588,7 +35033,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L21) +[parser/chord\_sheet\_parser.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L21) *** @@ -25598,7 +35043,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L25) +[parser/chord\_sheet\_parser.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L25) *** @@ -25608,7 +35053,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:27](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L27) +[parser/chord\_sheet\_parser.ts:27](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L27) *** @@ -25618,7 +35063,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:29](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L29) +[parser/chord\_sheet\_parser.ts:29](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L29) ### Methods @@ -25638,7 +35083,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:160](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L160) +[parser/chord\_sheet\_parser.ts:160](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L160) *** @@ -25652,7 +35097,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:82](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L82) +[parser/chord\_sheet\_parser.ts:82](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L82) *** @@ -25666,7 +35111,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:177](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L177) +[parser/chord\_sheet\_parser.ts:177](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L177) *** @@ -25680,7 +35125,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:124](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L124) +[parser/chord\_sheet\_parser.ts:124](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L124) *** @@ -25700,7 +35145,7 @@ ChordSheetParser is deprecated, please use ChordsOverWordsParser. ##### Defined in -[parser/chord\_sheet\_parser.ts:107](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L107) +[parser/chord\_sheet\_parser.ts:107](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L107) *** @@ -25732,7 +35177,7 @@ The parsed song ##### Defined in -[parser/chord\_sheet\_parser.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L70) +[parser/chord\_sheet\_parser.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L70) *** @@ -25750,7 +35195,7 @@ The parsed song ##### Defined in -[parser/chord\_sheet\_parser.ts:84](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L84) +[parser/chord\_sheet\_parser.ts:84](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L84) *** @@ -25770,7 +35215,7 @@ The parsed song ##### Defined in -[parser/chord\_sheet\_parser.ts:128](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L128) +[parser/chord\_sheet\_parser.ts:128](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L128) *** @@ -25788,7 +35233,7 @@ The parsed song ##### Defined in -[parser/chord\_sheet\_parser.ts:94](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L94) +[parser/chord\_sheet\_parser.ts:94](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L94) *** @@ -25808,7 +35253,7 @@ The parsed song ##### Defined in -[parser/chord\_sheet\_parser.ts:146](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L146) +[parser/chord\_sheet\_parser.ts:146](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L146) *** @@ -25822,7 +35267,7 @@ The parsed song ##### Defined in -[parser/chord\_sheet\_parser.ts:118](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L118) +[parser/chord\_sheet\_parser.ts:118](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L118) *** @@ -25840,7 +35285,7 @@ The parsed song ##### Defined in -[parser/chord\_sheet\_parser.ts:173](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L173) +[parser/chord\_sheet\_parser.ts:173](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L173) @@ -25872,7 +35317,7 @@ Serializes a song into een plain object, and deserializes the serialized object ##### Defined in -[chord\_sheet\_serializer.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L40) +[chord\_sheet\_serializer.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L40) *** @@ -25882,7 +35327,7 @@ Serializes a song into een plain object, and deserializes the serialized object ##### Defined in -[chord\_sheet\_serializer.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L42) +[chord\_sheet\_serializer.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L42) ### Methods @@ -25906,7 +35351,7 @@ The deserialized song ##### Defined in -[chord\_sheet\_serializer.ts:151](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L151) +[chord\_sheet\_serializer.ts:151](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L151) *** @@ -25924,7 +35369,7 @@ The deserialized song ##### Defined in -[chord\_sheet\_serializer.ts:156](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L156) +[chord\_sheet\_serializer.ts:156](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L156) *** @@ -25942,7 +35387,7 @@ The deserialized song ##### Defined in -[chord\_sheet\_serializer.ts:201](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L201) +[chord\_sheet\_serializer.ts:201](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L201) *** @@ -25960,7 +35405,7 @@ The deserialized song ##### Defined in -[chord\_sheet\_serializer.ts:184](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L184) +[chord\_sheet\_serializer.ts:184](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L184) *** @@ -25978,7 +35423,7 @@ The deserialized song ##### Defined in -[chord\_sheet\_serializer.ts:234](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L234) +[chord\_sheet\_serializer.ts:234](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L234) *** @@ -25996,7 +35441,7 @@ The deserialized song ##### Defined in -[chord\_sheet\_serializer.ts:259](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L259) +[chord\_sheet\_serializer.ts:259](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L259) *** @@ -26014,7 +35459,7 @@ The deserialized song ##### Defined in -[chord\_sheet\_serializer.ts:191](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L191) +[chord\_sheet\_serializer.ts:191](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L191) *** @@ -26032,7 +35477,7 @@ The deserialized song ##### Defined in -[chord\_sheet\_serializer.ts:213](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L213) +[chord\_sheet\_serializer.ts:213](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L213) *** @@ -26050,7 +35495,7 @@ The deserialized song ##### Defined in -[chord\_sheet\_serializer.ts:239](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L239) +[chord\_sheet\_serializer.ts:239](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L239) *** @@ -26073,7 +35518,7 @@ object A plain JS object containing all chord sheet data ##### Defined in -[chord\_sheet\_serializer.ts:49](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L49) +[chord\_sheet\_serializer.ts:49](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L49) *** @@ -26091,7 +35536,7 @@ object A plain JS object containing all chord sheet data ##### Defined in -[chord\_sheet\_serializer.ts:91](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L91) +[chord\_sheet\_serializer.ts:91](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L91) *** @@ -26129,7 +35574,7 @@ object A plain JS object containing all chord sheet data ##### Defined in -[chord\_sheet\_serializer.ts:114](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L114) +[chord\_sheet\_serializer.ts:114](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L114) *** @@ -26147,7 +35592,7 @@ object A plain JS object containing all chord sheet data ##### Defined in -[chord\_sheet\_serializer.ts:142](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L142) +[chord\_sheet\_serializer.ts:142](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L142) *** @@ -26165,7 +35610,7 @@ object A plain JS object containing all chord sheet data ##### Defined in -[chord\_sheet\_serializer.ts:138](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L138) +[chord\_sheet\_serializer.ts:138](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L138) *** @@ -26183,7 +35628,7 @@ object A plain JS object containing all chord sheet data ##### Defined in -[chord\_sheet\_serializer.ts:63](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L63) +[chord\_sheet\_serializer.ts:63](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L63) *** @@ -26201,7 +35646,7 @@ object A plain JS object containing all chord sheet data ##### Defined in -[chord\_sheet\_serializer.ts:56](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L56) +[chord\_sheet\_serializer.ts:56](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L56) *** @@ -26219,7 +35664,7 @@ object A plain JS object containing all chord sheet data ##### Defined in -[chord\_sheet\_serializer.ts:134](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L134) +[chord\_sheet\_serializer.ts:134](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L134) *** @@ -26237,7 +35682,7 @@ object A plain JS object containing all chord sheet data ##### Defined in -[chord\_sheet\_serializer.ts:100](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L100) +[chord\_sheet\_serializer.ts:100](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L100) *** @@ -26255,7 +35700,7 @@ object A plain JS object containing all chord sheet data ##### Defined in -[chord\_sheet\_serializer.ts:124](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet_serializer.ts#L124) +[chord\_sheet\_serializer.ts:124](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet_serializer.ts#L124) @@ -26297,7 +35742,7 @@ options ##### Defined in -[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L26) ### Properties @@ -26311,7 +35756,7 @@ options ##### Defined in -[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L7) *** @@ -26321,7 +35766,7 @@ options ##### Defined in -[formatter/chords\_over\_words\_formatter.ts:18](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L18) +[formatter/chords\_over\_words\_formatter.ts:18](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chords_over_words_formatter.ts#L18) ### Methods @@ -26341,7 +35786,7 @@ options ##### Defined in -[formatter/chords\_over\_words\_formatter.ts:88](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L88) +[formatter/chords\_over\_words\_formatter.ts:88](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chords_over_words_formatter.ts#L88) *** @@ -26365,7 +35810,7 @@ the chord sheet ##### Defined in -[formatter/chords\_over\_words\_formatter.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L25) +[formatter/chords\_over\_words\_formatter.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chords_over_words_formatter.ts#L25) *** @@ -26379,7 +35824,7 @@ the chord sheet ##### Defined in -[formatter/chords\_over\_words\_formatter.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L34) +[formatter/chords\_over\_words\_formatter.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chords_over_words_formatter.ts#L34) *** @@ -26401,7 +35846,7 @@ the chord sheet ##### Defined in -[formatter/chords\_over\_words\_formatter.ts:145](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L145) +[formatter/chords\_over\_words\_formatter.ts:145](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chords_over_words_formatter.ts#L145) *** @@ -26423,7 +35868,7 @@ the chord sheet ##### Defined in -[formatter/chords\_over\_words\_formatter.ts:101](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L101) +[formatter/chords\_over\_words\_formatter.ts:101](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chords_over_words_formatter.ts#L101) *** @@ -26443,7 +35888,7 @@ the chord sheet ##### Defined in -[formatter/chords\_over\_words\_formatter.ts:68](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L68) +[formatter/chords\_over\_words\_formatter.ts:68](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chords_over_words_formatter.ts#L68) *** @@ -26463,7 +35908,7 @@ the chord sheet ##### Defined in -[formatter/chords\_over\_words\_formatter.ts:126](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L126) +[formatter/chords\_over\_words\_formatter.ts:126](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chords_over_words_formatter.ts#L126) *** @@ -26483,7 +35928,7 @@ the chord sheet ##### Defined in -[formatter/chords\_over\_words\_formatter.ts:80](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L80) +[formatter/chords\_over\_words\_formatter.ts:80](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chords_over_words_formatter.ts#L80) *** @@ -26505,7 +35950,7 @@ the chord sheet ##### Defined in -[formatter/chords\_over\_words\_formatter.ts:134](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L134) +[formatter/chords\_over\_words\_formatter.ts:134](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chords_over_words_formatter.ts#L134) *** @@ -26525,7 +35970,7 @@ the chord sheet ##### Defined in -[formatter/chords\_over\_words\_formatter.ts:55](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L55) +[formatter/chords\_over\_words\_formatter.ts:55](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chords_over_words_formatter.ts#L55) *** @@ -26539,7 +35984,7 @@ the chord sheet ##### Defined in -[formatter/chords\_over\_words\_formatter.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L42) +[formatter/chords\_over\_words\_formatter.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chords_over_words_formatter.ts#L42) *** @@ -26559,7 +36004,7 @@ the chord sheet ##### Defined in -[formatter/chords\_over\_words\_formatter.ts:114](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/chords_over_words_formatter.ts#L114) +[formatter/chords\_over\_words\_formatter.ts:114](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/chords_over_words_formatter.ts#L114) @@ -26626,7 +36071,7 @@ You can even use a markdown style frontmatter separator to separate the header f ##### Defined in -[parser/chords\_over\_words\_parser.ts:51](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chords_over_words_parser.ts#L51) +[parser/chords\_over\_words\_parser.ts:51](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chords_over_words_parser.ts#L51) ### Accessors @@ -26646,7 +36091,7 @@ All warnings raised during parsing the chord sheet ##### Defined in -[parser/chords\_over\_words\_parser.ts:58](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chords_over_words_parser.ts#L58) +[parser/chords\_over\_words\_parser.ts:58](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chords_over_words_parser.ts#L58) ### Methods @@ -26678,7 +36123,7 @@ https://peggyjs.org/documentation.html#using-the-parser ##### Defined in -[parser/chords\_over\_words\_parser.ts:71](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chords_over_words_parser.ts#L71) +[parser/chords\_over\_words\_parser.ts:71](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chords_over_words_parser.ts#L71) @@ -26708,7 +36153,7 @@ Represents a comment. See https://www.chordpro.org/chordpro/chordpro-file-format ##### Defined in -[chord\_sheet/comment.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/comment.ts#L7) +[chord\_sheet/comment.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/comment.ts#L7) ### Properties @@ -26718,7 +36163,7 @@ Represents a comment. See https://www.chordpro.org/chordpro/chordpro-file-format ##### Defined in -[chord\_sheet/comment.ts:5](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/comment.ts#L5) +[chord\_sheet/comment.ts:5](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/comment.ts#L5) ### Methods @@ -26734,7 +36179,7 @@ Returns a deep copy of the Comment, useful when programmatically transforming a ##### Defined in -[chord\_sheet/comment.ts:23](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/comment.ts#L23) +[chord\_sheet/comment.ts:23](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/comment.ts#L23) *** @@ -26750,7 +36195,7 @@ Indicates whether a Comment should be visible in a formatted chord sheet (except ##### Defined in -[chord\_sheet/comment.ts:15](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/comment.ts#L15) +[chord\_sheet/comment.ts:15](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/comment.ts#L15) *** @@ -26764,7 +36209,7 @@ Indicates whether a Comment should be visible in a formatted chord sheet (except ##### Defined in -[chord\_sheet/comment.ts:27](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/comment.ts#L27) +[chord\_sheet/comment.ts:27](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/comment.ts#L27) @@ -26802,7 +36247,7 @@ Indicates whether a Comment should be visible in a formatted chord sheet (except ##### Defined in -[chord\_sheet/chord\_pro/composite.ts:9](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/composite.ts#L9) +[chord\_sheet/chord\_pro/composite.ts:9](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/composite.ts#L9) ### Properties @@ -26816,7 +36261,7 @@ Indicates whether a Comment should be visible in a formatted chord sheet (except ##### Defined in -[chord\_sheet/ast\_component.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L6) +[chord\_sheet/ast\_component.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/ast_component.ts#L6) *** @@ -26826,7 +36271,7 @@ Indicates whether a Comment should be visible in a formatted chord sheet (except ##### Defined in -[chord\_sheet/chord\_pro/composite.ts:5](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/composite.ts#L5) +[chord\_sheet/chord\_pro/composite.ts:5](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/composite.ts#L5) *** @@ -26840,7 +36285,7 @@ Indicates whether a Comment should be visible in a formatted chord sheet (except ##### Defined in -[chord\_sheet/ast\_component.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L4) +[chord\_sheet/ast\_component.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/ast_component.ts#L4) *** @@ -26854,7 +36299,7 @@ Indicates whether a Comment should be visible in a formatted chord sheet (except ##### Defined in -[chord\_sheet/ast\_component.ts:8](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L8) +[chord\_sheet/ast\_component.ts:8](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/ast_component.ts#L8) *** @@ -26864,7 +36309,7 @@ Indicates whether a Comment should be visible in a formatted chord sheet (except ##### Defined in -[chord\_sheet/chord\_pro/composite.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/composite.ts#L7) +[chord\_sheet/chord\_pro/composite.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/composite.ts#L7) ### Methods @@ -26882,7 +36327,7 @@ Indicates whether a Comment should be visible in a formatted chord sheet (except ##### Defined in -[chord\_sheet/chord\_pro/composite.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/composite.ts#L25) +[chord\_sheet/chord\_pro/composite.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/composite.ts#L25) *** @@ -26906,7 +36351,7 @@ Indicates whether a Comment should be visible in a formatted chord sheet (except ##### Defined in -[chord\_sheet/chord\_pro/composite.ts:15](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/composite.ts#L15) +[chord\_sheet/chord\_pro/composite.ts:15](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/composite.ts#L15) *** @@ -26920,7 +36365,7 @@ Indicates whether a Comment should be visible in a formatted chord sheet (except ##### Defined in -[chord\_sheet/chord\_pro/composite.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/composite.ts#L21) +[chord\_sheet/chord\_pro/composite.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/composite.ts#L21) @@ -26961,7 +36406,7 @@ options ##### Defined in -[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L26) ### Properties @@ -26971,7 +36416,7 @@ options ##### Defined in -[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L7) @@ -27013,7 +36458,7 @@ options ##### Defined in -[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L26) ### Properties @@ -27027,7 +36472,7 @@ options ##### Defined in -[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L7) ### Accessors @@ -27058,7 +36503,7 @@ the CSS object ##### Defined in -[formatter/html\_formatter.ts:66](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L66) +[formatter/html\_formatter.ts:66](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_formatter.ts#L66) *** @@ -27078,7 +36523,7 @@ the CSS object ##### Defined in -[formatter/html\_div\_formatter.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_div_formatter.ts#L44) +[formatter/html\_div\_formatter.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_div_formatter.ts#L44) *** @@ -27098,7 +36543,7 @@ the CSS object ##### Defined in -[formatter/html\_div\_formatter.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_div_formatter.ts#L40) +[formatter/html\_div\_formatter.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_div_formatter.ts#L40) ### Methods @@ -27132,7 +36577,7 @@ the CSS string ##### Defined in -[formatter/html\_formatter.ts:50](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L50) +[formatter/html\_formatter.ts:50](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_formatter.ts#L50) *** @@ -27160,7 +36605,7 @@ The HTML string ##### Defined in -[formatter/html\_formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L26) +[formatter/html\_formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_formatter.ts#L26) @@ -27207,7 +36652,7 @@ options ##### Defined in -[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L26) ### Properties @@ -27221,7 +36666,7 @@ options ##### Defined in -[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L7) ### Accessors @@ -27248,7 +36693,7 @@ the CSS object ##### Defined in -[formatter/html\_formatter.ts:66](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L66) +[formatter/html\_formatter.ts:66](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_formatter.ts#L66) *** @@ -27264,7 +36709,7 @@ the CSS object ##### Defined in -[formatter/html\_formatter.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L70) +[formatter/html\_formatter.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_formatter.ts#L70) *** @@ -27280,7 +36725,7 @@ the CSS object ##### Defined in -[formatter/html\_formatter.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L72) +[formatter/html\_formatter.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_formatter.ts#L72) ### Methods @@ -27310,7 +36755,7 @@ the CSS string ##### Defined in -[formatter/html\_formatter.ts:50](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L50) +[formatter/html\_formatter.ts:50](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_formatter.ts#L50) *** @@ -27334,7 +36779,7 @@ The HTML string ##### Defined in -[formatter/html\_formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L26) +[formatter/html\_formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_formatter.ts#L26) @@ -27377,7 +36822,7 @@ options ##### Defined in -[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L26) ### Properties @@ -27391,7 +36836,7 @@ options ##### Defined in -[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L7) ### Accessors @@ -27422,7 +36867,7 @@ the CSS object ##### Defined in -[formatter/html\_formatter.ts:66](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L66) +[formatter/html\_formatter.ts:66](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_formatter.ts#L66) *** @@ -27442,7 +36887,7 @@ the CSS object ##### Defined in -[formatter/html\_table\_formatter.ts:45](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_table_formatter.ts#L45) +[formatter/html\_table\_formatter.ts:45](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_table_formatter.ts#L45) *** @@ -27462,7 +36907,7 @@ the CSS object ##### Defined in -[formatter/html\_table\_formatter.ts:41](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_table_formatter.ts#L41) +[formatter/html\_table\_formatter.ts:41](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_table_formatter.ts#L41) ### Methods @@ -27496,7 +36941,7 @@ the CSS string ##### Defined in -[formatter/html\_formatter.ts:50](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L50) +[formatter/html\_formatter.ts:50](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_formatter.ts#L50) *** @@ -27524,7 +36969,7 @@ The HTML string ##### Defined in -[formatter/html\_formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/html_formatter.ts#L26) +[formatter/html\_formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/html_formatter.ts#L26) @@ -27576,7 +37021,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:249](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L249) +[key.ts:249](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L249) ### Properties @@ -27590,7 +37035,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:51](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L51) +[key.ts:51](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L51) *** @@ -27604,7 +37049,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L70) +[key.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L70) *** @@ -27618,7 +37063,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:55](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L55) +[key.ts:55](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L55) *** @@ -27632,7 +37077,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:53](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L53) +[key.ts:53](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L53) *** @@ -27642,7 +37087,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:74](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L74) +[key.ts:74](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L74) *** @@ -27656,7 +37101,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:76](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L76) +[key.ts:76](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L76) *** @@ -27670,7 +37115,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L72) +[key.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L72) *** @@ -27684,7 +37129,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:57](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L57) +[key.ts:57](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L57) ### Accessors @@ -27700,7 +37145,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:285](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L285) +[key.ts:285](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L285) *** @@ -27716,7 +37161,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:519](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L519) +[key.ts:519](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L519) *** @@ -27732,7 +37177,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:490](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L490) +[key.ts:490](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L490) *** @@ -27748,7 +37193,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:301](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L301) +[key.ts:301](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L301) *** @@ -27764,7 +37209,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:305](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L305) +[key.ts:305](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L305) *** @@ -27780,7 +37225,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:59](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L59) +[key.ts:59](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L59) ### Methods @@ -27794,7 +37239,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:595](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L595) +[key.ts:595](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L595) *** @@ -27808,7 +37253,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:603](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L603) +[key.ts:603](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L603) *** @@ -27826,7 +37271,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:558](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L558) +[key.ts:558](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L558) *** @@ -27840,7 +37285,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:317](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L317) +[key.ts:317](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L317) *** @@ -27858,7 +37303,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:280](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L280) +[key.ts:280](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L280) *** @@ -27876,7 +37321,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:410](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L410) +[key.ts:410](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L410) *** @@ -27894,7 +37339,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:390](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L390) +[key.ts:390](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L390) *** @@ -27908,7 +37353,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:402](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L402) +[key.ts:402](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L402) *** @@ -27922,7 +37367,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:398](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L398) +[key.ts:398](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L398) *** @@ -27936,7 +37381,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:293](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L293) +[key.ts:293](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L293) *** @@ -27950,7 +37395,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:406](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L406) +[key.ts:406](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L406) *** @@ -27964,7 +37409,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:394](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L394) +[key.ts:394](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L394) *** @@ -27978,7 +37423,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:297](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L297) +[key.ts:297](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L297) *** @@ -27992,7 +37437,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:630](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L630) +[key.ts:630](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L630) *** @@ -28010,7 +37455,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:644](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L644) +[key.ts:644](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L644) *** @@ -28028,7 +37473,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:611](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L611) +[key.ts:611](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L611) *** @@ -28046,7 +37491,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:362](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L362) +[key.ts:362](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L362) *** @@ -28064,7 +37509,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:386](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L386) +[key.ts:386](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L386) *** @@ -28082,7 +37527,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:342](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L342) +[key.ts:342](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L342) *** @@ -28100,7 +37545,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:382](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L382) +[key.ts:382](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L382) *** @@ -28114,7 +37559,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:309](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L309) +[key.ts:309](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L309) *** @@ -28132,7 +37577,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:456](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L456) +[key.ts:456](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L456) *** @@ -28150,7 +37595,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:476](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L476) +[key.ts:476](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L476) *** @@ -28168,7 +37613,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:431](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L431) +[key.ts:431](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L431) *** @@ -28186,7 +37631,7 @@ The only function considered public API is `Key.distance` ##### Defined in -[key.ts:452](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L452) +[key.ts:452](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L452) *** @@ -28210,7 +37655,7 @@ Returns a string representation of an object. ##### Defined in -[key.ts:480](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L480) +[key.ts:480](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L480) *** @@ -28228,7 +37673,7 @@ Returns a string representation of an object. ##### Defined in -[key.ts:544](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L544) +[key.ts:544](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L544) *** @@ -28242,7 +37687,7 @@ Returns a string representation of an object. ##### Defined in -[key.ts:582](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L582) +[key.ts:582](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L582) *** @@ -28256,7 +37701,7 @@ Returns a string representation of an object. ##### Defined in -[key.ts:568](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L568) +[key.ts:568](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L568) *** @@ -28274,7 +37719,7 @@ Returns a string representation of an object. ##### Defined in -[key.ts:625](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L625) +[key.ts:625](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L625) *** @@ -28302,7 +37747,7 @@ the distance in semitones ##### Defined in -[key.ts:245](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L245) +[key.ts:245](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L245) *** @@ -28322,7 +37767,7 @@ the distance in semitones ##### Defined in -[key.ts:419](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L419) +[key.ts:419](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L419) *** @@ -28342,7 +37787,7 @@ the distance in semitones ##### Defined in -[key.ts:152](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L152) +[key.ts:152](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L152) *** @@ -28364,7 +37809,7 @@ the distance in semitones ##### Defined in -[key.ts:193](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L193) +[key.ts:193](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L193) *** @@ -28386,7 +37831,7 @@ the distance in semitones ##### Defined in -[key.ts:161](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L161) +[key.ts:161](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L161) *** @@ -28404,7 +37849,7 @@ the distance in semitones ##### Defined in -[key.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L78) +[key.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L78) *** @@ -28424,7 +37869,7 @@ the distance in semitones ##### Defined in -[key.ts:93](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L93) +[key.ts:93](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L93) *** @@ -28442,7 +37887,7 @@ the distance in semitones ##### Defined in -[key.ts:209](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L209) +[key.ts:209](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L209) *** @@ -28468,7 +37913,7 @@ the distance in semitones ##### Defined in -[key.ts:108](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L108) +[key.ts:108](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L108) *** @@ -28486,7 +37931,7 @@ the distance in semitones ##### Defined in -[key.ts:617](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L617) +[key.ts:617](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L617) *** @@ -28510,7 +37955,7 @@ the distance in semitones ##### Defined in -[key.ts:176](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L176) +[key.ts:176](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L176) *** @@ -28528,7 +37973,7 @@ the distance in semitones ##### Defined in -[key.ts:235](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L235) +[key.ts:235](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L235) *** @@ -28546,7 +37991,7 @@ the distance in semitones ##### Defined in -[key.ts:217](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L217) +[key.ts:217](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L217) *** @@ -28564,7 +38009,7 @@ the distance in semitones ##### Defined in -[key.ts:225](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/key.ts#L225) +[key.ts:225](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/key.ts#L225) @@ -28598,7 +38043,7 @@ Represents a line in a chord sheet, consisting of items of type ChordLyricsPair ##### Defined in -[chord\_sheet/line.ts:62](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L62) +[chord\_sheet/line.ts:62](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L62) ### Properties @@ -28612,7 +38057,7 @@ See: https://www.chordpro.org/chordpro/directives-props_chord_legacy/ ##### Defined in -[chord\_sheet/line.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L60) +[chord\_sheet/line.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L60) *** @@ -28622,7 +38067,7 @@ See: https://www.chordpro.org/chordpro/directives-props_chord_legacy/ ##### Defined in -[chord\_sheet/line.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L38) +[chord\_sheet/line.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L38) *** @@ -28634,7 +38079,7 @@ The items ([ChordLyricsPair](#classeschordlyricspairmd) or [Tag](#classestagmd) ##### Defined in -[chord\_sheet/line.ts:29](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L29) +[chord\_sheet/line.ts:29](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L29) *** @@ -28644,7 +38089,7 @@ The items ([ChordLyricsPair](#classeschordlyricspairmd) or [Tag](#classestagmd) ##### Defined in -[chord\_sheet/line.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L40) +[chord\_sheet/line.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L40) *** @@ -28654,7 +38099,7 @@ The items ([ChordLyricsPair](#classeschordlyricspairmd) or [Tag](#classestagmd) ##### Defined in -[chord\_sheet/line.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L44) +[chord\_sheet/line.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L44) *** @@ -28668,7 +38113,7 @@ See: https://www.chordpro.org/chordpro/directives-props_text_legacy/ ##### Defined in -[chord\_sheet/line.ts:52](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L52) +[chord\_sheet/line.ts:52](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L52) *** @@ -28678,7 +38123,7 @@ See: https://www.chordpro.org/chordpro/directives-props_text_legacy/ ##### Defined in -[chord\_sheet/line.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L42) +[chord\_sheet/line.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L42) *** @@ -28691,7 +38136,7 @@ Values can be [VERSE](#variablesversemd), [CHORUS](#variableschorusmd) or [NONE] ##### Defined in -[chord\_sheet/line.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L36) +[chord\_sheet/line.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L36) ### Accessors @@ -28707,7 +38152,7 @@ Values can be [VERSE](#variablesversemd), [CHORUS](#variableschorusmd) or [NONE] ##### Defined in -[chord\_sheet/line.ts:223](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L223) +[chord\_sheet/line.ts:223](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L223) ### Methods @@ -28727,7 +38172,7 @@ Values can be [VERSE](#variablesversemd), [CHORUS](#variableschorusmd) or [NONE] ##### Defined in -[chord\_sheet/line.ts:174](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L174) +[chord\_sheet/line.ts:174](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L174) *** @@ -28745,7 +38190,7 @@ Values can be [VERSE](#variablesversemd), [CHORUS](#variableschorusmd) or [NONE] ##### Defined in -[chord\_sheet/line.ts:207](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L207) +[chord\_sheet/line.ts:207](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L207) *** @@ -28767,7 +38212,7 @@ The item to be added ##### Defined in -[chord\_sheet/line.ts:83](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L83) +[chord\_sheet/line.ts:83](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L83) *** @@ -28787,7 +38232,7 @@ The item to be added ##### Defined in -[chord\_sheet/line.ts:201](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L201) +[chord\_sheet/line.ts:201](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L201) *** @@ -28805,7 +38250,7 @@ The item to be added ##### Defined in -[chord\_sheet/line.ts:191](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L191) +[chord\_sheet/line.ts:191](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L191) *** @@ -28821,7 +38266,7 @@ Returns a deep copy of the line and all of its items ##### Defined in -[chord\_sheet/line.ts:107](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L107) +[chord\_sheet/line.ts:107](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L107) *** @@ -28835,7 +38280,7 @@ Returns a deep copy of the line and all of its items ##### Defined in -[chord\_sheet/line.ts:185](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L185) +[chord\_sheet/line.ts:185](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L185) *** @@ -28853,7 +38298,7 @@ Indicates whether the line contains items that are renderable. Please use [hasRe ##### Defined in -[chord\_sheet/line.ts:170](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L170) +[chord\_sheet/line.ts:170](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L170) *** @@ -28869,7 +38314,7 @@ Indicates whether the line contains items that are renderable ##### Defined in -[chord\_sheet/line.ts:99](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L99) +[chord\_sheet/line.ts:99](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L99) *** @@ -28885,7 +38330,7 @@ Indicates whether the line type is BRIDGE ##### Defined in -[chord\_sheet/line.ts:129](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L129) +[chord\_sheet/line.ts:129](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L129) *** @@ -28901,7 +38346,7 @@ Indicates whether the line type is [CHORUS](#variableschorusmd) ##### Defined in -[chord\_sheet/line.ts:137](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L137) +[chord\_sheet/line.ts:137](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L137) *** @@ -28917,7 +38362,7 @@ Indicates whether the line contains any items ##### Defined in -[chord\_sheet/line.ts:71](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L71) +[chord\_sheet/line.ts:71](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L71) *** @@ -28933,7 +38378,7 @@ Indicates whether the line type is GRID ##### Defined in -[chord\_sheet/line.ts:145](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L145) +[chord\_sheet/line.ts:145](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L145) *** @@ -28947,7 +38392,7 @@ Indicates whether the line type is GRID ##### Defined in -[chord\_sheet/line.ts:75](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L75) +[chord\_sheet/line.ts:75](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L75) *** @@ -28961,7 +38406,7 @@ Indicates whether the line type is GRID ##### Defined in -[chord\_sheet/line.ts:241](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L241) +[chord\_sheet/line.ts:241](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L241) *** @@ -28975,7 +38420,7 @@ Indicates whether the line type is GRID ##### Defined in -[chord\_sheet/line.ts:237](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L237) +[chord\_sheet/line.ts:237](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L237) *** @@ -28991,7 +38436,7 @@ Indicates whether the line type is [TAB](#variablestabmd) ##### Defined in -[chord\_sheet/line.ts:153](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L153) +[chord\_sheet/line.ts:153](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L153) *** @@ -29007,7 +38452,7 @@ Indicates whether the line type is [VERSE](#variablesversemd) ##### Defined in -[chord\_sheet/line.ts:161](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L161) +[chord\_sheet/line.ts:161](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L161) *** @@ -29025,7 +38470,7 @@ Indicates whether the line type is [VERSE](#variablesversemd) ##### Defined in -[chord\_sheet/line.ts:196](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L196) +[chord\_sheet/line.ts:196](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L196) *** @@ -29043,7 +38488,7 @@ Indicates whether the line type is [VERSE](#variablesversemd) ##### Defined in -[chord\_sheet/line.ts:111](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L111) +[chord\_sheet/line.ts:111](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L111) *** @@ -29065,7 +38510,7 @@ Indicates whether the line type is [VERSE](#variablesversemd) ##### Defined in -[chord\_sheet/line.ts:213](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/line.ts#L213) +[chord\_sheet/line.ts:213](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/line.ts#L213) @@ -29101,7 +38546,7 @@ Indicates whether the line type is [VERSE](#variablesversemd) ##### Defined in -[chord\_sheet/chord\_pro/literal.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/literal.ts#L6) +[chord\_sheet/chord\_pro/literal.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/literal.ts#L6) ### Properties @@ -29115,7 +38560,7 @@ Indicates whether the line type is [VERSE](#variablesversemd) ##### Defined in -[chord\_sheet/ast\_component.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L6) +[chord\_sheet/ast\_component.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/ast_component.ts#L6) *** @@ -29129,7 +38574,7 @@ Indicates whether the line type is [VERSE](#variablesversemd) ##### Defined in -[chord\_sheet/ast\_component.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L4) +[chord\_sheet/ast\_component.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/ast_component.ts#L4) *** @@ -29143,7 +38588,7 @@ Indicates whether the line type is [VERSE](#variablesversemd) ##### Defined in -[chord\_sheet/ast\_component.ts:8](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L8) +[chord\_sheet/ast\_component.ts:8](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/ast_component.ts#L8) *** @@ -29153,7 +38598,7 @@ Indicates whether the line type is [VERSE](#variablesversemd) ##### Defined in -[chord\_sheet/chord\_pro/literal.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/literal.ts#L4) +[chord\_sheet/chord\_pro/literal.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/literal.ts#L4) ### Methods @@ -29171,7 +38616,7 @@ Indicates whether the line type is [VERSE](#variablesversemd) ##### Defined in -[chord\_sheet/chord\_pro/literal.ts:19](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/literal.ts#L19) +[chord\_sheet/chord\_pro/literal.ts:19](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/literal.ts#L19) *** @@ -29189,7 +38634,7 @@ Indicates whether the line type is [VERSE](#variablesversemd) ##### Defined in -[chord\_sheet/chord\_pro/literal.ts:11](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/literal.ts#L11) +[chord\_sheet/chord\_pro/literal.ts:11](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/literal.ts#L11) *** @@ -29203,7 +38648,7 @@ Indicates whether the line type is [VERSE](#variablesversemd) ##### Defined in -[chord\_sheet/chord\_pro/literal.ts:15](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/literal.ts#L15) +[chord\_sheet/chord\_pro/literal.ts:15](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/literal.ts#L15) @@ -29246,7 +38691,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L28) +[chord\_sheet/metadata.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata.ts#L28) ### Properties @@ -29256,7 +38701,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L26) +[chord\_sheet/metadata.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata.ts#L26) ### Accessors @@ -29276,7 +38721,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata\_accessors.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L38) +[chord\_sheet/metadata\_accessors.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L38) *** @@ -29296,7 +38741,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata\_accessors.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L44) +[chord\_sheet/metadata\_accessors.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L44) *** @@ -29316,7 +38761,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata\_accessors.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L28) +[chord\_sheet/metadata\_accessors.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L28) *** @@ -29336,7 +38781,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata\_accessors.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L46) +[chord\_sheet/metadata\_accessors.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L46) *** @@ -29356,7 +38801,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata\_accessors.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L40) +[chord\_sheet/metadata\_accessors.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L40) *** @@ -29376,7 +38821,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata\_accessors.ts:30](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L30) +[chord\_sheet/metadata\_accessors.ts:30](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L30) *** @@ -29396,7 +38841,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata\_accessors.ts:22](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L22) +[chord\_sheet/metadata\_accessors.ts:22](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L22) *** @@ -29416,7 +38861,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata\_accessors.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L42) +[chord\_sheet/metadata\_accessors.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L42) *** @@ -29436,7 +38881,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata\_accessors.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L26) +[chord\_sheet/metadata\_accessors.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L26) *** @@ -29456,7 +38901,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata\_accessors.ts:32](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L32) +[chord\_sheet/metadata\_accessors.ts:32](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L32) *** @@ -29476,7 +38921,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata\_accessors.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L34) +[chord\_sheet/metadata\_accessors.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L34) *** @@ -29496,7 +38941,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata\_accessors.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L24) +[chord\_sheet/metadata\_accessors.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L24) *** @@ -29516,7 +38961,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata\_accessors.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L36) +[chord\_sheet/metadata\_accessors.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L36) ### Methods @@ -29536,7 +38981,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L46) +[chord\_sheet/metadata.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata.ts#L46) *** @@ -29550,7 +38995,7 @@ See [Metadata#get](#get) ##### Defined in -[chord\_sheet/metadata.ts:178](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L178) +[chord\_sheet/metadata.ts:178](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata.ts#L178) *** @@ -29568,7 +39013,7 @@ the cloned Metadata object ##### Defined in -[chord\_sheet/metadata.ts:174](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L174) +[chord\_sheet/metadata.ts:174](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata.ts#L174) *** @@ -29586,7 +39031,7 @@ the cloned Metadata object ##### Defined in -[chord\_sheet/metadata.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L42) +[chord\_sheet/metadata.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata.ts#L42) *** @@ -29627,7 +39072,7 @@ else it returns an array of strings. ##### Defined in -[chord\_sheet/metadata.ts:109](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L109) +[chord\_sheet/metadata.ts:109](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata.ts#L109) *** @@ -29645,7 +39090,7 @@ else it returns an array of strings. ##### Defined in -[chord\_sheet/metadata.ts:150](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L150) +[chord\_sheet/metadata.ts:150](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata.ts#L150) *** @@ -29667,7 +39112,7 @@ else it returns an array of strings. ##### Defined in -[chord\_sheet/metadata.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L78) +[chord\_sheet/metadata.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata.ts#L78) *** @@ -29689,7 +39134,7 @@ else it returns an array of strings. ##### Defined in -[chord\_sheet/metadata.ts:82](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L82) +[chord\_sheet/metadata.ts:82](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata.ts#L82) *** @@ -29707,7 +39152,7 @@ else it returns an array of strings. ##### Defined in -[chord\_sheet/metadata.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L36) +[chord\_sheet/metadata.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata.ts#L36) *** @@ -29725,7 +39170,7 @@ else it returns an array of strings. ##### Defined in -[chord\_sheet/metadata.ts:138](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L138) +[chord\_sheet/metadata.ts:138](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata.ts#L138) *** @@ -29745,7 +39190,7 @@ else it returns an array of strings. ##### Defined in -[chord\_sheet/metadata.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata.ts#L70) +[chord\_sheet/metadata.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata.ts#L70) @@ -29781,7 +39226,7 @@ The [Line](#classeslinemd) items of which the paragraph consists ##### Defined in -[chord\_sheet/paragraph.ts:16](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L16) +[chord\_sheet/paragraph.ts:16](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/paragraph.ts#L16) ### Accessors @@ -29799,7 +39244,7 @@ Returns the paragraph contents as one string where lines are separated by newlin ##### Defined in -[chord\_sheet/paragraph.ts:52](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L52) +[chord\_sheet/paragraph.ts:52](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/paragraph.ts#L52) *** @@ -29818,7 +39263,7 @@ in the first line. ##### Defined in -[chord\_sheet/paragraph.ts:68](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L68) +[chord\_sheet/paragraph.ts:68](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/paragraph.ts#L68) *** @@ -29837,7 +39282,7 @@ If not, it returns [INDETERMINATE](#variablesindeterminatemd) ##### Defined in -[chord\_sheet/paragraph.ts:87](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L87) +[chord\_sheet/paragraph.ts:87](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/paragraph.ts#L87) ### Methods @@ -29855,7 +39300,7 @@ If not, it returns [INDETERMINATE](#variablesindeterminatemd) ##### Defined in -[chord\_sheet/paragraph.ts:18](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L18) +[chord\_sheet/paragraph.ts:18](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/paragraph.ts#L18) *** @@ -29875,7 +39320,7 @@ Indicates whether the paragraph contains lines with renderable items. ##### Defined in -[chord\_sheet/paragraph.ts:103](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L103) +[chord\_sheet/paragraph.ts:103](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/paragraph.ts#L103) *** @@ -29889,7 +39334,7 @@ Indicates whether the paragraph contains lines with renderable items. ##### Defined in -[chord\_sheet/paragraph.ts:107](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L107) +[chord\_sheet/paragraph.ts:107](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/paragraph.ts#L107) *** @@ -29910,7 +39355,7 @@ the paragraph contents as one string where lines are separated by newlines. ##### Defined in -[chord\_sheet/paragraph.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/paragraph.ts#L28) +[chord\_sheet/paragraph.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/paragraph.ts#L28) @@ -29944,7 +39389,7 @@ the paragraph contents as one string where lines are separated by newlines. ##### Defined in -[chord\_sheet/soft\_line\_break.ts:2](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/soft_line_break.ts#L2) +[chord\_sheet/soft\_line\_break.ts:2](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/soft_line_break.ts#L2) @@ -29986,7 +39431,7 @@ Creates a new {Song} instance ##### Defined in -[chord\_sheet/song.ts:54](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L54) +[chord\_sheet/song.ts:54](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L54) ### Properties @@ -29996,7 +39441,7 @@ Creates a new {Song} instance ##### Defined in -[chord\_sheet/song.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L44) +[chord\_sheet/song.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L44) *** @@ -30006,7 +39451,7 @@ Creates a new {Song} instance ##### Defined in -[chord\_sheet/song.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L46) +[chord\_sheet/song.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L46) *** @@ -30020,7 +39465,7 @@ The [Line](#classeslinemd) items of which the song consists ##### Defined in -[chord\_sheet/song.ts:35](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L35) +[chord\_sheet/song.ts:35](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L35) *** @@ -30033,7 +39478,7 @@ an array containing all unique values for the entry. ##### Defined in -[chord\_sheet/song.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L42) +[chord\_sheet/song.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L42) *** @@ -30043,7 +39488,7 @@ an array containing all unique values for the entry. ##### Defined in -[chord\_sheet/song.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L48) +[chord\_sheet/song.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L48) ### Accessors @@ -30063,7 +39508,7 @@ an array containing all unique values for the entry. ##### Defined in -[chord\_sheet/metadata\_accessors.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L38) +[chord\_sheet/metadata\_accessors.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L38) *** @@ -30083,7 +39528,7 @@ an array containing all unique values for the entry. ##### Defined in -[chord\_sheet/metadata\_accessors.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L44) +[chord\_sheet/metadata\_accessors.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L44) *** @@ -30104,7 +39549,7 @@ The song body lines ##### Defined in -[chord\_sheet/song.ts:64](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L64) +[chord\_sheet/song.ts:64](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L64) *** @@ -30127,7 +39572,7 @@ Returns the song paragraphs, skipping the paragraphs that only contain empty lin ##### Defined in -[chord\_sheet/song.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L78) +[chord\_sheet/song.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L78) *** @@ -30147,7 +39592,7 @@ Returns the song paragraphs, skipping the paragraphs that only contain empty lin ##### Defined in -[chord\_sheet/metadata\_accessors.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L28) +[chord\_sheet/metadata\_accessors.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L28) *** @@ -30167,7 +39612,7 @@ Returns the song paragraphs, skipping the paragraphs that only contain empty lin ##### Defined in -[chord\_sheet/metadata\_accessors.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L46) +[chord\_sheet/metadata\_accessors.ts:46](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L46) *** @@ -30187,7 +39632,7 @@ Returns the song paragraphs, skipping the paragraphs that only contain empty lin ##### Defined in -[chord\_sheet/metadata\_accessors.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L40) +[chord\_sheet/metadata\_accessors.ts:40](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L40) *** @@ -30207,7 +39652,7 @@ Returns the song paragraphs, skipping the paragraphs that only contain empty lin ##### Defined in -[chord\_sheet/metadata\_accessors.ts:30](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L30) +[chord\_sheet/metadata\_accessors.ts:30](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L30) *** @@ -30225,7 +39670,7 @@ The body paragraphs of the song, with any `{chorus}` tag expanded into the targe ##### Defined in -[chord\_sheet/song.ts:156](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L156) +[chord\_sheet/song.ts:156](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L156) *** @@ -30245,7 +39690,7 @@ The body paragraphs of the song, with any `{chorus}` tag expanded into the targe ##### Defined in -[chord\_sheet/metadata\_accessors.ts:22](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L22) +[chord\_sheet/metadata\_accessors.ts:22](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L22) *** @@ -30265,7 +39710,7 @@ The body paragraphs of the song, with any `{chorus}` tag expanded into the targe ##### Defined in -[chord\_sheet/metadata\_accessors.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L42) +[chord\_sheet/metadata\_accessors.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L42) *** @@ -30285,7 +39730,7 @@ The [Paragraph](#classesparagraphmd) items of which the song consists ##### Defined in -[chord\_sheet/song.ts:148](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L148) +[chord\_sheet/song.ts:148](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L148) *** @@ -30305,7 +39750,7 @@ The [Paragraph](#classesparagraphmd) items of which the song consists ##### Defined in -[chord\_sheet/metadata\_accessors.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L26) +[chord\_sheet/metadata\_accessors.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L26) *** @@ -30325,7 +39770,7 @@ The [Paragraph](#classesparagraphmd) items of which the song consists ##### Defined in -[chord\_sheet/metadata\_accessors.ts:32](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L32) +[chord\_sheet/metadata\_accessors.ts:32](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L32) *** @@ -30345,7 +39790,7 @@ The [Paragraph](#classesparagraphmd) items of which the song consists ##### Defined in -[chord\_sheet/metadata\_accessors.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L34) +[chord\_sheet/metadata\_accessors.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L34) *** @@ -30365,7 +39810,7 @@ The [Paragraph](#classesparagraphmd) items of which the song consists ##### Defined in -[chord\_sheet/metadata\_accessors.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L24) +[chord\_sheet/metadata\_accessors.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L24) *** @@ -30385,7 +39830,7 @@ The [Paragraph](#classesparagraphmd) items of which the song consists ##### Defined in -[chord\_sheet/metadata\_accessors.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/metadata_accessors.ts#L36) +[chord\_sheet/metadata\_accessors.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/metadata_accessors.ts#L36) ### Methods @@ -30403,7 +39848,7 @@ The [Paragraph](#classesparagraphmd) items of which the song consists ##### Defined in -[chord\_sheet/song.ts:380](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L380) +[chord\_sheet/song.ts:380](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L380) *** @@ -30430,7 +39875,7 @@ The changed song ##### Defined in -[chord\_sheet/song.ts:304](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L304) +[chord\_sheet/song.ts:304](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L304) *** @@ -30459,7 +39904,7 @@ The value to set, or `null` to remove the directive ##### Defined in -[chord\_sheet/song.ts:357](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L357) +[chord\_sheet/song.ts:357](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L357) *** @@ -30477,7 +39922,7 @@ The cloned song ##### Defined in -[chord\_sheet/song.ts:186](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L186) +[chord\_sheet/song.ts:186](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L186) *** @@ -30495,7 +39940,7 @@ The cloned song ##### Defined in -[chord\_sheet/song.ts:417](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L417) +[chord\_sheet/song.ts:417](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L417) *** @@ -30520,7 +39965,7 @@ the chord definitions ##### Defined in -[chord\_sheet/song.ts:453](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L453) +[chord\_sheet/song.ts:453](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L453) *** @@ -30538,7 +39983,7 @@ the chords ##### Defined in -[chord\_sheet/song.ts:427](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L427) +[chord\_sheet/song.ts:427](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L427) *** @@ -30560,7 +40005,7 @@ the chords ##### Defined in -[chord\_sheet/song.ts:194](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L194) +[chord\_sheet/song.ts:194](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L194) *** @@ -30582,7 +40027,7 @@ the chords ##### Defined in -[chord\_sheet/song.ts:198](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L198) +[chord\_sheet/song.ts:198](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L198) *** @@ -30600,7 +40045,7 @@ the chords ##### Defined in -[chord\_sheet/song.ts:164](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L164) +[chord\_sheet/song.ts:164](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L164) *** @@ -30637,7 +40082,7 @@ song.mapItems((item) => { ##### Defined in -[chord\_sheet/song.ts:398](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L398) +[chord\_sheet/song.ts:398](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L398) *** @@ -30674,7 +40119,7 @@ song.mapLines((line) => { ##### Defined in -[chord\_sheet/song.ts:485](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L485) +[chord\_sheet/song.ts:485](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L485) *** @@ -30688,7 +40133,7 @@ song.mapLines((line) => { ##### Defined in -[chord\_sheet/song.ts:332](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L332) +[chord\_sheet/song.ts:332](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L332) *** @@ -30706,7 +40151,7 @@ song.mapLines((line) => { ##### Defined in -[chord\_sheet/song.ts:86](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L86) +[chord\_sheet/song.ts:86](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L86) *** @@ -30734,7 +40179,7 @@ The changed song ##### Defined in -[chord\_sheet/song.ts:225](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L225) +[chord\_sheet/song.ts:225](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L225) *** @@ -30762,7 +40207,7 @@ The changed song ##### Defined in -[chord\_sheet/song.ts:211](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L211) +[chord\_sheet/song.ts:211](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L211) *** @@ -30782,7 +40227,7 @@ The changed song ##### Defined in -[chord\_sheet/song.ts:190](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L190) +[chord\_sheet/song.ts:190](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L190) *** @@ -30817,7 +40262,7 @@ The transposed song ##### Defined in -[chord\_sheet/song.ts:252](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L252) +[chord\_sheet/song.ts:252](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L252) *** @@ -30848,7 +40293,7 @@ The transposed song ##### Defined in -[chord\_sheet/song.ts:292](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L292) +[chord\_sheet/song.ts:292](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L292) *** @@ -30879,7 +40324,7 @@ The transposed song ##### Defined in -[chord\_sheet/song.ts:279](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L279) +[chord\_sheet/song.ts:279](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L279) *** @@ -30903,7 +40348,7 @@ the changed song ##### Defined in -[chord\_sheet/song.ts:322](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/song.ts#L322) +[chord\_sheet/song.ts:322](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/song.ts#L322) @@ -30945,7 +40390,7 @@ Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-direc ##### Defined in -[chord\_sheet/tag.ts:412](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L412) +[chord\_sheet/tag.ts:412](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L412) ### Properties @@ -30955,7 +40400,7 @@ Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-direc ##### Defined in -[chord\_sheet/tag.ts:402](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L402) +[chord\_sheet/tag.ts:402](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L402) *** @@ -30965,7 +40410,7 @@ Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-direc ##### Defined in -[chord\_sheet/tag.ts:406](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L406) +[chord\_sheet/tag.ts:406](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L406) *** @@ -30975,7 +40420,7 @@ Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-direc ##### Defined in -[chord\_sheet/tag.ts:404](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L404) +[chord\_sheet/tag.ts:404](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L404) *** @@ -30985,7 +40430,7 @@ Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-direc ##### Defined in -[chord\_sheet/tag.ts:408](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L408) +[chord\_sheet/tag.ts:408](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L408) *** @@ -30995,7 +40440,7 @@ Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-direc ##### Defined in -[chord\_sheet/tag.ts:410](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L410) +[chord\_sheet/tag.ts:410](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L410) *** @@ -31009,7 +40454,7 @@ Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-direc ##### Defined in -[chord\_sheet/ast\_component.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L6) +[chord\_sheet/ast\_component.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/ast_component.ts#L6) *** @@ -31023,7 +40468,7 @@ Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-direc ##### Defined in -[chord\_sheet/ast\_component.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L4) +[chord\_sheet/ast\_component.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/ast_component.ts#L4) *** @@ -31037,7 +40482,7 @@ Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-direc ##### Defined in -[chord\_sheet/ast\_component.ts:8](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L8) +[chord\_sheet/ast\_component.ts:8](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/ast_component.ts#L8) ### Accessors @@ -31069,7 +40514,7 @@ The tag full name. When the original tag used the short name, `name` will return ##### Defined in -[chord\_sheet/tag.ts:491](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L491) +[chord\_sheet/tag.ts:491](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L491) *** @@ -31089,7 +40534,7 @@ The original tag name that was used to construct the tag. ##### Defined in -[chord\_sheet/tag.ts:500](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L500) +[chord\_sheet/tag.ts:500](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L500) *** @@ -31121,7 +40566,7 @@ The tag value ##### Defined in -[chord\_sheet/tag.ts:513](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L513) +[chord\_sheet/tag.ts:513](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L513) ### Methods @@ -31143,7 +40588,7 @@ The cloned tag ##### Defined in -[chord\_sheet/tag.ts:555](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L555) +[chord\_sheet/tag.ts:555](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L555) *** @@ -31162,7 +40607,7 @@ https://chordpro.org/chordpro/directives-env_bridge/, https://chordpro.org/chord ##### Defined in -[chord\_sheet/tag.ts:539](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L539) +[chord\_sheet/tag.ts:539](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L539) *** @@ -31178,7 +40623,7 @@ Checks whether the tag value is a non-empty string. ##### Defined in -[chord\_sheet/tag.ts:521](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L521) +[chord\_sheet/tag.ts:521](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L521) *** @@ -31192,7 +40637,7 @@ Checks whether the tag value is a non-empty string. ##### Defined in -[chord\_sheet/tag.ts:477](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L477) +[chord\_sheet/tag.ts:477](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L477) *** @@ -31208,7 +40653,7 @@ Checks whether the tag is either a standard meta tag or a custom meta directive ##### Defined in -[chord\_sheet/tag.ts:547](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L547) +[chord\_sheet/tag.ts:547](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L547) *** @@ -31224,7 +40669,7 @@ Checks whether the tag is usually rendered inline. It currently only applies to ##### Defined in -[chord\_sheet/tag.ts:529](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L529) +[chord\_sheet/tag.ts:529](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L529) *** @@ -31238,7 +40683,7 @@ Checks whether the tag is usually rendered inline. It currently only applies to ##### Defined in -[chord\_sheet/tag.ts:465](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L465) +[chord\_sheet/tag.ts:465](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L465) *** @@ -31252,7 +40697,7 @@ Checks whether the tag is usually rendered inline. It currently only applies to ##### Defined in -[chord\_sheet/tag.ts:473](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L473) +[chord\_sheet/tag.ts:473](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L473) *** @@ -31266,7 +40711,7 @@ Checks whether the tag is usually rendered inline. It currently only applies to ##### Defined in -[chord\_sheet/tag.ts:469](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L469) +[chord\_sheet/tag.ts:469](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L469) *** @@ -31286,7 +40731,7 @@ Checks whether the tag is usually rendered inline. It currently only applies to ##### Defined in -[chord\_sheet/tag.ts:563](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L563) +[chord\_sheet/tag.ts:563](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L563) *** @@ -31302,7 +40747,7 @@ Returns a string representation of an object. ##### Defined in -[chord\_sheet/tag.ts:559](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L559) +[chord\_sheet/tag.ts:559](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L559) *** @@ -31320,7 +40765,7 @@ Returns a string representation of an object. ##### Defined in -[chord\_sheet/tag.ts:437](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L437) +[chord\_sheet/tag.ts:437](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L437) *** @@ -31338,7 +40783,7 @@ Returns a string representation of an object. ##### Defined in -[chord\_sheet/tag.ts:455](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L455) +[chord\_sheet/tag.ts:455](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L455) *** @@ -31358,7 +40803,7 @@ Returns a string representation of an object. ##### Defined in -[chord\_sheet/tag.ts:445](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/tag.ts#L445) +[chord\_sheet/tag.ts:445](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/tag.ts#L445) @@ -31394,7 +40839,7 @@ Returns a string representation of an object. ##### Defined in -[chord\_sheet/chord\_pro/ternary.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L24) +[chord\_sheet/chord\_pro/ternary.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/ternary.ts#L24) ### Properties @@ -31408,7 +40853,7 @@ Returns a string representation of an object. ##### Defined in -[chord\_sheet/ast\_component.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L6) +[chord\_sheet/ast\_component.ts:6](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/ast_component.ts#L6) *** @@ -31418,7 +40863,7 @@ Returns a string representation of an object. ##### Defined in -[chord\_sheet/chord\_pro/ternary.ts:22](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L22) +[chord\_sheet/chord\_pro/ternary.ts:22](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/ternary.ts#L22) *** @@ -31432,7 +40877,7 @@ Returns a string representation of an object. ##### Defined in -[chord\_sheet/ast\_component.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L4) +[chord\_sheet/ast\_component.ts:4](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/ast_component.ts#L4) *** @@ -31446,7 +40891,7 @@ Returns a string representation of an object. ##### Defined in -[chord\_sheet/ast\_component.ts:8](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/ast_component.ts#L8) +[chord\_sheet/ast\_component.ts:8](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/ast_component.ts#L8) *** @@ -31456,7 +40901,7 @@ Returns a string representation of an object. ##### Defined in -[chord\_sheet/chord\_pro/ternary.ts:20](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L20) +[chord\_sheet/chord\_pro/ternary.ts:20](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/ternary.ts#L20) *** @@ -31466,7 +40911,7 @@ Returns a string representation of an object. ##### Defined in -[chord\_sheet/chord\_pro/ternary.ts:18](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L18) +[chord\_sheet/chord\_pro/ternary.ts:18](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/ternary.ts#L18) *** @@ -31476,7 +40921,7 @@ Returns a string representation of an object. ##### Defined in -[chord\_sheet/chord\_pro/ternary.ts:16](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L16) +[chord\_sheet/chord\_pro/ternary.ts:16](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/ternary.ts#L16) ### Methods @@ -31494,7 +40939,7 @@ Returns a string representation of an object. ##### Defined in -[chord\_sheet/chord\_pro/ternary.ts:98](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L98) +[chord\_sheet/chord\_pro/ternary.ts:98](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/ternary.ts#L98) *** @@ -31528,7 +40973,7 @@ The evaluated expression ##### Defined in -[chord\_sheet/chord\_pro/ternary.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L48) +[chord\_sheet/chord\_pro/ternary.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/ternary.ts#L48) *** @@ -31550,7 +40995,7 @@ The evaluated expression ##### Defined in -[chord\_sheet/chord\_pro/ternary.ts:86](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L86) +[chord\_sheet/chord\_pro/ternary.ts:86](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/ternary.ts#L86) *** @@ -31570,7 +41015,7 @@ The evaluated expression ##### Defined in -[chord\_sheet/chord\_pro/ternary.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L60) +[chord\_sheet/chord\_pro/ternary.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/ternary.ts#L60) *** @@ -31590,7 +41035,7 @@ The evaluated expression ##### Defined in -[chord\_sheet/chord\_pro/ternary.ts:68](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L68) +[chord\_sheet/chord\_pro/ternary.ts:68](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/ternary.ts#L68) *** @@ -31604,7 +41049,7 @@ The evaluated expression ##### Defined in -[chord\_sheet/chord\_pro/ternary.ts:94](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/chord_sheet/chord_pro/ternary.ts#L94) +[chord\_sheet/chord\_pro/ternary.ts:94](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/ternary.ts#L94) @@ -31646,7 +41091,7 @@ options ##### Defined in -[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L26) +[formatter/formatter.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L26) ### Properties @@ -31660,7 +41105,7 @@ options ##### Defined in -[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/formatter.ts#L7) +[formatter/formatter.ts:7](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/formatter.ts#L7) *** @@ -31670,7 +41115,7 @@ options ##### Defined in -[formatter/text\_formatter.ts:17](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L17) +[formatter/text\_formatter.ts:17](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L17) ### Methods @@ -31690,7 +41135,7 @@ options ##### Defined in -[formatter/text\_formatter.ts:102](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L102) +[formatter/text\_formatter.ts:102](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L102) *** @@ -31714,7 +41159,7 @@ the chord sheet ##### Defined in -[formatter/text\_formatter.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L24) +[formatter/text\_formatter.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L24) *** @@ -31728,7 +41173,7 @@ the chord sheet ##### Defined in -[formatter/text\_formatter.ts:33](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L33) +[formatter/text\_formatter.ts:33](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L33) *** @@ -31750,7 +41195,7 @@ the chord sheet ##### Defined in -[formatter/text\_formatter.ts:161](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L161) +[formatter/text\_formatter.ts:161](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L161) *** @@ -31772,7 +41217,7 @@ the chord sheet ##### Defined in -[formatter/text\_formatter.ts:129](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L129) +[formatter/text\_formatter.ts:129](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L129) *** @@ -31792,7 +41237,7 @@ the chord sheet ##### Defined in -[formatter/text\_formatter.ts:66](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L66) +[formatter/text\_formatter.ts:66](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L66) *** @@ -31812,7 +41257,7 @@ the chord sheet ##### Defined in -[formatter/text\_formatter.ts:142](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L142) +[formatter/text\_formatter.ts:142](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L142) *** @@ -31832,7 +41277,7 @@ the chord sheet ##### Defined in -[formatter/text\_formatter.ts:94](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L94) +[formatter/text\_formatter.ts:94](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L94) *** @@ -31854,7 +41299,7 @@ the chord sheet ##### Defined in -[formatter/text\_formatter.ts:150](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L150) +[formatter/text\_formatter.ts:150](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L150) *** @@ -31874,7 +41319,7 @@ the chord sheet ##### Defined in -[formatter/text\_formatter.ts:53](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L53) +[formatter/text\_formatter.ts:53](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L53) *** @@ -31888,7 +41333,7 @@ the chord sheet ##### Defined in -[formatter/text\_formatter.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L44) +[formatter/text\_formatter.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L44) *** @@ -31906,7 +41351,7 @@ the chord sheet ##### Defined in -[formatter/text\_formatter.ts:86](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L86) +[formatter/text\_formatter.ts:86](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L86) *** @@ -31924,7 +41369,7 @@ the chord sheet ##### Defined in -[formatter/text\_formatter.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/formatter/text_formatter.ts#L78) +[formatter/text\_formatter.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/formatter/text_formatter.ts#L78) @@ -31971,7 +41416,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/ultimate\_guitar\_parser.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L38) +[parser/ultimate\_guitar\_parser.ts:38](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/ultimate_guitar_parser.ts#L38) ### Properties @@ -31985,7 +41430,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/chord\_sheet\_parser.ts:31](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L31) +[parser/chord\_sheet\_parser.ts:31](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L31) *** @@ -31999,7 +41444,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/chord\_sheet\_parser.ts:35](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L35) +[parser/chord\_sheet\_parser.ts:35](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L35) *** @@ -32009,7 +41454,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/ultimate\_guitar\_parser.ts:31](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L31) +[parser/ultimate\_guitar\_parser.ts:31](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/ultimate_guitar_parser.ts#L31) *** @@ -32023,7 +41468,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/chord\_sheet\_parser.ts:37](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L37) +[parser/chord\_sheet\_parser.ts:37](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L37) *** @@ -32037,7 +41482,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/chord\_sheet\_parser.ts:33](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L33) +[parser/chord\_sheet\_parser.ts:33](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L33) *** @@ -32051,7 +41496,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/chord\_sheet\_parser.ts:23](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L23) +[parser/chord\_sheet\_parser.ts:23](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L23) *** @@ -32065,7 +41510,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/chord\_sheet\_parser.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L21) +[parser/chord\_sheet\_parser.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L21) *** @@ -32079,7 +41524,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/chord\_sheet\_parser.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L25) +[parser/chord\_sheet\_parser.ts:25](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L25) *** @@ -32093,7 +41538,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/chord\_sheet\_parser.ts:27](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L27) +[parser/chord\_sheet\_parser.ts:27](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L27) *** @@ -32107,7 +41552,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/chord\_sheet\_parser.ts:29](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L29) +[parser/chord\_sheet\_parser.ts:29](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L29) ### Methods @@ -32131,7 +41576,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/chord\_sheet\_parser.ts:160](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L160) +[parser/chord\_sheet\_parser.ts:160](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L160) *** @@ -32149,7 +41594,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/ultimate\_guitar\_parser.ts:79](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L79) +[parser/ultimate\_guitar\_parser.ts:79](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/ultimate_guitar_parser.ts#L79) *** @@ -32169,7 +41614,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/ultimate\_guitar\_parser.ts:100](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L100) +[parser/ultimate\_guitar\_parser.ts:100](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/ultimate_guitar_parser.ts#L100) *** @@ -32187,7 +41632,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/chord\_sheet\_parser.ts:177](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L177) +[parser/chord\_sheet\_parser.ts:177](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L177) *** @@ -32205,7 +41650,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/chord\_sheet\_parser.ts:124](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L124) +[parser/chord\_sheet\_parser.ts:124](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L124) *** @@ -32229,7 +41674,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/chord\_sheet\_parser.ts:107](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L107) +[parser/chord\_sheet\_parser.ts:107](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L107) *** @@ -32243,7 +41688,7 @@ whether to preserve trailing whitespace for chords ##### Defined in -[parser/ultimate\_guitar\_parser.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L72) +[parser/ultimate\_guitar\_parser.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/ultimate_guitar_parser.ts#L72) *** @@ -32279,7 +41724,7 @@ The parsed song ##### Defined in -[parser/chord\_sheet\_parser.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L70) +[parser/chord\_sheet\_parser.ts:70](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L70) *** @@ -32301,7 +41746,7 @@ The parsed song ##### Defined in -[parser/ultimate\_guitar\_parser.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L42) +[parser/ultimate\_guitar\_parser.ts:42](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/ultimate_guitar_parser.ts#L42) *** @@ -32325,7 +41770,7 @@ The parsed song ##### Defined in -[parser/chord\_sheet\_parser.ts:128](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L128) +[parser/chord\_sheet\_parser.ts:128](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L128) *** @@ -32347,7 +41792,7 @@ The parsed song ##### Defined in -[parser/chord\_sheet\_parser.ts:94](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L94) +[parser/chord\_sheet\_parser.ts:94](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L94) *** @@ -32371,7 +41816,7 @@ The parsed song ##### Defined in -[parser/chord\_sheet\_parser.ts:146](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L146) +[parser/chord\_sheet\_parser.ts:146](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L146) *** @@ -32389,7 +41834,7 @@ The parsed song ##### Defined in -[parser/chord\_sheet\_parser.ts:118](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L118) +[parser/chord\_sheet\_parser.ts:118](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L118) *** @@ -32411,7 +41856,7 @@ The parsed song ##### Defined in -[parser/chord\_sheet\_parser.ts:173](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/chord_sheet_parser.ts#L173) +[parser/chord\_sheet\_parser.ts:173](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/chord_sheet_parser.ts#L173) *** @@ -32425,7 +41870,7 @@ The parsed song ##### Defined in -[parser/ultimate\_guitar\_parser.ts:113](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L113) +[parser/ultimate\_guitar\_parser.ts:113](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/ultimate_guitar_parser.ts#L113) *** @@ -32445,7 +41890,7 @@ The parsed song ##### Defined in -[parser/ultimate\_guitar\_parser.ts:87](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/parser/ultimate_guitar_parser.ts#L87) +[parser/ultimate\_guitar\_parser.ts:87](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/parser/ultimate_guitar_parser.ts#L87) @@ -32520,7 +41965,7 @@ Used to mark a section as ABC music notation ### Defined in -[constants.ts:62](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L62) +[constants.ts:62](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/constants.ts#L62) @@ -32540,7 +41985,7 @@ Used to mark a paragraph as chorus ### Defined in -[constants.ts:13](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L13) +[constants.ts:13](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/constants.ts#L13) @@ -32560,7 +42005,7 @@ Used to mark a paragraph as containing lines with both verse and chorus type ### Defined in -[constants.ts:27](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L27) +[constants.ts:27](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/constants.ts#L27) @@ -32580,7 +42025,7 @@ Used to mark a section as Lilypond notation ### Defined in -[constants.ts:55](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L55) +[constants.ts:55](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/constants.ts#L55) @@ -32600,7 +42045,7 @@ Used to mark a paragraph as not containing a line marked with a type ### Defined in -[constants.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L34) +[constants.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/constants.ts#L34) @@ -32616,7 +42061,7 @@ Used to mark a paragraph as not containing a line marked with a type ### Defined in -[constants.ts:77](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L77) +[constants.ts:77](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/constants.ts#L77) @@ -32632,7 +42077,7 @@ Used to mark a paragraph as not containing a line marked with a type ### Defined in -[constants.ts:76](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L76) +[constants.ts:76](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/constants.ts#L76) @@ -32648,7 +42093,7 @@ Used to mark a paragraph as not containing a line marked with a type ### Defined in -[constants.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L78) +[constants.ts:78](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/constants.ts#L78) @@ -32664,7 +42109,7 @@ Used to mark a paragraph as not containing a line marked with a type ### Defined in -[constants.ts:75](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L75) +[constants.ts:75](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/constants.ts#L75) @@ -32684,7 +42129,7 @@ Used to mark a paragraph as tab ### Defined in -[constants.ts:41](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L41) +[constants.ts:41](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/constants.ts#L41) @@ -32704,7 +42149,7 @@ Used to mark a paragraph as verse ### Defined in -[constants.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/constants.ts#L48) +[constants.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/constants.ts#L48) @@ -32834,7 +42279,7 @@ Used to mark a paragraph as verse ### Defined in -[index.ts:75](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/index.ts#L75) +[index.ts:75](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/index.ts#L75) @@ -33046,7 +42491,7 @@ Used to mark a paragraph as verse ### Defined in -[template\_helpers.ts:98](https://github.com/martijnversluis/ChordSheetJS/blob/527a821c6e115173be348231ebc50a4eabaf8d07/src/template_helpers.ts#L98) +[template\_helpers.ts:98](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/template_helpers.ts#L98) # Media @@ -33061,11 +42506,11 @@ I love receiving pull requests from everyone! Please read this short document be #### `README.md` Are you trying to make changes to `README.md`? Wait! `README.md` is a auto-generated file. - - to make changes in the first part, go to [docs/README.hbs](docs/README.hbs) + - to make changes in the first part, go to [INTRO.md](#_mediaintromd) - the api docs are generated from JSdoc comment embedded in the code, so changing those comments will result in API doc changes. -When your changes are complete, be sure to run `yarn readme` to regenerate `README.md` and commit the updated `README.md` _together_ with the `README.hbs` changes and/or API doc changes. +When your changes are complete, be sure to run `yarn readme` to regenerate `README.md` and commit the updated `README.md` _together_ with the `INTRO.md` changes and/or API doc changes. ### Pull request guidelines @@ -33113,7 +42558,8 @@ Make your change. Add tests for your change. Make the tests pass: Push to your fork and [submit a pull request][pr]. -[pr]: https://github.com/martijnversluis/ChordSheetJS/compare/# Classes[**chordsheetjs**](#readmemd) • **Docs*****[chordsheetjs](#globalsmd) / Chord +[pr]: https://github.com/martijnversluis/ChordSheetJS/compare/# Classes[**chordsheetjs**](#readmemd) • **Docs***** +[chordsheetjs](#globalsmd) / Chord ## Class: Chord @@ -33155,7 +42601,7 @@ Represents a Chord, consisting of a root, suffix (quality) and bass ##### Defined in -[chord.ts:344](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L344) +[chord.ts:344](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L344) ### Properties @@ -33169,7 +42615,7 @@ Represents a Chord, consisting of a root, suffix (quality) and bass ##### Defined in -[chord.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L24) +[chord.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L24) *** @@ -33183,7 +42629,7 @@ Represents a Chord, consisting of a root, suffix (quality) and bass ##### Defined in -[chord.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L26) +[chord.ts:26](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L26) *** @@ -33197,7 +42643,7 @@ Represents a Chord, consisting of a root, suffix (quality) and bass ##### Defined in -[chord.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L28) +[chord.ts:28](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L28) ### Methods @@ -33213,7 +42659,7 @@ Returns a deep copy of the chord ##### Defined in -[chord.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L60) +[chord.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L60) *** @@ -33231,7 +42677,7 @@ Returns a deep copy of the chord ##### Defined in -[chord.ts:374](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L374) +[chord.ts:374](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L374) *** @@ -33247,7 +42693,7 @@ Determines whether the chord is a chord solfege ##### Defined in -[chord.ts:160](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L160) +[chord.ts:160](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L160) *** @@ -33263,7 +42709,7 @@ Determines whether the chord is a chord symbol ##### Defined in -[chord.ts:110](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L110) +[chord.ts:110](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L110) *** @@ -33277,7 +42723,7 @@ Determines whether the chord is a chord symbol ##### Defined in -[chord.ts:432](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L432) +[chord.ts:432](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L432) *** @@ -33293,7 +42739,7 @@ Determines whether the chord is a numeral ##### Defined in -[chord.ts:246](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L246) +[chord.ts:246](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L246) *** @@ -33309,7 +42755,7 @@ Determines whether the chord is numeric ##### Defined in -[chord.ts:227](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L227) +[chord.ts:227](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L227) *** @@ -33323,7 +42769,7 @@ Determines whether the chord is numeric ##### Defined in -[chord.ts:436](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L436) +[chord.ts:436](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L436) *** @@ -33374,7 +42820,7 @@ the normalized chord ##### Defined in -[chord.ts:294](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L294) +[chord.ts:294](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L294) *** @@ -33392,7 +42838,7 @@ the normalized chord ##### Defined in -[chord.ts:442](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L442) +[chord.ts:442](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L442) *** @@ -33419,7 +42865,7 @@ the chord solfege ##### Defined in -[chord.ts:122](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L122) +[chord.ts:122](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L122) *** @@ -33448,7 +42894,7 @@ the chord solfege string ##### Defined in -[chord.ts:152](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L152) +[chord.ts:152](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L152) *** @@ -33475,7 +42921,7 @@ the chord symbol ##### Defined in -[chord.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L72) +[chord.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L72) *** @@ -33504,7 +42950,7 @@ the chord symbol string ##### Defined in -[chord.ts:102](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L102) +[chord.ts:102](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L102) *** @@ -33529,7 +42975,7 @@ the numeral chord ##### Defined in -[chord.ts:194](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L194) +[chord.ts:194](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L194) *** @@ -33556,7 +43002,7 @@ the numeral chord string ##### Defined in -[chord.ts:219](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L219) +[chord.ts:219](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L219) *** @@ -33581,7 +43027,7 @@ the numeric chord ##### Defined in -[chord.ts:170](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L170) +[chord.ts:170](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L170) *** @@ -33608,7 +43054,7 @@ the numeric chord string ##### Defined in -[chord.ts:238](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L238) +[chord.ts:238](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L238) *** @@ -33637,7 +43083,7 @@ the chord string ##### Defined in -[chord.ts:257](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L257) +[chord.ts:257](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L257) *** @@ -33661,7 +43107,7 @@ the new, transposed chord ##### Defined in -[chord.ts:340](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L340) +[chord.ts:340](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L340) *** @@ -33679,7 +43125,7 @@ the new, transposed chord ##### Defined in -[chord.ts:331](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L331) +[chord.ts:331](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L331) *** @@ -33697,7 +43143,7 @@ the new, transposed chord ##### Defined in -[chord.ts:323](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L323) +[chord.ts:323](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L323) *** @@ -33721,7 +43167,7 @@ the new, changed chord ##### Defined in -[chord.ts:315](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L315) +[chord.ts:315](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L315) *** @@ -33747,7 +43193,7 @@ the new, changed chord ##### Defined in -[chord.ts:407](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L407) +[chord.ts:407](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L407) *** @@ -33775,7 +43221,7 @@ the new, changed chord ##### Defined in -[chord.ts:380](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L380) +[chord.ts:380](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L380) *** @@ -33798,7 +43244,7 @@ the chord string, eg `Esus4/G#` or `1sus4/#3`. ##### Defined in -[chord.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L36) +[chord.ts:36](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L36) *** @@ -33816,7 +43262,7 @@ the chord string, eg `Esus4/G#` or `1sus4/#3`. ##### Defined in -[chord.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord.ts#L44) +[chord.ts:44](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord.ts#L44) @@ -33860,7 +43306,7 @@ A chord definitions overrides a previous chord definition for the exact same cho ##### Defined in -[chord\_sheet/chord\_pro/chord\_definition.ts:47](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/chord_definition.ts#L47) +[chord\_sheet/chord\_pro/chord\_definition.ts:47](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_pro/chord_definition.ts#L47) ### Properties @@ -33873,7 +43319,7 @@ The offset must be 1 or higher. ##### Defined in -[chord\_sheet/chord\_pro/chord\_definition.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/chord_definition.ts#L24) +[chord\_sheet/chord\_pro/chord\_definition.ts:24](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_pro/chord_definition.ts#L24) *** @@ -33890,7 +43336,7 @@ Note that the values -, x, X, and N are used to designate a string without finge ##### Defined in -[chord\_sheet/chord\_pro/chord\_definition.ts:45](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/chord_definition.ts#L45) +[chord\_sheet/chord\_pro/chord\_definition.ts:45](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_pro/chord_definition.ts#L45) *** @@ -33906,7 +43352,7 @@ the topmost fret position is 1. With base-fret 3, fret position 1 indicates the ##### Defined in -[chord\_sheet/chord\_pro/chord\_definition.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/chord_definition.ts#L34) +[chord\_sheet/chord\_pro/chord\_definition.ts:34](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_pro/chord_definition.ts#L34) *** @@ -33918,7 +43364,7 @@ The chord name, e.g. `C`, `Dm`, `G7`. ##### Defined in -[chord\_sheet/chord\_pro/chord\_definition.ts:17](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/chord_definition.ts#L17) +[chord\_sheet/chord\_pro/chord\_definition.ts:17](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_pro/chord_definition.ts#L17) ### Methods @@ -33932,7 +43378,7 @@ The chord name, e.g. `C`, `Dm`, `G7`. ##### Defined in -[chord\_sheet/chord\_pro/chord\_definition.ts:54](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_pro/chord_definition.ts#L54) +[chord\_sheet/chord\_pro/chord\_definition.ts:54](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_pro/chord_definition.ts#L54) @@ -33974,7 +43420,7 @@ The annotation ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L21) +[chord\_sheet/chord\_lyrics\_pair.ts:21](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_lyrics_pair.ts#L21) ### Properties @@ -33984,7 +43430,7 @@ The annotation ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:13](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L13) +[chord\_sheet/chord\_lyrics\_pair.ts:13](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_lyrics_pair.ts#L13) *** @@ -33994,7 +43440,7 @@ The annotation ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:9](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L9) +[chord\_sheet/chord\_lyrics\_pair.ts:9](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_lyrics_pair.ts#L9) *** @@ -34004,7 +43450,7 @@ The annotation ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:11](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L11) +[chord\_sheet/chord\_lyrics\_pair.ts:11](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_lyrics_pair.ts#L11) ### Methods @@ -34022,7 +43468,7 @@ The annotation ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:100](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L100) +[chord\_sheet/chord\_lyrics\_pair.ts:100](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_lyrics_pair.ts#L100) *** @@ -34038,7 +43484,7 @@ Returns a deep copy of the ChordLyricsPair, useful when programmatically transfo ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:56](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L56) +[chord\_sheet/chord\_lyrics\_pair.ts:56](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_lyrics_pair.ts#L56) *** @@ -34054,7 +43500,7 @@ Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L48) +[chord\_sheet/chord\_lyrics\_pair.ts:48](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_lyrics_pair.ts#L48) *** @@ -34078,7 +43524,7 @@ Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:64](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L64) +[chord\_sheet/chord\_lyrics\_pair.ts:64](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_lyrics_pair.ts#L64) *** @@ -34096,7 +43542,7 @@ Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:76](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L76) +[chord\_sheet/chord\_lyrics\_pair.ts:76](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_lyrics_pair.ts#L76) *** @@ -34114,7 +43560,7 @@ Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L72) +[chord\_sheet/chord\_lyrics\_pair.ts:72](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_lyrics_pair.ts#L72) *** @@ -34128,7 +43574,7 @@ Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet ##### Defined in -[chord\_sheet/chord\_lyrics\_pair.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/9f253175713caec7da72f86d7b0f5039f75675e7/src/chord_sheet/chord_lyrics_pair.ts#L60) +[chord\_sheet/chord\_lyrics\_pair.ts:60](https://github.com/martijnversluis/ChordSheetJS/blob/9c6f2f6de369bd12244e28526047676dd5086772/src/chord_sheet/chord_lyrics_pair.ts#L60) *** diff --git a/package.json b/package.json index e217303b..98425bd7 100644 --- a/package.json +++ b/package.json @@ -67,7 +67,7 @@ "build:release": "yarn unibuild --force --release", "ci": "yarn install && yarn unibuild lint && yarn unibuild test && yarn build:release", "debug:chordpro": "tsx script/debug_parser.ts chord_pro --skip-chord-grammar", - "prepare": "yarn build", + "prepare": "yarn install && yarn build", "prepublishOnly": "yarn install && yarn test && yarn build:release", "readme": "yarn unibuild build readme -f", "test": "yarn unibuild lint && yarn unibuild test",