API Docs for: 1.4.4
Show:

ukeGeeks.chordPainter Class

Draws large chord diagram grid (aka "reference" diagrams) on canvas

Methods

getErrors

() Array

returns array of unknown chords

Returns:

Array:

getIgnoredChords

() Array

List of chords excluded from the master chord diagrams

Returns:

Array:

array of strings

ignoreChord

(
  • chord
)
Boolean

Checks whether speicified chord (name) is on the ignore list.

Parameters:

  • chord String

    Chord name

Returns:

Boolean:

return TRUE if "chord" is on ignore list.

init

(
  • htmlHandles
)
Void

Again this is a constructor replacement

Parameters:

  • htmlHandles ukeGeeks.data.htmlHandles

    DOM Element object

Returns:

Void:

show

(
  • chords
)
Void

Plots the passed in chords (array of ) by adding canvas elements inside passed DOM element.

Parameters:

  • chords Array

    Array of chord objects to be plotted

Returns:

Void:

showInline

(
  • chords
)
Void

Plots chords "inline" with the lyrics. Searches for <code data-chordName="Am7"></code>. When found adds canvas element and draws chord named in data-chordName attribute

Parameters:

  • chords Array

    Array of chord objects to be plotted

Returns:

Void:

Properties

_brush

ukeGeeks.chordBrush instance handle private

ukeGeeks.canvas object handle

_errors

Array private

keep an array of missing chords (strings)

_ignoreMatchList

Array private

If ignoreCommonChords option is true then this will contain list of matched chords: ones defined in the ignore list that were also found in the song

_public

Object

attach public members to this object

_tacet

RegExp private

Ignore "tacet" or "no chord" chords