Class ChordLyricsPair

Represents a chord with the corresponding (partial) lyrics

Index

Constructors

Methods

clone isRenderable

Constructors

constructor

new ChordLyricsPair(
    chords?: string,
    lyrics?: null | string,
    annotation?: null | string,
): ChordLyricsPair
Initialises a ChordLyricsPair
Parameters
- chords: string = ''
  The chords
- lyrics: null | string = null
  The lyrics
- annotation: null | string = null
  The annotation
Returns ChordLyricsPair
- Defined in chord_sheet/chord_lyrics_pair.ts:21

Methods

clone

clone(): ChordLyricsPair
Returns a deep copy of the ChordLyricsPair, useful when programmatically transforming a song

Returns ChordLyricsPair
- Defined in chord_sheet/chord_lyrics_pair.ts:56

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