API Docs for: 1.4.4
Show:

ukeGeeks.scriptasaurus Class

Defined in: scriptasaurus\ukeGeeks.scriptasaurus.js:1
Module: ukeGeeks

Finds page HTML elements & creates ukeGeek objects; Reads song text, parses, draws choard diagrams.

Methods

_getHandlesFromClass

(
  • wrap
)
ukeGeeks.data.htmlHandles private

Defined in scriptasaurus\ukeGeeks.scriptasaurus.js:155

Parameters:

  • wrap DomElement

Returns:

ukeGeeks.data.htmlHandles:

_getHandlesFromId

() ukeGeeks.data.htmlHandles private

Defined in scriptasaurus\ukeGeeks.scriptasaurus.js:171

Returns:

ukeGeeks.data.htmlHandles:

_runSong

(
  • handles
)
SongObj private

Defined in scriptasaurus\ukeGeeks.scriptasaurus.js:84

Parameters:

  • handles ukeGeeks.data.htmlHandles

Returns:

SongObj:

init

(
  • isIeFamily
)
Void

Defined in scriptasaurus\ukeGeeks.scriptasaurus.js:18

Preps this class for running

Parameters:

  • isIeFamily Bool

    TRUE if UserAgent (Browser to you and me) is Internet Explorer

Returns:

Void:

run

() SongObject

Defined in scriptasaurus\ukeGeeks.scriptasaurus.js:36

Runs all Scriptasaurus methods using the element Ids defined in the settings class. This is your "Do All". See data.song for structure.

Returns:

SongObject:

runByClasses

() Array of songObject

Defined in scriptasaurus\ukeGeeks.scriptasaurus.js:54

Same as "run" except runs using class names, this allows you to have multiple songs on a single page.

Returns:

Array of songObject:

setTuningOffset

(
  • offset
)

Defined in scriptasaurus\ukeGeeks.scriptasaurus.js:72

Is this really nececessary?

Parameters:

  • offset Int

    (optional) default 0. Number of semitones to shift the tuning. See ukeGeeks.definitions.instrument.

showErrors

() Void

Defined in scriptasaurus\ukeGeeks.scriptasaurus.js:136

Shows a JavaScript alert box containing list of unknown chords.

Returns:

Void:

Properties

_public

Object

Defined in scriptasaurus\ukeGeeks.scriptasaurus.js:11

attach public members to this object