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,131 @@
1
+ import { FontInfo } from './font';
2
+ import { GroupAttributes, RenderContext, TextMeasure } from './rendercontext';
3
+ export declare type Attributes = Record<string, any>;
4
+ export interface State {
5
+ state: Attributes;
6
+ attributes: Attributes;
7
+ shadow_attributes: Attributes;
8
+ lineWidth: number;
9
+ }
10
+ declare class MeasureTextCache {
11
+ protected txt?: SVGTextElement;
12
+ protected cache: Record<string, Record<string, TextMeasure>>;
13
+ lookup(text: string, svg: SVGSVGElement, attributes: Attributes): TextMeasure;
14
+ measureImpl(text: string, svg: SVGSVGElement, attributes: Attributes): TextMeasure;
15
+ }
16
+ /**
17
+ * SVG rendering context with an API similar to CanvasRenderingContext2D.
18
+ */
19
+ export declare class SVGContext extends RenderContext {
20
+ protected static measureTextCache: MeasureTextCache;
21
+ element: HTMLElement;
22
+ svg: SVGSVGElement;
23
+ width: number;
24
+ height: number;
25
+ path: string;
26
+ pen: {
27
+ x: number;
28
+ y: number;
29
+ };
30
+ lineWidth: number;
31
+ attributes: Attributes;
32
+ shadow_attributes: Attributes;
33
+ state: Attributes;
34
+ state_stack: State[];
35
+ parent: SVGGElement;
36
+ groups: SVGGElement[];
37
+ backgroundFillStyle: string;
38
+ /** Formatted as CSS font shorthand (e.g., 'italic bold 12pt Arial') */
39
+ protected fontCSSString: string;
40
+ constructor(element: HTMLElement);
41
+ /**
42
+ * Use one of the overload signatures to create an SVG element of a specific type.
43
+ * The last overload accepts an arbitrary string, and is identical to the
44
+ * implementation signature.
45
+ * Feel free to add new overloads for other SVG element types as required.
46
+ */
47
+ create(svgElementType: 'g'): SVGGElement;
48
+ create(svgElementType: 'path'): SVGPathElement;
49
+ create(svgElementType: 'rect'): SVGRectElement;
50
+ create(svgElementType: 'svg'): SVGSVGElement;
51
+ create(svgElementType: 'text'): SVGTextElement;
52
+ create(svgElementType: string): SVGElement;
53
+ openGroup(cls?: string, id?: string, attrs?: GroupAttributes): SVGGElement;
54
+ closeGroup(): void;
55
+ add(elem: SVGElement): void;
56
+ setFillStyle(style: string): this;
57
+ /**
58
+ * Used to set the fill color for `clearRect()`. This allows us to simulate
59
+ * cutting a "hole" into the SVG drawing.
60
+ */
61
+ setBackgroundFillStyle(style: string): this;
62
+ setStrokeStyle(style: string): this;
63
+ setShadowColor(color: string): this;
64
+ /**
65
+ * @param blur A non-negative float specifying the level of shadow blur, where 0
66
+ * represents no blur and larger numbers represent increasingly more blur.
67
+ * @returns this
68
+ */
69
+ setShadowBlur(blur: number): this;
70
+ /**
71
+ * @param width
72
+ * @returns this
73
+ */
74
+ setLineWidth(width: number): this;
75
+ /**
76
+ * @param lineDash an array of integers in the form of [dash, space, dash, space, etc...]
77
+ * @returns this
78
+ *
79
+ * See: [SVG `stroke-dasharray` attribute](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray)
80
+ */
81
+ setLineDash(lineDash: number[]): this;
82
+ /**
83
+ * @param capType
84
+ * @returns this
85
+ */
86
+ setLineCap(capType: CanvasLineCap): this;
87
+ resize(width: number, height: number): this;
88
+ scale(x: number, y: number): this;
89
+ /**
90
+ * 1 arg: string in the "x y w h" format
91
+ * 4 args: x:number, y:number, w:number, h:number
92
+ */
93
+ setViewBox(viewBox_or_minX: string | number, minY?: number, width?: number, height?: number): void;
94
+ applyAttributes(element: SVGElement, attributes: Attributes): SVGElement;
95
+ clear(): void;
96
+ rect(x: number, y: number, width: number, height: number, attributes?: Attributes): this;
97
+ fillRect(x: number, y: number, width: number, height: number): this;
98
+ clearRect(x: number, y: number, width: number, height: number): this;
99
+ beginPath(): this;
100
+ moveTo(x: number, y: number): this;
101
+ lineTo(x: number, y: number): this;
102
+ bezierCurveTo(x1: number, y1: number, x2: number, y2: number, x: number, y: number): this;
103
+ quadraticCurveTo(x1: number, y1: number, x: number, y: number): this;
104
+ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, counterclockwise: boolean): this;
105
+ closePath(): this;
106
+ private getShadowStyle;
107
+ fill(attributes?: Attributes): this;
108
+ stroke(): this;
109
+ measureText(text: string): TextMeasure;
110
+ fillText(text: string, x: number, y: number): this;
111
+ save(): this;
112
+ restore(): this;
113
+ set fillStyle(style: string | CanvasGradient | CanvasPattern);
114
+ get fillStyle(): string | CanvasGradient | CanvasPattern;
115
+ set strokeStyle(style: string | CanvasGradient | CanvasPattern);
116
+ get strokeStyle(): string | CanvasGradient | CanvasPattern;
117
+ /**
118
+ * @param f is 1) a `FontInfo` object or
119
+ * 2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
120
+ * 3) a string representing the font family (one of `size`, `weight`, or `style` must also be provided).
121
+ * @param size a string specifying the font size and unit (e.g., '16pt'), or a number (the unit is assumed to be 'pt').
122
+ * @param weight is a string (e.g., 'bold', 'normal') or a number (100, 200, ... 900). It is inserted
123
+ * into the font-weight attribute (e.g., font-weight="bold")
124
+ * @param style is a string (e.g., 'italic', 'normal') that is inserted into the
125
+ * font-style attribute (e.g., font-style="italic")
126
+ */
127
+ setFont(f?: string | FontInfo, size?: string | number, weight?: string | number, style?: string): this;
128
+ /** Return a string of the form `'italic bold 15pt Arial'` */
129
+ getFont(): string;
130
+ }
131
+ export {};
@@ -0,0 +1,92 @@
1
+ import { Element } from './element';
2
+ import { Factory } from './factory';
3
+ import { FormatParams, Formatter, FormatterOptions } from './formatter';
4
+ import { RenderContext } from './rendercontext';
5
+ import { Stave, StaveOptions } from './stave';
6
+ import { StaveConnector } from './staveconnector';
7
+ import { Voice } from './voice';
8
+ export interface SystemFormatterOptions extends FormatterOptions {
9
+ alpha?: number;
10
+ }
11
+ export interface SystemStave {
12
+ voices: Voice[];
13
+ stave?: Stave;
14
+ noJustification?: boolean;
15
+ options?: StaveOptions;
16
+ spaceAbove?: number;
17
+ spaceBelow?: number;
18
+ debugNoteMetrics?: boolean;
19
+ }
20
+ /**
21
+ * Formatting for systems created/drawn from factory:
22
+ *
23
+ * If width is provided, the system will use the specified width.
24
+ *
25
+ * If noJustification flag is 'true', there is no justification between voices
26
+ * Otherwise, autoWidth defaults to true.
27
+ *
28
+ * If autowidth is true, the system uses format.preCalculateMinWidth
29
+ * for the width of all voices, and default stave padding
30
+ */
31
+ export interface SystemOptions {
32
+ factory?: Factory;
33
+ noPadding?: boolean;
34
+ debugFormatter?: boolean;
35
+ spaceBetweenStaves?: number;
36
+ formatIterations?: number;
37
+ autoWidth?: boolean;
38
+ x?: number;
39
+ width?: number;
40
+ y?: number;
41
+ details?: SystemFormatterOptions;
42
+ formatOptions?: FormatParams;
43
+ noJustification?: boolean;
44
+ }
45
+ /**
46
+ * System implements a musical system, which is a collection of staves,
47
+ * each which can have one or more voices. All voices across all staves in
48
+ * the system are formatted together.
49
+ */
50
+ export declare class System extends Element {
51
+ static get CATEGORY(): string;
52
+ protected options: Required<SystemOptions>;
53
+ protected factory: Factory;
54
+ protected formatter?: Formatter;
55
+ protected startX?: number;
56
+ protected lastY?: number;
57
+ protected parts: Required<SystemStave>[];
58
+ protected connector?: StaveConnector;
59
+ protected debugNoteMetricsYs?: {
60
+ y: number;
61
+ voice: Voice;
62
+ }[];
63
+ constructor(params?: SystemOptions);
64
+ /** Set formatting options. */
65
+ setOptions(options?: SystemOptions): void;
66
+ /** Set associated context. */
67
+ setContext(context: RenderContext): this;
68
+ /**
69
+ * Add connector between staves.
70
+ * @param type see {@link StaveConnector.typeString}
71
+ */
72
+ addConnector(type?: string): StaveConnector;
73
+ /**
74
+ * Add a stave to the system.
75
+ *
76
+ * Example (one voice):
77
+ *
78
+ * `system.addStave({voices: [score.voice(score.notes('C#5/q, B4, A4, G#4'))]});`
79
+ *
80
+ * Example (two voices):
81
+ *
82
+ * `system.addStave({voices: [`
83
+ * `score.voice(score.notes('C#5/q, B4, A4, G#4', {stem: 'up'})),`
84
+ * `score.voice(score.notes('C#4/h, C#4', {stem: 'down'}))`
85
+ * `]});`
86
+ */
87
+ addStave(params: SystemStave): Stave;
88
+ /** Format the system. */
89
+ format(): void;
90
+ /** Render the system. */
91
+ draw(): void;
92
+ }
@@ -0,0 +1,96 @@
1
+ import { ArticulationStruct } from './articulation';
2
+ import { Font } from './font';
3
+ import { Fraction } from './fraction';
4
+ export declare class Tables {
5
+ static STEM_WIDTH: number;
6
+ static STEM_HEIGHT: number;
7
+ static STAVE_LINE_THICKNESS: number;
8
+ static RESOLUTION: number;
9
+ /**
10
+ * Customize this by calling Flow.setMusicFont(...fontNames);
11
+ */
12
+ static MUSIC_FONT_STACK: Font[];
13
+ /**
14
+ * @returns the `Font` object at the head of the music font stack.
15
+ */
16
+ static currentMusicFont(): Font;
17
+ static NOTATION_FONT_SCALE: number;
18
+ static TABLATURE_FONT_SCALE: number;
19
+ static SLASH_NOTEHEAD_WIDTH: number;
20
+ static STAVE_LINE_DISTANCE: number;
21
+ static TEXT_HEIGHT_OFFSET_HACK: number;
22
+ static clefProperties(clef: string): {
23
+ line_shift: number;
24
+ };
25
+ /**
26
+ * @param keyOctaveGlyph a string in the format "key/octave" (e.g., "c/5") or "key/octave/custom-note-head-code" (e.g., "g/5/t3").
27
+ * @param clef
28
+ * @param params a struct with one option, `octave_shift` for clef ottavation (0 = default; 1 = 8va; -1 = 8vb, etc.).
29
+ * @returns properties for the specified note.
30
+ */
31
+ static keyProperties(keyOctaveGlyph: string, clef?: string, params?: {
32
+ octave_shift?: number;
33
+ }): any;
34
+ static integerToNote(integer?: number): string;
35
+ static tabToGlyph(fret: string, scale?: number): {
36
+ text: string;
37
+ code?: string;
38
+ getWidth: () => number;
39
+ shift_y: number;
40
+ };
41
+ static textWidth(text: string): number;
42
+ static articulationCodes(artic: string): ArticulationStruct;
43
+ static accidentalMap: Record<string, {
44
+ code: string;
45
+ parenRightPaddingAdjustment: number;
46
+ }>;
47
+ static accidentalCodes(acc: string): {
48
+ code: string;
49
+ parenRightPaddingAdjustment: number;
50
+ };
51
+ static accidentalColumnsTable: Record<number, {
52
+ [name: string]: number[];
53
+ }>;
54
+ static ornamentCodes(acc: string): {
55
+ code: string;
56
+ };
57
+ static keySignature(spec: string): {
58
+ type: string;
59
+ line: number;
60
+ }[];
61
+ static getKeySignatures(): Record<string, {
62
+ acc?: string;
63
+ num: number;
64
+ }>;
65
+ static hasKeySignature(spec: string): boolean;
66
+ static unicode: {
67
+ sharp: string;
68
+ flat: string;
69
+ natural: string;
70
+ triangle: string;
71
+ 'o-with-slash': string;
72
+ degrees: string;
73
+ circle: string;
74
+ };
75
+ /**
76
+ * Convert duration aliases to the number based duration.
77
+ * If the input isn't an alias, simply return the input.
78
+ * @param duration
79
+ * @returns Example: 'q' -> '4', '8' -> '8'
80
+ */
81
+ static sanitizeDuration(duration: string): string;
82
+ /** Convert the `duration` to a fraction. */
83
+ static durationToFraction(duration: string): Fraction;
84
+ /** Convert the `duration` to a number. */
85
+ static durationToNumber(duration: string): number;
86
+ static durationToTicks(duration: string): number;
87
+ static getGlyphProps(duration: string, type?: string): any | undefined;
88
+ static validTypes: Record<string, {
89
+ name: string;
90
+ }>;
91
+ static TIME4_4: {
92
+ num_beats: number;
93
+ beat_value: number;
94
+ resolution: number;
95
+ };
96
+ }
@@ -0,0 +1,44 @@
1
+ import { GlyphProps } from './glyph';
2
+ import { Stave } from './stave';
3
+ import { StaveNoteStruct } from './stavenote';
4
+ import { StemmableNote } from './stemmablenote';
5
+ export interface TabNotePosition {
6
+ str: number;
7
+ fret: number | string;
8
+ }
9
+ export interface TabNoteStruct extends StaveNoteStruct {
10
+ positions: TabNotePosition[];
11
+ }
12
+ export declare class TabNote extends StemmableNote {
13
+ static get CATEGORY(): string;
14
+ protected ghost: boolean;
15
+ protected glyphs: GlyphProps[];
16
+ protected positions: TabNotePosition[];
17
+ constructor(noteStruct: TabNoteStruct, draw_stem?: boolean);
18
+ greatestString: () => number;
19
+ leastString: () => number;
20
+ reset(): this;
21
+ setGhost(ghost: boolean): this;
22
+ hasStem(): boolean;
23
+ getStemExtension(): number;
24
+ updateWidth(): void;
25
+ setStave(stave: Stave): this;
26
+ getPositions(): TabNotePosition[];
27
+ getModifierStartXY(position: number, index: number): {
28
+ x: number;
29
+ y: number;
30
+ };
31
+ getLineForRest(): number;
32
+ preFormat(): void;
33
+ getStemX(): number;
34
+ getStemY(): number;
35
+ getStemExtents(): {
36
+ topY: number;
37
+ baseY: number;
38
+ };
39
+ drawFlag(): void;
40
+ drawModifiers(): void;
41
+ drawStemThrough(): void;
42
+ drawPositions(): void;
43
+ draw(): void;
44
+ }
@@ -0,0 +1,34 @@
1
+ import { FontInfo } from './font';
2
+ import { TieNotes } from './stavetie';
3
+ import { TabTie } from './tabtie';
4
+ export declare class TabSlide extends TabTie {
5
+ static get CATEGORY(): string;
6
+ static TEXT_FONT: Required<FontInfo>;
7
+ static get SLIDE_UP(): number;
8
+ static get SLIDE_DOWN(): number;
9
+ static createSlideUp(notes: TieNotes): TabSlide;
10
+ static createSlideDown(notes: TieNotes): TabSlide;
11
+ /**
12
+ * @param notes is a struct of the form:
13
+ * {
14
+ * first_note: Note,
15
+ * last_note: Note,
16
+ * first_indices: [n1, n2, n3],
17
+ * last_indices: [n1, n2, n3]
18
+ * }
19
+ * @param notes.first_note the starting note of the slide
20
+ * @param notes.last_note the ending note of the slide
21
+ * @param notes.first_indices specifies which string + fret positions of the TabNote are used in this slide. zero indexed.
22
+ * @param notes.last_indices currently unused. we assume it's the same as first_indices.
23
+ *
24
+ * @param direction TabSlide.SLIDE_UP or TabSlide.SLIDE_DOWN
25
+ */
26
+ constructor(notes: TieNotes, direction?: number);
27
+ renderTie(params: {
28
+ direction: number;
29
+ first_x_px: number;
30
+ last_x_px: number;
31
+ last_ys: number[];
32
+ first_ys: number[];
33
+ }): void;
34
+ }
@@ -0,0 +1,7 @@
1
+ import { Stave, StaveOptions } from './stave';
2
+ export declare class TabStave extends Stave {
3
+ static get CATEGORY(): string;
4
+ constructor(x: number, y: number, width: number, options?: StaveOptions);
5
+ getYForGlyphs(): number;
6
+ addTabGlyph(): this;
7
+ }
@@ -0,0 +1,18 @@
1
+ import { StaveTie, TieNotes } from './stavetie';
2
+ export declare class TabTie extends StaveTie {
3
+ static get CATEGORY(): string;
4
+ static createHammeron(notes: TieNotes): TabTie;
5
+ static createPulloff(notes: TieNotes): TabTie;
6
+ /**
7
+ * @param notes is a struct that has:
8
+ * {
9
+ * first_note: Note,
10
+ * last_note: Note,
11
+ * first_indices: [n1, n2, n3],
12
+ * last_indices: [n1, n2, n3]
13
+ * }
14
+ *
15
+ * @param text
16
+ */
17
+ constructor(notes: TieNotes, text?: string);
18
+ }
@@ -0,0 +1,55 @@
1
+ import { Element } from './element';
2
+ import { FontInfo } from './font';
3
+ import { Note } from './note';
4
+ import { RenderContext } from './rendercontext';
5
+ export interface TextBracketParams {
6
+ start: Note;
7
+ stop: Note;
8
+ text?: string;
9
+ superscript?: string;
10
+ position?: number | string;
11
+ }
12
+ export declare enum TextBracketPosition {
13
+ TOP = 1,
14
+ BOTTOM = -1
15
+ }
16
+ export declare class TextBracket extends Element {
17
+ static DEBUG: boolean;
18
+ static get CATEGORY(): string;
19
+ static TEXT_FONT: Required<FontInfo>;
20
+ render_options: {
21
+ dashed: boolean;
22
+ color: string;
23
+ line_width: number;
24
+ underline_superscript: boolean;
25
+ show_bracket: boolean;
26
+ dash: number[];
27
+ bracket_height: number;
28
+ };
29
+ protected readonly text: string;
30
+ protected readonly superscript: string;
31
+ protected line: number;
32
+ readonly position: TextBracketPosition;
33
+ readonly start: Note;
34
+ readonly stop: Note;
35
+ static get Position(): typeof TextBracketPosition;
36
+ static get PositionString(): Record<string, number>;
37
+ /**
38
+ * @deprecated Use `TextBracket.Position` instead.
39
+ */
40
+ static get Positions(): typeof TextBracketPosition;
41
+ /**
42
+ * @deprecated Use `TextBracket.PositionString` instead.
43
+ */
44
+ static get PositionsString(): Record<string, number>;
45
+ constructor({ start, stop, text, superscript, position }: TextBracketParams);
46
+ /**
47
+ * Apply the text backet styling to the provided context.
48
+ * @param ctx
49
+ * @returns this
50
+ */
51
+ applyStyle(ctx: RenderContext): this;
52
+ setDashed(dashed: boolean, dash?: number[]): this;
53
+ setLine(line: number): this;
54
+ draw(): void;
55
+ }
@@ -0,0 +1,39 @@
1
+ import { Glyph } from './glyph';
2
+ import { Note } from './note';
3
+ import { TextNoteStruct } from './textnote';
4
+ /**
5
+ * `TextDynamics` renders traditional
6
+ * text dynamics markings, **ie: p, f, sfz, rfz, ppp**
7
+ *
8
+ * You can render any dynamics string that contains a combination of
9
+ * the following letters: P, M, F, Z, R, S
10
+ */
11
+ export declare class TextDynamics extends Note {
12
+ /** To enable logging for this class. Set `Vex.Flow.TextDynamics.DEBUG` to `true`. */
13
+ static DEBUG: boolean;
14
+ static get CATEGORY(): string;
15
+ protected sequence: string;
16
+ protected line: number;
17
+ protected glyphs: Glyph[];
18
+ /** The glyph data for each dynamics letter. */
19
+ static get GLYPHS(): Record<string, {
20
+ code: string;
21
+ width: number;
22
+ }>;
23
+ /**
24
+ * Create the dynamics marking.
25
+ *
26
+ * A `TextDynamics` object inherits from `Note` so that it can be formatted
27
+ * within a `Voice`.
28
+ *
29
+ * @param noteStruct an object that contains a `duration` property and a
30
+ * `sequence` of letters that represents the letters to render.
31
+ */
32
+ constructor(noteStruct: TextNoteStruct);
33
+ /** Set the Stave line on which the note should be placed. */
34
+ setLine(line: number): this;
35
+ /** Preformat the dynamics text. */
36
+ preFormat(): this;
37
+ /** Draw the dynamics text on the rendering context. */
38
+ draw(): void;
39
+ }
@@ -0,0 +1,109 @@
1
+ import { FontGlyph, FontInfo } from './font';
2
+ export interface TextFormatterInfo extends Record<string, unknown> {
3
+ family: string;
4
+ resolution?: number;
5
+ glyphs?: Record<string, FontGlyph>;
6
+ serifs: boolean;
7
+ monospaced: boolean;
8
+ italic: boolean;
9
+ bold: boolean;
10
+ maxSizeGlyph?: string;
11
+ superscriptOffset?: number;
12
+ subscriptOffset?: number;
13
+ description: string;
14
+ }
15
+ export declare class TextFormatter {
16
+ /** To enable logging for this class. Set `Vex.Flow.TextFormatter.DEBUG` to `true`. */
17
+ static DEBUG: boolean;
18
+ /**
19
+ * Return all registered font families.
20
+ */
21
+ static getFontFamilies(): TextFormatterInfo[];
22
+ /**
23
+ * Call `TextFormatter.registerInfo(info)` to register font information before using this method.
24
+ *
25
+ * This method creates a formatter for the font that most closely matches the requested font.
26
+ * We compare font family, bold, and italic attributes.
27
+ * This method will return a fallback formatter if there are no matches.
28
+ */
29
+ static create(requestedFont?: FontInfo): TextFormatter;
30
+ /**
31
+ * @param fontFamily used as a key to the font registry.
32
+ * @returns the same info object that was passed in via `TextFormatter.registerInfo(info)`
33
+ */
34
+ static getInfo(fontFamily: string): TextFormatterInfo | undefined;
35
+ /**
36
+ * Apps may register their own fonts and metrics, and those metrics
37
+ * will be available to the app for formatting.
38
+ *
39
+ * Metrics can be generated from a font file using fontgen_text.js in the tools/fonts directory.
40
+ * @param info
41
+ * @param overwrite
42
+ */
43
+ static registerInfo(info: TextFormatterInfo, overwrite?: boolean): void;
44
+ /** Font family. */
45
+ protected family: string;
46
+ /** Specified in `pt` units. */
47
+ protected size: number;
48
+ /** Font metrics are extracted at 1000 upem (units per em). */
49
+ protected resolution: number;
50
+ /**
51
+ * For text formatting, we do not require glyph outlines, but instead rely on glyph
52
+ * bounding box metrics such as:
53
+ * ```
54
+ * {
55
+ * x_min: 48,
56
+ * x_max: 235,
57
+ * y_min: -17,
58
+ * y_max: 734,
59
+ * ha: 751,
60
+ * leftSideBearing: 48,
61
+ * advanceWidth: 286,
62
+ * }
63
+ * ```
64
+ */
65
+ protected glyphs: Record<string, FontGlyph>;
66
+ protected description?: string;
67
+ protected serifs: boolean;
68
+ protected monospaced: boolean;
69
+ protected italic: boolean;
70
+ protected bold: boolean;
71
+ protected superscriptOffset: number;
72
+ protected subscriptOffset: number;
73
+ protected maxSizeGlyph: string;
74
+ protected cacheKey: string;
75
+ /**
76
+ * Use `TextFormatter.create(...)` to build an instance from information previously
77
+ * registered via `TextFormatter.registerInfo(info)`.
78
+ */
79
+ private constructor();
80
+ updateParams(params: TextFormatterInfo): void;
81
+ /** Create a hash with the current font data, so we can cache computed widths. */
82
+ updateCacheKey(): void;
83
+ /**
84
+ * The glyphs table is indexed by the character (e.g., 'C', '@').
85
+ * See: robotoslab_glyphs.ts & petalumascript_glyphs.ts.
86
+ */
87
+ getGlyphMetrics(character: string): FontGlyph;
88
+ get maxHeight(): number;
89
+ /**
90
+ * Retrieve the character's advanceWidth as a fraction of an `em` unit.
91
+ * For the space character ' ' as defined in the:
92
+ * petalumascript_glyphs.ts: 250 advanceWidth in the 1000 unitsPerEm font returns 0.25.
93
+ * robotoslab_glyphs.ts: 509 advanceWidth in the 2048 unitsPerEm font returns 0.2485.
94
+ */
95
+ getWidthForCharacterInEm(c: string): number;
96
+ /**
97
+ * Retrieve the total width of `text` in `em` units.
98
+ */
99
+ getWidthForTextInEm(text: string): number;
100
+ /** The width of the text (in `em`) is scaled by the font size (in `px`). */
101
+ getWidthForTextInPx(text: string): number;
102
+ /**
103
+ * @param size in pt.
104
+ */
105
+ setFontSize(size: number): this;
106
+ /** `this.size` is specified in points. Convert to pixels. */
107
+ get fontSizeInPixels(): number;
108
+ getResolution(): number;
109
+ }
@@ -0,0 +1,49 @@
1
+ import { FontInfo } from './font';
2
+ import { Note, NoteStruct } from './note';
3
+ export declare enum TextJustification {
4
+ LEFT = 1,
5
+ CENTER = 2,
6
+ RIGHT = 3
7
+ }
8
+ export interface TextNoteStruct extends NoteStruct {
9
+ text?: string;
10
+ glyph?: string;
11
+ ignore_ticks?: boolean;
12
+ smooth?: boolean;
13
+ font?: FontInfo;
14
+ subscript?: string;
15
+ superscript?: string;
16
+ }
17
+ /**
18
+ * `TextNote` is a notation element that is positioned in time. Generally
19
+ * meant for objects that sit above/below the staff and inline with each other.
20
+ * `TextNote` has to be assigned to a `Stave` before rendering by means of `setStave`.
21
+ * Examples of this would be such as dynamics, lyrics, chord changes, etc.
22
+ */
23
+ export declare class TextNote extends Note {
24
+ static get CATEGORY(): string;
25
+ static TEXT_FONT: Required<FontInfo>;
26
+ static readonly Justification: typeof TextJustification;
27
+ /** Glyph data. */
28
+ static get GLYPHS(): Record<string, {
29
+ code: string;
30
+ }>;
31
+ protected text: string;
32
+ protected superscript?: string;
33
+ protected subscript?: string;
34
+ protected smooth: boolean;
35
+ protected justification: TextJustification;
36
+ protected line: number;
37
+ constructor(noteStruct: TextNoteStruct);
38
+ /** Set the horizontal justification of the TextNote. */
39
+ setJustification(just: TextJustification): this;
40
+ /** Set the Stave line on which the note should be placed. */
41
+ setLine(line: number): this;
42
+ /** Pre-render formatting. */
43
+ preFormat(): void;
44
+ /**
45
+ * Renders the TextNote.
46
+ * `TextNote` has to be assigned to a `Stave` before rendering by means of `setStave`.
47
+ */
48
+ draw(): void;
49
+ }