vexflow 5.4.0 → 5.6.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.
Files changed (127) hide show
  1. package/build/cjs/vexflow-bravura.js +2 -2
  2. package/build/cjs/vexflow-bravura.js.map +1 -1
  3. package/build/cjs/vexflow-core.js +2 -2
  4. package/build/cjs/vexflow-core.js.map +1 -1
  5. package/build/cjs/vexflow-debug-with-tests.js +1740 -372
  6. package/build/cjs/vexflow-debug-with-tests.js.map +1 -1
  7. package/build/cjs/vexflow-debug.js +565 -258
  8. package/build/cjs/vexflow-debug.js.map +1 -1
  9. package/build/cjs/vexflow.js +2 -2
  10. package/build/cjs/vexflow.js.map +1 -1
  11. package/build/esm/src/annotation.js +2 -1
  12. package/build/esm/src/continuouslayout.js +107 -16
  13. package/build/esm/src/continuousspan.js +9 -1
  14. package/build/esm/src/easyscore/composition.js +83 -18
  15. package/build/esm/src/factory.js +2 -9
  16. package/build/esm/src/formatter.js +1 -1
  17. package/build/esm/src/fretdiagram.js +6 -2
  18. package/build/esm/src/gracenotegroup.js +4 -3
  19. package/build/esm/src/guitarmodifiers.js +4 -1
  20. package/build/esm/src/metrics.js +24 -5
  21. package/build/esm/src/note.js +1 -0
  22. package/build/esm/src/notehead.js +21 -10
  23. package/build/esm/src/phraselayout.js +13 -5
  24. package/build/esm/src/publication.js +10 -5
  25. package/build/esm/src/publicationview.js +3 -2
  26. package/build/esm/src/stave.js +4 -2
  27. package/build/esm/src/stavenote.js +56 -13
  28. package/build/esm/src/stavesection.js +15 -10
  29. package/build/esm/src/stavetie.js +3 -2
  30. package/build/esm/src/strokes.js +1 -1
  31. package/build/esm/src/svgcontext.js +11 -3
  32. package/build/esm/src/tabnote.js +6 -8
  33. package/build/esm/src/tabtie.js +3 -0
  34. package/build/esm/src/version.js +3 -3
  35. package/build/esm/tests/chordsymbol_tests.js +4 -1
  36. package/build/esm/tests/demo_petzold_tests.js +26 -14
  37. package/build/esm/tests/demo_repertoire_tests.js +5 -1
  38. package/build/esm/tests/demos/ballade.js +15 -0
  39. package/build/esm/tests/demos/electric.js +1 -3
  40. package/build/esm/tests/demos/fugue.js +19 -0
  41. package/build/esm/tests/demos/greensleeves.js +1 -2
  42. package/build/esm/tests/demos/kesh.js +2 -3
  43. package/build/esm/tests/demos/saints.js +17 -5
  44. package/build/esm/tests/engraving/continuous-studies.mjs +24 -0
  45. package/build/esm/tests/engraving/publication-studies.mjs +30 -0
  46. package/build/esm/tests/font_tests.js +8 -0
  47. package/build/esm/tests/gracenote_tests.js +1 -1
  48. package/build/esm/tests/gracetabnote_tests.js +19 -3
  49. package/build/esm/tests/node/chord-kerning-tests.mjs +2 -2
  50. package/build/esm/tests/node/continuous-score-tests.mjs +157 -2
  51. package/build/esm/tests/node/easyscore-tests.mjs +38 -0
  52. package/build/esm/tests/node/engraving-layout-tests.mjs +33 -0
  53. package/build/esm/tests/node/instrument-profile-tests.mjs +40 -0
  54. package/build/esm/tests/node/local-engraving-tests.mjs +58 -0
  55. package/build/esm/tests/node/metrics-tests.mjs +2 -0
  56. package/build/esm/tests/node/phrase-layout-tests.mjs +58 -5
  57. package/build/esm/tests/node/publication-tests.mjs +158 -2
  58. package/build/esm/tests/node/svg-export-tests.mjs +50 -21
  59. package/build/esm/tests/scores/ballade.js +399 -0
  60. package/build/esm/tests/scores/drums.js +93 -0
  61. package/build/esm/tests/scores/electric.js +83 -0
  62. package/build/esm/tests/scores/falseta.js +46 -0
  63. package/build/esm/tests/scores/fugue.js +366 -0
  64. package/build/esm/tests/scores/guitar.js +32 -0
  65. package/build/esm/tests/scores/kesh.js +146 -0
  66. package/build/esm/tests/scores/prelude.js +84 -0
  67. package/build/esm/tests/scores/quartertones.js +78 -0
  68. package/build/esm/tests/scores/saints.js +70 -0
  69. package/build/esm/tests/scores/sumer.js +126 -0
  70. package/build/esm/tests/scores/viewer.js +162 -0
  71. package/build/esm/tests/tabnote_tests.js +43 -0
  72. package/build/esm/tests/vexflow_test_helpers.js +1 -0
  73. package/build/esm/tools/explorer/catalog/expression.mjs +16 -6
  74. package/build/esm/tools/explorer/catalog/guitar.mjs +2 -2
  75. package/build/types/src/continuouslayout.d.ts +4 -0
  76. package/build/types/src/continuousspan.d.ts +10 -2
  77. package/build/types/src/easyscore/composition.d.ts +19 -0
  78. package/build/types/src/fretdiagram.d.ts +2 -0
  79. package/build/types/src/instrumentprofile.d.ts +4 -0
  80. package/build/types/src/note.d.ts +2 -0
  81. package/build/types/src/notehead.d.ts +2 -0
  82. package/build/types/src/publication.d.ts +3 -1
  83. package/build/types/src/stave.d.ts +4 -2
  84. package/build/types/src/stavenote.d.ts +10 -0
  85. package/build/types/src/stavesection.d.ts +3 -0
  86. package/build/types/src/svgcontext.d.ts +2 -0
  87. package/build/types/src/typeguard.d.ts +1 -0
  88. package/changelog/CHANGELOG.md +16 -0
  89. package/package.json +4 -1
  90. package/tests/all.html +9 -0
  91. package/tests/demo_petzold_tests.ts +30 -16
  92. package/tests/demos/ballade.ts +36 -0
  93. package/tests/demos/ballade.webp +0 -0
  94. package/tests/demos/electric.ts +1 -3
  95. package/tests/demos/electric.webp +0 -0
  96. package/tests/demos/fugue.ts +27 -0
  97. package/tests/demos/fugue.webp +0 -0
  98. package/tests/demos/greensleeves.ts +1 -3
  99. package/tests/demos/greensleeves.webp +0 -0
  100. package/tests/demos/kesh.ts +2 -4
  101. package/tests/demos/kesh.webp +0 -0
  102. package/tests/demos/saints.ts +20 -7
  103. package/tests/demos/saints.webp +0 -0
  104. package/tests/flow.html +165 -52
  105. package/tests/minuet.webp +0 -0
  106. package/tests/scores/ballade.js +445 -0
  107. package/tests/scores/drums.js +101 -0
  108. package/tests/scores/drums.webp +0 -0
  109. package/tests/scores/electric.js +93 -0
  110. package/tests/scores/electric.webp +0 -0
  111. package/tests/scores/falseta.js +53 -0
  112. package/tests/scores/falseta.webp +0 -0
  113. package/tests/scores/fugue.js +433 -0
  114. package/tests/scores/guitar.js +34 -0
  115. package/tests/scores/index.html +48 -0
  116. package/tests/scores/kesh.js +171 -0
  117. package/tests/scores/kesh.webp +0 -0
  118. package/tests/scores/prelude.js +90 -0
  119. package/tests/scores/prelude.webp +0 -0
  120. package/tests/scores/quartertones.js +83 -0
  121. package/tests/scores/quartertones.webp +0 -0
  122. package/tests/scores/saints.js +85 -0
  123. package/tests/scores/saints.webp +0 -0
  124. package/tests/scores/sumer.js +139 -0
  125. package/tests/scores/sumer.webp +0 -0
  126. package/tests/scores/viewer.css +132 -0
  127. package/tests/scores/viewer.js +150 -0
