Class: Keyboard

music21 .keyboard. Keyboard

new Keyboard()

A Class representing a whole Keyboard full of keys.

Properties:

Name	Type	Description
`whiteKeyWidth`	number	default 23
`scaleFactor`	number	default 1
`keyObjects`	object	a mapping of id to `music21.keyboard.Key` objects
`svgObj`	DOMObject	the SVG object of the keyboard
`markC`	Boolean	default true
`showNames`	Boolean	default false
`showOctaves`	Boolean	default false
`startPitch`	string	default "C3"
`endPitch`	string	default "C5"
`hideable`	Boolean	default false -- add a way to hide and show keyboard
`scrollable`	Boolean	default false -- add scroll bars to change octave

Source:

music21/keyboard.js, line 257

Members

callbacks :object

An object of callbacks on events.

default:

click: this.clickhandler

Type:

object

Source:

music21/keyboard.js, line 295

Methods

appendHideableKeyboard(where, keyboardSVG)

Puts a hideable keyboard inside a Div with the proper controls.

Do not call this directly, just use createSVG after changing the
hideable property on the keyboard to True.

Parameters:

Name	Type	Description
`where`	DOMObject
`keyboardSVG`	DOMObject

Source:

music21/keyboard.js, line 593

appendKeyboard(where) → {music21.keyboard.Keyboard}

Appends a keyboard to the where parameter

Parameters:

Name	Type	Argument	Description
`where`	JQueryDOMObject \| DOMObject	<optional>

Source:

music21/keyboard.js, line 335

Returns:

this

Type: music21.keyboard.Keyboard

clickhandler(keyRect)

Handle a click on a given SVG object

Parameters:

Name	Type	Description
`keyRect`	DOMObject	the dom object with the keyboard.

Source:

music21/keyboard.js, line 363

createSVG() → {DOMObject}

Draws the SVG associated with this Keyboard

Source:

music21/keyboard.js, line 391

Returns:

new svgDOM

Type: DOMObject

markMiddleC(strokeColor)

Puts a circle on middle c.

Parameters:

Name	Type	Argument	Default	Description
`strokeColor`	string	<optional>	'red'

Source:

music21/keyboard.js, line 506

markNoteNames(labelOctaves)

Puts note names on every white key.

Parameters:

Name	Type	Argument	Default	Description
`labelOctaves`	Boolean	<optional>	false

Source:

music21/keyboard.js, line 518

redrawSVG() → {DOMObject}

Redraws the SVG associated with this Keyboard

Source:

music21/keyboard.js, line 318

Returns:

new svgDOM

Type: DOMObject

removeNoteNames()

Remove note names on the keys, if they exist

Source:

music21/keyboard.js, line 534

wrapScrollable(svgDOM) → {JQueryDOMObject}

Wraps the SVG object inside a scrollable set of buttons

Do not call this directly, just use createSVG after changing the
scrollable property on the keyboard to True.

Parameters:

Name	Type	Description
`svgDOM`	DOMObject

Source:

music21/keyboard.js, line 548

Returns:

Type: JQueryDOMObject