ugsChordBuilder.StringDots Class
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
Parameters:
-
string
Int -
dots
Dot_Array
Item Index
Methods
fretNumber
-
fret
Handles the offset, translates from fret (on the diagram's N frets) to the insturment's complete fretbaord
Parameters:
-
fret
Int
Returns:
getDefinition
-
chordName
-
startingFret
Returns complete ChordPro definition statement
Parameters:
-
chordName
String -
startingFret
Int
Returns:
getDefinition
-
chordName
-
startingFret
Returns "highlighted" (HTML-ified) ChordPro definition statement.
Parameters:
-
chordName
String -
startingFret
Int
Returns:
getFinger
-
dots
-
fret
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:
getMinMax
-
ary
Returns the minimum & maximum fret found withing array (of dots)
Parameters:
-
ary
Dot_array
Returns:
getPrimaryFrets
-
startingFret
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:
scrub
-
chordName
Returns "safe" version of chord name, removing disallowed characters and reserved names (such as "add:")
Parameters:
-
chordName
String