@@ -0,0 +1,132 @@
1
+ /* The reader shares a coordinate system with the SVG. Print only the selected physical pages. */
2
+ :root {
3
+ font-family: system-ui, sans-serif;
4
+ color: #183530;
5
+ background: #f4f5f1;
6
+ }
7
+ * {
8
+ box-sizing: border-box;
9
+ }
10
+ body {
11
+ margin: 0;
12
+ }
13
+ main {
14
+ max-width: 70rem;
15
+ margin: auto;
16
+ padding: 1.25rem clamp(1rem, 4vw, 3.5rem) 3rem;
17
+ }
18
+ header,
19
+ #tools {
20
+ display: flex;
21
+ gap: 1rem;
22
+ align-items: center;
23
+ flex-wrap: wrap;
24
+ }
25
+ header {
26
+ justify-content: space-between;
27
+ border-bottom: 1px solid #b8c8bf;
28
+ padding-bottom: 0.8rem;
29
+ }
30
+ a {
31
+ color: #205b52;
32
+ }
33
+ h1 {
34
+ font:
35
+ 500 clamp(2rem, 5vw, 3.8rem)/1.08 Georgia,
36
+ serif;
37
+ margin: 1.4rem 0 0.4rem;
38
+ }
39
+ #credit {
40
+ margin: 0;
41
+ color: #55625b;
42
+ }
43
+ #intro {
44
+ line-height: 1.5;
45
+ max-width: 68ch;
46
+ }
47
+ #tools {
48
+ margin: 1.25rem 0;
49
+ }
50
+ button,
51
+ select {
52
+ font: inherit;
53
+ padding: 0.48rem 0.65rem;
54
+ border: 1px solid #a1b3aa;
55
+ background: white;
56
+ color: inherit;
57
+ border-radius: 0.28rem;
58
+ max-width: 100%;
59
+ }
60
+ button {
61
+ cursor: pointer;
62
+ }
63
+ label {
64
+ font-weight: 600;
65
+ }
66
+ select {
67
+ font-weight: 400;
68
+ }
69
+ #page {
70
+ overflow: auto;
71
+ background: white;
72
+ border: 1px solid #cbd4cd;
73
+ }
74
+ #frame {
75
+ position: relative;
76
+ margin: 0 auto;
77
+ }
78
+ #highlight {
79
+ position: absolute;
80
+ pointer-events: none;
81
+ background: #2e977720;
82
+ outline: 2px solid #157a62;
83
+ border-radius: 3px;
84
+ }
85
+ #reading {
86
+ display: grid;
87
+ gap: 0.35rem;
88
+ margin: 1rem 0;
89
+ }
90
+ #score > svg {
91
+ display: block;
92
+ }
93
+ .publication #score > svg {
94
+ height: auto;
95
+ width: min(100%, 210mm);
96
+ margin: auto;
97
+ border-bottom: 1px solid #b8c8bf;
98
+ }
99
+ [hidden],
100
+ #reading[hidden],
101
+ #tools[hidden] {
102
+ display: none;
103
+ }
104
+ @page {
105
+ size: A4;
106
+ margin: 0;
107
+ }
108
+ @media print {
109
+ body,
110
+ main,
111
+ #page,
112
+ #frame {
113
+ background: white;
114
+ padding: 0;
115
+ margin: 0;
116
+ border: 0;
117
+ overflow: visible;
118
+ max-width: none;
119
+ }
120
+ main > :not(#page) {
121
+ display: none !important;
122
+ }
123
+ .publication #score > svg {
124
+ width: 210mm;
125
+ height: 297mm;
126
+ border: 0;
127
+ break-after: page;
128
+ }
129
+ .publication #score > svg:last-child {
130
+ break-after: auto;
131
+ }
132
+ }
@@ -0,0 +1,150 @@
1
+ // Lazy-load one edition. Retain the selected event ID when harmony, part or available width changes.
2
+ (() => {
3
+ const el = (id) => document.getElementById(id);
4
+ const pieces = ['saints', 'electric', 'kesh', 'falseta', 'sumer', 'prelude', 'drums', 'quartertones'];
5
+ let selected, navigation, edition, composition, score, spec, renderedWidth;
6
+
7
+ function highlight() {
8
+ const region = navigation.regions.find((r) => r.kind === 'event' && r.id === selected);
9
+ const box = el('highlight');
10
+ box.hidden = !region;
11
+ if (region) {
12
+ const svg = el('score').querySelector('svg');
13
+ const matrix = svg.getScreenCTM();
14
+ const point = new DOMPoint(region.x, region.y).matrixTransform(matrix);
15
+ const frame = el('frame').getBoundingClientRect();
16
+ Object.assign(box.style, {
17
+ left: point.x - frame.left - 2 + 'px',
18
+ top: point.y - frame.top - 2 + 'px',
19
+ width: region.w * matrix.a + 4 + 'px',
20
+ height: region.h * matrix.d + 4 + 'px',
21
+ });
22
+ }
23
+ }
24
+
25
+ /** Recompute hit regions after VexFlow has assigned the new system positions. */
26
+ function reflow() {
27
+ if (!composition) return;
28
+ const width = Math.min(el('page').clientWidth, el('width').value === 'Narrow' ? 390 : 1100);
29
+ if (width === renderedWidth) return;
30
+ renderedWidth = width;
31
+ const sheet = composition.sheet;
32
+ sheet.setWidth(Math.max(210, width - 34)).format();
33
+ const ctx = score.factory.getContext();
34
+ const height = Math.ceil(sheet.getHeight() + 90);
35
+ ctx.resize(width, height);
36
+ ctx.clear();
37
+ score.draw({ retain: true });
38
+ // An indivisible bar can exceed the target width. Fit all of its ink, including ledger lines
39
+ // and marks outside the nominal stave. Hit testing uses the inverse of this same transform.
40
+ const svg = el('score').querySelector('svg');
41
+ const ink = svg.getBBox();
42
+ const x = Math.min(0, ink.x - 8),
43
+ y = Math.min(0, ink.y - 8);
44
+ const w = Math.max(width, ink.x + ink.width + 8) - x,
45
+ h = ink.y + ink.height + 12 - y;
46
+ svg.setAttribute('viewBox', [x, y, w, h].join(' '));
47
+ svg.style.width = '100%';
48
+ svg.style.height = (width * h) / w + 'px';
49
+ el('score').style.width = '100%';
50
+ el('frame').style.width = width + 'px';
51
+ navigation = new VexFlow.ScoreNavigation(composition, spec.staves);
52
+ const events = navigation.events;
53
+ selected = events.some((e) => e.id === selected) ? selected : events[0]?.id;
54
+ el('events').replaceChildren(...events.map((e) => new Option(e.label, e.id)));
55
+ el('events').value = selected;
56
+ highlight();
57
+ }
58
+ function render() {
59
+ const choice = el('edition').value;
60
+ el('score').replaceChildren();
61
+ if (edition.publication) {
62
+ const { spec, options } = edition.publication(choice, VexFlow);
63
+ new VexFlow.Publication(spec).render(el('score'), options);
64
+ el('frame').className = 'publication';
65
+ return;
66
+ }
67
+ score = VexFlow.EasyScore.create({ renderer: { elementId: 'score', width: 700, height: 300 } });
68
+ const music = edition.create(VexFlow, score, choice);
69
+ spec = music.spec;
70
+ spec.sheet = { width: 700, x: 16, y: 42, rowGap: 26, measurePadding: 18 };
71
+ composition = score.compose(spec);
72
+ music.decorate?.(composition);
73
+ el('legend').textContent = music.legend ?? '';
74
+ el('legend').hidden = !music.legend;
75
+ renderedWidth = undefined;
76
+ reflow();
77
+ }
78
+ /** Initialize native controls after the selected font faces are ready to measure. */
79
+ function loadScript(name) {
80
+ return new Promise((resolve, reject) => {
81
+ const script = document.createElement('script');
82
+ script.src = './' + name + '.js';
83
+ script.onload = resolve;
84
+ script.onerror = () => reject(Error('Unable to load ' + name + '.js'));
85
+ document.head.append(script);
86
+ });
87
+ }
88
+ /** Classic scripts also work when Grunt opens the gallery directly from disk. */
89
+ async function open() {
90
+ const id = new URLSearchParams(location.search).get('piece');
91
+ if (!pieces.includes(id)) throw Error('Choose a score from the gallery.');
92
+ window.FeaturedScores = {};
93
+ if (id === 'electric' || id === 'falseta') await loadScript('guitar');
94
+ await loadScript(id);
95
+ edition = window.FeaturedScores[id];
96
+ document.title = edition.title + ' · VexFlow';
97
+ for (const key of ['title', 'credit', 'intro']) el(key).textContent = edition[key];
98
+ el('source').href = './' + id + '.js';
99
+ el('source').hidden = false;
100
+ const fonts = edition.fonts ?? ['Bravura', 'Academico'];
101
+ VexFlow.setFonts(...fonts);
102
+ await Promise.all(fonts.map((name) => document.fonts.load('16px "' + name + '"')));
103
+ if (edition.choices) {
104
+ el('edition-label').hidden = false;
105
+ el('edition-label').firstElementChild.textContent = edition.control + ' ';
106
+ el('edition').replaceChildren(...edition.choices.map((c) => new Option(c, c)));
107
+ }
108
+ selected = edition.focus;
109
+ render();
110
+ el('edition').onchange = render;
111
+ el('width').onchange = reflow;
112
+ el('print').hidden = !edition.publication;
113
+ el('print').onclick = () => window.print();
114
+ el('width-label').hidden = !!edition.publication;
115
+ el('reading').hidden = !!edition.publication;
116
+ el('events').onchange = () => {
117
+ selected = el('events').value;
118
+ highlight();
119
+ if (!el('highlight').hidden) el('highlight').scrollIntoView({ block: 'nearest' });
120
+ };
121
+ if (edition.focus) {
122
+ el('action').hidden = false;
123
+ el('action').textContent = edition.action ?? 'Follow the held “in”';
124
+ el('action').onclick = () => {
125
+ selected = edition.focus;
126
+ el('events').value = selected;
127
+ highlight();
128
+ el('highlight').scrollIntoView({ block: 'center' });
129
+ };
130
+ }
131
+ el('frame').onclick = (e) => {
132
+ if (!navigation) return;
133
+ const matrix = el('score').querySelector('svg').getScreenCTM();
134
+ const point = new DOMPoint(e.clientX, e.clientY).matrixTransform(matrix.inverse());
135
+ const hit = navigation.hitTest(point.x, point.y);
136
+ if (hit?.kind === 'event') {
137
+ selected = hit.id;
138
+ el('events').value = selected;
139
+ highlight();
140
+ }
141
+ };
142
+ el('tools').hidden = false;
143
+ el('status').textContent = '';
144
+ new ResizeObserver(reflow).observe(el('page'));
145
+ }
146
+ open().catch((error) => {
147
+ el('status').textContent = error.message;
148
+ console.error(error);
149
+ });
150
+ })();