vexflow 4.0.1-beta.1 → 4.0.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.
Files changed (353) hide show
  1. package/README.md +48 -65
  2. package/build/cjs/vexflow-bravura.js +2 -2
  3. package/build/cjs/vexflow-bravura.js.map +1 -1
  4. package/build/cjs/vexflow-core.js +2 -2
  5. package/build/cjs/vexflow-core.js.map +1 -1
  6. package/build/cjs/vexflow-debug-with-tests.js +724 -697
  7. package/build/cjs/vexflow-debug-with-tests.js.map +1 -1
  8. package/build/cjs/vexflow-debug.js +550 -610
  9. package/build/cjs/vexflow-debug.js.map +1 -1
  10. package/build/cjs/vexflow-font-gonville.js +1 -1
  11. package/build/cjs/vexflow-font-gonville.js.map +1 -1
  12. package/build/cjs/vexflow-gonville.js +2 -2
  13. package/build/cjs/vexflow-gonville.js.map +1 -1
  14. package/build/cjs/vexflow-petaluma.js +2 -2
  15. package/build/cjs/vexflow-petaluma.js.map +1 -1
  16. package/build/cjs/vexflow.js +2 -2
  17. package/build/cjs/vexflow.js.map +1 -1
  18. package/build/esm/entry/vexflow-bravura.js +10 -0
  19. package/build/esm/entry/vexflow-core.js +53 -0
  20. package/build/esm/entry/vexflow-debug-with-tests.js +11 -0
  21. package/build/esm/entry/vexflow-debug.js +8 -0
  22. package/build/esm/entry/vexflow-font-bravura.js +7 -0
  23. package/build/esm/entry/vexflow-font-custom.js +7 -0
  24. package/build/esm/entry/vexflow-font-gonville.js +7 -0
  25. package/build/esm/entry/vexflow-font-petaluma.js +7 -0
  26. package/build/esm/entry/vexflow-gonville.js +10 -0
  27. package/build/esm/entry/vexflow-petaluma.js +10 -0
  28. package/build/esm/entry/vexflow.js +8 -0
  29. package/build/esm/src/accidental.js +348 -0
  30. package/build/esm/src/annotation.js +238 -0
  31. package/build/esm/src/articulation.js +267 -0
  32. package/build/esm/src/barnote.js +58 -0
  33. package/build/esm/src/beam.js +644 -0
  34. package/build/esm/src/bend.js +202 -0
  35. package/build/esm/src/boundingbox.js +59 -0
  36. package/build/esm/src/boundingboxcomputation.js +107 -0
  37. package/build/esm/src/canvascontext.js +202 -0
  38. package/build/esm/src/chordsymbol.js +578 -0
  39. package/build/esm/src/clef.js +153 -0
  40. package/build/esm/src/clefnote.js +65 -0
  41. package/build/esm/src/crescendo.js +77 -0
  42. package/build/esm/src/curve.js +118 -0
  43. package/build/esm/src/dot.js +137 -0
  44. package/build/esm/src/easyscore.js +374 -0
  45. package/build/esm/src/element.js +216 -0
  46. package/build/esm/src/factory.js +445 -0
  47. package/build/esm/src/flow.js +288 -0
  48. package/build/esm/src/font.js +262 -0
  49. package/build/esm/src/fonts/bravura_glyphs.js +3239 -0
  50. package/build/esm/src/fonts/bravura_metrics.js +507 -0
  51. package/build/esm/src/fonts/custom_glyphs.js +78 -0
  52. package/build/esm/src/fonts/custom_metrics.js +5 -0
  53. package/build/esm/src/fonts/gonville_glyphs.js +828 -0
  54. package/build/esm/src/fonts/gonville_metrics.js +421 -0
  55. package/build/esm/src/fonts/load_all.js +10 -0
  56. package/build/esm/src/fonts/load_bravura.js +6 -0
  57. package/build/esm/src/fonts/load_custom.js +6 -0
  58. package/build/esm/src/fonts/load_gonville.js +6 -0
  59. package/build/esm/src/fonts/load_petaluma.js +6 -0
  60. package/build/esm/src/fonts/petaluma_glyphs.js +1335 -0
  61. package/build/esm/src/fonts/petaluma_metrics.js +536 -0
  62. package/build/esm/src/fonts/petalumascript_glyphs.js +863 -0
  63. package/build/esm/src/fonts/robotoslab_glyphs.js +863 -0
  64. package/build/esm/src/fonts/textfonts.js +44 -0
  65. package/build/esm/src/formatter.js +585 -0
  66. package/build/esm/src/fraction.js +171 -0
  67. package/build/esm/src/frethandfinger.js +156 -0
  68. package/build/esm/src/ghostnote.js +50 -0
  69. package/build/esm/src/glyph.js +337 -0
  70. package/build/esm/src/glyphnote.js +55 -0
  71. package/build/esm/src/gracenote.js +133 -0
  72. package/build/esm/src/gracenotegroup.js +128 -0
  73. package/build/esm/src/gracetabnote.js +12 -0
  74. package/build/esm/src/index.js +89 -0
  75. package/build/esm/src/keymanager.js +99 -0
  76. package/build/esm/src/keysignature.js +250 -0
  77. package/build/esm/src/keysignote.js +28 -0
  78. package/build/esm/src/modifier.js +128 -0
  79. package/build/esm/src/modifiercontext.js +110 -0
  80. package/build/esm/src/multimeasurerest.js +173 -0
  81. package/build/esm/src/music.js +322 -0
  82. package/build/esm/src/note.js +371 -0
  83. package/build/esm/src/notehead.js +169 -0
  84. package/build/esm/src/notesubgroup.js +59 -0
  85. package/build/esm/src/ornament.js +206 -0
  86. package/build/esm/src/parenthesis.js +76 -0
  87. package/build/esm/src/parser.js +164 -0
  88. package/build/esm/src/pedalmarking.js +192 -0
  89. package/build/esm/src/registry.js +81 -0
  90. package/build/esm/src/rendercontext.js +24 -0
  91. package/build/esm/src/renderer.js +112 -0
  92. package/build/esm/src/repeatnote.js +22 -0
  93. package/build/esm/src/stave.js +547 -0
  94. package/build/esm/src/stavebarline.js +182 -0
  95. package/build/esm/src/staveconnector.js +196 -0
  96. package/build/esm/src/stavehairpin.js +120 -0
  97. package/build/esm/src/staveline.js +215 -0
  98. package/build/esm/src/stavemodifier.js +77 -0
  99. package/build/esm/src/stavenote.js +860 -0
  100. package/build/esm/src/staverepetition.js +155 -0
  101. package/build/esm/src/stavesection.js +58 -0
  102. package/build/esm/src/stavetempo.js +91 -0
  103. package/build/esm/src/stavetext.js +82 -0
  104. package/build/esm/src/stavetie.js +141 -0
  105. package/build/esm/src/stavevolta.js +67 -0
  106. package/build/esm/src/stem.js +131 -0
  107. package/build/esm/src/stemmablenote.js +193 -0
  108. package/build/esm/src/stringnumber.js +231 -0
  109. package/build/esm/src/strokes.js +200 -0
  110. package/build/esm/src/svgcontext.js +414 -0
  111. package/build/esm/src/system.js +109 -0
  112. package/build/esm/src/tables.js +1102 -0
  113. package/build/esm/src/tabnote.js +299 -0
  114. package/build/esm/src/tabslide.js +76 -0
  115. package/build/esm/src/tabstave.js +17 -0
  116. package/build/esm/src/tabtie.js +19 -0
  117. package/build/esm/src/textbracket.js +144 -0
  118. package/build/esm/src/textdynamics.js +81 -0
  119. package/build/esm/src/textformatter.js +177 -0
  120. package/build/esm/src/textnote.js +174 -0
  121. package/build/esm/src/tickable.js +214 -0
  122. package/build/esm/src/tickcontext.js +170 -0
  123. package/build/esm/src/timesigglyph.js +85 -0
  124. package/build/esm/src/timesignature.js +89 -0
  125. package/build/esm/src/timesignote.js +32 -0
  126. package/build/esm/src/tremolo.js +47 -0
  127. package/build/esm/src/tuning.js +54 -0
  128. package/build/esm/src/tuplet.js +240 -0
  129. package/build/esm/src/typeguard.js +30 -0
  130. package/build/esm/src/util.js +58 -0
  131. package/build/esm/src/version.js +3 -3
  132. package/build/esm/src/vex.js +51 -0
  133. package/build/esm/src/vibrato.js +100 -0
  134. package/build/esm/src/vibratobracket.js +50 -0
  135. package/build/esm/src/voice.js +187 -0
  136. package/build/esm/src/web.js +15 -0
  137. package/build/esm/tests/accidental_tests.js +974 -0
  138. package/build/esm/tests/annotation_tests.js +390 -0
  139. package/build/esm/tests/articulation_tests.js +365 -0
  140. package/build/esm/tests/auto_beam_formatting_tests.js +548 -0
  141. package/build/esm/tests/bach_tests.js +335 -0
  142. package/build/esm/tests/barline_tests.js +52 -0
  143. package/build/esm/tests/beam_tests.js +614 -0
  144. package/build/esm/tests/bend_tests.js +215 -0
  145. package/build/esm/tests/boundingbox_tests.js +53 -0
  146. package/build/esm/tests/boundingboxcomputation_tests.js +183 -0
  147. package/build/esm/tests/chordsymbol_tests.js +320 -0
  148. package/build/esm/tests/clef_tests.js +131 -0
  149. package/build/esm/tests/curve_tests.js +118 -0
  150. package/build/esm/tests/dot_tests.js +123 -0
  151. package/build/esm/tests/easyscore_tests.js +462 -0
  152. package/build/esm/tests/factory_tests.js +44 -0
  153. package/build/esm/tests/font_tests.js +135 -0
  154. package/build/esm/tests/formatter/framestack.js +61 -0
  155. package/build/esm/tests/formatter/tests.js +203 -0
  156. package/build/esm/tests/formatter_tests.js +670 -0
  157. package/build/esm/tests/fraction_tests.js +72 -0
  158. package/build/esm/tests/ghostnote_tests.js +77 -0
  159. package/build/esm/tests/glyphnote_tests.js +113 -0
  160. package/build/esm/tests/gracenote_tests.js +413 -0
  161. package/build/esm/tests/gracetabnote_tests.js +79 -0
  162. package/build/esm/tests/index.js +68 -0
  163. package/build/esm/tests/key_clef_tests.js +103 -0
  164. package/build/esm/tests/keymanager_tests.js +68 -0
  165. package/build/esm/tests/keysignature_tests.js +308 -0
  166. package/build/esm/tests/mocks.js +71 -0
  167. package/build/esm/tests/modifier_tests.js +24 -0
  168. package/build/esm/tests/multimeasurerest_tests.js +141 -0
  169. package/build/esm/tests/music_tests.js +161 -0
  170. package/build/esm/tests/notehead_tests.js +137 -0
  171. package/build/esm/tests/notesubgroup_tests.js +149 -0
  172. package/build/esm/tests/offscreencanvas_tests.js +47 -0
  173. package/build/esm/tests/ornament_tests.js +298 -0
  174. package/build/esm/tests/parser_tests.js +122 -0
  175. package/build/esm/tests/pedalmarking_tests.js +64 -0
  176. package/build/esm/tests/percussion_tests.js +180 -0
  177. package/build/esm/tests/registry_tests.js +64 -0
  178. package/build/esm/tests/renderer_tests.js +113 -0
  179. package/build/esm/tests/rests_tests.js +248 -0
  180. package/build/esm/tests/rhythm_tests.js +357 -0
  181. package/build/esm/tests/stave_tests.js +560 -0
  182. package/build/esm/tests/staveconnector_tests.js +402 -0
  183. package/build/esm/tests/stavehairpin_tests.js +90 -0
  184. package/build/esm/tests/staveline_tests.js +122 -0
  185. package/build/esm/tests/stavemodifier_tests.js +51 -0
  186. package/build/esm/tests/stavenote_tests.js +867 -0
  187. package/build/esm/tests/stavetie_tests.js +108 -0
  188. package/build/esm/tests/stringnumber_tests.js +259 -0
  189. package/build/esm/tests/strokes_tests.js +275 -0
  190. package/build/esm/tests/style_tests.js +98 -0
  191. package/build/esm/tests/support/qunit.js +2765 -0
  192. package/build/esm/tests/tabnote_tests.js +474 -0
  193. package/build/esm/tests/tabslide_tests.js +135 -0
  194. package/build/esm/tests/tabstave_tests.js +23 -0
  195. package/build/esm/tests/tabtie_tests.js +173 -0
  196. package/build/esm/tests/textbracket_tests.js +100 -0
  197. package/build/esm/tests/textformatter_tests.js +24 -0
  198. package/build/esm/tests/textnote_tests.js +215 -0
  199. package/build/esm/tests/threevoice_tests.js +132 -0
  200. package/build/esm/tests/tickcontext_tests.js +36 -0
  201. package/build/esm/tests/timesignature_tests.js +134 -0
  202. package/build/esm/tests/tremolo_tests.js +75 -0
  203. package/build/esm/tests/tuning_tests.js +56 -0
  204. package/build/esm/tests/tuplet_tests.js +450 -0
  205. package/build/esm/tests/typeguard_tests.js +82 -0
  206. package/build/esm/tests/vexflow_test_helpers.js +266 -0
  207. package/build/esm/tests/vf_prefix_tests.js +115 -0
  208. package/build/esm/tests/vibrato_tests.js +92 -0
  209. package/build/esm/tests/vibratobracket_tests.js +45 -0
  210. package/build/esm/tests/voice_tests.js +69 -0
  211. package/build/types/entry/vexflow-bravura.d.ts +2 -0
  212. package/build/types/entry/vexflow-core.d.ts +2 -0
  213. package/build/types/entry/vexflow-debug.d.ts +2 -0
  214. package/build/types/entry/vexflow-font-bravura.d.ts +3771 -0
  215. package/build/types/entry/vexflow-font-custom.d.ts +86 -0
  216. package/build/types/entry/vexflow-font-gonville.d.ts +1267 -0
  217. package/build/types/entry/vexflow-font-petaluma.d.ts +1896 -0
  218. package/build/types/entry/vexflow-gonville.d.ts +2 -0
  219. package/build/types/entry/vexflow-petaluma.d.ts +2 -0
  220. package/build/types/entry/vexflow.d.ts +2 -0
  221. package/build/types/src/accidental.d.ts +66 -0
  222. package/build/types/src/annotation.d.ts +61 -0
  223. package/build/types/src/articulation.d.ts +62 -0
  224. package/build/types/src/barnote.d.ts +29 -0
  225. package/build/types/src/beam.d.ts +153 -0
  226. package/build/types/src/bend.d.ts +73 -0
  227. package/build/types/src/boundingbox.d.ts +42 -0
  228. package/build/types/src/boundingboxcomputation.d.ts +33 -0
  229. package/build/types/src/canvascontext.d.ts +89 -0
  230. package/build/types/src/chordsymbol.d.ts +149 -0
  231. package/build/types/src/clef.d.ts +48 -0
  232. package/build/types/src/clefnote.d.ts +25 -0
  233. package/build/types/src/crescendo.d.ts +27 -0
  234. package/build/types/src/curve.d.ts +41 -0
  235. package/build/types/src/dot.d.ts +20 -0
  236. package/build/types/src/easyscore.d.ts +152 -0
  237. package/build/types/src/element.d.ts +202 -0
  238. package/build/types/src/factory.d.ts +274 -0
  239. package/build/types/src/flow.d.ts +260 -0
  240. package/build/types/src/font.d.ts +180 -0
  241. package/build/types/src/fonts/bravura_glyphs.d.ts +3239 -0
  242. package/build/types/src/fonts/bravura_metrics.d.ts +533 -0
  243. package/build/types/src/fonts/custom_glyphs.d.ts +78 -0
  244. package/build/types/src/fonts/custom_metrics.d.ts +5 -0
  245. package/build/types/src/fonts/gonville_glyphs.d.ts +828 -0
  246. package/build/types/src/fonts/gonville_metrics.d.ts +440 -0
  247. package/build/types/src/fonts/load_all.d.ts +1 -0
  248. package/build/types/src/fonts/load_bravura.d.ts +1 -0
  249. package/build/types/src/fonts/load_custom.d.ts +1 -0
  250. package/build/types/src/fonts/load_gonville.d.ts +1 -0
  251. package/build/types/src/fonts/load_petaluma.d.ts +1 -0
  252. package/build/types/src/fonts/petaluma_glyphs.d.ts +1335 -0
  253. package/build/types/src/fonts/petaluma_metrics.d.ts +562 -0
  254. package/build/types/src/fonts/petalumascript_glyphs.d.ts +863 -0
  255. package/build/types/src/fonts/robotoslab_glyphs.d.ts +863 -0
  256. package/build/types/src/fonts/textfonts.d.ts +1 -0
  257. package/build/types/src/formatter.d.ts +203 -0
  258. package/build/types/src/fraction.d.ts +62 -0
  259. package/build/types/src/frethandfinger.d.ts +22 -0
  260. package/build/types/src/ghostnote.d.ts +16 -0
  261. package/build/types/src/glyph.d.ts +141 -0
  262. package/build/types/src/glyphnote.d.ts +17 -0
  263. package/build/types/src/gracenote.d.ts +19 -0
  264. package/build/types/src/gracenotegroup.d.ts +33 -0
  265. package/build/types/src/gracetabnote.d.ts +5 -0
  266. package/build/types/src/index.d.ts +89 -0
  267. package/build/types/src/keymanager.d.ts +25 -0
  268. package/build/types/src/keysignature.d.ts +50 -0
  269. package/build/types/src/keysignote.d.ts +11 -0
  270. package/build/types/src/modifier.d.ts +97 -0
  271. package/build/types/src/modifiercontext.d.ts +45 -0
  272. package/build/types/src/multimeasurerest.d.ts +61 -0
  273. package/build/types/src/music.d.ts +91 -0
  274. package/build/types/src/note.d.ts +232 -0
  275. package/build/types/src/notehead.d.ts +70 -0
  276. package/build/types/src/notesubgroup.d.ts +18 -0
  277. package/build/types/src/ornament.d.ts +76 -0
  278. package/build/types/src/parenthesis.d.ts +22 -0
  279. package/build/types/src/parser.d.ts +45 -0
  280. package/build/types/src/pedalmarking.d.ts +69 -0
  281. package/build/types/src/registry.d.ts +40 -0
  282. package/build/types/src/rendercontext.d.ts +64 -0
  283. package/build/types/src/renderer.d.ts +35 -0
  284. package/build/types/src/repeatnote.d.ts +6 -0
  285. package/build/types/src/stave.d.ts +186 -0
  286. package/build/types/src/stavebarline.d.ts +28 -0
  287. package/build/types/src/staveconnector.d.ts +67 -0
  288. package/build/types/src/stavehairpin.d.ts +56 -0
  289. package/build/types/src/staveline.d.ts +54 -0
  290. package/build/types/src/stavemodifier.d.ts +44 -0
  291. package/build/types/src/stavenote.d.ts +154 -0
  292. package/build/types/src/staverepetition.d.ts +32 -0
  293. package/build/types/src/stavesection.d.ts +15 -0
  294. package/build/types/src/stavetempo.d.ts +25 -0
  295. package/build/types/src/stavetext.d.ts +25 -0
  296. package/build/types/src/stavetie.d.ts +59 -0
  297. package/build/types/src/stavevolta.d.ts +21 -0
  298. package/build/types/src/stem.d.ts +58 -0
  299. package/build/types/src/stemmablenote.d.ts +39 -0
  300. package/build/types/src/stringnumber.d.ts +27 -0
  301. package/build/types/src/strokes.d.ts +33 -0
  302. package/build/types/src/svgcontext.d.ts +131 -0
  303. package/build/types/src/system.d.ts +92 -0
  304. package/build/types/src/tables.d.ts +96 -0
  305. package/build/types/src/tabnote.d.ts +44 -0
  306. package/build/types/src/tabslide.d.ts +34 -0
  307. package/build/types/src/tabstave.d.ts +7 -0
  308. package/build/types/src/tabtie.d.ts +18 -0
  309. package/build/types/src/textbracket.d.ts +55 -0
  310. package/build/types/src/textdynamics.d.ts +39 -0
  311. package/build/types/src/textformatter.d.ts +109 -0
  312. package/build/types/src/textnote.d.ts +49 -0
  313. package/build/types/src/tickable.d.ts +140 -0
  314. package/build/types/src/tickcontext.d.ts +82 -0
  315. package/build/types/src/timesigglyph.d.ts +14 -0
  316. package/build/types/src/timesignature.d.ts +26 -0
  317. package/build/types/src/timesignote.d.ts +11 -0
  318. package/build/types/src/tremolo.d.ts +17 -0
  319. package/build/types/src/tuning.d.ts +23 -0
  320. package/build/types/src/tuplet.d.ts +105 -0
  321. package/build/types/src/typeguard.d.ts +99 -0
  322. package/build/types/src/util.d.ts +27 -0
  323. package/build/types/src/version.d.ts +3 -0
  324. package/build/types/src/vex.d.ts +18 -0
  325. package/build/types/src/vibrato.d.ts +29 -0
  326. package/build/types/src/vibratobracket.d.ts +33 -0
  327. package/build/types/src/voice.d.ts +108 -0
  328. package/build/types/src/web.d.ts +2 -0
  329. package/entry/vexflow-bravura.ts +3 -3
  330. package/entry/vexflow-core.ts +3 -3
  331. package/entry/vexflow-debug-with-tests.ts +16 -2
  332. package/entry/vexflow-debug.ts +11 -3
  333. package/entry/vexflow-gonville.ts +3 -3
  334. package/entry/vexflow-petaluma.ts +3 -3
  335. package/entry/vexflow.ts +3 -3
  336. package/package.json +1 -1
  337. package/src/annotation.ts +38 -6
  338. package/src/articulation.ts +8 -2
  339. package/src/beam.ts +53 -6
  340. package/src/easyscore.ts +11 -1
  341. package/src/factory.ts +16 -2
  342. package/src/flow.ts +35 -20
  343. package/src/font.ts +0 -4
  344. package/src/fonts/gonville_glyphs.ts +4 -4
  345. package/src/formatter.ts +24 -8
  346. package/src/glyph.ts +8 -0
  347. package/src/index.ts +2 -7
  348. package/src/note.ts +2 -1
  349. package/src/staveline.ts +2 -5
  350. package/src/stavenote.ts +13 -9
  351. package/src/stavetext.ts +3 -3
  352. package/src/system.ts +1 -7
  353. package/src/textnote.ts +9 -11
