ChordSheetJS

A JavaScript library for parsing and formatting chord sheets

Contents

• Installation
• How to ...?
• Supported ChordPro directives
• API docs

Installation

Package managers

ChordSheetJS is on npm, to install run:

npm install chordsheetjs

Load with import:

import ChordSheetJS from 'chordsheetjs';

or require():

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:

<script src="bundle.js"></script>
<script>
// ChordSheetJS is available in global namespace now
const parser = new ChordSheetJS.ChordProParser();
</script>

How to ...?

Parse chord sheet

Regular chord sheets

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.ChordSheetParser();
const song = parser.parse(chordSheet);

Ultimate Guitar chord sheets

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

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

const formatter = new ChordSheetJS.TextFormatter();
const disp = formatter.format(song);

HTML format

Table-based layout

const formatter = new ChordSheetJS.HtmlTableFormatter();
const disp = formatter.format(song);

Div-based layout

const formatter = new ChordSheetJS.HtmlDivFormatter();
const disp = formatter.format(song);

Chord pro format

const formatter = new ChordSheetJS.ChordProFormatter();
const disp = formatter.format(song);

Serialize/deserialize

Chord sheets (Songs) 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.

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:

HtmlTableFormatter.cssString();
// .paragraph {
//   margin-bottom: 1em;
// }

HtmlTableFormatter.cssString('.chordSheetViewer');
// .chordSheetViewer .paragraph {
//   margin-bottom: 1em;
// }

HtmlTableFormatter.cssObject();
// '.paragraph': {
//   marginBottom: '1em'
// }

Parsing and modifying chords

import { parseChord } from 'chordsheetjs';

Parse

const chord = parseChord('Ebsus4/Bb');

Parse numeric chords (Nashville system):

const chord = parseChord('b1sus4/#3');

Display with #toString

Use #toString() to convert the chord to a chord string (eg Dsus/F#)

const chord = parseChord('Ebsus4/Bb');
chord.toString(); // --> "Ebsus4/Bb"

Clone

var chord2 = chord.clone();

Normalize

Normalizes keys B#, E#, Cb and Fb to C, F, B and E

const chord = parseChord('E#/B#'),
normalizedChord = chord.normalize();
normalizedChord.toString(); // --> "F/C"

Switch modifier

Convert # to b and vice versa

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)

const chord = parseChord('Eb/Bb');
const chord2 = chord.useModifier('#');
chord2.toString(); // --> "D#/A#"

const chord = parseChord('Eb/Bb');
const chord2 = chord.useModifier('b');
chord2.toString(); // --> "Eb/Bb"

Transpose up

const chord = parseChord('Eb/Bb');
const chord2 = chord.transposeUp();
chord2.toString(); // -> "E/B"

Transpose down

const chord = parseChord('Eb/Bb');
const chord2 = chord.transposeDown();
chord2.toString(); // -> "D/A"

Transpose

const chord = parseChord('C/E');
const chord2 = chord.transpose(4);
chord2.toString(); // -> "E/G#"

const chord = parseChord('C/E');
const chord2 = chord.transpose(-4);
chord2.toString(); // -> "Ab/C"

Convert numeric chord to chord symbol

const numericChord = parseChord('2/4');
const chordSymbol = toChordSymbol(numericChord, 'E');
chordSymbol.toString(); // -> "F#m/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.

✔️ = supported

🕑 = will be supported in a future version

✖️ = currently no plans to support it in the near future

Meta-data directives

Formatting directives

Environment directives

Chord diagrams

Fonts, sizes and colours

Output related directives

Custom extensions

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.

Classes

ChordLyricsPair

Represents a chord with the corresponding (partial) lyrics

Comment

Represents a comment. See https://www.chordpro.org/chordpro/chordpro-file-format-specification/#overview

Line : Font

Represents a line in a chord sheet, consisting of items of type ChordLyricsPair or Tag

Metadata

Stores song metadata. Properties can be accessed using the get() method:

const metadata = new Metadata({ author: 'John' }); metadata.get('author') // => 'John'

