API Docs for: 1.4.4
Show:

File: editor\ugsEditorPlus.options.js

/**
 * Options (Features) you can turn on or off. Where available defaults to values defined in UkeGeeks.settings
 *
 * @class options
 * @namespace ugsEditorPlus
 * @static
 * @singleton
 */
ugsEditorPlus.options = {
	/**
	 * If true attempts compatibility for versions of Microsoft Internet Explorer prior to IE9
	 * @example
	 *  Allowed values: true, false
	 * @property useLegacyIe
	 * @type Boolean
	 * @default false
	 */
	useLegacyIe: false,

	/**
	 * If true the Edit Song box is shown when the page loads; false hides it.
	 * @example
	 *  Allowed values: true, false
	 * @property showEditOnLoad
	 * @type Boolean
	 * @default true
	 */
	showEditOnLoad: true,

	/**
	 * Lyric's font size (pts)
	 * @example
	 *  Allowed values: 6, 6.5, 7, 7.5, 8, 8.5, 9, 10, 11, 12, 13, 14
	 * @property fontSize
	 * @type Number
	 * @default 12
	 */
	fontSize: 12,

	/**
	 * Reference diagram size expressed as a percentage (100% being max)
	 * @example
	 *  Allowed values: 40 ("tiny"), 65 ("small"), 80 ("medium"), 90 ("large"), 100 ("x-large")
	 * @property diagramSize
	 * @type Integer
	 * @default 100
	 */
	diagramSize: 100,

	/**
	 * Specify where reference diagrams should be show
	 * @example
	 *  Allowed values: left, top, or none
	 * @property diagramPosition
	 * @type Text
	 * @default left
	 */
	diagramPosition: "left",

	/**
	 * Specify how chord names within lyrics should be shown
	 * @example
	 *  Allowed values: inline, above, or miniDiagrams
	 * @property lyricStyle
	 * @type Text
	 * @default above
	 */
	lyricStyle: "above",

	/**
	 * Specify page width (mock paper)
	 * @example
	 *  Allowed values: letter, a4, screen
	 * @property paper
	 * @type Text
	 * @default letter
	 */
	paper: "letter",

	/**
	 * Theme shortname applied on page load.
	 * @example
	 *  Allowed values: frosty, jellyBean, justBlack, krampus, normal, notebook, pumpkin, reversed, western, zombie
	 * @property theme
	 * @type Text
	 * @default normal
	 */
	theme: "normal",

	/**
	 * Ukulele tuning ("instrument") for drawing diagrams.
	 * @example
	 *  Allowed values: soprano or baritone
	 * @property tuning
	 * @type Text
	 * @default soprano
	 */
	tuning: "soprano",

	/**
	 * Show/hide the square brackets around chord names within lyrics, ex: [Am]
	 * @example
	 *  Allowed values: true, false
	 * @property hideChordEnclosures
	 * @type Boolean
	 * @default see UkeGeeks.settings
	 */
	hideChordEnclosures: false,

	/**
	 * Order in which reference diagrams are sorted, either alphabetically (true) or order
	 * in which they appear within the song (false).
	 * @example
	 * Allowed values: true, false
	 * @property sortAlphabetical
	 * @type Boolean
	 * @default see UkeGeeks.settings
	 */
	sortAlphabetical: false,

	/**
	 * If TRUE chords in the "commonChords" list will be ignored (excluded from reference chord diagrams)
	 * @example
	 * Allowed values: true, false
	 * @property ignoreCommonChords
	 * @type Boolean
	 * @default see UkeGeeks.settings
	 */
	ignoreCommonChords: false,

	/**
	 * Array of chords to be ignored when drawing reference diagrams (if "ignoreCommonChords" is enabled)
	 * @example
	 *  (string or array of strings): as an  array of strings: ["A", "G"] or comma delimited list: "A, G"
	 * @property commonChords
	 * @type mixed
	 * @default see UkeGeeks.settings
	 */
	commonChords: []
};