@@ -0,0 +1,108 @@
1
+ import { BoundingBox } from './boundingbox';
2
+ import { Element } from './element';
3
+ import { Fraction } from './fraction';
4
+ import { RenderContext } from './rendercontext';
5
+ import { Stave } from './stave';
6
+ import { Tickable } from './tickable';
7
+ export interface VoiceTime {
8
+ num_beats: number;
9
+ beat_value: number;
10
+ /** Defaults to `Flow.RESOLUTION` if not provided. */
11
+ resolution?: number;
12
+ }
13
+ export declare enum VoiceMode {
14
+ STRICT = 1,
15
+ SOFT = 2,
16
+ FULL = 3
17
+ }
18
+ /**
19
+ * `Voice` is mainly a container object to group `Tickables` for formatting.
20
+ */
21
+ export declare class Voice extends Element {
22
+ static get CATEGORY(): string;
23
+ /**
24
+ * Modes allow the addition of ticks in three different ways:
25
+ * - STRICT: This is the default. Ticks must fill the voice.
26
+ * - SOFT: Ticks can be added without restrictions.
27
+ * - FULL: Ticks do not need to fill the voice, but can't exceed the maximum tick length.
28
+ */
29
+ static get Mode(): typeof VoiceMode;
30
+ protected resolutionMultiplier: number;
31
+ protected smallestTickCount: Fraction;
32
+ protected stave?: Stave;
33
+ protected mode: VoiceMode;
34
+ protected expTicksUsed?: number;
35
+ protected preFormatted: boolean;
36
+ protected options: {
37
+ softmaxFactor: number;
38
+ };
39
+ protected readonly totalTicks: Fraction;
40
+ protected readonly ticksUsed: Fraction;
41
+ protected readonly largestTickWidth: number;
42
+ protected readonly tickables: Tickable[];
43
+ protected readonly time: Required<VoiceTime>;
44
+ constructor(time?: VoiceTime | string, options?: {
45
+ softmaxFactor: number;
46
+ });
47
+ /** Get the total ticks in the voice. */
48
+ getTotalTicks(): Fraction;
49
+ /** Get the total ticks used in the voice by all the tickables. */
50
+ getTicksUsed(): Fraction;
51
+ /** Get the largest width of all the tickables. */
52
+ getLargestTickWidth(): number;
53
+ /** Get the tick count for the shortest tickable */
54
+ getSmallestTickCount(): Fraction;
55
+ /** Get the tickables in the voice. */
56
+ getTickables(): Tickable[];
57
+ /** Get the voice mode. */
58
+ getMode(): number;
59
+ /**
60
+ * Set the voice mode.
61
+ * @param mode value from `VoiceMode`
62
+ */
63
+ setMode(mode: number): this;
64
+ /** Get the resolution multiplier for the voice. */
65
+ getResolutionMultiplier(): number;
66
+ /** Get the actual tick resolution for the voice. */
67
+ getActualResolution(): number;
68
+ /** Set the voice's stave. */
69
+ setStave(stave: Stave): this;
70
+ getStave(): Stave | undefined;
71
+ /** Get the bounding box for the voice. */
72
+ getBoundingBox(): BoundingBox | undefined;
73
+ /** Set the voice mode to strict or soft. */
74
+ setStrict(strict: boolean): this;
75
+ /** Determine if the voice is complete according to the voice mode. */
76
+ isComplete(): boolean;
77
+ /**
78
+ * We use softmax to layout the tickables proportional to the exponent of
79
+ * their duration. The softmax factor is used to determine the 'linearness' of
80
+ * the layout.
81
+ *
82
+ * The softmax of all the tickables in this voice should sum to 1.
83
+ */
84
+ setSoftmaxFactor(factor: number): this;
85
+ /**
86
+ * Calculate the sum of the exponents of all the ticks in this voice to use
87
+ * as the denominator of softmax.
88
+ */
89
+ protected reCalculateExpTicksUsed(): number;
90
+ /** Get the softmax-scaled value of a tick duration. 'tickValue' is a number. */
91
+ softmax(tickValue: number): number;
92
+ /** Add a tickable to the voice. */
93
+ addTickable(tickable: Tickable): this;
94
+ /** Add an array of tickables to the voice. */
95
+ addTickables(tickables: Tickable[]): this;
96
+ /** Preformat the voice by applying the voice's stave to each note. */
97
+ preFormat(): this;
98
+ checkStave(): Stave;
99
+ /**
100
+ * Render the voice onto the canvas `context` and an optional `stave`.
101
+ * If `stave` is omitted, it is expected that the notes have staves
102
+ * already set.
103
+ *
104
+ * This method also calculates the voice's boundingBox while drawing
105
+ * the notes. Note the similarities with this.getBoundingBox().
106
+ */
107
+ draw(context?: RenderContext, stave?: Stave): void;
108
+ }
@@ -0,0 +1,2 @@
1
+ export declare function isHTMLCanvas(element: any): element is HTMLCanvasElement;
2
+ export declare function isHTMLDiv(element: any): element is HTMLDivElement;
@@ -4,8 +4,6 @@
4
4
  // vexflow-bravura.ts is the entry point for vexflow-bravura.js.
