ukeGeeks.settings Class
Customize your installation. This JSON object controls appearance and HTML element names. It's divided into four sections: graphics, ids, layout, and "options".
Item Index
Methods
Properties
- _public
- colors
- commonChords
- defaultInstrument
- environment.isIe
- fonts
- fretBox.dotRadius
- fretBox.fretSpace
- fretBox.height
- fretBox.lineWidth
- fretBox.showText
- fretBox.stringSpace
- fretBox.topLeftPos
- fretBox.width
- fretBox.xStroke
- fretBox.xWidth
- ids
- inlineDiagrams
- layout
- numFrets
- opts
- opts.autoFixOverlaps
- opts.ignoreCommonChords
- opts.retainBrackets
- opts.sortAlphabetical
- tabs
- tuning
- wrapClasses
Methods
_scaleFont
-
font -
mulitplier
TODO: determine minimum font size... 5pt/px?
Parameters:
-
fontStringDescription
-
mulitplierIntsee scale method's parameter
Returns:
_scaleNode
-
node -
mulitplier
TODO: determine minimum value... 1?
Parameters:
-
nodeDatatypeDescription
-
mulitplierIntsee scale method's parameter
Returns:
mixed
scale
-
mulitplier
Scales the standard chord diagram's dimensions and font sizes by multiplying all falues by passed in value. Note: this is currently a destructive change: no backup of original values is retained.
Parameters:
-
mulitplierInt
Returns:
Properties
_public
Object
attach public members to this object
colors
JSON Object
Chord Diagram Colors for fretboard's grid lines and text. Don't use shorthand (i.e. "#0ff") as this might cause a problem with IE canvas.
commonChords
String Array
List of common chords to be "ignored" (won't show master chord diagrams)
defaultInstrument
Enum_int
The initial tuning when page first loads, used in scriptasaurus.init.
environment.isIe
Bool
set in scriptasaurus. True if UserAgent is Internet Explorer
fonts
JSON Object
Chord Diagram Font styles -- font size, font-weight, font-face stack, etc.
fretBox.dotRadius
Int
Dot (finger position) radius in pixels
fretBox.fretSpace
Int
Row Height -- vertical height between frets (pixels)
fretBox.height
Int
Chord Box's Bounding height
fretBox.lineWidth
Decimal
Fretboard line width in pixels
fretBox.showText
Bool
True if chord name and finger "number" are to be drawn on canvas. By default normal chord diagrams have text (TRUE) whereas inlineDiagrams (i.e. chord diagrams shown above lyrics) do NOT as they are too small (thus inlineFretbox.showText is FALSE)
fretBox.stringSpace
Int
String Spacing -- horizontal distance between strings (pixels)
fretBox.topLeftPos
JSON
top-left position -- the offset for chord box. Doing this programatically had "issues", decided to make this adjustment manual.
fretBox.width
Int
Chord Box's Bounding width
fretBox.xStroke
Decimal
muted string "X" stroke thickness. Recommend this be about 1.3 to 2.1 relative to lineWidth
fretBox.xWidth
Decimal
muted string "X" width of the 'X' crossbars. Recommend this be about 0.5 to 0.9 relative to stringSpace.
ids
JSON Object
ID's of key HTML page elements
inlineDiagrams
Bool
If TRUE the Chord Digram is drawn ABOVE lyrics
layout
JSON Object
Layout of Chord Digrams when inlineFredBoxes are being used. Identical in structure to "fretBox". See fretBox for properties.
numFrets
Int
Number of frets to draw. Default is 5 (as this is as wide as my hand can go and I've never seen a chord diagram requiring more than this. But ya never know.
opts
JSON Object
Options (Features) you can turn on or off
opts.autoFixOverlaps
Boolean
if TRUE chords that overlap each other (in the music area) will have their spacing adjuste to prevent overlapping.
opts.ignoreCommonChords
Boolean
if TRUE chords in the "commonChords" list will be ignored (excluded) from having thier master chord diagram drawn
opts.retainBrackets
Boolean
the [ and ] surrounding chord names often looks bad in print (usually only good when inline) set true to keep then, false to get rid of the buggers.
opts.sortAlphabetical
Boolean
If true chord reference diagrams are sorted alphabetically, otherwise chords are shown in the order in which they appear within the song.
tabs
JSON Object
TODO: Clean-up Tab Options!!
tuning
String Array
Array of string names, changes between baritone and soprano
wrapClasses
JSON Object
CSS Class names used to find page elements-- be careful if renaming!