API Docs for: 1.4.4
Show:

ugsEditorPlus.options Class

Options (Features) you can turn on or off. Where available defaults to values defined in UkeGeeks.settings

Properties

commonChords

Mixed

Array of chords to be ignored when drawing reference diagrams (if "ignoreCommonChords" is enabled)

Default: see UkeGeeks.settings

Example:

(string or array of strings): as an array of strings: ["A", "G"] or comma delimited list: "A, G"

diagramPosition

Text

Specify where reference diagrams should be show

Default: left

Example:

Allowed values: left, top, or none

diagramSize

Integer

Reference diagram size expressed as a percentage (100% being max)

Default: 100

Example:

Allowed values: 40 ("tiny"), 65 ("small"), 80 ("medium"), 90 ("large"), 100 ("x-large")

fontSize

Number

Lyric's font size (pts)

Default: 12

Example:

Allowed values: 6, 6.5, 7, 7.5, 8, 8.5, 9, 10, 11, 12, 13, 14

hideChordEnclosures

Boolean

Show/hide the square brackets around chord names within lyrics, ex: [Am]

Default: see UkeGeeks.settings

Example:

Allowed values: true, false

ignoreCommonChords

Boolean

If TRUE chords in the "commonChords" list will be ignored (excluded from reference chord diagrams)

Default: see UkeGeeks.settings

Example:

Allowed values: true, false

lyricStyle

Text

Specify how chord names within lyrics should be shown

Default: above

Example:

Allowed values: inline, above, or miniDiagrams

paper

Text

Specify page width (mock paper)

Default: letter

Example:

Allowed values: letter, a4, screen

showEditOnLoad

Boolean

If true the Edit Song box is shown when the page loads; false hides it.

Default: true

Example:

Allowed values: true, false

sortAlphabetical

Boolean

Order in which reference diagrams are sorted, either alphabetically (true) or order in which they appear within the song (false).

Default: see UkeGeeks.settings

Example:

Allowed values: true, false

theme

Text

Theme shortname applied on page load.

Default: normal

Example:

Allowed values: frosty, jellyBean, justBlack, krampus, normal, notebook, pumpkin, reversed, western, zombie

tuning

Text

Ukulele tuning ("instrument") for drawing diagrams.

Default: soprano

Example:

Allowed values: soprano or baritone

useLegacyIe

Boolean

If true attempts compatibility for versions of Microsoft Internet Explorer prior to IE9

Default: false

Example:

Allowed values: true, false