5
5
  // This version bundles the Bravura music engraving font.
6
6
 
7
- import { Vex } from '../src/vex';
8
-
9
7
  import { Flow } from '../src/flow';
10
8
  import { loadBravura } from '../src/fonts/load_bravura';
11
9
  import { loadCustom } from '../src/fonts/load_custom';
@@ -16,8 +14,10 @@ loadCustom();
16
14
  Flow.setMusicFont('Bravura', 'Custom');
17
15
  loadTextFonts();
18
16
 
17
+ // Re-export all exports from index.ts.
19
18
  export * from '../src/index';
20
- export default Vex;
19
+ // Also collect all exports into a default export for CJS projects.
20
+ export * as default from '../src/index';
21
21
 
22
22
  // ADD_MUSIC_FONT
23
23
  // To make a vexflow-xxx.js build that ONLY loads your new music font, copy this file and name it vexflow-xxx.ts.
@@ -9,8 +9,6 @@
9
9
  // All music fonts will be loaded dynamically via: `Flow.fetchMusicFont(fontName)`
10
10
  // Remember to call `Flow.setMusicFont(fontName)` after fetching the font module.
11
11
 
12
- import { Vex } from '../src/vex';
13
-
14
12
  import { Flow } from '../src/flow';
15
13
  import { Font, FontModule } from '../src/font';
