API Docs for: 1.4.4
Show:

ukeGeeks.transpose Class

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

Can shift a single chord or list of chords up/down by a series of steps. Hangles finding equivalent chord names (i.e. A# is same as Bb)

Item Index

Methods

Properties

Methods

getTone

(
  • name
)

Defined in scriptasaurus\ukeGeeks.transpose.js:64

Returns object with name (A - G with flat/sharp), integer value (0 - 11), and its "suffix" (minor, 7th, etc)

Parameters:

  • name Object

    (string)

Returns:

JSON

retune

(
  • offset
)
Array

Defined in scriptasaurus\ukeGeeks.transpose.js:82

Returns a mapping -- an array of JSON with "original" chord name and "transposed" chord names.

Parameters:

  • offset Object

    (int) optional

Returns:

Array:

shift

(
  • name
  • steps
)

Defined in scriptasaurus\ukeGeeks.transpose.js:39

Pass in a chord name returns new chord name for the original chord shifted by "steps" semitones.

Parameters:

  • name Object

    (string) chord name, should be in chord dictionary

  • steps Object

    (int) number of semitones to transpose

Returns:

string

shiftChords

(
  • array<strings>
  • int
)

Defined in scriptasaurus\ukeGeeks.transpose.js:111

returns copy of input string array shifted by number of steps

Parameters:

  • array<strings> Object

    chords chord names to be shifted

  • int Object

    steps number of semitone steps (up or down)

Returns:

array

Properties

_public

Object

Defined in scriptasaurus\ukeGeeks.transpose.js:11

attach public members to this object