vexflow 4.0.1-beta.1 → 4.0.1-beta.2

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 (331) 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 +92 -24
  6. package/build/cjs/vexflow-debug-with-tests.js.map +1 -1
  7. package/build/cjs/vexflow-debug.js +38 -16
  8. package/build/cjs/vexflow-debug.js.map +1 -1
  9. package/build/cjs/vexflow-font-gonville.js +1 -1
  10. package/build/cjs/vexflow-font-gonville.js.map +1 -1
  11. package/build/cjs/vexflow-gonville.js +2 -2
  12. package/build/cjs/vexflow-gonville.js.map +1 -1
  13. package/build/cjs/vexflow-petaluma.js +2 -2
  14. package/build/cjs/vexflow-petaluma.js.map +1 -1
  15. package/build/cjs/vexflow.js +2 -2
  16. package/build/cjs/vexflow.js.map +1 -1
  17. package/build/esm/entry/vexflow-bravura.js +11 -0
  18. package/build/esm/entry/vexflow-core.js +54 -0
  19. package/build/esm/entry/vexflow-debug-with-tests.js +4 -0
  20. package/build/esm/entry/vexflow-debug.js +3 -0
  21. package/build/esm/entry/vexflow-font-bravura.js +7 -0
  22. package/build/esm/entry/vexflow-font-custom.js +7 -0
  23. package/build/esm/entry/vexflow-font-gonville.js +7 -0
  24. package/build/esm/entry/vexflow-font-petaluma.js +7 -0
  25. package/build/esm/entry/vexflow-gonville.js +11 -0
  26. package/build/esm/entry/vexflow-petaluma.js +11 -0
  27. package/build/esm/entry/vexflow.js +9 -0
  28. package/build/esm/src/accidental.js +348 -0
  29. package/build/esm/src/annotation.js +232 -0
  30. package/build/esm/src/articulation.js +267 -0
  31. package/build/esm/src/barnote.js +58 -0
  32. package/build/esm/src/beam.js +632 -0
  33. package/build/esm/src/bend.js +202 -0
  34. package/build/esm/src/boundingbox.js +59 -0
  35. package/build/esm/src/boundingboxcomputation.js +107 -0
  36. package/build/esm/src/canvascontext.js +202 -0
  37. package/build/esm/src/chordsymbol.js +578 -0
  38. package/build/esm/src/clef.js +153 -0
  39. package/build/esm/src/clefnote.js +65 -0
  40. package/build/esm/src/crescendo.js +77 -0
  41. package/build/esm/src/curve.js +118 -0
  42. package/build/esm/src/dot.js +137 -0
  43. package/build/esm/src/easyscore.js +374 -0
  44. package/build/esm/src/element.js +216 -0
  45. package/build/esm/src/factory.js +440 -0
  46. package/build/esm/src/flow.js +275 -0
  47. package/build/esm/src/font.js +264 -0
  48. package/build/esm/src/fonts/bravura_glyphs.js +3239 -0
  49. package/build/esm/src/fonts/bravura_metrics.js +507 -0
  50. package/build/esm/src/fonts/custom_glyphs.js +78 -0
  51. package/build/esm/src/fonts/custom_metrics.js +5 -0
  52. package/build/esm/src/fonts/gonville_glyphs.js +828 -0
  53. package/build/esm/src/fonts/gonville_metrics.js +421 -0
  54. package/build/esm/src/fonts/load_all.js +10 -0
  55. package/build/esm/src/fonts/load_bravura.js +6 -0
  56. package/build/esm/src/fonts/load_custom.js +6 -0
  57. package/build/esm/src/fonts/load_gonville.js +6 -0
  58. package/build/esm/src/fonts/load_petaluma.js +6 -0
  59. package/build/esm/src/fonts/petaluma_glyphs.js +1335 -0
  60. package/build/esm/src/fonts/petaluma_metrics.js +536 -0
  61. package/build/esm/src/fonts/petalumascript_glyphs.js +863 -0
  62. package/build/esm/src/fonts/robotoslab_glyphs.js +863 -0
  63. package/build/esm/src/fonts/textfonts.js +44 -0
  64. package/build/esm/src/formatter.js +568 -0
  65. package/build/esm/src/fraction.js +171 -0
  66. package/build/esm/src/frethandfinger.js +156 -0
  67. package/build/esm/src/ghostnote.js +50 -0
  68. package/build/esm/src/glyph.js +331 -0
  69. package/build/esm/src/glyphnote.js +55 -0
  70. package/build/esm/src/gracenote.js +133 -0
  71. package/build/esm/src/gracenotegroup.js +128 -0
  72. package/build/esm/src/gracetabnote.js +12 -0
  73. package/build/esm/src/index.js +91 -0
  74. package/build/esm/src/keymanager.js +99 -0
  75. package/build/esm/src/keysignature.js +250 -0
  76. package/build/esm/src/keysignote.js +28 -0
  77. package/build/esm/src/modifier.js +128 -0
  78. package/build/esm/src/modifiercontext.js +110 -0
  79. package/build/esm/src/multimeasurerest.js +173 -0
  80. package/build/esm/src/music.js +322 -0
  81. package/build/esm/src/note.js +371 -0
  82. package/build/esm/src/notehead.js +169 -0
  83. package/build/esm/src/notesubgroup.js +59 -0
  84. package/build/esm/src/ornament.js +206 -0
  85. package/build/esm/src/parenthesis.js +76 -0
  86. package/build/esm/src/parser.js +164 -0
  87. package/build/esm/src/pedalmarking.js +192 -0
  88. package/build/esm/src/registry.js +81 -0
  89. package/build/esm/src/rendercontext.js +24 -0
  90. package/build/esm/src/renderer.js +112 -0
  91. package/build/esm/src/repeatnote.js +22 -0
  92. package/build/esm/src/stave.js +547 -0
  93. package/build/esm/src/stavebarline.js +182 -0
  94. package/build/esm/src/staveconnector.js +196 -0
  95. package/build/esm/src/stavehairpin.js +120 -0
  96. package/build/esm/src/staveline.js +218 -0
  97. package/build/esm/src/stavemodifier.js +77 -0
  98. package/build/esm/src/stavenote.js +855 -0
  99. package/build/esm/src/staverepetition.js +155 -0
  100. package/build/esm/src/stavesection.js +58 -0
  101. package/build/esm/src/stavetempo.js +91 -0
  102. package/build/esm/src/stavetext.js +82 -0
  103. package/build/esm/src/stavetie.js +141 -0
  104. package/build/esm/src/stavevolta.js +67 -0
  105. package/build/esm/src/stem.js +131 -0
  106. package/build/esm/src/stemmablenote.js +193 -0
  107. package/build/esm/src/stringnumber.js +231 -0
  108. package/build/esm/src/strokes.js +200 -0
  109. package/build/esm/src/svgcontext.js +414 -0
  110. package/build/esm/src/system.js +116 -0
  111. package/build/esm/src/tables.js +1102 -0
  112. package/build/esm/src/tabnote.js +299 -0
  113. package/build/esm/src/tabslide.js +76 -0
  114. package/build/esm/src/tabstave.js +17 -0
  115. package/build/esm/src/tabtie.js +19 -0
  116. package/build/esm/src/textbracket.js +144 -0
  117. package/build/esm/src/textdynamics.js +81 -0
  118. package/build/esm/src/textformatter.js +177 -0
  119. package/build/esm/src/textnote.js +176 -0
  120. package/build/esm/src/tickable.js +214 -0
  121. package/build/esm/src/tickcontext.js +170 -0
  122. package/build/esm/src/timesigglyph.js +85 -0
  123. package/build/esm/src/timesignature.js +89 -0
  124. package/build/esm/src/timesignote.js +32 -0
  125. package/build/esm/src/tremolo.js +47 -0
  126. package/build/esm/src/tuning.js +54 -0
  127. package/build/esm/src/tuplet.js +240 -0
  128. package/build/esm/src/typeguard.js +30 -0
  129. package/build/esm/src/util.js +58 -0
  130. package/build/esm/src/version.js +3 -3
  131. package/build/esm/src/vex.js +51 -0
  132. package/build/esm/src/vibrato.js +100 -0
  133. package/build/esm/src/vibratobracket.js +50 -0
  134. package/build/esm/src/voice.js +187 -0
  135. package/build/esm/src/web.js +15 -0
  136. package/build/esm/tests/accidental_tests.js +974 -0
  137. package/build/esm/tests/annotation_tests.js +377 -0
  138. package/build/esm/tests/articulation_tests.js +365 -0
  139. package/build/esm/tests/auto_beam_formatting_tests.js +548 -0
  140. package/build/esm/tests/bach_tests.js +335 -0
  141. package/build/esm/tests/barline_tests.js +52 -0
  142. package/build/esm/tests/beam_tests.js +595 -0
  143. package/build/esm/tests/bend_tests.js +215 -0
  144. package/build/esm/tests/boundingbox_tests.js +53 -0
  145. package/build/esm/tests/boundingboxcomputation_tests.js +183 -0
  146. package/build/esm/tests/chordsymbol_tests.js +320 -0
  147. package/build/esm/tests/clef_tests.js +131 -0
  148. package/build/esm/tests/curve_tests.js +118 -0
  149. package/build/esm/tests/dot_tests.js +123 -0
  150. package/build/esm/tests/easyscore_tests.js +459 -0
  151. package/build/esm/tests/factory_tests.js +44 -0
  152. package/build/esm/tests/font_tests.js +135 -0
  153. package/build/esm/tests/formatter/framestack.js +61 -0
  154. package/build/esm/tests/formatter/tests.js +203 -0
  155. package/build/esm/tests/formatter_tests.js +669 -0
  156. package/build/esm/tests/fraction_tests.js +72 -0
  157. package/build/esm/tests/ghostnote_tests.js +77 -0
  158. package/build/esm/tests/glyphnote_tests.js +113 -0
  159. package/build/esm/tests/gracenote_tests.js +413 -0
  160. package/build/esm/tests/gracetabnote_tests.js +79 -0
  161. package/build/esm/tests/index.js +68 -0
  162. package/build/esm/tests/key_clef_tests.js +103 -0
  163. package/build/esm/tests/keymanager_tests.js +68 -0
  164. package/build/esm/tests/keysignature_tests.js +308 -0
  165. package/build/esm/tests/mocks.js +71 -0
  166. package/build/esm/tests/modifier_tests.js +24 -0
  167. package/build/esm/tests/multimeasurerest_tests.js +141 -0
  168. package/build/esm/tests/music_tests.js +161 -0
  169. package/build/esm/tests/notehead_tests.js +137 -0
  170. package/build/esm/tests/notesubgroup_tests.js +149 -0
  171. package/build/esm/tests/offscreencanvas_tests.js +47 -0
  172. package/build/esm/tests/ornament_tests.js +298 -0
  173. package/build/esm/tests/parser_tests.js +122 -0
  174. package/build/esm/tests/pedalmarking_tests.js +64 -0
  175. package/build/esm/tests/percussion_tests.js +180 -0
  176. package/build/esm/tests/registry_tests.js +64 -0
  177. package/build/esm/tests/renderer_tests.js +113 -0
  178. package/build/esm/tests/rests_tests.js +248 -0
  179. package/build/esm/tests/rhythm_tests.js +357 -0
  180. package/build/esm/tests/stave_tests.js +560 -0
  181. package/build/esm/tests/staveconnector_tests.js +402 -0
  182. package/build/esm/tests/stavehairpin_tests.js +90 -0
  183. package/build/esm/tests/staveline_tests.js +122 -0
  184. package/build/esm/tests/stavemodifier_tests.js +51 -0
  185. package/build/esm/tests/stavenote_tests.js +867 -0
  186. package/build/esm/tests/stavetie_tests.js +108 -0
  187. package/build/esm/tests/stringnumber_tests.js +259 -0
  188. package/build/esm/tests/strokes_tests.js +275 -0
  189. package/build/esm/tests/style_tests.js +98 -0
  190. package/build/esm/tests/support/qunit.js +2765 -0
  191. package/build/esm/tests/tabnote_tests.js +474 -0
  192. package/build/esm/tests/tabslide_tests.js +135 -0
  193. package/build/esm/tests/tabstave_tests.js +23 -0
  194. package/build/esm/tests/tabtie_tests.js +173 -0
  195. package/build/esm/tests/textbracket_tests.js +100 -0
  196. package/build/esm/tests/textformatter_tests.js +24 -0
  197. package/build/esm/tests/textnote_tests.js +215 -0
  198. package/build/esm/tests/threevoice_tests.js +132 -0
  199. package/build/esm/tests/tickcontext_tests.js +36 -0
  200. package/build/esm/tests/timesignature_tests.js +134 -0
  201. package/build/esm/tests/tremolo_tests.js +75 -0
  202. package/build/esm/tests/tuning_tests.js +56 -0
  203. package/build/esm/tests/tuplet_tests.js +450 -0
  204. package/build/esm/tests/typeguard_tests.js +82 -0
  205. package/build/esm/tests/vexflow_test_helpers.js +266 -0
  206. package/build/esm/tests/vf_prefix_tests.js +115 -0
  207. package/build/esm/tests/vibrato_tests.js +92 -0
  208. package/build/esm/tests/vibratobracket_tests.js +45 -0
  209. package/build/esm/tests/voice_tests.js +69 -0
  210. package/build/types/entry/vexflow-bravura.d.ts +3 -0
  211. package/build/types/entry/vexflow-core.d.ts +3 -0
  212. package/build/types/entry/vexflow-debug.d.ts +3 -0
  213. package/build/types/entry/vexflow-font-bravura.d.ts +3771 -0
  214. package/build/types/entry/vexflow-font-custom.d.ts +86 -0
  215. package/build/types/entry/vexflow-font-gonville.d.ts +1267 -0
  216. package/build/types/entry/vexflow-font-petaluma.d.ts +1896 -0
  217. package/build/types/entry/vexflow-gonville.d.ts +3 -0
  218. package/build/types/entry/vexflow-petaluma.d.ts +3 -0
  219. package/build/types/entry/vexflow.d.ts +3 -0
  220. package/build/types/src/accidental.d.ts +66 -0
  221. package/build/types/src/annotation.d.ts +60 -0
  222. package/build/types/src/articulation.d.ts +62 -0
  223. package/build/types/src/barnote.d.ts +29 -0
  224. package/build/types/src/beam.d.ts +124 -0
  225. package/build/types/src/bend.d.ts +73 -0
  226. package/build/types/src/boundingbox.d.ts +42 -0
  227. package/build/types/src/boundingboxcomputation.d.ts +33 -0
  228. package/build/types/src/canvascontext.d.ts +89 -0
  229. package/build/types/src/chordsymbol.d.ts +149 -0
  230. package/build/types/src/clef.d.ts +48 -0
  231. package/build/types/src/clefnote.d.ts +25 -0
  232. package/build/types/src/crescendo.d.ts +27 -0
  233. package/build/types/src/curve.d.ts +41 -0
  234. package/build/types/src/dot.d.ts +20 -0
  235. package/build/types/src/easyscore.d.ts +148 -0
  236. package/build/types/src/element.d.ts +202 -0
  237. package/build/types/src/factory.d.ts +271 -0
  238. package/build/types/src/flow.d.ts +245 -0
  239. package/build/types/src/font.d.ts +181 -0
  240. package/build/types/src/fonts/bravura_glyphs.d.ts +3239 -0
  241. package/build/types/src/fonts/bravura_metrics.d.ts +533 -0
  242. package/build/types/src/fonts/custom_glyphs.d.ts +78 -0
  243. package/build/types/src/fonts/custom_metrics.d.ts +5 -0
  244. package/build/types/src/fonts/gonville_glyphs.d.ts +828 -0
  245. package/build/types/src/fonts/gonville_metrics.d.ts +440 -0
  246. package/build/types/src/fonts/load_all.d.ts +1 -0
  247. package/build/types/src/fonts/load_bravura.d.ts +1 -0
  248. package/build/types/src/fonts/load_custom.d.ts +1 -0
  249. package/build/types/src/fonts/load_gonville.d.ts +1 -0
  250. package/build/types/src/fonts/load_petaluma.d.ts +1 -0
  251. package/build/types/src/fonts/petaluma_glyphs.d.ts +1335 -0
  252. package/build/types/src/fonts/petaluma_metrics.d.ts +562 -0
  253. package/build/types/src/fonts/petalumascript_glyphs.d.ts +863 -0
  254. package/build/types/src/fonts/robotoslab_glyphs.d.ts +863 -0
  255. package/build/types/src/fonts/textfonts.d.ts +1 -0
  256. package/build/types/src/formatter.d.ts +203 -0
  257. package/build/types/src/fraction.d.ts +62 -0
  258. package/build/types/src/frethandfinger.d.ts +22 -0
  259. package/build/types/src/ghostnote.d.ts +16 -0
  260. package/build/types/src/glyph.d.ts +139 -0
  261. package/build/types/src/glyphnote.d.ts +17 -0
  262. package/build/types/src/gracenote.d.ts +19 -0
  263. package/build/types/src/gracenotegroup.d.ts +33 -0
  264. package/build/types/src/gracetabnote.d.ts +5 -0
  265. package/build/types/src/index.d.ts +91 -0
  266. package/build/types/src/keymanager.d.ts +25 -0
  267. package/build/types/src/keysignature.d.ts +50 -0
  268. package/build/types/src/keysignote.d.ts +11 -0
  269. package/build/types/src/modifier.d.ts +97 -0
  270. package/build/types/src/modifiercontext.d.ts +45 -0
  271. package/build/types/src/multimeasurerest.d.ts +61 -0
  272. package/build/types/src/music.d.ts +91 -0
  273. package/build/types/src/note.d.ts +231 -0
  274. package/build/types/src/notehead.d.ts +70 -0
  275. package/build/types/src/notesubgroup.d.ts +18 -0
  276. package/build/types/src/ornament.d.ts +76 -0
  277. package/build/types/src/parenthesis.d.ts +22 -0
  278. package/build/types/src/parser.d.ts +45 -0
  279. package/build/types/src/pedalmarking.d.ts +69 -0
  280. package/build/types/src/registry.d.ts +40 -0
  281. package/build/types/src/rendercontext.d.ts +64 -0
  282. package/build/types/src/renderer.d.ts +35 -0
  283. package/build/types/src/repeatnote.d.ts +6 -0
  284. package/build/types/src/stave.d.ts +186 -0
  285. package/build/types/src/stavebarline.d.ts +28 -0
  286. package/build/types/src/staveconnector.d.ts +67 -0
  287. package/build/types/src/stavehairpin.d.ts +56 -0
  288. package/build/types/src/staveline.d.ts +57 -0
  289. package/build/types/src/stavemodifier.d.ts +44 -0
  290. package/build/types/src/stavenote.d.ts +154 -0
  291. package/build/types/src/staverepetition.d.ts +32 -0
  292. package/build/types/src/stavesection.d.ts +15 -0
  293. package/build/types/src/stavetempo.d.ts +25 -0
  294. package/build/types/src/stavetext.d.ts +25 -0
  295. package/build/types/src/stavetie.d.ts +59 -0
  296. package/build/types/src/stavevolta.d.ts +21 -0
  297. package/build/types/src/stem.d.ts +58 -0
  298. package/build/types/src/stemmablenote.d.ts +39 -0
  299. package/build/types/src/stringnumber.d.ts +27 -0
  300. package/build/types/src/strokes.d.ts +33 -0
  301. package/build/types/src/svgcontext.d.ts +131 -0
  302. package/build/types/src/system.d.ts +92 -0
  303. package/build/types/src/tables.d.ts +96 -0
  304. package/build/types/src/tabnote.d.ts +44 -0
  305. package/build/types/src/tabslide.d.ts +34 -0
  306. package/build/types/src/tabstave.d.ts +7 -0
  307. package/build/types/src/tabtie.d.ts +18 -0
  308. package/build/types/src/textbracket.d.ts +55 -0
  309. package/build/types/src/textdynamics.d.ts +39 -0
  310. package/build/types/src/textformatter.d.ts +109 -0
  311. package/build/types/src/textnote.d.ts +49 -0
  312. package/build/types/src/tickable.d.ts +140 -0
  313. package/build/types/src/tickcontext.d.ts +82 -0
  314. package/build/types/src/timesigglyph.d.ts +14 -0
  315. package/build/types/src/timesignature.d.ts +26 -0
  316. package/build/types/src/timesignote.d.ts +11 -0
  317. package/build/types/src/tremolo.d.ts +17 -0
  318. package/build/types/src/tuning.d.ts +23 -0
  319. package/build/types/src/tuplet.d.ts +105 -0
  320. package/build/types/src/typeguard.d.ts +99 -0
  321. package/build/types/src/util.d.ts +27 -0
  322. package/build/types/src/version.d.ts +3 -0
  323. package/build/types/src/vex.d.ts +18 -0
  324. package/build/types/src/vibrato.d.ts +29 -0
  325. package/build/types/src/vibratobracket.d.ts +33 -0
  326. package/build/types/src/voice.d.ts +108 -0
  327. package/build/types/src/web.d.ts +2 -0
  328. package/package.json +1 -1
  329. package/src/annotation.ts +27 -6
  330. package/src/articulation.ts +8 -2
  331. package/src/fonts/gonville_glyphs.ts +4 -4
