API Docs for: 1.4.4
Show:

ugsChordBuilder.StringDots Class

Defined in: editor\ugsChordBuilder.js:699
Module: ugsChordBuilder

Class for "reorganized" dots, think of this as a necklace where the thread, the instrument string, has zero or more beads, or dots -- fret plus finger

Constructor

ugsChordBuilder.StringDots

(
  • string
  • dots
)
private

Defined in editor\ugsChordBuilder.js:699

Parameters:

  • string Int
  • dots Dot_Array

Methods

fretNumber

(
  • fret
)
Int

Defined in editor\ugsChordBuilder.js:758

Handles the offset, translates from fret (on the diagram's N frets) to the insturment's complete fretbaord

Parameters:

  • fret Int

Returns:

Int:

getDefinition

(
  • chordName
  • startingFret
)
String

Defined in editor\ugsChordBuilder.js:803

Returns complete ChordPro definition statement

Parameters:

  • chordName String
  • startingFret Int

Returns:

String:

getDefinition

(
  • chordName
  • startingFret
)
String

Defined in editor\ugsChordBuilder.js:832

Returns "highlighted" (HTML-ified) ChordPro definition statement.

Parameters:

  • chordName String
  • startingFret Int

Returns:

String:

getFinger

(
  • dots
  • fret
)
Int

Defined in editor\ugsChordBuilder.js:768

Not too surprisingly this finds "fret" within dots and returns finger. If there isn't a dot for fret returns zed.

Parameters:

  • dots Array
  • fret Int

Returns:

Int:

getMinMax

(
  • ary
)
JSON

Defined in editor\ugsChordBuilder.js:735

Returns the minimum & maximum fret found withing array (of dots)

Parameters:

  • ary Dot_array

Returns:

JSON:

getPrimaryFrets

(
  • startingFret
)
Int

Defined in editor\ugsChordBuilder.js:785

Returns an array of ints, one for each string, with the HIGHEST REAL fret appearing on that string. Default is zed per string.

Parameters:

  • startingFret Int

Returns:

Int:

scrub

(
  • chordName
)
String

Defined in editor\ugsChordBuilder.js:855

Returns "safe" version of chord name, removing disallowed characters and reserved names (such as "add:")

Parameters:

  • chordName String

Returns:

String: