Class ChordLyricsPair

Represents a chord with the corresponding (partial) lyrics

Index

Constructors

Accessors

Methods

clone hasLyrics isRenderable useModifier

Constructors

constructor

new ChordLyricsPair(
    chords?: string,
    lyrics?: string | null,
    annotation?: string | null,
    chordObj?: Chord | null,
): ChordLyricsPair
Initialises a ChordLyricsPair
Parameters
- chords: string = ''
  The chords
- lyrics: string | null = null
  The lyrics
- annotation: string | null = null
  The annotation
- chordObj: Chord | null = null
  Optional pre-parsed Chord object
Returns ChordLyricsPair
- Defined in src/chord_sheet/chord_lyrics_pair.ts:26

Accessors

chord

get chord(): Chord | null
Returns the Chord object if available, otherwise parses from string

Returns Chord | null
- Defined in src/chord_sheet/chord_lyrics_pair.ts:39

Methods

clone

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

Returns ChordLyricsPair
- Defined in src/chord_sheet/chord_lyrics_pair.ts:62

hasLyrics

hasLyrics(): boolean
Indicates whether the ChordLyricsPair has non-empty lyrics.

Returns boolean
- Defined in src/chord_sheet/chord_lyrics_pair.ts:54

isRenderable

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

Returns boolean
- Defined in src/chord_sheet/chord_lyrics_pair.ts:47

useModifier

useModifier(accidental: Accidental): ChordLyricsPair
Parameters
- accidental: Accidental
Returns ChordLyricsPair
Deprecated
Use useAccidental instead
- Defined in src/chord_sheet/chord_lyrics_pair.ts:115