API Docs for: 1.4.4
Show:

ugsEditorPlus.reformat Class

Module: ugsEditorPlus

Methods

countChords

(
  • words
)

Defined in editor\ugsEditorPlus.reformat.js:147

Looks for supported chords.

Parameters:

  • words Array of words

Returns:

[int] number found

hasChords

() Bool

Defined in editor\ugsEditorPlus.reformat.js:84

TRUE if one or more chord lines detected

Returns:

Bool:

isTabBlock

(
  • lines
  • index
)

Defined in editor\ugsEditorPlus.reformat.js:202

TRUE if we can make a Tab block using this and the following 3 linrd (we need a set of four tab lines followed by a non-tab line)

Parameters:

  • lines Array of Lines
  • index Int

    current line's index within line array

Returns:

[bool]

merge

(
  • lines
)

Defined in editor\ugsEditorPlus.reformat.js:163

Return merged song -- chords embedded within lyrics

Parameters:

  • lines Array of Lines

Returns:

[string]

mergeLines

(
  • chordLine
  • lyricsLine
)

Defined in editor\ugsEditorPlus.reformat.js:221

Return a single line

Parameters:

  • chordLine String

    the line containing the chord names

  • lyricsLine String

    the line of lyrics

Returns:

[string] merged lines

read

(
  • text
)
Array of Lines

Defined in editor\ugsEditorPlus.reformat.js:93

Accepts a text block

Parameters:

  • text String

    string RAW song

Returns:

Array of Lines:

run

(
  • text
)
String public

Defined in editor\ugsEditorPlus.reformat.js:70

Accepts a text block, returns "ChordPro" text block with chord lines merged into lyric lines with chords enclosed in square-brackets (i.e. [Cdim])

Parameters:

  • text String

    songstring

Returns:

String:

ChordPro format text block

toLineType

(
  • line
)
_enums.lineTypes

Defined in editor\ugsEditorPlus.reformat.js:122

Guesses as to the line's tyupe --

Parameters:

  • line Line

Returns:

_enums.lineTypes:

wrapChords

(
  • chordLine
)

Defined in editor\ugsEditorPlus.reformat.js:250

Wraps the words on the line within square brackets " C D " is returned as "[C] [D]"

Parameters:

  • chordLine String

    the line containing the chord names

Returns:

[string] each word of input line gets bracketed

Properties

_enums

Unknown private

Defined in editor\ugsEditorPlus.reformat.js:19

_public

JsonObject

Defined in editor\ugsEditorPlus.reformat.js:10

attach public members to this object