16
14
  import { loadTextFonts } from '../src/fonts/textfonts';
@@ -71,5 +69,7 @@ Flow.fetchMusicFont = async (fontName: string, fontModuleOrPath?: string | FontM
71
69
  // Load the two text fonts that ChordSymbol & Annotation use.
72
70
  loadTextFonts();
73
71
 
72
+ // Re-export all exports from index.ts.
74
73
  export * from '../src/index';
75
- export default Vex;
74
+ // Also collect all exports into a default export for CJS projects.
75
+ export * as default from '../src/index';
@@ -5,8 +5,22 @@
5
5
  // It statically bundles all the music engraving fonts, and also includes the tests from vexflow/tests/.
6
6
  // The output file is used by flow.html & flow-headless-browser.html to run the tests.
7
7
 
8
- import { Vex } from './vexflow';
8
+ import * as VexSrc from '../src/index';
9
+ import * as VexTests from '../tests/index';
9
10
 
11
+ import { Flow } from '../src/flow';
12
+ import { loadAllMusicFonts } from '../src/fonts/load_all';
13
+ import { loadTextFonts } from '../src/fonts/textfonts';
14
+
15
+ loadAllMusicFonts();
16
+ Flow.setMusicFont('Bravura', 'Gonville', 'Custom');
17
+ loadTextFonts();
18
+
19
+ // Re-export all exports from src/index.ts and tests/index.ts.
10
20
  export * from '../src/index';
11
21
  export * from '../tests/index';
12
- export default Vex;
22
+ // Also collect all exports into a default export for CJS projects.
23
+ export default {
24
+ ...VexSrc,
25
+ ...VexTests,
26
+ };
@@ -4,12 +4,20 @@
4
4
  // vexflow-debug.ts is the entry point for the build output file vexflow-debug.js.
5
5
  // It statically bundles all the music engraving fonts.
6
6
 
7
- // Currently, it just imports vexflow.ts, but the webpack config inside Gruntfile.js
7
+ // Currently, it is identical to vexflow.ts, but the webpack config inside Gruntfile.js
8
8
  // sets the webpack mode to 'development' to produce an unminified build.
9
9
 
10
10
  // In the future, we could do something different with this entry file, such as turn on flags for logging.
11
11
 
12
- import { Vex } from './vexflow';
12
+ import { Flow } from '../src/flow';
13
+ import { loadAllMusicFonts } from '../src/fonts/load_all';
14
+ import { loadTextFonts } from '../src/fonts/textfonts';
13
15
 
16
+ loadAllMusicFonts();
17
+ Flow.setMusicFont('Bravura', 'Gonville', 'Custom');
18
+ loadTextFonts();
19
+
20
+ // Re-export all exports from index.ts.
14
21
  export * from '../src/index';
15
- export default Vex;
22
+ // Also collect all exports into a default export for CJS projects.
23
+ export * as default from '../src/index';
@@ -4,8 +4,6 @@
4
4
  // vexflow-gonville.ts is the entry point for vexflow-gonville.js.
5
5
  // This version bundles the Gonville music engraving font.
6
6
 
7
- import { Vex } from '../src/vex';
8
-
9
7
  import { Flow } from '../src/flow';
10
8
  import { loadCustom } from '../src/fonts/load_custom';
11
9
  import { loadGonville } from '../src/fonts/load_gonville';
@@ -16,5 +14,7 @@ loadCustom();
16
14
  Flow.setMusicFont('Gonville', 'Custom');
17
15
  loadTextFonts();
18
16
 
17
+ // Re-export all exports from index.ts.
19
18
  export * from '../src/index';
20
- export default Vex;
19
+ // Also collect all exports into a default export for CJS projects.
20
+ export * as default from '../src/index';
@@ -4,8 +4,6 @@
4
4
  // vexflow-petaluma.ts is the entry point for vexflow-petaluma.js.
5
5
  // This version bundles the Petaluma music engraving font.
6
6
 
7
- import { Vex } from '../src/vex';
8
-
9
7
  import { Flow } from '../src/flow';
10
8
  import { loadCustom } from '../src/fonts/load_custom';
11
9
  import { loadPetaluma } from '../src/fonts/load_petaluma';
@@ -16,5 +14,7 @@ loadCustom();
16
14
  Flow.setMusicFont('Petaluma', 'Custom');
17
15
  loadTextFonts();
18
16
 
17
+ // Re-export all exports from index.ts.
19
18
  export * from '../src/index';
20
- export default Vex;
19
+ // Also collect all exports into a default export for CJS projects.
20
+ export * as default from '../src/index';
package/entry/vexflow.ts CHANGED
@@ -7,8 +7,6 @@
7
7
 
8
8
  // The webpack config inside Gruntfile.js sets the mode to 'production' to produce a minified build.
9
9
 
10
- import { Vex } from '../src/vex';
11
-
12
10
  import { Flow } from '../src/flow';
13
11
  import { loadAllMusicFonts } from '../src/fonts/load_all';
14
12
  import { loadTextFonts } from '../src/fonts/textfonts';
@@ -17,5 +15,7 @@ loadAllMusicFonts();
17
15
  Flow.setMusicFont('Bravura', 'Gonville', 'Custom');
18
16
  loadTextFonts();
19
17
 
18
+ // Re-export all exports from index.ts.
20
19
  export * from '../src/index';
21
- export default Vex;
20
+ // Also collect all exports into a default export for CJS projects.
21
+ export * as default from '../src/index';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vexflow",
3
- "version": "4.0.1-beta.1",
3
+ "version": "4.0.1",
4
4
  "description": "A JavaScript library for rendering music notation and guitar tablature.",
5
5
  "exports": {
6
6
  ".": {
package/src/annotation.ts CHANGED
@@ -69,10 +69,19 @@ export class Annotation extends Modifier {
69
69
  centerStem: AnnotationVerticalJustify.CENTER_STEM,
70
70
  };
71
71
 
72
+ // Use the same padding for annotations as note head so the
73
+ // words don't run into each other.
74
+ static get minAnnotationPadding(): number {
75
+ const musicFont = Tables.currentMusicFont();
76
+ return musicFont.lookupMetric('glyphs.noteHead.minPadding');
77
+ }
72
78
  /** Arrange annotations within a `ModifierContext` */
73
79
  static format(annotations: Annotation[], state: ModifierContextState): boolean {
74
80
  if (!annotations || annotations.length === 0) return false;
75
- let width = 0;
81
+ let leftWidth = 0;
82
+ let rightWidth = 0;
83
+ let maxLeftGlyphWidth = 0;
84
+ let maxRightGlyphWidth = 0;
76
85
  for (let i = 0; i < annotations.length; ++i) {
77
86
  const annotation = annotations[i];
78
87
  const textFormatter = TextFormatter.create(annotation.textFont);
@@ -81,6 +90,22 @@ export class Annotation extends Modifier {
81
90
  let verticalSpaceNeeded = textLines;
82
91
 
83
92
  const note = annotation.checkAttachedNote();
93
+ const glyphWidth = note.getGlyph().getWidth();
94
+ // Get the text width from the font metrics.
95
+ const textWidth = textFormatter.getWidthForTextInPx(annotation.text);
96
+ if (annotation.horizontalJustification === AnnotationHorizontalJustify.LEFT) {
97
+ maxLeftGlyphWidth = Math.max(glyphWidth, maxLeftGlyphWidth);
98
+ leftWidth = Math.max(leftWidth, textWidth) + Annotation.minAnnotationPadding;
99
+ } else if (annotation.horizontalJustification === AnnotationHorizontalJustify.RIGHT) {
100
+ maxRightGlyphWidth = Math.max(glyphWidth, maxLeftGlyphWidth);
101
+ rightWidth = Math.max(rightWidth, textWidth);
102
+ } else {
103
+ leftWidth = Math.max(leftWidth, textWidth / 2) + Annotation.minAnnotationPadding;
104
+ rightWidth = Math.max(rightWidth, textWidth / 2);
105
+ maxLeftGlyphWidth = Math.max(glyphWidth / 2, maxLeftGlyphWidth);
106
+ maxRightGlyphWidth = Math.max(glyphWidth / 2, maxRightGlyphWidth);
107
+ }
108
+
84
109
  const stave: Stave | undefined = note.getStave();
85
110
  const stemDirection = note.hasStem() ? note.getStemDirection() : Stem.UP;
86
111
  let stemHeight = 0;
@@ -104,9 +129,6 @@ export class Annotation extends Modifier {
104
129
  if (stave) {
105
130
  lines = stave.getNumLines();
106
131
  }
107
- // Get the text width from the font metrics.
108
- const textWidth = textFormatter.getWidthForTextInPx(annotation.text);
109
- width = Math.max(width, textWidth);
110
132
 
111
133
  if (annotation.verticalJustification === this.VerticalJustify.TOP) {
112
134
  let noteLine = note.getLineNumber(true);
@@ -146,8 +168,13 @@ export class Annotation extends Modifier {
146
168
  annotation.setTextLine(state.text_line);
147
169
  }
148
170
  }
149
- state.left_shift += width / 2;
150
- state.right_shift += width / 2;
171
+ const rightOverlap = Math.min(
172
+ Math.max(rightWidth - maxRightGlyphWidth, 0),
173
+ Math.max(rightWidth - state.right_shift, 0)
174
+ );
175
+ const leftOverlap = Math.min(Math.max(leftWidth - maxLeftGlyphWidth, 0), Math.max(leftWidth - state.left_shift, 0));
176
+ state.left_shift += leftOverlap;
177
+ state.right_shift += rightOverlap;
151
178
  return true;
152
179
  }
153
180
 
@@ -210,6 +237,10 @@ export class Annotation extends Modifier {
210
237
 
211
238
  // We're changing context parameters. Save current state.
212
239
  ctx.save();
240
+ // Apply style might not save context, if this.style is undefined, so we
241
+ // still need to save context state just before this, since we will be
242
+ // changing ctx parameters below.
243
+ this.applyStyle();
213
244
  const classString = Object.keys(this.getAttribute('classes')).join(' ');
214
245
  ctx.openGroup(classString, this.getAttribute('id'));
215
246
  ctx.setFont(this.textFont);
@@ -269,6 +300,7 @@ export class Annotation extends Modifier {
269
300
  L('Rendering annotation: ', this.text, x, y);
270
301
  ctx.fillText(this.text, x, y);
271
302
  ctx.closeGroup();
303
+ this.restoreStyle();
272
304
  ctx.restore();
273
305
  }
274
306
  }
@@ -205,6 +205,7 @@ export class Articulation extends Modifier {
205
205
  if (!articulations || articulations.length === 0) return false;
206
206
 
207
207
  const margin = 0.5;
208
+ let maxGlyphWidth = 0;
208
209
 
209
210
  const getIncrement = (articulation: Articulation, line: number, position: number) =>
210
211
  roundToNearestHalf(
@@ -214,6 +215,7 @@ export class Articulation extends Modifier {
214
215
 
215
216
  articulations.forEach((articulation) => {
216
217
  const note = articulation.checkAttachedNote();
218
+ maxGlyphWidth = Math.max(note.getGlyph().getWidth(), maxGlyphWidth);
217
219
  let lines = 5;
218
220
  const stemDirection = note.hasStem() ? note.getStemDirection() : Stem.UP;
219
221
  let stemHeight = 0;
@@ -261,9 +263,13 @@ export class Articulation extends Modifier {
261
263
  const width = articulations
262
264
  .map((articulation) => articulation.getWidth())
263
265
  .reduce((maxWidth, articWidth) => Math.max(articWidth, maxWidth));
266
+ const overlap = Math.min(
267
+ Math.max(width - maxGlyphWidth, 0),
268
+ Math.max(width - (state.left_shift + state.right_shift), 0)
269
+ );
264
270
 
265
- state.left_shift += width / 2;
266
- state.right_shift += width / 2;
271
+ state.left_shift += overlap / 2;
272
+ state.right_shift += overlap / 2;
267
273
  return true;
268
274
  }
269
275
 
package/src/beam.ts CHANGED
@@ -37,9 +37,11 @@ function getStemSlope(firstNote: StemmableNote, lastNote: StemmableNote) {
37
37
  return (lastStemTipY - firstStemTipY) / (lastStemX - firstStemX);
38
38
  }
39
39
 
40
- const BEAM_LEFT = 'L';
41
- const BEAM_RIGHT = 'R';
42
- const BEAM_BOTH = 'B';
40
+ export const BEAM_LEFT = 'L';
41
+ export const BEAM_RIGHT = 'R';
42
+ export const BEAM_BOTH = 'B';
43
+
44
+ export type PartialBeamDirection = typeof BEAM_LEFT | typeof BEAM_RIGHT | typeof BEAM_BOTH;
43
45
 
44
46
  /** `Beams` span over a set of `StemmableNotes`. */
45
47
  export class Beam extends Element {
@@ -74,6 +76,15 @@ export class Beam extends Element {
74
76
  private beam_count: number;
75
77
  private unbeamable?: boolean;
76
78
 
79
+ /**
80
+ * Overrides to default beam directions for secondary-level beams that do not
81
+ * connect to any other note. See further explanation at
82
+ * `setPartialBeamSideAt`
83
+ */
84
+ private forcedPartialDirections: {
85
+ [noteIndex: number]: PartialBeamDirection;
86
+ } = {};
87
+
77
88
  /** Get the direction of the beam */
78
89
  getStemDirection(): number {
79
90
  return this.stem_direction;
@@ -527,6 +538,33 @@ export class Beam extends Element {
527
538
  return this;
528
539
  }
529
540
 
541
+ /**
542
+ * Forces the direction of a partial beam (a secondary-level beam that exists
543
+ * on one note only of the beam group). This is useful in rhythms such as 6/8
544
+ * eighth-sixteenth-eighth-sixteenth, where the direction of the beam on the
545
+ * first sixteenth note can help imply whether the rhythm is to be felt as
546
+ * three groups of eighth notes (typical) or as two groups of three-sixteenths
547
+ * (less common):
548
+ * ```
549
+ * ┌───┬──┬──┐ ┌──┬──┬──┐
550
+ * │ ├─ │ ─┤ vs │ ─┤ │ ─┤
551
+ * │ │ │ │ │ │ │ │
552
+ * ```
553
+ */
554
+ setPartialBeamSideAt(noteIndex: number, side: PartialBeamDirection) {
555
+ this.forcedPartialDirections[noteIndex] = side;
556
+ return this;
557
+ }
558
+
559
+ /**
560
+ * Restore the default direction of a partial beam (a secondary-level beam
561
+ * that does not connect to any other notes).
562
+ */
563
+ unsetPartialBeamSideAt(noteIndex: number) {
564
+ delete this.forcedPartialDirections[noteIndex];
565
+ return this;
566
+ }
567
+
530
568
  /** Return the y coordinate for linear function. */
531
569
  getSlopeY(x: number, first_x_px: number, first_y_px: number, slope: number): number {
532
570
  return first_y_px + (x - first_x_px) * slope;
@@ -712,11 +750,20 @@ export class Beam extends Element {
712
750
  }
713
751
 
714
752
  /** Return upper level beam direction. */
715
- lookupBeamDirection(duration: string, prev_tick: number, tick: number, next_tick: number): string {
753
+ lookupBeamDirection(
754
+ duration: string,
755
+ prev_tick: number,
756
+ tick: number,
757
+ next_tick: number,
758
+ noteIndex: number
759
+ ): PartialBeamDirection {
716
760
  if (duration === '4') {
717
761
  return BEAM_LEFT;
718
762
  }
719
763
 
764
+ const forcedBeamDirection = this.forcedPartialDirections[noteIndex];
765
+ if (forcedBeamDirection) return forcedBeamDirection;
766
+
720
767
  const lookup_duration = `${Tables.durationToNumber(duration) / 2}`;
721
768
  const prev_note_gets_beam = prev_tick < Tables.durationToTicks(lookup_duration);
722
769
  const next_note_gets_beam = next_tick < Tables.durationToTicks(lookup_duration);
@@ -730,7 +777,7 @@ export class Beam extends Element {
730
777
  return BEAM_RIGHT;
731
778
  }
732
779
 
733
- return this.lookupBeamDirection(lookup_duration, prev_tick, tick, next_tick);
780
+ return this.lookupBeamDirection(lookup_duration, prev_tick, tick, next_tick, noteIndex);
734
781
  }
735
782
 
736
783
  /** Get the x coordinates for the beam lines of specific `duration`. */
@@ -803,7 +850,7 @@ export class Beam extends Element {
803
850
  const prev_tick = prev_note.getIntrinsicTicks();
804
851
  const next_tick = next_note.getIntrinsicTicks();
805
852
  const tick = note.getIntrinsicTicks();
806
- const beam_direction = this.lookupBeamDirection(duration, prev_tick, tick, next_tick);
853
+ const beam_direction = this.lookupBeamDirection(duration, prev_tick, tick, next_tick, i);
807
854
 
808
855
  if ([BEAM_LEFT, BEAM_BOTH].includes(beam_direction)) {
809
856
  current_beam.end = current_beam.start - partial_beam_length;
package/src/easyscore.ts CHANGED
@@ -3,6 +3,7 @@
3
3
 
4
4
  import { Accidental } from './accidental';
5
5
  import { Articulation } from './articulation';
6
+ import { PartialBeamDirection } from './beam';
6
7
  import { Dot } from './dot';
7
8
  import { Factory } from './factory';
8
9
  import { FretHandFinger } from './frethandfinger';
@@ -501,7 +502,16 @@ export class EasyScore {
501
502
  return result;
502
503
  }
503
504
 
504
- beam(notes: StemmableNote[], options?: { autoStem?: boolean; secondaryBeamBreaks?: number[] }): StemmableNote[] {
505
+ beam(
506
+ notes: StemmableNote[],
507
+ options?: {
508
+ autoStem?: boolean;
509
+ secondaryBeamBreaks?: number[];
510
+ partialBeamDirections?: {
511
+ [noteIndex: number]: PartialBeamDirection;
512
+ };
513
+ }
514
+ ): StemmableNote[] {
505
515
  this.factory.Beam({ notes, options });
506
516
  return notes;
507
517
  }
package/src/factory.ts CHANGED
@@ -6,7 +6,7 @@ import { Accidental } from './accidental';
6
6
  import { Annotation, AnnotationHorizontalJustify, AnnotationVerticalJustify } from './annotation';
7
7
  import { Articulation } from './articulation';
8
8
  import { BarNote } from './barnote';
9
- import { Beam } from './beam';
9
+ import { Beam, PartialBeamDirection } from './beam';
10
10
  import { ChordSymbol } from './chordsymbol';
11
11
  import { ClefNote } from './clefnote';
12
12
  import { Curve, CurveOptions } from './curve';
@@ -494,9 +494,23 @@ export class Factory {
494
494
  return tuplet;
495
495
  }
496
496
 
497
- Beam(params: { notes: StemmableNote[]; options?: { autoStem?: boolean; secondaryBeamBreaks?: number[] } }): Beam {
497
+ Beam(params: {
498
+ notes: StemmableNote[];
499
+ options?: {
500
+ autoStem?: boolean;
501
+ secondaryBeamBreaks?: number[];
502
+ partialBeamDirections?: {
503
+ [noteIndex: number]: PartialBeamDirection;
504
+ };
505
+ };
506
+ }): Beam {
498
507
  const beam = new Beam(params.notes, params.options?.autoStem).setContext(this.context);
499
508
  beam.breakSecondaryAt(params.options?.secondaryBeamBreaks ?? []);
509
+ if (params.options?.partialBeamDirections) {
510
+ Object.entries(params.options?.partialBeamDirections).forEach(([noteIndex, direction]) => {
511
+ beam.setPartialBeamSideAt(Number(noteIndex), direction);
512
+ });
513
+ }
500
514
  this.renderQ.push(beam);
501
515
  return beam;
502
516
  }