@@ -0,0 +1,271 @@
1
+ import { Accidental } from './accidental';
2
+ import { Annotation, AnnotationHorizontalJustify, AnnotationVerticalJustify } from './annotation';
3
+ import { Articulation } from './articulation';
4
+ import { BarNote } from './barnote';
5
+ import { Beam } from './beam';
6
+ import { ChordSymbol } from './chordsymbol';
7
+ import { ClefNote } from './clefnote';
8
+ import { Curve, CurveOptions } from './curve';
9
+ import { EasyScore, EasyScoreOptions } from './easyscore';
10
+ import { Element } from './element';
11
+ import { FontInfo } from './font';
12
+ import { Formatter, FormatterOptions } from './formatter';
13
+ import { FretHandFinger } from './frethandfinger';
14
+ import { GhostNote } from './ghostnote';
15
+ import { Glyph } from './glyph';
16
+ import { GlyphNote, GlyphNoteOptions } from './glyphnote';
17
+ import { GraceNote, GraceNoteStruct } from './gracenote';
18
+ import { GraceNoteGroup } from './gracenotegroup';
19
+ import { KeySigNote } from './keysignote';
20
+ import { ModifierContext } from './modifiercontext';
21
+ import { MultiMeasureRest, MultimeasureRestRenderOptions } from './multimeasurerest';
22
+ import { Note, NoteStruct } from './note';
23
+ import { NoteSubGroup } from './notesubgroup';
24
+ import { PedalMarking } from './pedalmarking';
25
+ import { RenderContext } from './rendercontext';
26
+ import { RepeatNote } from './repeatnote';
27
+ import { Stave, StaveOptions } from './stave';
28
+ import { BarlineType } from './stavebarline';
29
+ import { StaveConnector } from './staveconnector';
30
+ import { StaveLine } from './staveline';
31
+ import { StaveNote, StaveNoteStruct } from './stavenote';
32
+ import { StaveTie } from './stavetie';
33
+ import { StemmableNote } from './stemmablenote';
34
+ import { StringNumber } from './stringnumber';
35
+ import { System, SystemOptions } from './system';
36
+ import { TabNote, TabNoteStruct } from './tabnote';
37
+ import { TabStave } from './tabstave';
38
+ import { TextBracket } from './textbracket';
39
+ import { TextDynamics } from './textdynamics';
40
+ import { TextNote, TextNoteStruct } from './textnote';
41
+ import { TickContext } from './tickcontext';
42
+ import { TimeSigNote } from './timesignote';
43
+ import { Tuplet, TupletOptions } from './tuplet';
44
+ import { VibratoBracket } from './vibratobracket';
45
+ import { Voice, VoiceTime } from './voice';
46
+ export interface FactoryOptions {
47
+ stave?: {
48
+ space: number;
49
+ };
50
+ renderer?: {
51
+ elementId: string | null;
52
+ backend?: number;
53
+ width: number;
54
+ height: number;
55
+ background?: string;
56
+ };
57
+ font?: FontInfo;
58
+ }
59
+ /**
60
+ * Factory implements a high level API around VexFlow.
61
+ */
62
+ export declare class Factory {
63
+ /** To enable logging for this class. Set `Vex.Flow.Factory.DEBUG` to `true`. */
64
+ static DEBUG: boolean;
65
+ /** Default text font. */
66
+ static TEXT_FONT: Required<FontInfo>;
67
+ /**
68
+ * Static simplified function to access constructor without providing FactoryOptions
69
+ *
70
+ * Example:
71
+ *
72
+ * Create an SVG renderer and attach it to the DIV element named "boo" to render using <page-width> 1200 and <page-height> 600
73
+ *
74
+ * `const vf: Factory = Vex.Flow.Factory.newFromElementId('boo', 1200, 600 );`
75
+ */
76
+ static newFromElementId(elementId: string | null, width?: number, height?: number): Factory;
77
+ protected options: Required<FactoryOptions>;
78
+ protected stave?: Stave;
79
+ protected context: RenderContext;
80
+ protected staves: Stave[];
81
+ protected voices: Voice[];
82
+ protected renderQ: Element[];
83
+ protected systems: System[];
84
+ /**
85
+ * Example:
86
+ *
87
+ * Create an SVG renderer and attach it to the DIV element named "boo" to render using <page-width> 1200 and <page-height> 600
88
+ *
89
+ * `const vf: Factory = new Vex.Flow.Factory({renderer: { elementId: 'boo', width: 1200, height: 600 }});`
90
+ */
91
+ constructor(options?: FactoryOptions);
92
+ reset(): void;
93
+ setOptions(options?: FactoryOptions): void;
94
+ initRenderer(): void;
95
+ getContext(): RenderContext;
96
+ setContext(context: RenderContext): this;
97
+ getStave(): Stave | undefined;
98
+ getVoices(): Voice[];
99
+ /** Return pixels from current stave spacing. */
100
+ Stave(params?: {
101
+ x?: number;
102
+ y?: number;
103
+ width?: number;
104
+ options?: StaveOptions;
105
+ }): Stave;
106
+ TabStave(params?: {
107
+ x?: number;
108
+ y?: number;
109
+ width?: number;
110
+ options?: StaveOptions;
111
+ }): TabStave;
112
+ StaveNote(noteStruct: StaveNoteStruct): StaveNote;
113
+ GlyphNote(glyph: Glyph, noteStruct: NoteStruct, options?: GlyphNoteOptions): GlyphNote;
114
+ RepeatNote(type: string, noteStruct?: NoteStruct, options?: GlyphNoteOptions): RepeatNote;
115
+ GhostNote(noteStruct: string | NoteStruct): GhostNote;
116
+ TextNote(noteStruct: TextNoteStruct): TextNote;
117
+ BarNote(params?: {
118
+ type?: BarlineType | string;
119
+ }): BarNote;
120
+ ClefNote(params?: {
121
+ type?: string;
122
+ options?: {
123
+ size?: string;
124
+ annotation?: string;
125
+ };
126
+ }): ClefNote;
127
+ TimeSigNote(params?: {
128
+ time?: string;
129
+ }): TimeSigNote;
130
+ KeySigNote(params: {
131
+ key: string;
132
+ cancelKey?: string;
133
+ alterKey?: string[];
134
+ }): KeySigNote;
135
+ TabNote(noteStruct: TabNoteStruct): TabNote;
136
+ GraceNote(noteStruct: GraceNoteStruct): GraceNote;
137
+ GraceNoteGroup(params: {
138
+ notes: StemmableNote[];
139
+ slur?: boolean;
140
+ }): GraceNoteGroup;
141
+ Accidental(params: {
142
+ type: string;
143
+ }): Accidental;
144
+ Annotation(params?: {
145
+ text?: string;
146
+ hJustify?: string | AnnotationHorizontalJustify;
147
+ vJustify?: string | AnnotationVerticalJustify;
148
+ font?: FontInfo;
149
+ }): Annotation;
150
+ ChordSymbol(params?: {
151
+ vJustify?: string;
152
+ hJustify?: string;
153
+ kerning?: boolean;
154
+ reportWidth?: boolean;
155
+ fontFamily?: string;
156
+ fontSize?: number;
157
+ fontWeight?: string;
158
+ }): ChordSymbol;
159
+ Articulation(params?: {
160
+ type?: string;
161
+ position?: string | number;
162
+ }): Articulation;
163
+ TextDynamics(params?: {
164
+ text?: string;
165
+ duration?: string;
166
+ dots?: number;
167
+ line?: number;
168
+ }): TextDynamics;
169
+ Fingering(params: {
170
+ number?: string;
171
+ position?: string;
172
+ }): FretHandFinger;
173
+ StringNumber(params: {
174
+ number: string;
175
+ position: string;
176
+ }): StringNumber;
177
+ TickContext(): TickContext;
178
+ ModifierContext(): ModifierContext;
179
+ MultiMeasureRest(params: MultimeasureRestRenderOptions): MultiMeasureRest;
180
+ Voice(params?: {
181
+ time?: VoiceTime | string;
182
+ options?: {
183
+ softmaxFactor: number;
184
+ };
185
+ }): Voice;
186
+ StaveConnector(params: {
187
+ top_stave: Stave;
188
+ bottom_stave: Stave;
189
+ type: string;
190
+ }): StaveConnector;
191
+ Formatter(options?: FormatterOptions): Formatter;
192
+ Tuplet(params?: {
193
+ notes?: Note[];
194
+ options?: TupletOptions;
195
+ }): Tuplet;
196
+ Beam(params: {
197
+ notes: StemmableNote[];
198
+ options?: {
199
+ autoStem?: boolean;
200
+ secondaryBeamBreaks?: number[];
201
+ };
202
+ }): Beam;
203
+ Curve(params: {
204
+ from: Note;
205
+ to: Note;
206
+ options: CurveOptions;
207
+ }): Curve;
208
+ StaveTie(params: {
209
+ from?: Note | null;
210
+ to?: Note | null;
211
+ first_indices?: number[];
212
+ last_indices?: number[];
213
+ text?: string;
214
+ options?: {
215
+ direction?: number;
216
+ };
217
+ }): StaveTie;
218
+ StaveLine(params: {
219
+ from: StaveNote;
220
+ to: StaveNote;
221
+ first_indices: number[];
222
+ last_indices: number[];
223
+ options?: {
224
+ text?: string;
225
+ font?: FontInfo;
226
+ };
227
+ }): StaveLine;
228
+ VibratoBracket(params: {
229
+ from: Note | null;
230
+ to: Note | null;
231
+ options: {
232
+ harsh?: boolean;
233
+ line?: number;
234
+ };
235
+ }): VibratoBracket;
236
+ TextBracket(params: {
237
+ from: Note;
238
+ to: Note;
239
+ text: string;
240
+ options: {
241
+ superscript: string;
242
+ position: string;
243
+ line?: number;
244
+ font?: FontInfo;
245
+ };
246
+ }): TextBracket;
247
+ System(params?: SystemOptions): System;
248
+ /**
249
+ * Creates EasyScore. Normally the first step after constructing a Factory. For example:
250
+ * ```
251
+ * const vf: Factory = new Vex.Flow.Factory({renderer: { elementId: 'boo', width: 1200, height: 600 }});
252
+ * const score: EasyScore = vf.EasyScore();
253
+ * ```
254
+ * @param options.factory optional instance of Factory
255
+ * @param options.builder instance of Builder
256
+ * @param options.commitHooks function to call after a note element is created
257
+ * @param options.throwOnError throw error in case of parsing error
258
+ */
259
+ EasyScore(options?: EasyScoreOptions): EasyScore;
260
+ PedalMarking(params?: {
261
+ notes?: StaveNote[];
262
+ options?: {
263
+ style: string;
264
+ };
265
+ }): PedalMarking;
266
+ NoteSubGroup(params?: {
267
+ notes?: Note[];
268
+ }): NoteSubGroup;
269
+ /** Render the score. */
270
+ draw(): void;
271
+ }
@@ -0,0 +1,245 @@
1
+ import { Accidental } from './accidental';
2
+ import { Annotation } from './annotation';
3
+ import { Articulation } from './articulation';
4
+ import { BarNote } from './barnote';
5
+ import { Beam } from './beam';
6
+ import { Bend } from './bend';
7
+ import { BoundingBox } from './boundingbox';
8
+ import { BoundingBoxComputation } from './boundingboxcomputation';
9
+ import { CanvasContext } from './canvascontext';
10
+ import { ChordSymbol } from './chordsymbol';
11
+ import { Clef } from './clef';
12
+ import { ClefNote } from './clefnote';
13
+ import { Crescendo } from './crescendo';
14
+ import { Curve } from './curve';
15
+ import { Dot } from './dot';
16
+ import { EasyScore } from './easyscore';
17
+ import { Element } from './element';
18
+ import { Factory } from './factory';
19
+ import { Font, FontModule } from './font';
20
+ import { Formatter } from './formatter';
21
+ import { Fraction } from './fraction';
22
+ import { FretHandFinger } from './frethandfinger';
23
+ import { GhostNote } from './ghostnote';
24
+ import { Glyph } from './glyph';
25
+ import { GlyphNote } from './glyphnote';
26
+ import { GraceNote } from './gracenote';
27
+ import { GraceNoteGroup } from './gracenotegroup';
28
+ import { GraceTabNote } from './gracetabnote';
29
+ import { KeyManager } from './keymanager';
30
+ import { KeySignature } from './keysignature';
31
+ import { KeySigNote } from './keysignote';
32
+ import { Modifier, ModifierPosition } from './modifier';
33
+ import { ModifierContext } from './modifiercontext';
34
+ import { MultiMeasureRest } from './multimeasurerest';
35
+ import { Music } from './music';
36
+ import { Note } from './note';
37
+ import { NoteHead } from './notehead';
38
+ import { NoteSubGroup } from './notesubgroup';
39
+ import { Ornament } from './ornament';
40
+ import { Parenthesis } from './parenthesis';
41
+ import { Parser } from './parser';
42
+ import { PedalMarking } from './pedalmarking';
43
+ import { Registry } from './registry';
44
+ import { RenderContext } from './rendercontext';
45
+ import { Renderer } from './renderer';
46
+ import { RepeatNote } from './repeatnote';
47
+ import { Stave } from './stave';
48
+ import { Barline, BarlineType } from './stavebarline';
49
+ import { StaveConnector } from './staveconnector';
50
+ import { StaveHairpin } from './stavehairpin';
51
+ import { StaveLine } from './staveline';
52
+ import { StaveModifier } from './stavemodifier';
53
+ import { StaveNote } from './stavenote';
54
+ import { Repetition } from './staverepetition';
55
+ import { StaveTempo } from './stavetempo';
56
+ import { StaveText } from './stavetext';
57
+ import { StaveTie } from './stavetie';
58
+ import { Volta } from './stavevolta';
59
+ import { Stem } from './stem';
60
+ import { StringNumber } from './stringnumber';
61
+ import { Stroke } from './strokes';
62
+ import { SVGContext } from './svgcontext';
63
+ import { System } from './system';
64
+ import { TabNote } from './tabnote';
65
+ import { TabSlide } from './tabslide';
66
+ import { TabStave } from './tabstave';
67
+ import { TabTie } from './tabtie';
68
+ import { TextBracket } from './textbracket';
69
+ import { TextDynamics } from './textdynamics';
70
+ import { TextFormatter } from './textformatter';
71
+ import { TextNote } from './textnote';
72
+ import { TickContext } from './tickcontext';
73
+ import { TimeSignature } from './timesignature';
74
+ import { TimeSigNote } from './timesignote';
75
+ import { Tremolo } from './tremolo';
76
+ import { Tuning } from './tuning';
77
+ import { Tuplet } from './tuplet';
78
+ import { Vibrato } from './vibrato';
79
+ import { VibratoBracket } from './vibratobracket';
80
+ import { Voice } from './voice';
81
+ export declare class Flow {
82
+ static get BUILD(): {
83
+ /** version number. */
84
+ VERSION: string;
85
+ /** git commit ID that this library was built from. */
86
+ ID: string;
87
+ /** The date when this library was compiled. */
88
+ DATE: string;
89
+ };
90
+ static Accidental: typeof Accidental;
91
+ static Annotation: typeof Annotation;
92
+ static Articulation: typeof Articulation;
93
+ static Barline: typeof Barline;
94
+ static BarNote: typeof BarNote;
95
+ static Beam: typeof Beam;
96
+ static Bend: typeof Bend;
97
+ static BoundingBox: typeof BoundingBox;
98
+ static BoundingBoxComputation: typeof BoundingBoxComputation;
99
+ static CanvasContext: typeof CanvasContext;
100
+ static ChordSymbol: typeof ChordSymbol;
101
+ static Clef: typeof Clef;
102
+ static ClefNote: typeof ClefNote;
103
+ static Crescendo: typeof Crescendo;
104
+ static Curve: typeof Curve;
105
+ static Dot: typeof Dot;
106
+ static EasyScore: typeof EasyScore;
107
+ static Element: typeof Element;
108
+ static Factory: typeof Factory;
109
+ static get Flow(): typeof Flow;
110
+ static Font: typeof Font;
111
+ static Formatter: typeof Formatter;
112
+ static Fraction: typeof Fraction;
113
+ static FretHandFinger: typeof FretHandFinger;
114
+ static GhostNote: typeof GhostNote;
115
+ static Glyph: typeof Glyph;
116
+ static GlyphNote: typeof GlyphNote;
117
+ static GraceNote: typeof GraceNote;
118
+ static GraceNoteGroup: typeof GraceNoteGroup;
119
+ static GraceTabNote: typeof GraceTabNote;
120
+ static KeyManager: typeof KeyManager;
121
+ static KeySignature: typeof KeySignature;
122
+ static KeySigNote: typeof KeySigNote;
123
+ static Modifier: typeof Modifier;
124
+ static ModifierContext: typeof ModifierContext;
125
+ static MultiMeasureRest: typeof MultiMeasureRest;
126
+ static Music: typeof Music;
127
+ static Note: typeof Note;
128
+ static NoteHead: typeof NoteHead;
129
+ static NoteSubGroup: typeof NoteSubGroup;
130
+ static Ornament: typeof Ornament;
131
+ static Parenthesis: typeof Parenthesis;
132
+ static Parser: typeof Parser;
133
+ static PedalMarking: typeof PedalMarking;
134
+ static Registry: typeof Registry;
135
+ static RenderContext: typeof RenderContext;
136
+ static Renderer: typeof Renderer;
137
+ static RepeatNote: typeof RepeatNote;
138
+ static Repetition: typeof Repetition;
139
+ static Stave: typeof Stave;
140
+ static StaveConnector: typeof StaveConnector;
141
+ static StaveHairpin: typeof StaveHairpin;
142
+ static StaveLine: typeof StaveLine;
143
+ static StaveModifier: typeof StaveModifier;
144
+ static StaveNote: typeof StaveNote;
145
+ static StaveTempo: typeof StaveTempo;
146
+ static StaveText: typeof StaveText;
147
+ static StaveTie: typeof StaveTie;
148
+ static Stem: typeof Stem;
149
+ static StringNumber: typeof StringNumber;
150
+ static Stroke: typeof Stroke;
151
+ static SVGContext: typeof SVGContext;
152
+ static System: typeof System;
153
+ static TabNote: typeof TabNote;
154
+ static TabSlide: typeof TabSlide;
155
+ static TabStave: typeof TabStave;
156
+ static TabTie: typeof TabTie;
157
+ static TextBracket: typeof TextBracket;
158
+ static TextDynamics: typeof TextDynamics;
159
+ static TextFormatter: typeof TextFormatter;
160
+ static TextNote: typeof TextNote;
161
+ static TickContext: typeof TickContext;
162
+ static TimeSignature: typeof TimeSignature;
163
+ static TimeSigNote: typeof TimeSigNote;
164
+ static Tremolo: typeof Tremolo;
165
+ static Tuning: typeof Tuning;
166
+ static Tuplet: typeof Tuplet;
167
+ static Vibrato: typeof Vibrato;
168
+ static VibratoBracket: typeof VibratoBracket;
169
+ static Voice: typeof Voice;
170
+ static Volta: typeof Volta;
171
+ static BarlineType: typeof BarlineType;
172
+ static ModifierPosition: typeof ModifierPosition;
173
+ /**
174
+ * Examples:
175
+ * ```
176
+ * Vex.Flow.setMusicFont('Petaluma');
177
+ * Vex.Flow.setMusicFont('Bravura', 'Gonville');
178
+ * ```
179
+ *
180
+ * **CASE 1**: You are using `vexflow.js`, which includes all music fonts (Bravura, Gonville, Petaluma, Custom).
181
+ * In this case, calling this method is optional, since VexFlow already defaults to a music font stack of:
182
+ * 'Bravura', 'Gonville', 'Custom'.
183
+ *
184
+ * **CASE 2**: You are using `vexflow-bravura.js` or `vexflow-petaluma.js` or `vexflow-gonville.js`,
185
+ * which includes a single music font. Calling this method is unnecessary.
186
+ *
187
+ * **CASE 3**: You are using the light weight `vexflow-core.js` to take advantage of lazy loading for fonts.
188
+ * In this case, the default music font stack is empty.
189
+ * Example:
190
+ * ```
191
+ * await Vex.Flow.fetchMusicFont('Petaluma');
192
+ * Vex.Flow.setMusicFont('Petaluma');
193
+ * ... (do VexFlow stuff) ...
194
+ * ```
195
+ * See `demos/fonts/` for more examples.
196
+ *
197
+ * @returns an array of Font objects corresponding to the provided `fontNames`.
198
+ */
199
+ static setMusicFont(...fontNames: string[]): Font[];
200
+ /**
201
+ * Used with vexflow-core which supports dynamic font loading.
202
+ */
203
+ static fetchMusicFont(fontName: string, fontModuleOrPath?: string | FontModule): Promise<void>;
204
+ static getMusicFont(): string[];
205
+ static get NOTATION_FONT_SCALE(): number;
206
+ static set NOTATION_FONT_SCALE(value: number);
207
+ static get TABLATURE_FONT_SCALE(): number;
208
+ static set TABLATURE_FONT_SCALE(value: number);
209
+ static get RESOLUTION(): number;
210
+ static set RESOLUTION(value: number);
211
+ static get SLASH_NOTEHEAD_WIDTH(): number;
212
+ static set SLASH_NOTEHEAD_WIDTH(value: number);
213
+ static get STAVE_LINE_DISTANCE(): number;
214
+ static set STAVE_LINE_DISTANCE(value: number);
215
+ static get STAVE_LINE_THICKNESS(): number;
216
+ static set STAVE_LINE_THICKNESS(value: number);
217
+ static get STEM_HEIGHT(): number;
218
+ static set STEM_HEIGHT(value: number);
219
+ static get STEM_WIDTH(): number;
220
+ static set STEM_WIDTH(value: number);
221
+ static get TIME4_4(): {
222
+ num_beats: number;
223
+ beat_value: number;
224
+ resolution: number;
225
+ };
226
+ static get accidentalMap(): Record<string, {
227
+ code: string;
228
+ parenRightPaddingAdjustment: number;
229
+ }>;
230
+ static get unicode(): Record<string, string>;
231
+ static keySignature(spec: string): {
232
+ type: string;
233
+ line: number;
234
+ }[];
235
+ static hasKeySignature(spec: string): boolean;
236
+ static getKeySignatures(): Record<string, {
237
+ acc?: string;
238
+ num: number;
239
+ }>;
240
+ static clefProperties(clef: string): {
241
+ line_shift: number;
242
+ };
243
+ static keyProperties(key: string, clef?: string, params?: any): any;
244
+ static durationToTicks(duration: string): number;
245
+ }
@@ -0,0 +1,181 @@
1
+ export interface FontInfo {
2
+ /** CSS font-family, e.g., 'Arial', 'Helvetica Neue, Arial, sans-serif', 'Times, serif' */
3
+ family?: string;
4
+ /**
5
+ * CSS font-size (e.g., '10pt', '12px').
6
+ * For backwards compatibility with 3.0.9, plain numbers are assumed to be specified in 'pt'.
7
+ */
8
+ size?: number | string;
9
+ /** `bold` or a number (e.g., 900) as inspired by CSS font-weight. */
10
+ weight?: string | number;
11
+ /** `italic` as inspired by CSS font-style. */
12
+ style?: string;
13
+ }
14
+ export declare type FontModule = {
15
+ data: FontData;
16
+ metrics: FontMetrics;
17
+ };
18
+ export interface FontData {
19
+ glyphs: Record<string, FontGlyph>;
20
+ fontFamily?: string;
21
+ resolution: number;
22
+ generatedOn?: string;
23
+ }
24
+ /** Specified in the `xxx_metrics.ts` files. */
25
+ export interface FontMetrics extends Record<string, any> {
26
+ name: string;
27
+ smufl: boolean;
28
+ stave?: Record<string, number>;
29
+ accidental?: Record<string, number>;
30
+ clef?: Record<string, any>;
31
+ pedalMarking?: Record<string, Record<string, number>>;
32
+ digits?: Record<string, number>;
33
+ articulation?: Record<string, Record<string, number>>;
34
+ tremolo?: Record<string, Record<string, number>>;
35
+ noteHead?: Record<string, Record<string, number>>;
36
+ glyphs: Record<string, Record<string, any>>;
37
+ }
38
+ export interface FontGlyph {
39
+ x_min: number;
40
+ x_max: number;
41
+ y_min?: number;
42
+ y_max?: number;
43
+ ha: number;
44
+ leftSideBearing?: number;
45
+ advanceWidth?: number;
46
+ o?: string;
47
+ cached_outline?: number[];
48
+ }
49
+ export declare enum FontWeight {
50
+ NORMAL = "normal",
51
+ BOLD = "bold"
52
+ }
53
+ export declare enum FontStyle {
54
+ NORMAL = "normal",
55
+ ITALIC = "italic"
56
+ }
57
+ export declare class Font {
58
+ /** Default sans-serif font family. */
59
+ static SANS_SERIF: string;
60
+ /** Default serif font family. */
61
+ static SERIF: string;
62
+ /** Default font size in `pt`. */
63
+ static SIZE: number;
64
+ /** Given a length (for units: pt, px, em, %, in, mm, cm) what is the scale factor to convert it to px? */
65
+ static scaleToPxFrom: Record<string, number>;
66
+ /**
67
+ * @param fontSize a font size to convert. Can be specified as a CSS length string (e.g., '16pt', '1em')
68
+ * or as a number (the unit is assumed to be 'pt'). See `Font.scaleToPxFrom` for the supported
69
+ * units (e.g., pt, em, %).
70
+ * @returns the number of pixels that is equivalent to `fontSize`
71
+ */
72
+ static convertSizeToPixelValue(fontSize?: string | number): number;
73
+ /**
74
+ * @param fontSize a font size to convert. Can be specified as a CSS length string (e.g., '16pt', '1em')
75
+ * or as a number (the unit is assumed to be 'pt'). See `Font.scaleToPxFrom` for the supported
76
+ * units (e.g., pt, em, %).
77
+ * @returns the number of points that is equivalent to `fontSize`
78
+ */
79
+ static convertSizeToPointValue(fontSize?: string | number): number;
80
+ /**
81
+ * @param f
82
+ * @param size
83
+ * @param weight
84
+ * @param style
85
+ * @returns the `size` field will include the units (e.g., '12pt', '16px').
86
+ */
87
+ static validate(f?: string | FontInfo, size?: string | number, weight?: string | number, style?: string): Required<FontInfo>;
88
+ /**
89
+ * @param cssFontShorthand a string formatted as CSS font shorthand (e.g., 'italic bold 15pt Arial').
90
+ */
91
+ static fromCSSString(cssFontShorthand: string): Required<FontInfo>;
92
+ /**
93
+ * @returns a CSS font shorthand string of the form `italic bold 16pt Arial`.
94
+ */
95
+ static toCSSString(fontInfo?: FontInfo): string;
96
+ /**
97
+ * @param fontSize a number representing a font size, or a string font size with units.
98
+ * @param scaleFactor multiply the size by this factor.
99
+ * @returns size * scaleFactor (e.g., 16pt * 3 = 48pt, 8px * 0.5 = 4px, 24 * 2 = 48).
100
+ * If the fontSize argument was a number, the return value will be a number.
101
+ * If the fontSize argument was a string, the return value will be a string.
102
+ */
103
+ static scaleSize<T extends number | string>(fontSize: T, scaleFactor: number): T;
104
+ /**
105
+ * @param weight a string (e.g., 'bold') or a number (e.g., 600 / semi-bold in the OpenType spec).
106
+ * @returns true if the font weight indicates bold.
107
+ */
108
+ static isBold(weight?: string | number): boolean;
109
+ /**
110
+ * @param style
111
+ * @returns true if the font style indicates 'italic'.
112
+ */
113
+ static isItalic(style?: string): boolean;
114
+ /**
115
+ * Customize this field to specify a different CDN for delivering web fonts.
116
+ * Alternative: https://cdn.jsdelivr.net/npm/vexflow-fonts@1.0.3/
117
+ * Or you can use your own host.
118
+ */
119
+ static WEB_FONT_HOST: string;
120
+ /**
121
+ * These font files will be loaded from the CDN specified by `Font.WEB_FONT_HOST` when
122
+ * `await Font.loadWebFonts()` is called. Customize this field to specify a different
123
+ * set of fonts to load. See: `Font.loadWebFonts()`.
124
+ */
125
+ static WEB_FONT_FILES: Record<string, string>;
126
+ /**
127
+ * @param fontName
128
+ * @param woffURL The absolute or relative URL to the woff file.
129
+ * @param includeWoff2 If true, we assume that a woff2 file is in
130
+ * the same folder as the woff file, and will append a `2` to the url.
131
+ */
132
+ static loadWebFont(fontName: string, woffURL: string, includeWoff2?: boolean): Promise<FontFace>;
133
+ /**
134
+ * Load the web fonts that are used by ChordSymbol. For example, `flow.html` calls:
135
+ * `await Vex.Flow.Font.loadWebFonts();`
136
+ * Alternatively, you may load web fonts with a stylesheet link (e.g., from Google Fonts),
137
+ * and a @font-face { font-family: ... } rule in your CSS.
138
+ * If you do not load either of these fonts, ChordSymbol will fall back to Times or Arial,
139
+ * depending on the current music engraving font.
140
+ *
141
+ * You can customize `Font.WEB_FONT_HOST` and `Font.WEB_FONT_FILES` to load different fonts
142
+ * for your app.
143
+ */
144
+ static loadWebFonts(): Promise<void>;
145
+ static loadTextFonts(): void;
146
+ /**
147
+ * @param fontName
148
+ * @param data optionally set the Font object's `.data` property.
149
+ * This is usually done when setting up a font for the first time.
150
+ * @param metrics optionally set the Font object's `.metrics` property.
151
+ * This is usually done when setting up a font for the first time.
152
+ * @returns a Font object with the given `fontName`.
153
+ * Reuse an existing Font object if a matching one is found.
154
+ */
155
+ static load(fontName: string, data?: FontData, metrics?: FontMetrics): Font;
156
+ protected name: string;
157
+ protected data?: FontData;
158
+ protected metrics?: FontMetrics;
159
+ /**
160
+ * Use `Font.load(fontName)` to get a Font object.
161
+ * Do not call this constructor directly.
162
+ */
163
+ private constructor();
164
+ getName(): string;
165
+ getData(): FontData;
166
+ getMetrics(): FontMetrics;
167
+ setData(data: FontData): void;
168
+ setMetrics(metrics: FontMetrics): void;
169
+ hasData(): boolean;
170
+ getResolution(): number;
171
+ getGlyphs(): Record<string, FontGlyph>;
172
+ /**
173
+ * Use the provided key to look up a value in this font's metrics file (e.g., bravura_metrics.ts, petaluma_metrics.ts).
174
+ * @param key is a string separated by periods (e.g., stave.endPaddingMax, clef.lineCount.'5'.shiftY).
175
+ * @param defaultValue is returned if the lookup fails.
176
+ * @returns the retrieved value (or `defaultValue` if the lookup fails).
177
+ */
178
+ lookupMetric(key: string, defaultValue?: Record<string, any> | number): any;
179
+ /** For debugging. */
180
+ toString(): string;
181
+ }