See [get](#Metadata+get)

Paragraph

Represents a paragraph of lines in a chord sheet

Song

Represents a song in a chord sheet. Currently a chord sheet can only have one song.

Tag

Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-directives/

ChordProFormatter

Formats a song into a ChordPro chord sheet

ChordsOverWordsFormatter

Formats a song into a plain text chord sheet

Formatter

Base class for all formatters, taking care of receiving a configuration wrapping that inside a Configuration object

HtmlDivFormatter

Formats a song into HTML. It uses DIVs to align lyrics with chords, which makes it useful for responsive web pages.

HtmlFormatter

Acts as a base class for HTML formatters

HtmlTableFormatter

Formats a song into HTML. It uses TABLEs to align lyrics with chords, which makes the HTML for things like PDF conversion.

TextFormatter

Formats a song into a plain text chord sheet

ChordProParser

Parses a ChordPro chord sheet

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.

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.

ParserWarning

Represents a parser warning, currently only used by ChordProParser.

PegBasedParser

Parses a chords over words sheet

UltimateGuitarParser

Parses an Ultimate Guitar chord sheet with metadata Inherits from [ChordSheetParser](#ChordSheetParser)

Chord

Represents a Chord, consisting of a root, suffix (quality) and bass

ChordSheetSerializer

Serializes a song into een plain object, and deserializes the serialized object back into a [Song](#Song)

Key

Represents a key, such as Eb (symbol), #3 (numeric) or VII (numeral).

The only function considered public API is Key.distance

Members

Font : string | null

The font color

FontSize : number

The font size

ALBUM : string

Artist meta directive. See https://www.chordpro.org/chordpro/directives-artist/

ARTIST : string

Capo meta directive. See https://www.chordpro.org/chordpro/directives-capo/

CAPO : string

Comment directive. See https://www.chordpro.org/chordpro/directives-comment/

COMMENT : string

Composer meta directive. See https://www.chordpro.org/chordpro/directives-composer/

COMPOSER : string

Copyright meta directive. See https://www.chordpro.org/chordpro/directives-copyright/

COPYRIGHT : string

Duration meta directive. See https://www.chordpro.org/chordpro/directives-duration/

DURATION : string

End of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/

END_OF_BRIDGE : string

End of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/

END_OF_CHORUS : string

End of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/

END_OF_TAB : string

End of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/

END_OF_VERSE : string

Key meta directive. See https://www.chordpro.org/chordpro/directives-key/

KEY : string

_Key meta directive. Reflects the key as transposed by the capo value See https://www.chordpro.org/chordpro/directives-key/

_KEY : string

Lyricist meta directive. See https://www.chordpro.org/chordpro/directives-lyricist/

LYRICIST : string

Start of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/

START_OF_BRIDGE : string

Start of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/

START_OF_CHORUS : string

Start of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/

START_OF_TAB : string

Start of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/

START_OF_VERSE : string

Subtitle meta directive. See https://www.chordpro.org/chordpro/directives-subtitle/

SUBTITLE : string

Tempo meta directive. See https://www.chordpro.org/chordpro/directives-tempo/

TEMPO : string

Time meta directive. See https://www.chordpro.org/chordpro/directives-time/

TIME : string

Title meta directive. See https://www.chordpro.org/chordpro/directives-title/

TITLE : string

Transpose meta directive. See: https://www.chordpro.org/chordpro/directives-transpose/

TRANSPOSE : string

New Key meta directive. See: bettermusic#53

NEW_KEY : string

Year meta directive. See https://www.chordpro.org/chordpro/directives-year/

YEAR : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/

CHORDFONT : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/

CHORDSIZE : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/

CHORDCOLOUR : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/

TEXTFONT : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/

TEXTSIZE : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/

TEXTCOLOUR : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/

TITLEFONT : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/

TITLESIZE : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/

TITLECOLOUR : string

Chorus directive. Support repeating an earlier defined section. See https://www.chordpro.org/chordpro/directives-env_chorus/

defaultCss ⇒ string

Generates basic CSS, scoped within the provided selector, to use with output generated by [HtmlTableFormatter](#HtmlTableFormatter)

defaultCss ⇒ string

Generates basic CSS, scoped within the provided selector, to use with output generated by [HtmlTableFormatter](#HtmlTableFormatter)

Constants

ALBUM : string

Album meta directive. See https://www.chordpro.org/chordpro/directives-album/

defaultCss : Object.<string, Object.<string, string>>

Basic CSS, in object style à la useStyles, to use with output generated by {@link }HtmlTableFormatter} For a CSS string see [scopedCss](scopedCss)

VERSE : string

Used to mark a paragraph as verse

VERSE : string

Used to mark a paragraph as chorus

CHORUS : string

Used to mark a paragraph as not containing a line marked with a type

NONE : string

Used to mark a paragraph as containing lines with both verse and chorus type

INDETERMINATE : string

Used to mark a paragraph as tab

Functions

parseChord(chordString) ⇒ Chord | null

Tries to parse a chord string into a chord

getCapos(key) ⇒ Object.<string, string>

Returns applicable capos for the provided key

getKeys(key) ⇒ Array.<string>

Returns applicable keys to transpose to from the provided key

ChordLyricsPair

Represents a chord with the corresponding (partial) lyrics

Kind: global class

• ChordLyricsPair
  • new ChordLyricsPair(chords, lyrics)
  • .chords : string
  • .lyrics : string
  • .isRenderable() ⇒ boolean
  • .clone() ⇒ ChordLyricsPair

new ChordLyricsPair(chords, lyrics)

Initialises a ChordLyricsPair

chordLyricsPair.chords : string

The chords

Kind: instance property of ChordLyricsPair

chordLyricsPair.lyrics : string

The lyrics

Kind: instance property of ChordLyricsPair

chordLyricsPair.isRenderable() ⇒ boolean

Indicates whether a ChordLyricsPair should be visible in a formatted chord sheet (except for ChordPro sheets)

Kind: instance method of ChordLyricsPair

chordLyricsPair.clone() ⇒ ChordLyricsPair

Returns a deep copy of the ChordLyricsPair, useful when programmatically transforming a song

Kind: instance method of ChordLyricsPair

Comment

Represents a comment. See https://www.chordpro.org/chordpro/chordpro-file-format-specification/#overview

Kind: global class

• Comment
  • .isRenderable() ⇒ boolean
  • .clone() ⇒ Comment

comment.isRenderable() ⇒ boolean

Indicates whether a Comment should be visible in a formatted chord sheet (except for ChordPro sheets)

Kind: instance method of Comment

comment.clone() ⇒ Comment

Returns a deep copy of the Comment, useful when programmatically transforming a song

Kind: instance method of Comment

Line : Font

Represents a line in a chord sheet, consisting of items of type ChordLyricsPair or Tag

Kind: global class

• Line : Font
  • new Line()
  • .isEmpty() ⇒ boolean
  • .addItem(item)
  • .hasRenderableItems() ⇒ boolean
  • .clone() ⇒ Line
  • .isVerse() ⇒ boolean
  • .isChorus() ⇒ boolean
  • .hasContent() ⇒ boolean

new Line()

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/

line.isEmpty() ⇒ boolean

Indicates whether the line contains any items

Kind: instance method of Line

line.addItem(item)

Adds an item ([ChordLyricsPair](#ChordLyricsPair) or [Tag](#Tag)) to the line

Kind: instance method of Line

line.hasRenderableItems() ⇒ boolean

Indicates whether the line contains items that are renderable

Kind: instance method of Line

line.clone() ⇒ Line

Returns a deep copy of the line and all of its items

Kind: instance method of Line

line.isVerse() ⇒ boolean

Indicates whether the line type is [VERSE](#VERSE)

Kind: instance method of Line

line.isChorus() ⇒ boolean

Indicates whether the line type is [CHORUS](#CHORUS)

Kind: instance method of Line

line.hasContent() ⇒ boolean

Deprecated

Indicates whether the line contains items that are renderable. Please use [hasRenderableItems](hasRenderableItems)

Kind: instance method of Line

Metadata

Stores song metadata. Properties can be accessed using the get() method:

const metadata = new Metadata({ author: 'John' }); metadata.get('author') // => 'John'

See [get](#Metadata+get)

Kind: global class

• Metadata
  • .get(prop) ⇒ Array.<String> | String
  • .clone() ⇒ Metadata

metadata.get(prop) ⇒ Array.<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'

Kind: instance method of Metadata
Returns: Array.<String> | String -

the metadata value(s). If there is only one value, it will return a String, else it returns an array of strings.

metadata.clone() ⇒ Metadata

Returns a deep clone of this Metadata object

Kind: instance method of Metadata
Returns: Metadata -

the cloned Metadata object

Paragraph

Represents a paragraph of lines in a chord sheet

Kind: global class

• Paragraph
  • .addLine : Array.<Line>
  • .type ⇒ string
  • .hasRenderableItems() ⇒ boolean

paragraph.addLine : Array.<Line>

The [Line](#Line) items of which the paragraph consists

Kind: instance property of Paragraph

paragraph.type ⇒ string

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](#INDETERMINATE)

Kind: instance property of Paragraph

paragraph.hasRenderableItems() ⇒ boolean

Indicates whether the paragraph contains lines with renderable items.

Kind: instance method of Paragraph
See: Line.hasRenderableItems

Song

Represents a song in a chord sheet. Currently a chord sheet can only have one song.

Kind: global class

• Song
  • new Song(metadata)
  • .bodyLines ⇒ Array.<Line>
  • .bodyParagraphs ⇒ Array.<Paragraph>
  • .paragraphs : Array.<Paragraph>
  • .expandedBodyParagraphs : Array.<Paragraph>
  • .metaData ⇒
  • .clone() ⇒ Song
  • .setKey(key) ⇒ Song
  • .setCapo(capo) ⇒ Song
  • .transpose(delta, [options]) ⇒ Song
  • .transposeUp([options]) ⇒ Song
  • .transposeDown([options]) ⇒ Song
  • .changeKey(newKey) ⇒ Song
  • .changeMetadata(name, value)
  • .mapItems(func) ⇒ Song
  • .mapLines(func) ⇒ Song

new Song(metadata)

Creates a new {Song} instance

song.bodyLines ⇒ Array.<Line>

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.

Kind: instance property of Song
Returns: Array.<Line> -

The song body lines

song.bodyParagraphs ⇒ Array.<Paragraph>

Returns the song paragraphs, skipping the paragraphs that only contain empty lines (empty as in not rendering any content)

Kind: instance property of Song
See: bodyLines

song.paragraphs : Array.<Paragraph>

The [Paragraph](#Paragraph) items of which the song consists

Kind: instance property of Song

song.expandedBodyParagraphs : Array.<Paragraph>

The body paragraphs of the song, with any {chorus} tag expanded into the targetted chorus

Kind: instance property of Song

song.metaData ⇒

Deprecated

The song's metadata. Please use [metadata](metadata) instead.

Kind: instance property of Song
Returns:

Metadata The metadata

song.clone() ⇒ Song

Returns a deep clone of the song

Kind: instance method of Song
Returns: Song -

The cloned song

song.setKey(key) ⇒ Song

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

Kind: instance method of Song
Returns: Song -

The changed song

song.setCapo(capo) ⇒ Song

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

Kind: instance method of Song
Returns: Song -

The changed song

song.transpose(delta, [options]) ⇒ Song

Transposes the song by the specified delta. It will:

• transpose all chords, see: [transpose](#Chord+transpose)
• transpose the song key in [metadata](metadata)
• update any existing key directive

Kind: instance method of Song
Returns: Song -

The transposed song

song.transposeUp([options]) ⇒ Song

Transposes the song up by one semitone. It will:

• transpose all chords, see: [transpose](#Chord+transpose)
• transpose the song key in [metadata](metadata)
• update any existing key directive

Kind: instance method of Song
Returns: Song -

The transposed song

song.transposeDown([options]) ⇒ Song

Transposes the song down by one semitone. It will:

• transpose all chords, see: [transpose](#Chord+transpose)
• transpose the song key in [metadata](metadata)
• update any existing key directive

Kind: instance method of Song
Returns: Song -

The transposed song

song.changeKey(newKey) ⇒ Song

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

Kind: instance method of Song
Returns: Song -

The changed song

song.changeMetadata(name, value)

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.

Kind: instance method of Song

song.mapItems(func) ⇒ Song

Change the song contents inline. Return a new [Item](Item) to replace it. Return null to remove it.

Kind: instance method of Song
Returns: Song -

the changed song

Example

// transpose all chords:
song.mapItems((item) => {
  if (item instanceof ChordLyricsPair) {
    return item.transpose(2, 'D');
  }

  return item;
});

song.mapLines(func) ⇒ Song

Change the song contents inline. Return a new [Line](#Line) to replace it. Return null to remove it.

Kind: instance method of Song
Returns: Song -

the changed song

Example

// remove lines with only Tags:
song.mapLines((line) => {
  if (line.items.every(item => item instanceof Tag)) {
    return null;
  }

  return line;
});

Tag

Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-directives/

Kind: global class

• Tag
  • .name : string
  • .originalName : string
  • .value : string
  • .hasValue() ⇒ boolean
  • .isRenderable() ⇒ boolean
  • .hasRenderableLabel()
  • .isMetaTag() ⇒ boolean
  • .clone() ⇒ Tag

tag.name : string

The tag full name. When the original tag used the short name, name will return the full name.

Kind: instance property of Tag

tag.originalName : string

The original tag name that was used to construct the tag.

Kind: instance property of Tag

tag.value : string

The tag value

Kind: instance property of Tag

tag.hasValue() ⇒ boolean

Checks whether the tag value is a non-empty string.

Kind: instance method of Tag

tag.isRenderable() ⇒ boolean

Checks whether the tag is usually rendered inline. It currently only applies to comment tags.

Kind: instance method of Tag

tag.hasRenderableLabel()

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/

Kind: instance method of Tag

tag.isMetaTag() ⇒ boolean

Checks whether the tag is either a standard meta tag or a custom meta directive ({x_some_name})

Kind: instance method of Tag

tag.clone() ⇒ Tag

Returns a clone of the tag.

Kind: instance method of Tag
Returns: Tag -

The cloned tag

ChordProFormatter

Formats a song into a ChordPro chord sheet

Kind: global class

chordProFormatter.format(song) ⇒ string

Formats a song into a ChordPro chord sheet.

Kind: instance method of ChordProFormatter
Returns: string -

The ChordPro string

ChordsOverWordsFormatter

Formats a song into a plain text chord sheet

Kind: global class

chordsOverWordsFormatter.format(song) ⇒ string

Formats a song into a plain text chord sheet

Kind: instance method of ChordsOverWordsFormatter
Returns: string -

the chord sheet

Formatter

Base class for all formatters, taking care of receiving a configuration wrapping that inside a Configuration object

Kind: global class

new Formatter([configuration])

Instantiate

HtmlDivFormatter

Formats a song into HTML. It uses DIVs to align lyrics with chords, which makes it useful for responsive web pages.

Kind: global class

HtmlFormatter

Acts as a base class for HTML formatters

Kind: global class

• HtmlFormatter
  • instance
    • .cssObject ⇒ Object.<string, Object.<string, string>>
    • .format(song) ⇒ string
    • .cssString(scope) ⇒ string
  • static
    • .cssString()
    • .cssObject()

htmlFormatter.cssObject ⇒ Object.<string, Object.<string, string>>

Basic CSS, in object style à la useStyles, to use with the HTML output For a CSS string see [cssString](cssString)

Example:

'.paragraph': {
  marginBottom: '1em'
}

Kind: instance property of HtmlFormatter
Returns: Object.<string, Object.<string, string>> -

the CSS object

htmlFormatter.format(song) ⇒ string

Formats a song into HTML.

Kind: instance method of HtmlFormatter
Returns: string -

The HTML string

htmlFormatter.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;
}

Kind: instance method of HtmlFormatter
Returns: string -

the CSS string

HtmlFormatter.cssString()

Deprecated

Generates basic CSS, optionally scoped within the provided selector, to use with the HTML output

Kind: static method of HtmlFormatter

HtmlFormatter.cssObject()

Deprecated

Basic CSS, in object style à la useStyles, to use with the HTML output

Kind: static method of HtmlFormatter

HtmlTableFormatter

Formats a song into HTML. It uses TABLEs to align lyrics with chords, which makes the HTML for things like PDF conversion.

Kind: global class

TextFormatter

Formats a song into a plain text chord sheet

Kind: global class

textFormatter.format(song) ⇒ string

Formats a song into a plain text chord sheet

Kind: instance method of TextFormatter
Returns: string -

the chord sheet

ChordProParser

Parses a ChordPro chord sheet

Kind: global class

chordProParser.parse(chordProChordSheet) ⇒ Song

Parses a ChordPro chord sheet into a song

Kind: instance method of ChordProParser
Returns: Song -

The parsed song

ChordSheetParser

Deprecated

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.

Kind: global class

• ChordSheetParser
  • new ChordSheetParser([options])
  • .parse(chordSheet, [options]) ⇒ Song

new ChordSheetParser([options])

Instantiate a chord sheet parser ChordSheetParser is deprecated, please use ChordsOverWordsParser.

chordSheetParser.parse(chordSheet, [options]) ⇒ Song

Parses a chord sheet into a song

Kind: instance method of ChordSheetParser
Returns: Song -

The parsed song

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.

Kind: global class

chordsOverWordsParser.parse(chordsOverWordsSheet) ⇒ Song

Parses a chords over words sheet into a song

Kind: instance method of ChordsOverWordsParser
Returns: Song -

The parsed song

ParserWarning

Represents a parser warning, currently only used by ChordProParser.

Kind: global class

parserWarning.toString() ⇒ string

Returns a stringified version of the warning

Kind: instance method of ParserWarning
Returns: string -

The string warning

PegBasedParser

Parses a chords over words sheet

Kind: global class

pegBasedParser.warnings : Array.<ParserWarning>

All warnings raised during parsing the chord sheet

Kind: instance property of PegBasedParser

UltimateGuitarParser

Parses an Ultimate Guitar chord sheet with metadata Inherits from [ChordSheetParser](#ChordSheetParser)

Kind: global class

Chord

Represents a Chord, consisting of a root, suffix (quality) and bass

Kind: global class

• Chord
  • instance
    • .clone() ⇒ Chord
    • .toChordSymbol([referenceKey]) ⇒ Chord
    • .toChordSymbolString([referenceKey]) ⇒ string
    • .isChordSymbol() ⇒ boolean
    • .toNumeric([referenceKey]) ⇒ Chord
    • .toNumeral([referenceKey]) ⇒ Chord
    • .toNumeralString([referenceKey]) ⇒ string
    • .isNumeric() ⇒ boolean
    • .toNumericString([referenceKey]) ⇒ string
    • .isNumeral() ⇒ boolean
    • .toString([configuration]) ⇒ string
    • .normalize([key], [options]) ⇒ Chord
    • .useModifier(newModifier) ⇒ Chord
    • .transposeUp() ⇒ Chord
    • .transposeDown() ⇒ Chord
    • .transpose(delta) ⇒ Chord
  • static
    • .parse(chordString) ⇒ Chord | null

chord.clone() ⇒ Chord

Returns a deep copy of the chord

Kind: instance method of Chord

chord.toChordSymbol([referenceKey]) ⇒ Chord

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.

Kind: instance method of Chord
Returns: Chord -

the chord symbol

chord.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.

Kind: instance method of Chord
Returns: string -

the chord symbol string

chord.isChordSymbol() ⇒ boolean

Determines whether the chord is a chord symbol

Kind: instance method of Chord

chord.toNumeric([referenceKey]) ⇒ Chord

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.

Kind: instance method of Chord
Returns: Chord -

the numeric chord

chord.toNumeral([referenceKey]) ⇒ Chord

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.

Kind: instance method of Chord
Returns: Chord -

the numeral chord

chord.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.

Kind: instance method of Chord
Returns: string -

the numeral chord string

chord.isNumeric() ⇒ boolean

Determines whether the chord is numeric

Kind: instance method of Chord

chord.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.

Kind: instance method of Chord
Returns: string -

the numeric chord string

chord.isNumeral() ⇒ boolean

Determines whether the chord is a numeral

Kind: instance method of Chord

chord.toString([configuration]) ⇒ string

Converts the chord to a string, eg Esus4/G# or 1sus4/#3

Kind: instance method of Chord
Returns: string -

the chord string

chord.normalize([key], [options]) ⇒ Chord

Normalizes the chord root and bass notes:

• 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.

Kind: instance method of Chord
Returns: Chord -

the normalized chord

chord.useModifier(newModifier) ⇒ Chord

Switches to the specified modifier

Kind: instance method of Chord
Returns: Chord -

the new, changed chord

chord.transposeUp() ⇒ Chord

Transposes the chord up by 1 semitone. Eg. A becomes A#, Eb becomes E

Kind: instance method of Chord
Returns: Chord -

the new, transposed chord

chord.transposeDown() ⇒ Chord

Transposes the chord down by 1 semitone. Eg. A# becomes A, E becomes Eb

Kind: instance method of Chord
Returns: Chord -

the new, transposed chord

chord.transpose(delta) ⇒ Chord

Transposes the chord by the specified number of semitones

Kind: instance method of Chord
Returns: Chord -

the new, transposed chord

Chord.parse(chordString) ⇒ Chord | null

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.

Kind: static method of Chord

ChordSheetSerializer

Serializes a song into een plain object, and deserializes the serialized object back into a [Song](#Song)

Kind: global class

• ChordSheetSerializer
  • .serialize() ⇒
  • .deserialize(serializedSong) ⇒ Song

chordSheetSerializer.serialize() ⇒

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)

Kind: instance method of ChordSheetSerializer
Returns:

object A plain JS object containing all chord sheet data

chordSheetSerializer.deserialize(serializedSong) ⇒ Song

Deserializes a song that has been serialized using [serialize](serialize)

Kind: instance method of ChordSheetSerializer
Returns: Song -

The deserialized song

Key

Represents a key, such as Eb (symbol), #3 (numeric) or VII (numeral).

The only function considered public API is Key.distance

Kind: global class

Key.distance(oneKey, otherKey) ⇒ number

Calculates the distance in semitones between one key and another.

Kind: static method of Key
Returns: number -

the distance in semitones

Font : string | null

The font color

Kind: global variable

font.toCssString() ⇒ string

Converts the font, size and color to a CSS string. If possible, font and size are combined to the font shorthand. If font contains double quotes (") those will be converted to single quotes (').

Kind: instance method of Font
Returns: string -

The CSS string

// Returns "font-family: 'Times New Roman'"
new Font({ font: '"Times New Roman"' }).toCssString()

Example

// Returns "color: red; font-family: Verdana"
new Font({ font: 'Verdana', colour: 'red' }).toCssString()

Example

// Returns "font: 30px Verdana"
new Font({ font: 'Verdana', size: '30' }).toCssString()

Example

// Returns "color: blue; font: 30% Verdana"
new Font({ font: 'Verdana', size: '30%', colour: 'blue' }).toCssString()

FontSize : number

The font size

Kind: global variable

fontSize.toString() ⇒ string

Stringifies the font size by concatenating size and unit

Kind: instance method of FontSize
Returns: string -

The font size

// Returns "30px"
new FontSize(30, 'px').toString()

Example

// Returns "120%"
new FontSize(120, '%').toString()

ALBUM : string

Artist meta directive. See https://www.chordpro.org/chordpro/directives-artist/

Kind: global variable

ARTIST : string

Capo meta directive. See https://www.chordpro.org/chordpro/directives-capo/

Kind: global variable

CAPO : string

Comment directive. See https://www.chordpro.org/chordpro/directives-comment/

Kind: global variable

COMMENT : string

Composer meta directive. See https://www.chordpro.org/chordpro/directives-composer/

Kind: global variable

COMPOSER : string

Copyright meta directive. See https://www.chordpro.org/chordpro/directives-copyright/

Kind: global variable

COPYRIGHT : string

Duration meta directive. See https://www.chordpro.org/chordpro/directives-duration/

Kind: global variable

DURATION : string

End of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/

Kind: global variable

END_OF_BRIDGE : string

End of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/

Kind: global variable

END_OF_CHORUS : string

End of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/

Kind: global variable

END_OF_TAB : string

End of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/

Kind: global variable

END_OF_VERSE : string

Key meta directive. See https://www.chordpro.org/chordpro/directives-key/

Kind: global variable

KEY : string

_Key meta directive. Reflects the key as transposed by the capo value See https://www.chordpro.org/chordpro/directives-key/

Kind: global variable

_KEY : string

Lyricist meta directive. See https://www.chordpro.org/chordpro/directives-lyricist/

Kind: global variable

LYRICIST : string

Start of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/

Kind: global variable

START_OF_BRIDGE : string

Start of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/

Kind: global variable

START_OF_CHORUS : string

Start of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/

Kind: global variable

START_OF_TAB : string

Start of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/

Kind: global variable

START_OF_VERSE : string

Subtitle meta directive. See https://www.chordpro.org/chordpro/directives-subtitle/

Kind: global variable

SUBTITLE : string

Tempo meta directive. See https://www.chordpro.org/chordpro/directives-tempo/

Kind: global variable

TEMPO : string

Time meta directive. See https://www.chordpro.org/chordpro/directives-time/

Kind: global variable

TIME : string

Title meta directive. See https://www.chordpro.org/chordpro/directives-title/

Kind: global variable

TITLE : string

Transpose meta directive. See: https://www.chordpro.org/chordpro/directives-transpose/

Kind: global variable

TRANSPOSE : string

New Key meta directive. See: bettermusic#53

Kind: global variable

NEW_KEY : string

Year meta directive. See https://www.chordpro.org/chordpro/directives-year/

Kind: global variable

YEAR : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/

Kind: global variable

CHORDFONT : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/

Kind: global variable

CHORDSIZE : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/

Kind: global variable

CHORDCOLOUR : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/

Kind: global variable

TEXTFONT : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/

Kind: global variable

TEXTSIZE : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/

Kind: global variable

TEXTCOLOUR : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/

Kind: global variable

TITLEFONT : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/

Kind: global variable

TITLESIZE : string

Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/

Kind: global variable

TITLECOLOUR : string

Chorus directive. Support repeating an earlier defined section. See https://www.chordpro.org/chordpro/directives-env_chorus/

Kind: global variable

defaultCss ⇒ string

Generates basic CSS, scoped within the provided selector, to use with output generated by [HtmlTableFormatter](#HtmlTableFormatter)

Kind: global variable
Returns: string -

the CSS string

defaultCss ⇒ string

Generates basic CSS, scoped within the provided selector, to use with output generated by [HtmlTableFormatter](#HtmlTableFormatter)

Kind: global variable
Returns: string -

the CSS string

ALBUM : string

Album meta directive. See https://www.chordpro.org/chordpro/directives-album/

Kind: global constant

defaultCss : Object.<string, Object.<string, string>>

Basic CSS, in object style à la useStyles, to use with output generated by {@link }HtmlTableFormatter} For a CSS string see [scopedCss](scopedCss)

Kind: global constant

VERSE : string

Used to mark a paragraph as verse

Kind: global constant

VERSE : string

Used to mark a paragraph as chorus

Kind: global constant

CHORUS : string

Used to mark a paragraph as not containing a line marked with a type

Kind: global constant

NONE : string

Used to mark a paragraph as containing lines with both verse and chorus type

Kind: global constant

INDETERMINATE : string

Used to mark a paragraph as tab

Kind: global constant

parseChord(chordString) ⇒ Chord | null

Deprecated

Tries to parse a chord string into a chord

Kind: global function

getCapos(key) ⇒ Object.<string, string>

Returns applicable capos for the provided key

Kind: global function
Returns: Object.<string, string> -

The available capos, where the keys are capo numbers and the values are the effective key for that capo.

getKeys(key) ⇒ Array.<string>

Returns applicable keys to transpose to from the provided key

Kind: global function
Returns: Array.<string> -

The available keys