@molecule/app-feature-piano-roll-svelte 0.0.0-stage → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +325 -2
- package/dist/PianoRoll.svelte +633 -0
- package/dist/PianoRoll.svelte.d.ts +5 -0
- package/dist/PianoRoll.svelte.d.ts.map +1 -0
- package/dist/components.d.ts +8 -0
- package/dist/components.d.ts.map +1 -0
- package/dist/components.js +7 -0
- package/dist/geometry.d.ts +91 -0
- package/dist/geometry.d.ts.map +1 -0
- package/dist/geometry.js +149 -0
- package/dist/index.d.ts +44 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +43 -0
- package/dist/types.d.ts +70 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +7 -0
- package/package.json +75 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,326 @@
|
|
|
1
|
-
|
|
1
|
+
<!--
|
|
2
|
+
AUTO-GENERATED — DO NOT EDIT THIS FILE.
|
|
3
|
+
Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
|
|
4
|
+
Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
|
|
5
|
+
To change this document, edit the module-level JSDoc in src/index.ts.
|
|
6
|
+
Generated: 2026-11-21T12:46:32.491Z
|
|
7
|
+
-->
|
|
2
8
|
|
|
3
|
-
|
|
9
|
+
# @molecule/app-feature-piano-roll-svelte
|
|
10
|
+
|
|
11
|
+
Svelte piano roll — MIDI note-grid editor for music-daw and other DAW-style
|
|
12
|
+
surfaces. Renders a vertical piano keyboard on the left, a horizontal time
|
|
13
|
+
grid on the right, and draggable / resizable note rectangles on top.
|
|
14
|
+
|
|
15
|
+
Svelte counterpart of `@molecule/app-feature-piano-roll-react`: the same props
|
|
16
|
+
(React names), the same DOM for the same input, and the same callback calls,
|
|
17
|
+
so an app switches framework by changing only the package name it imports.
|
|
18
|
+
|
|
19
|
+
> **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
|
|
20
|
+
> It is written to be read by coding agents as much as by people, and is generated from this
|
|
21
|
+
> package's source — edit `src/index.ts` JSDoc, not this file.
|
|
22
|
+
|
|
23
|
+
## Quick Start
|
|
24
|
+
|
|
25
|
+
```svelte
|
|
26
|
+
<script lang="ts">
|
|
27
|
+
import { PianoRoll, type MidiNote } from '@molecule/app-feature-piano-roll-svelte'
|
|
28
|
+
|
|
29
|
+
let notes = $state<MidiNote[]>([])
|
|
30
|
+
</script>
|
|
31
|
+
|
|
32
|
+
<PianoRoll
|
|
33
|
+
{notes}
|
|
34
|
+
snap="1/16"
|
|
35
|
+
onNoteAdd={(note) => (notes = [...notes, note])}
|
|
36
|
+
onNoteMove={(noteId, startBeat, pitch) =>
|
|
37
|
+
(notes = notes.map((n) => (n.id === noteId ? { ...n, startBeat, pitch } : n)))}
|
|
38
|
+
onNoteResize={(noteId, durationBeats) =>
|
|
39
|
+
(notes = notes.map((n) => (n.id === noteId ? { ...n, durationBeats } : n)))}
|
|
40
|
+
onNoteDelete={(noteId) => (notes = notes.filter((n) => n.id !== noteId))}
|
|
41
|
+
/>
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Type
|
|
45
|
+
|
|
46
|
+
`feature`
|
|
47
|
+
|
|
48
|
+
## Installation
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
npm install @molecule/app-feature-piano-roll-svelte @molecule/app-svelte @molecule/app-ui @molecule/app-ui-svelte svelte
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## API
|
|
55
|
+
|
|
56
|
+
### Interfaces
|
|
57
|
+
|
|
58
|
+
#### `MidiNote`
|
|
59
|
+
|
|
60
|
+
A single MIDI note rendered on the piano roll. `pitch` is a standard MIDI
|
|
61
|
+
pitch number in the closed interval `[0, 127]` where `60` represents middle C
|
|
62
|
+
(`C4`). `startBeat` is the note's start position on the time grid, and
|
|
63
|
+
`durationBeats` is its length in beats. `id` is a stable identifier used as
|
|
64
|
+
the row key and as the argument passed back to all event handlers.
|
|
65
|
+
`velocity` is an optional MIDI velocity in the closed interval `[0, 127]`
|
|
66
|
+
(defaults to a neutral mid-range).
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
interface MidiNote {
|
|
70
|
+
/** Stable identifier for the note (used as the row key + handler arg). */
|
|
71
|
+
id: string
|
|
72
|
+
/** MIDI pitch number, `0..127`. `60` is middle C. */
|
|
73
|
+
pitch: number
|
|
74
|
+
/** Start beat on the timeline (>= 0). */
|
|
75
|
+
startBeat: number
|
|
76
|
+
/** Duration in beats (always positive — minimum is enforced). */
|
|
77
|
+
durationBeats: number
|
|
78
|
+
/** Optional MIDI velocity, `0..127`. */
|
|
79
|
+
velocity?: number
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
#### `PianoRollProps`
|
|
84
|
+
|
|
85
|
+
Props accepted by the {@link PianoRoll} component.
|
|
86
|
+
|
|
87
|
+
```typescript
|
|
88
|
+
interface PianoRollProps {
|
|
89
|
+
/** MIDI notes rendered on the grid. Order is preserved as-is. */
|
|
90
|
+
notes: MidiNote[]
|
|
91
|
+
/** Horizontal scale: pixels rendered per musical beat. Defaults to `80`. */
|
|
92
|
+
pixelsPerBeat?: number
|
|
93
|
+
/** Vertical row height per pitch in pixels. Defaults to `20`. */
|
|
94
|
+
noteHeight?: number
|
|
95
|
+
/** Lowest visible pitch (top-most row excluded — see `highestPitch`). Defaults to `21` (A0). */
|
|
96
|
+
lowestPitch?: number
|
|
97
|
+
/** Highest visible pitch (top-most row inclusive). Defaults to `108` (C8). */
|
|
98
|
+
highestPitch?: number
|
|
99
|
+
/** Snap resolution applied to clicks, drags, and resizes. Defaults to `'1/16'`. */
|
|
100
|
+
snap?: PianoRollSnap
|
|
101
|
+
/**
|
|
102
|
+
* Total beats rendered in the time grid. When omitted, the grid extends to
|
|
103
|
+
* cover all notes plus a small trailing pad (minimum 16 beats so empty rolls
|
|
104
|
+
* are still usable).
|
|
105
|
+
*/
|
|
106
|
+
beatsCount?: number
|
|
107
|
+
/**
|
|
108
|
+
* Called with a freshly-created note when the user paints an empty cell — by
|
|
109
|
+
* clicking it, or via the keyboard cell cursor (arrow keys to move, Enter /
|
|
110
|
+
* Space to paint).
|
|
111
|
+
*/
|
|
112
|
+
onNoteAdd?: (note: MidiNote) => void
|
|
113
|
+
/** Called with the updated note when a note is dragged horizontally / vertically. */
|
|
114
|
+
onNoteMove?: (noteId: string, startBeat: number, pitch: number) => void
|
|
115
|
+
/** Called with the updated duration when a note's right-edge handle is dragged. */
|
|
116
|
+
onNoteResize?: (noteId: string, durationBeats: number) => void
|
|
117
|
+
/** Called when the user right-clicks a note. */
|
|
118
|
+
onNoteDelete?: (noteId: string) => void
|
|
119
|
+
/** Extra classes merged onto the root element. */
|
|
120
|
+
className?: string
|
|
121
|
+
}
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Types
|
|
125
|
+
|
|
126
|
+
#### `PianoRollSnap`
|
|
127
|
+
|
|
128
|
+
Snap resolution for note placement / movement / resize. Each value is a
|
|
129
|
+
fraction of a beat: `'1/16'` is sixteenth-notes (a quarter of a beat), `'1/4'`
|
|
130
|
+
is quarter-notes (one beat), `'1'` snaps to whole beats with no
|
|
131
|
+
sub-divisions, etc.
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
type PianoRollSnap = '1/16' | '1/8' | '1/4' | '1/2' | '1'
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Functions
|
|
138
|
+
|
|
139
|
+
#### `snapToBeats(snap)`
|
|
140
|
+
|
|
141
|
+
Convert a snap setting to its size in beats.
|
|
142
|
+
|
|
143
|
+
```typescript
|
|
144
|
+
function snapToBeats(snap: PianoRollSnap): number
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
- `snap` — Snap resolution.
|
|
148
|
+
|
|
149
|
+
**Returns:** Snap step size in beats.
|
|
150
|
+
|
|
151
|
+
#### `snapBeat(beat, snap)`
|
|
152
|
+
|
|
153
|
+
Snap a beat value to the nearest multiple of the snap step (rounding down).
|
|
154
|
+
|
|
155
|
+
```typescript
|
|
156
|
+
function snapBeat(beat: number, snap: PianoRollSnap): number
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
- `beat` — Raw beat value (may be fractional).
|
|
160
|
+
- `snap` — Snap resolution.
|
|
161
|
+
|
|
162
|
+
**Returns:** The floored snapped beat (>= 0).
|
|
163
|
+
|
|
164
|
+
#### `snapBeatRound(beat, snap)`
|
|
165
|
+
|
|
166
|
+
Round a beat value to the nearest snap step.
|
|
167
|
+
|
|
168
|
+
```typescript
|
|
169
|
+
function snapBeatRound(beat: number, snap: PianoRollSnap): number
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
- `beat` — Raw beat value (may be fractional).
|
|
173
|
+
- `snap` — Snap resolution.
|
|
174
|
+
|
|
175
|
+
**Returns:** The rounded snapped beat (>= 0).
|
|
176
|
+
|
|
177
|
+
#### `pixelsToBeats(pixels, pixelsPerBeat)`
|
|
178
|
+
|
|
179
|
+
Convert a pixel offset into beats given the horizontal scale.
|
|
180
|
+
|
|
181
|
+
```typescript
|
|
182
|
+
function pixelsToBeats(pixels: number, pixelsPerBeat: number): number
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
- `pixels` — Offset in pixels.
|
|
186
|
+
- `pixelsPerBeat` — Horizontal scale.
|
|
187
|
+
|
|
188
|
+
**Returns:** Beats represented by the offset (may be negative).
|
|
189
|
+
|
|
190
|
+
#### `beatsToPixels(beats, pixelsPerBeat)`
|
|
191
|
+
|
|
192
|
+
Convert a beat value into pixels given the horizontal scale.
|
|
193
|
+
|
|
194
|
+
```typescript
|
|
195
|
+
function beatsToPixels(beats: number, pixelsPerBeat: number): number
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
- `beats` — Beat value.
|
|
199
|
+
- `pixelsPerBeat` — Horizontal scale.
|
|
200
|
+
|
|
201
|
+
**Returns:** Pixel offset.
|
|
202
|
+
|
|
203
|
+
#### `yToPitch(y, noteHeight, highestPitch, lowestPitch)`
|
|
204
|
+
|
|
205
|
+
Convert a vertical pixel offset into a MIDI pitch. Higher pitches sit at the
|
|
206
|
+
top, so `y = 0` maps to `highestPitch`.
|
|
207
|
+
|
|
208
|
+
```typescript
|
|
209
|
+
function yToPitch(y: number, noteHeight: number, highestPitch: number, lowestPitch: number): number
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
- `y` — Vertical pixel offset from the top of the grid.
|
|
213
|
+
- `noteHeight` — Row height per pitch.
|
|
214
|
+
- `highestPitch` — Top-most pitch in the visible range.
|
|
215
|
+
- `lowestPitch` — Bottom-most pitch in the visible range.
|
|
216
|
+
|
|
217
|
+
**Returns:** A MIDI pitch clamped into `[lowestPitch, highestPitch]`.
|
|
218
|
+
|
|
219
|
+
#### `pitchToY(pitch, noteHeight, highestPitch)`
|
|
220
|
+
|
|
221
|
+
Convert a MIDI pitch into the vertical pixel offset of its row.
|
|
222
|
+
|
|
223
|
+
```typescript
|
|
224
|
+
function pitchToY(pitch: number, noteHeight: number, highestPitch: number): number
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
- `pitch` — MIDI pitch number.
|
|
228
|
+
- `noteHeight` — Row height per pitch.
|
|
229
|
+
- `highestPitch` — Top-most pitch in the visible range.
|
|
230
|
+
|
|
231
|
+
**Returns:** Vertical pixel offset for the pitch's row.
|
|
232
|
+
|
|
233
|
+
#### `isBlackKey(pitch)`
|
|
234
|
+
|
|
235
|
+
Determine whether a MIDI pitch corresponds to a black key on a piano
|
|
236
|
+
keyboard.
|
|
237
|
+
|
|
238
|
+
```typescript
|
|
239
|
+
function isBlackKey(pitch: number): boolean
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
- `pitch` — MIDI pitch number.
|
|
243
|
+
|
|
244
|
+
**Returns:** `true` if the pitch is a black key.
|
|
245
|
+
|
|
246
|
+
#### `pitchLabel(pitch)`
|
|
247
|
+
|
|
248
|
+
Format a MIDI pitch as a scientific-pitch-notation label.
|
|
249
|
+
|
|
250
|
+
```typescript
|
|
251
|
+
function pitchLabel(pitch: number): string
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
- `pitch` — MIDI pitch number.
|
|
255
|
+
|
|
256
|
+
**Returns:** Formatted label.
|
|
257
|
+
|
|
258
|
+
### Constants
|
|
259
|
+
|
|
260
|
+
#### `PianoRoll`
|
|
261
|
+
|
|
262
|
+
```typescript
|
|
263
|
+
const PianoRoll: LegacyComponentType
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
#### `PIANO_KEYS_WIDTH_PX`
|
|
267
|
+
|
|
268
|
+
Pixel width of the leading piano-keys column.
|
|
269
|
+
|
|
270
|
+
```typescript
|
|
271
|
+
const PIANO_KEYS_WIDTH_PX: 56
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
#### `MIN_NOTE_DURATION_BEATS`
|
|
275
|
+
|
|
276
|
+
Minimum note duration in beats — notes can't be resized below this.
|
|
277
|
+
|
|
278
|
+
```typescript
|
|
279
|
+
const MIN_NOTE_DURATION_BEATS: number
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
#### `DRAG_DISTANCE_THRESHOLD_PX`
|
|
283
|
+
|
|
284
|
+
Pointer-distance threshold (px) before a press becomes a drag.
|
|
285
|
+
|
|
286
|
+
```typescript
|
|
287
|
+
const DRAG_DISTANCE_THRESHOLD_PX: 3
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
#### `DEFAULT_NOTE_VELOCITY`
|
|
291
|
+
|
|
292
|
+
Default MIDI velocity assigned to freshly-painted notes.
|
|
293
|
+
|
|
294
|
+
```typescript
|
|
295
|
+
const DEFAULT_NOTE_VELOCITY: 96
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
## Injection Notes
|
|
299
|
+
|
|
300
|
+
### Requirements
|
|
301
|
+
|
|
302
|
+
Peer dependencies:
|
|
303
|
+
|
|
304
|
+
- `@molecule/app-svelte` ^3.5.0
|
|
305
|
+
- `@molecule/app-ui` ^1.0.1
|
|
306
|
+
- `@molecule/app-ui-svelte` ^1.1.0
|
|
307
|
+
- `svelte` ^5.0.0
|
|
308
|
+
|
|
309
|
+
### Runtime Dependencies
|
|
310
|
+
|
|
311
|
+
- `@molecule/app-svelte`
|
|
312
|
+
- `@molecule/app-ui`
|
|
313
|
+
- `@molecule/app-ui-svelte`
|
|
314
|
+
- `svelte`
|
|
315
|
+
|
|
316
|
+
- Requires a bonded ClassMap (`cm.cn`, `cm.cursorPointer`, …) — rendering
|
|
317
|
+
throws otherwise. No router dependency.
|
|
318
|
+
- Every visible string comes from `useTranslation()` (`pianoRoll.aria.*`)
|
|
319
|
+
via the companion `@molecule/app-locales-feature-piano-roll` locale bond,
|
|
320
|
+
so a locale switch re-renders it.
|
|
321
|
+
- The grid is focusable and paints from the keyboard (arrow keys move the
|
|
322
|
+
cell cursor, Enter / Space paints), exactly as React's.
|
|
323
|
+
|
|
324
|
+
## Translations
|
|
325
|
+
|
|
326
|
+
Translation strings are provided by `@molecule/app-locales-feature-piano-roll`.
|