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
package/README.md CHANGED
@@ -1,63 +1,37 @@
1
- # VexFlow 4 (beta)
1
+ # VexFlow
2
2
 
3
- A JavaScript / TypeScript library for rendering music notation.
3
+ VexFlow is an open-source library for rendering music notation. It is written in TypeScript (compiled to ES6), and outputs scores to HTML Canvas and SVG. It works in browsers and also in Node.js projects (e.g., a command line script to save a score as a PDF).
4
4
 
5
- Copyright (c) 2010 Mohit Muthanna Cheppudira
6
-
7
- ## Sponsor this Project
8
-
9
- If you use VexFlow in your app, startup, institution, and find it useful, please consider sponsoring its development here: https://github.com/sponsors/0xfe.
10
-
11
- ## Need Help?
12
-
13
- Ask on the [Vexflow Google Group](https://groups.google.com/forum/?fromgroups#!forum/vexflow).
14
-
15
- ## What is VexFlow?
16
-
17
- VexFlow is an open-source web-based music notation rendering API. It is written in TypeScript, and runs right in the browser. VexFlow supports HTML
18
- Canvas and SVG, and runs on all modern browsers.
19
-
20
- Go try out [The VexFlow Tutorial](https://github.com/0xfe/vexflow/wiki/Tutorial) to learn how to use VexFlow.
5
+ The guide below refers to VexFlow 4. If you need to work with the previous version, follow the [version 3.0.9 tutorial.](https://github.com/0xfe/vexflow/wiki/VexFlow-3.0.9-Tutorial)
21
6
 
22
7
  ## Quick Start
23
8
 
24
- ### Using npm
25
-
26
- To install version 4.0.0-beta:
9
+ The quickest way to add VexFlow to a web page is via a `<script>` tag.
27
10
 
28
- ```shell
29
- $ npm install vexflow@beta
11
+ ```html
12
+ <script src="https://cdn.jsdelivr.net/npm/vexflow/build/cjs/vexflow.js"></script>
13
+ <script>
14
+ // YOUR CODE GOES HERE
15
+ </script>
30
16
  ```
31
17
 
32
- To install version 3.0.9:
18
+ If your project uses a bundler, you can install VexFlow from npm:
33
19
 
34
- ```shell
35
- $ npm install vexflow
20
+ ```sh
21
+ npm install vexflow
36
22
  ```
37
23
 
38
- ### Using the HTML `script` Tag
39
-
40
- Releases are served via CDN:
41
-
42
- **unpkg**
43
-
44
- - Minified: https://unpkg.com/vexflow@4.0.0/build/vexflow.js
45
- - Debug: https://unpkg.com/vexflow@4.0.0/build/vexflow-debug.js
46
-
47
- **jsdelivr**
24
+ Read our detailed guide on [integrating with VexFlow.](https://github.com/0xfe/vexflow/wiki/VexFlow-4-Tutorial)
48
25
 
49
- - Minified: https://cdn.jsdelivr.net/npm/vexflow@4.0.0/build/vexflow.js
50
- - Debug: https://cdn.jsdelivr.net/npm/vexflow@4.0.0/build/vexflow-debug.js
26
+ ## EasyScore
51
27
 
52
- ### Using EasyScore
53
-
54
- The EasyScore API is a quick way to create simple music notation in VexFlow. See a running example in [this jsfiddle](https://jsfiddle.net/2pbh9xq0/).
28
+ EasyScore is VexFlow's high-level API for creating music notation. On a web page containing a `<div id="output"></div>`, the following code displays a score:
55
29
 
56
30
  ```javascript
57
- import Vex from 'vexflow';
31
+ const { Factory, EasyScore, System } = Vex.Flow;
58
32
 
59
- const vf = new Vex.Flow.Factory({
60
- renderer: { elementId: 'boo', width: 500, height: 200 },
33
+ const vf = new Factory({
34
+ renderer: { elementId: 'output', width: 500, height: 200 },
61
35
  });
62
36
 
63
37
  const score = vf.EasyScore();
@@ -76,28 +50,28 @@ system
76
50
  vf.draw();
77
51
  ```
78
52
 
79
- Learn the EasyScore API in the [Using EasyScore](https://github.com/0xfe/vexflow/wiki/Using-EasyScore) guide.
53
+ [See a running example of EasyScore here.](https://jsfiddle.net/t1672wza/)
80
54
 
81
- ### Using the Native API
55
+ [Learn more about EasyScore here.](https://github.com/0xfe/vexflow/wiki/Using-EasyScore)
82
56
 
83
- The example code below renders a VexFlow stave using SVG. See a running example in this [jsfiddle](https://jsfiddle.net/j6dpazx2/).
57
+ ## Native API
84
58
 
85
- ```javascript
86
- import Vex from 'vexflow';
59
+ If you need more control, you can use the low-level VexFlow API. Below, we render a stave using SVG. [See a running example of the low-level API here.](https://jsfiddle.net/vbu1nto7/)
87
60
 
88
- const VF = Vex.Flow;
61
+ ```javascript
62
+ const { Renderer, Stave } = Vex.Flow;
89
63
 
90
- // Create an SVG renderer and attach it to the DIV element named "vf".
91
- const div = document.getElementById('vf');
92
- const renderer = new VF.Renderer(div, VF.Renderer.Backends.SVG);
64
+ // Create an SVG renderer and attach it to the DIV element with id="output".
65
+ const div = document.getElementById('output');
66
+ const renderer = new Renderer(div, Renderer.Backends.SVG);
93
67
 
94
68
  // Configure the rendering context.
95
69
  renderer.resize(500, 500);
96
70
  const context = renderer.getContext();
97
71
  context.setFont('Arial', 10);
98
72
 
99
- // Create a stave of width 400 at position 10, 40 on the canvas.
100
- const stave = new VF.Stave(10, 40, 400);
73
+ // Create a stave of width 400 at position 10, 40.
74
+ const stave = new Stave(10, 40, 400);
101
75
 
102
76
  // Add a clef and time signature.
103
77
  stave.addClef('treble').addTimeSignature('4/4');
@@ -106,15 +80,29 @@ stave.addClef('treble').addTimeSignature('4/4');
106
80
  stave.setContext(context).draw();
107
81
  ```
108
82
 
109
- ## Resources
83
+ ## Examples
84
+
85
+ - Take a look at [the VexFlow tutorial](https://github.com/0xfe/vexflow/wiki/Tutorial).
86
+
87
+ - Dig into [the unit tests](https://github.com/0xfe/vexflow/tree/master/tests).
88
+
89
+ ## More Resources
90
+
91
+ - If you need help, come join us on the [Vexflow Google Group](https://groups.google.com/forum/?fromgroups#!forum/vexflow).
110
92
 
111
- To learn and contribute, check out the [VexFlow Wiki](https://github.com/0xfe/vexflow/wiki).
93
+ - Learn more on the [VexFlow wiki](https://github.com/0xfe/vexflow/wiki).
112
94
 
113
- To build VexFlow from scratch, read the [Build Instructions](https://github.com/0xfe/vexflow/wiki/Build-And-Release-Instructions).
95
+ - Build VexFlow from scratch by following the [build instructions](https://github.com/0xfe/vexflow/wiki/Build%2C-Test%2C-Release).
114
96
 
115
- Sponsor Vexflow: https://github.com/sponsors/0xfe
97
+ - [VexFlow](https://vexflow.com) was created by [Mohit Muthanna Cheppudira](https://muthanna.com) in 2010. Since then, many have contributed with code, documentation, bug reports, and feature requests. See the [list of contributors to the repository](https://github.com/0xfe/vexflow/graphs/contributors).
116
98
 
117
- ## MIT License
99
+ - [Projects Using VexFlow](https://github.com/0xfe/vexflow/wiki/Project-Gallery)
100
+
101
+ ## Sponsor this Project
102
+
103
+ If you find VexFlow useful, please consider sponsoring its development: https://github.com/sponsors/0xfe.
104
+
105
+ # MIT License
118
106
 
119
107
  Copyright (c) Mohit Muthanna Cheppudira 2010 <br/>
120
108
  0xFE <mohit@muthanna.com> https://www.vexflow.com
@@ -136,8 +124,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
136
124
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
137
125
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
138
126
  THE SOFTWARE.
139
-
140
- ## Links
141
-
142
- - [VexFlow Home](https://vexflow.com)
143
- - [Me](https://muthanna.com)