vexflow 5.0.0 → 5.1.1
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 +3 -3
- package/README.md +46 -53
- package/build/cjs/vexflow-bravura.js +2 -2
- package/build/cjs/vexflow-bravura.js.map +1 -1
- package/build/cjs/vexflow-core.js +2 -2
- package/build/cjs/vexflow-core.js.map +1 -1
- package/build/cjs/vexflow-debug-with-tests.js +3825 -1396
- package/build/cjs/vexflow-debug-with-tests.js.map +1 -1
- package/build/cjs/vexflow-debug.js +2577 -984
- package/build/cjs/vexflow-debug.js.map +1 -1
- package/build/cjs/vexflow.js +2 -2
- package/build/cjs/vexflow.js.map +1 -1
- package/build/esm/src/accidental.js +1 -0
- package/build/esm/src/annotation.js +31 -8
- package/build/esm/src/beam.js +4 -2
- package/build/esm/src/chordsymbol.js +3 -1
- package/build/esm/src/clef.js +3 -1
- package/build/esm/src/curve.js +68 -11
- package/build/esm/src/easyscore.js +40 -1
- package/build/esm/src/element.js +49 -11
- package/build/esm/src/factory.js +46 -9
- package/build/esm/src/flag.js +3 -1
- package/build/esm/src/font.js +20 -1
- package/build/esm/src/formatter.js +34 -36
- package/build/esm/src/fraction.js +4 -1
- package/build/esm/src/glyphnote.js +3 -1
- package/build/esm/src/gracenotegroup.js +18 -1
- package/build/esm/src/index.js +2 -0
- package/build/esm/src/keysignature.js +3 -1
- package/build/esm/src/metrics.js +58 -3
- package/build/esm/src/modifiercontext.js +15 -1
- package/build/esm/src/note.js +2 -2
- package/build/esm/src/notehead.js +3 -1
- package/build/esm/src/ornament.js +3 -1
- package/build/esm/src/pedalmarking.js +44 -5
- package/build/esm/src/registry.js +16 -6
- package/build/esm/src/rendercontext.js +10 -0
- package/build/esm/src/sheet.js +117 -0
- package/build/esm/src/stave.js +13 -8
- package/build/esm/src/stavebarline.js +53 -1
- package/build/esm/src/staveline.js +2 -0
- package/build/esm/src/stavenote.js +54 -19
- package/build/esm/src/stavetie.js +3 -1
- package/build/esm/src/stem.js +2 -1
- package/build/esm/src/stemmablenote.js +9 -0
- package/build/esm/src/stringnumber.js +0 -1
- package/build/esm/src/strokes.js +10 -0
- package/build/esm/src/svgcontext.js +14 -4
- package/build/esm/src/svgexport.js +68 -0
- package/build/esm/src/system.js +14 -0
- package/build/esm/src/tables.js +69 -37
- package/build/esm/src/tabnote.js +20 -1
- package/build/esm/src/textbracket.js +5 -4
- package/build/esm/src/textdynamics.js +5 -0
- package/build/esm/src/textmetricscache.js +93 -0
- package/build/esm/src/textnote.js +3 -3
- package/build/esm/src/tickable.js +56 -22
- package/build/esm/src/timesignature.js +30 -9
- package/build/esm/src/timesignote.js +3 -1
- package/build/esm/src/tuning.js +2 -2
- package/build/esm/src/tuplet.js +79 -29
- package/build/esm/src/util.js +1 -0
- package/build/esm/src/version.js +3 -3
- package/build/esm/src/vexflow.js +14 -2
- package/build/esm/src/voice.js +44 -8
- package/build/esm/tests/accidental_tests.js +52 -0
- package/build/esm/tests/annotation_tests.js +38 -0
- package/build/esm/tests/articulation_tests.js +34 -0
- package/build/esm/tests/beam_tests.js +17 -0
- package/build/esm/tests/curve_tests.js +81 -0
- package/build/esm/tests/font_tests.js +32 -1
- package/build/esm/tests/formatter_tests.js +58 -23
- package/build/esm/tests/gracenote_tests.js +58 -0
- package/build/esm/tests/gracetabnote_tests.js +40 -0
- package/build/esm/tests/keysignature_tests.js +14 -3
- package/build/esm/tests/node/metrics-tests.mjs +278 -0
- package/build/esm/tests/node/package-input-tests.mjs +149 -0
- package/build/esm/tests/node/render-metrics-tests.mjs +78 -0
- package/build/esm/tests/node/rendering-tests.mjs +75 -0
- package/build/esm/tests/node/sheet-tests.mjs +202 -0
- package/build/esm/tests/node/svg-export-tests.mjs +182 -0
- package/build/esm/tests/pedalmarking_tests.js +25 -0
- package/build/esm/tests/rests_tests.js +6 -0
- package/build/esm/tests/stave_tests.js +6 -3
- package/build/esm/tests/stavenote_tests.js +100 -55
- package/build/esm/tests/strokes_tests.js +19 -5
- package/build/esm/tests/timesignature_tests.js +19 -0
- package/build/esm/tests/tuplet_tests.js +273 -12
- package/build/esm/tests/unison_tests.js +13 -13
- package/build/esm/tests/voice_tests.js +34 -0
- package/build/esm/tools/render-metrics.mjs +49 -0
- package/build/esm/tools/score-fixtures.mjs +94 -0
- package/build/esm/tools/sheet-fixture.mjs +90 -0
- package/build/esm/tools/visual-regression.mjs +106 -0
- package/build/types/src/annotation.d.ts +17 -1
- package/build/types/src/curve.d.ts +24 -7
- package/build/types/src/easyscore.d.ts +8 -0
- package/build/types/src/element.d.ts +7 -0
- package/build/types/src/factory.d.ts +18 -1
- package/build/types/src/font.d.ts +2 -0
- package/build/types/src/formatter.d.ts +23 -14
- package/build/types/src/gracenotegroup.d.ts +5 -0
- package/build/types/src/index.d.ts +2 -0
- package/build/types/src/metrics.d.ts +2 -0
- package/build/types/src/modifiercontext.d.ts +4 -0
- package/build/types/src/pedalmarking.d.ts +4 -1
- package/build/types/src/registry.d.ts +2 -0
- package/build/types/src/rendercontext.d.ts +12 -0
- package/build/types/src/sheet.d.ts +49 -0
- package/build/types/src/stave.d.ts +4 -4
- package/build/types/src/stavebarline.d.ts +10 -0
- package/build/types/src/stavenote.d.ts +11 -0
- package/build/types/src/strokes.d.ts +4 -0
- package/build/types/src/svgcontext.d.ts +5 -0
- package/build/types/src/svgexport.d.ts +22 -0
- package/build/types/src/system.d.ts +4 -0
- package/build/types/src/tables.d.ts +9 -0
- package/build/types/src/tabnote.d.ts +4 -0
- package/build/types/src/textbracket.d.ts +1 -1
- package/build/types/src/textdynamics.d.ts +3 -0
- package/build/types/src/textmetricscache.d.ts +21 -0
- package/build/types/src/tickable.d.ts +27 -10
- package/build/types/src/timesignature.d.ts +4 -0
- package/build/types/src/tuplet.d.ts +8 -0
- package/build/types/src/util.d.ts +1 -0
- package/build/types/src/vexflow.d.ts +8 -1
- package/build/types/src/voice.d.ts +6 -0
- package/changelog/CHANGELOG.md +109 -0
- package/package.json +44 -26
- package/tests/flow.html +15 -7
package/LICENSE
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
The MIT License
|
|
2
2
|
|
|
3
|
-
Copyright (c) 2023-
|
|
3
|
+
Copyright (c) 2023-2026 VexFlow contributors (see AUTHORS.md)
|
|
4
4
|
Copyright (c) 2010-2022 Mohit Muthanna Cheppudira
|
|
5
5
|
|
|
6
6
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
@@ -19,4 +19,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
19
19
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
20
20
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
21
21
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
22
|
-
THE SOFTWARE.
|
|
22
|
+
THE SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,43 +1,33 @@
|
|
|
1
1
|
# VexFlow
|
|
2
2
|
|
|
3
|
-
VexFlow is an open-source library for rendering music
|
|
4
|
-
|
|
5
|
-
The guide below refers to VexFlow 5.
|
|
3
|
+
VexFlow is an open-source library for rendering sheet music. It is written in TypeScript, and outputs scores to HTML Canvas and SVG. It works in browsers and in Node.js projects (e.g., a command line script to save a score as a PDF).
|
|
6
4
|
|
|
7
5
|
## Quick Start
|
|
8
6
|
|
|
9
|
-
The
|
|
7
|
+
The simplest way to add VexFlow to a web page is via a `<script>` tag.
|
|
8
|
+
|
|
9
|
+
Save the page as UTF-8 and put `<meta charset="utf-8">` at the start of `<head>`. Without an explicit encoding, music symbols can appear as incorrect characters. A doctype alone does not set the encoding.
|
|
10
|
+
|
|
11
|
+
See this example: [https://jsfiddle.net/ck6erLhm/](https://jsfiddle.net/ck6erLhm/)
|
|
10
12
|
|
|
11
13
|
```html
|
|
12
|
-
|
|
13
|
-
<
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
src
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
<!-- Div where the scores will be output -->
|
|
27
|
-
<div id="output"></div>
|
|
28
|
-
|
|
29
|
-
<!-- Load library -->
|
|
30
|
-
<script src="https://cdn.jsdelivr.net/npm/vexflow@5.0.0-alpha.4/build/cjs/vexflow.js"></script>
|
|
31
|
-
|
|
32
|
-
<script>
|
|
33
|
-
document.fonts.ready.then(() => {
|
|
34
|
-
VexFlow.setFonts('Bravura', 'Academico');
|
|
35
|
-
// YOUR CODE GOES HERE
|
|
36
|
-
});
|
|
37
|
-
</script>
|
|
14
|
+
<!doctype html>
|
|
15
|
+
<html>
|
|
16
|
+
<head>
|
|
17
|
+
<meta charset="utf-8" />
|
|
18
|
+
<title>VexFlow score</title>
|
|
19
|
+
</head>
|
|
20
|
+
<body>
|
|
21
|
+
<div id="output"></div>
|
|
22
|
+
<script src="https://cdn.jsdelivr.net/npm/vexflow@5.1.1/build/cjs/vexflow.js"></script>
|
|
23
|
+
<script>
|
|
24
|
+
// YOUR CODE GOES HERE
|
|
25
|
+
</script>
|
|
26
|
+
</body>
|
|
27
|
+
</html>
|
|
38
28
|
```
|
|
39
29
|
|
|
40
|
-
The URL above includes a version number <code>vexflow@x.y.z</code>. Specifying a
|
|
30
|
+
The URL above includes a version number <code>vexflow@x.y.z</code>. Specifying a version prevents a future update from breaking your deployment.
|
|
41
31
|
|
|
42
32
|
If your project uses a bundler, you can install VexFlow from npm:
|
|
43
33
|
|
|
@@ -45,20 +35,19 @@ If your project uses a bundler, you can install VexFlow from npm:
|
|
|
45
35
|
npm install vexflow
|
|
46
36
|
```
|
|
47
37
|
|
|
48
|
-
|
|
38
|
+
[See our tutorial](https://vexflow.github.io/vexflow-examples/guides/tutorial/).
|
|
49
39
|
|
|
50
|
-
## Factory
|
|
40
|
+
## Factory and EasyScore
|
|
51
41
|
|
|
52
|
-
Factory
|
|
42
|
+
Factory and EasyScore are VexFlow's high-level API for creating staves, voices, and notes. On a web page containing a `<div id="output"></div>`, the following code displays a score:
|
|
53
43
|
|
|
54
44
|
```javascript
|
|
55
|
-
const
|
|
56
|
-
const vf = new Factory({
|
|
45
|
+
const factory = new VexFlow.Factory({
|
|
57
46
|
renderer: { elementId: 'output', width: 500, height: 200 },
|
|
58
47
|
});
|
|
59
48
|
|
|
60
|
-
const score =
|
|
61
|
-
const system =
|
|
49
|
+
const score = factory.EasyScore();
|
|
50
|
+
const system = factory.System();
|
|
62
51
|
|
|
63
52
|
system
|
|
64
53
|
.addStave({
|
|
@@ -70,16 +59,16 @@ system
|
|
|
70
59
|
.addClef('treble')
|
|
71
60
|
.addTimeSignature('4/4');
|
|
72
61
|
|
|
73
|
-
|
|
62
|
+
factory.draw();
|
|
74
63
|
```
|
|
75
64
|
|
|
76
|
-
[See it running here.](https://vexflow.github.io/vexflow-examples/getting-started)
|
|
65
|
+
[See it running here.](https://vexflow.github.io/vexflow-examples/guides/getting-started/)
|
|
77
66
|
|
|
78
67
|
[Learn more about EasyScore here.](https://github.com/0xfe/vexflow/wiki/Using-EasyScore)
|
|
79
68
|
|
|
80
69
|
## Native API
|
|
81
70
|
|
|
82
|
-
|
|
71
|
+
You can use the low-level VexFlow API if you need more control. Below, we render a stave using SVG. [See a running example of the low-level API here.](https://vexflow.github.io/vexflow-examples/guides/getting-started/)
|
|
83
72
|
|
|
84
73
|
```javascript
|
|
85
74
|
const { Renderer, Stave } = VexFlow;
|
|
@@ -91,7 +80,6 @@ const renderer = new Renderer(div, Renderer.Backends.SVG);
|
|
|
91
80
|
// Configure the rendering context.
|
|
92
81
|
renderer.resize(500, 500);
|
|
93
82
|
const context = renderer.getContext();
|
|
94
|
-
context.setFont('Arial', 10);
|
|
95
83
|
|
|
96
84
|
// Create a stave of width 400 at position 10, 40.
|
|
97
85
|
const stave = new Stave(10, 40, 400);
|
|
@@ -105,29 +93,34 @@ stave.setContext(context).draw();
|
|
|
105
93
|
|
|
106
94
|
## Examples
|
|
107
95
|
|
|
108
|
-
|
|
96
|
+
To save SVGs that display without installed fonts, see [portable SVG export](docs/portable-svg.md).
|
|
109
97
|
|
|
110
|
-
|
|
98
|
+
A good way to learn the API is to look at our examples & unit tests:
|
|
111
99
|
|
|
112
|
-
|
|
100
|
+
- [Examples](https://vexflow.github.io/vexflow-examples)
|
|
113
101
|
|
|
114
|
-
-
|
|
102
|
+
- [Unit Tests](https://github.com/vexflow/vexflow/tree/main/tests)
|
|
115
103
|
|
|
116
|
-
|
|
104
|
+
## More Resources
|
|
117
105
|
|
|
118
|
-
-
|
|
106
|
+
- [Text fonts and lyric layout](docs/text-and-lyrics.md), [jsdom rendering](docs/jsdom.md), and [score benchmarks](docs/benchmarks.md).
|
|
107
|
+
- [Score layout](docs/score-layout.md) and [responsive sheets and themes](docs/sheets-and-themes.md).
|
|
108
|
+
- [Rendering tests and visual comparisons](docs/testing.md).
|
|
109
|
+
- [VexFlow Explorer](tools/explorer/README.md): run `npm run explorer` to browse and edit notation.
|
|
119
110
|
|
|
120
|
-
-
|
|
111
|
+
- If you need help, start a [GitHub discussion](https://github.com/vexflow/vexflow/discussions).
|
|
121
112
|
|
|
122
|
-
-
|
|
113
|
+
- Learn more on the [VexFlow wiki](https://github.com/vexflow/vexflow/wiki).
|
|
123
114
|
|
|
124
|
-
|
|
115
|
+
- Build VexFlow from scratch by following the [build instructions](https://github.com/vexflow/vexflow/wiki/Build).
|
|
125
116
|
|
|
126
|
-
|
|
117
|
+
- [VexFlow](https://vexflow.com) was created by [Mohit Muthanna Cheppudira](https://muthanna.com) in 2010. It is currently maintained by [Ron Yeh](https://github.com/ronyeh) and [Rodrigo Vilar](https://github.com/rvilarl). Many others have contributed with code, documentation, bug reports, and feature requests. See the [list of contributors](https://github.com/0xfe/vexflow/graphs/contributors).
|
|
118
|
+
|
|
119
|
+
- [Projects Using VexFlow](https://github.com/0xfe/vexflow/wiki/Project-Gallery)
|
|
127
120
|
|
|
128
121
|
# MIT License
|
|
129
122
|
|
|
130
|
-
Copyright (c) 2023-present VexFlow contributors (see AUTHORS.md)
|
|
123
|
+
Copyright (c) 2023-present VexFlow contributors (see AUTHORS.md).<br />
|
|
131
124
|
Copyright (c) 2010-2022 Mohit Muthanna Cheppudira
|
|
132
125
|
|
|
133
126
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|