Class Piano

Index

Constructors

Methods

clearNotes clearPlayedNotes destroy render setNotes setPlayedNotes

Constructors

constructor

new Piano(options?: Partial<PianoOptions>): Piano
Creates a Piano instance.
Parameters
- options: Partial<PianoOptions> = {}
  The rendering options
Returns Piano
- Defined in packages/piano/src/Piano.ts:105

Methods

clearNotes

clearNotes(): Piano
Clears all highlighted notes.

Returns Piano
- Defined in packages/piano/src/Piano.ts:140

clearPlayedNotes

clearPlayedNotes(): Piano
Clears all played notes.

Returns Piano
- Defined in packages/piano/src/Piano.ts:184

destroy

destroy(): void
Removes the current element from the DOM.

Returns void
- Defined in packages/piano/src/Piano.ts:163

render

render(): Piano
Renders the UI inside the current element.

Returns Piano
- Defined in packages/piano/src/Piano.ts:153

setNotes

setNotes(notes: NoteInput, noteLabels?: NoteInput): Piano
Highlights the passed notes. Sets the corresponding note labels if passed.

Use an underscore in order to skip a note.
Parameters
- notes: NoteInput
  The notes to be displayed
- OptionalnoteLabels: NoteInput
  The corresponding note labels
Returns Piano
Example
```
// will highlight C4, E4 and C5 with labels 1, 3 and 5
setNotes("C4 E4 G4", "1 3 5")
```
Example
```
// will highlight C4, E4 and C5 with labels 1, (nothing) and 5
setNotes("C4 E4 G4", "1 _ 5")
```
- Defined in packages/piano/src/Piano.ts:132

setPlayedNotes

setPlayedNotes(notes: NoteInput): Piano
Sets the passed notes as played.
Parameters
- notes: NoteInput
  The notes to be played
Returns Piano
- Defined in packages/piano/src/Piano.ts:172