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.
- package/README.md +48 -65
- package/build/cjs/vexflow-bravura.js +2 -2
- package/build/cjs/vexflow-bravura.js.map +1 -1
- package/build/cjs/vexflow-core.js +2 -2
- package/build/cjs/vexflow-core.js.map +1 -1
- package/build/cjs/vexflow-debug-with-tests.js +724 -697
- package/build/cjs/vexflow-debug-with-tests.js.map +1 -1
- package/build/cjs/vexflow-debug.js +550 -610
- package/build/cjs/vexflow-debug.js.map +1 -1
- package/build/cjs/vexflow-font-gonville.js +1 -1
- package/build/cjs/vexflow-font-gonville.js.map +1 -1
- package/build/cjs/vexflow-gonville.js +2 -2
- package/build/cjs/vexflow-gonville.js.map +1 -1
- package/build/cjs/vexflow-petaluma.js +2 -2
- package/build/cjs/vexflow-petaluma.js.map +1 -1
- package/build/cjs/vexflow.js +2 -2
- package/build/cjs/vexflow.js.map +1 -1
- package/build/esm/entry/vexflow-bravura.js +10 -0
- package/build/esm/entry/vexflow-core.js +53 -0
- package/build/esm/entry/vexflow-debug-with-tests.js +11 -0
- package/build/esm/entry/vexflow-debug.js +8 -0
- package/build/esm/entry/vexflow-font-bravura.js +7 -0
- package/build/esm/entry/vexflow-font-custom.js +7 -0
- package/build/esm/entry/vexflow-font-gonville.js +7 -0
- package/build/esm/entry/vexflow-font-petaluma.js +7 -0
- package/build/esm/entry/vexflow-gonville.js +10 -0
- package/build/esm/entry/vexflow-petaluma.js +10 -0
- package/build/esm/entry/vexflow.js +8 -0
- package/build/esm/src/accidental.js +348 -0
- package/build/esm/src/annotation.js +238 -0
- package/build/esm/src/articulation.js +267 -0
- package/build/esm/src/barnote.js +58 -0
- package/build/esm/src/beam.js +644 -0
- package/build/esm/src/bend.js +202 -0
- package/build/esm/src/boundingbox.js +59 -0
- package/build/esm/src/boundingboxcomputation.js +107 -0
- package/build/esm/src/canvascontext.js +202 -0
- package/build/esm/src/chordsymbol.js +578 -0
- package/build/esm/src/clef.js +153 -0
- package/build/esm/src/clefnote.js +65 -0
- package/build/esm/src/crescendo.js +77 -0
- package/build/esm/src/curve.js +118 -0
- package/build/esm/src/dot.js +137 -0
- package/build/esm/src/easyscore.js +374 -0
- package/build/esm/src/element.js +216 -0
- package/build/esm/src/factory.js +445 -0
- package/build/esm/src/flow.js +288 -0
- package/build/esm/src/font.js +262 -0
- package/build/esm/src/fonts/bravura_glyphs.js +3239 -0
- package/build/esm/src/fonts/bravura_metrics.js +507 -0
- package/build/esm/src/fonts/custom_glyphs.js +78 -0
- package/build/esm/src/fonts/custom_metrics.js +5 -0
- package/build/esm/src/fonts/gonville_glyphs.js +828 -0
- package/build/esm/src/fonts/gonville_metrics.js +421 -0
- package/build/esm/src/fonts/load_all.js +10 -0
- package/build/esm/src/fonts/load_bravura.js +6 -0
- package/build/esm/src/fonts/load_custom.js +6 -0
- package/build/esm/src/fonts/load_gonville.js +6 -0
- package/build/esm/src/fonts/load_petaluma.js +6 -0
- package/build/esm/src/fonts/petaluma_glyphs.js +1335 -0
- package/build/esm/src/fonts/petaluma_metrics.js +536 -0
- package/build/esm/src/fonts/petalumascript_glyphs.js +863 -0
- package/build/esm/src/fonts/robotoslab_glyphs.js +863 -0
- package/build/esm/src/fonts/textfonts.js +44 -0
- package/build/esm/src/formatter.js +585 -0
- package/build/esm/src/fraction.js +171 -0
- package/build/esm/src/frethandfinger.js +156 -0
- package/build/esm/src/ghostnote.js +50 -0
- package/build/esm/src/glyph.js +337 -0
- package/build/esm/src/glyphnote.js +55 -0
- package/build/esm/src/gracenote.js +133 -0
- package/build/esm/src/gracenotegroup.js +128 -0
- package/build/esm/src/gracetabnote.js +12 -0
- package/build/esm/src/index.js +89 -0
- package/build/esm/src/keymanager.js +99 -0
- package/build/esm/src/keysignature.js +250 -0
- package/build/esm/src/keysignote.js +28 -0
- package/build/esm/src/modifier.js +128 -0
- package/build/esm/src/modifiercontext.js +110 -0
- package/build/esm/src/multimeasurerest.js +173 -0
- package/build/esm/src/music.js +322 -0
- package/build/esm/src/note.js +371 -0
- package/build/esm/src/notehead.js +169 -0
- package/build/esm/src/notesubgroup.js +59 -0
- package/build/esm/src/ornament.js +206 -0
- package/build/esm/src/parenthesis.js +76 -0
- package/build/esm/src/parser.js +164 -0
- package/build/esm/src/pedalmarking.js +192 -0
- package/build/esm/src/registry.js +81 -0
- package/build/esm/src/rendercontext.js +24 -0
- package/build/esm/src/renderer.js +112 -0
- package/build/esm/src/repeatnote.js +22 -0
- package/build/esm/src/stave.js +547 -0
- package/build/esm/src/stavebarline.js +182 -0
- package/build/esm/src/staveconnector.js +196 -0
- package/build/esm/src/stavehairpin.js +120 -0
- package/build/esm/src/staveline.js +215 -0
- package/build/esm/src/stavemodifier.js +77 -0
- package/build/esm/src/stavenote.js +860 -0
- package/build/esm/src/staverepetition.js +155 -0
- package/build/esm/src/stavesection.js +58 -0
- package/build/esm/src/stavetempo.js +91 -0
- package/build/esm/src/stavetext.js +82 -0
- package/build/esm/src/stavetie.js +141 -0
- package/build/esm/src/stavevolta.js +67 -0
- package/build/esm/src/stem.js +131 -0
- package/build/esm/src/stemmablenote.js +193 -0
- package/build/esm/src/stringnumber.js +231 -0
- package/build/esm/src/strokes.js +200 -0
- package/build/esm/src/svgcontext.js +414 -0
- package/build/esm/src/system.js +109 -0
- package/build/esm/src/tables.js +1102 -0
- package/build/esm/src/tabnote.js +299 -0
- package/build/esm/src/tabslide.js +76 -0
- package/build/esm/src/tabstave.js +17 -0
- package/build/esm/src/tabtie.js +19 -0
- package/build/esm/src/textbracket.js +144 -0
- package/build/esm/src/textdynamics.js +81 -0
- package/build/esm/src/textformatter.js +177 -0
- package/build/esm/src/textnote.js +174 -0
- package/build/esm/src/tickable.js +214 -0
- package/build/esm/src/tickcontext.js +170 -0
- package/build/esm/src/timesigglyph.js +85 -0
- package/build/esm/src/timesignature.js +89 -0
- package/build/esm/src/timesignote.js +32 -0
- package/build/esm/src/tremolo.js +47 -0
- package/build/esm/src/tuning.js +54 -0
- package/build/esm/src/tuplet.js +240 -0
- package/build/esm/src/typeguard.js +30 -0
- package/build/esm/src/util.js +58 -0
- package/build/esm/src/version.js +3 -3
- package/build/esm/src/vex.js +51 -0
- package/build/esm/src/vibrato.js +100 -0
- package/build/esm/src/vibratobracket.js +50 -0
- package/build/esm/src/voice.js +187 -0
- package/build/esm/src/web.js +15 -0
- package/build/esm/tests/accidental_tests.js +974 -0
- package/build/esm/tests/annotation_tests.js +390 -0
- package/build/esm/tests/articulation_tests.js +365 -0
- package/build/esm/tests/auto_beam_formatting_tests.js +548 -0
- package/build/esm/tests/bach_tests.js +335 -0
- package/build/esm/tests/barline_tests.js +52 -0
- package/build/esm/tests/beam_tests.js +614 -0
- package/build/esm/tests/bend_tests.js +215 -0
- package/build/esm/tests/boundingbox_tests.js +53 -0
- package/build/esm/tests/boundingboxcomputation_tests.js +183 -0
- package/build/esm/tests/chordsymbol_tests.js +320 -0
- package/build/esm/tests/clef_tests.js +131 -0
- package/build/esm/tests/curve_tests.js +118 -0
- package/build/esm/tests/dot_tests.js +123 -0
- package/build/esm/tests/easyscore_tests.js +462 -0
- package/build/esm/tests/factory_tests.js +44 -0
- package/build/esm/tests/font_tests.js +135 -0
- package/build/esm/tests/formatter/framestack.js +61 -0
- package/build/esm/tests/formatter/tests.js +203 -0
- package/build/esm/tests/formatter_tests.js +670 -0
- package/build/esm/tests/fraction_tests.js +72 -0
- package/build/esm/tests/ghostnote_tests.js +77 -0
- package/build/esm/tests/glyphnote_tests.js +113 -0
- package/build/esm/tests/gracenote_tests.js +413 -0
- package/build/esm/tests/gracetabnote_tests.js +79 -0
- package/build/esm/tests/index.js +68 -0
- package/build/esm/tests/key_clef_tests.js +103 -0
- package/build/esm/tests/keymanager_tests.js +68 -0
- package/build/esm/tests/keysignature_tests.js +308 -0
- package/build/esm/tests/mocks.js +71 -0
- package/build/esm/tests/modifier_tests.js +24 -0
- package/build/esm/tests/multimeasurerest_tests.js +141 -0
- package/build/esm/tests/music_tests.js +161 -0
- package/build/esm/tests/notehead_tests.js +137 -0
- package/build/esm/tests/notesubgroup_tests.js +149 -0
- package/build/esm/tests/offscreencanvas_tests.js +47 -0
- package/build/esm/tests/ornament_tests.js +298 -0
- package/build/esm/tests/parser_tests.js +122 -0
- package/build/esm/tests/pedalmarking_tests.js +64 -0
- package/build/esm/tests/percussion_tests.js +180 -0
- package/build/esm/tests/registry_tests.js +64 -0
- package/build/esm/tests/renderer_tests.js +113 -0
- package/build/esm/tests/rests_tests.js +248 -0
- package/build/esm/tests/rhythm_tests.js +357 -0
- package/build/esm/tests/stave_tests.js +560 -0
- package/build/esm/tests/staveconnector_tests.js +402 -0
- package/build/esm/tests/stavehairpin_tests.js +90 -0
- package/build/esm/tests/staveline_tests.js +122 -0
- package/build/esm/tests/stavemodifier_tests.js +51 -0
- package/build/esm/tests/stavenote_tests.js +867 -0
- package/build/esm/tests/stavetie_tests.js +108 -0
- package/build/esm/tests/stringnumber_tests.js +259 -0
- package/build/esm/tests/strokes_tests.js +275 -0
- package/build/esm/tests/style_tests.js +98 -0
- package/build/esm/tests/support/qunit.js +2765 -0
- package/build/esm/tests/tabnote_tests.js +474 -0
- package/build/esm/tests/tabslide_tests.js +135 -0
- package/build/esm/tests/tabstave_tests.js +23 -0
- package/build/esm/tests/tabtie_tests.js +173 -0
- package/build/esm/tests/textbracket_tests.js +100 -0
- package/build/esm/tests/textformatter_tests.js +24 -0
- package/build/esm/tests/textnote_tests.js +215 -0
- package/build/esm/tests/threevoice_tests.js +132 -0
- package/build/esm/tests/tickcontext_tests.js +36 -0
- package/build/esm/tests/timesignature_tests.js +134 -0
- package/build/esm/tests/tremolo_tests.js +75 -0
- package/build/esm/tests/tuning_tests.js +56 -0
- package/build/esm/tests/tuplet_tests.js +450 -0
- package/build/esm/tests/typeguard_tests.js +82 -0
- package/build/esm/tests/vexflow_test_helpers.js +266 -0
- package/build/esm/tests/vf_prefix_tests.js +115 -0
- package/build/esm/tests/vibrato_tests.js +92 -0
- package/build/esm/tests/vibratobracket_tests.js +45 -0
- package/build/esm/tests/voice_tests.js +69 -0
- package/build/types/entry/vexflow-bravura.d.ts +2 -0
- package/build/types/entry/vexflow-core.d.ts +2 -0
- package/build/types/entry/vexflow-debug.d.ts +2 -0
- package/build/types/entry/vexflow-font-bravura.d.ts +3771 -0
- package/build/types/entry/vexflow-font-custom.d.ts +86 -0
- package/build/types/entry/vexflow-font-gonville.d.ts +1267 -0
- package/build/types/entry/vexflow-font-petaluma.d.ts +1896 -0
- package/build/types/entry/vexflow-gonville.d.ts +2 -0
- package/build/types/entry/vexflow-petaluma.d.ts +2 -0
- package/build/types/entry/vexflow.d.ts +2 -0
- package/build/types/src/accidental.d.ts +66 -0
- package/build/types/src/annotation.d.ts +61 -0
- package/build/types/src/articulation.d.ts +62 -0
- package/build/types/src/barnote.d.ts +29 -0
- package/build/types/src/beam.d.ts +153 -0
- package/build/types/src/bend.d.ts +73 -0
- package/build/types/src/boundingbox.d.ts +42 -0
- package/build/types/src/boundingboxcomputation.d.ts +33 -0
- package/build/types/src/canvascontext.d.ts +89 -0
- package/build/types/src/chordsymbol.d.ts +149 -0
- package/build/types/src/clef.d.ts +48 -0
- package/build/types/src/clefnote.d.ts +25 -0
- package/build/types/src/crescendo.d.ts +27 -0
- package/build/types/src/curve.d.ts +41 -0
- package/build/types/src/dot.d.ts +20 -0
- package/build/types/src/easyscore.d.ts +152 -0
- package/build/types/src/element.d.ts +202 -0
- package/build/types/src/factory.d.ts +274 -0
- package/build/types/src/flow.d.ts +260 -0
- package/build/types/src/font.d.ts +180 -0
- package/build/types/src/fonts/bravura_glyphs.d.ts +3239 -0
- package/build/types/src/fonts/bravura_metrics.d.ts +533 -0
- package/build/types/src/fonts/custom_glyphs.d.ts +78 -0
- package/build/types/src/fonts/custom_metrics.d.ts +5 -0
- package/build/types/src/fonts/gonville_glyphs.d.ts +828 -0
- package/build/types/src/fonts/gonville_metrics.d.ts +440 -0
- package/build/types/src/fonts/load_all.d.ts +1 -0
- package/build/types/src/fonts/load_bravura.d.ts +1 -0
- package/build/types/src/fonts/load_custom.d.ts +1 -0
- package/build/types/src/fonts/load_gonville.d.ts +1 -0
- package/build/types/src/fonts/load_petaluma.d.ts +1 -0
- package/build/types/src/fonts/petaluma_glyphs.d.ts +1335 -0
- package/build/types/src/fonts/petaluma_metrics.d.ts +562 -0
- package/build/types/src/fonts/petalumascript_glyphs.d.ts +863 -0
- package/build/types/src/fonts/robotoslab_glyphs.d.ts +863 -0
- package/build/types/src/fonts/textfonts.d.ts +1 -0
- package/build/types/src/formatter.d.ts +203 -0
- package/build/types/src/fraction.d.ts +62 -0
- package/build/types/src/frethandfinger.d.ts +22 -0
- package/build/types/src/ghostnote.d.ts +16 -0
- package/build/types/src/glyph.d.ts +141 -0
- package/build/types/src/glyphnote.d.ts +17 -0
- package/build/types/src/gracenote.d.ts +19 -0
- package/build/types/src/gracenotegroup.d.ts +33 -0
- package/build/types/src/gracetabnote.d.ts +5 -0
- package/build/types/src/index.d.ts +89 -0
- package/build/types/src/keymanager.d.ts +25 -0
- package/build/types/src/keysignature.d.ts +50 -0
- package/build/types/src/keysignote.d.ts +11 -0
- package/build/types/src/modifier.d.ts +97 -0
- package/build/types/src/modifiercontext.d.ts +45 -0
- package/build/types/src/multimeasurerest.d.ts +61 -0
- package/build/types/src/music.d.ts +91 -0
- package/build/types/src/note.d.ts +232 -0
- package/build/types/src/notehead.d.ts +70 -0
- package/build/types/src/notesubgroup.d.ts +18 -0
- package/build/types/src/ornament.d.ts +76 -0
- package/build/types/src/parenthesis.d.ts +22 -0
- package/build/types/src/parser.d.ts +45 -0
- package/build/types/src/pedalmarking.d.ts +69 -0
- package/build/types/src/registry.d.ts +40 -0
- package/build/types/src/rendercontext.d.ts +64 -0
- package/build/types/src/renderer.d.ts +35 -0
- package/build/types/src/repeatnote.d.ts +6 -0
- package/build/types/src/stave.d.ts +186 -0
- package/build/types/src/stavebarline.d.ts +28 -0
- package/build/types/src/staveconnector.d.ts +67 -0
- package/build/types/src/stavehairpin.d.ts +56 -0
- package/build/types/src/staveline.d.ts +54 -0
- package/build/types/src/stavemodifier.d.ts +44 -0
- package/build/types/src/stavenote.d.ts +154 -0
- package/build/types/src/staverepetition.d.ts +32 -0
- package/build/types/src/stavesection.d.ts +15 -0
- package/build/types/src/stavetempo.d.ts +25 -0
- package/build/types/src/stavetext.d.ts +25 -0
- package/build/types/src/stavetie.d.ts +59 -0
- package/build/types/src/stavevolta.d.ts +21 -0
- package/build/types/src/stem.d.ts +58 -0
- package/build/types/src/stemmablenote.d.ts +39 -0
- package/build/types/src/stringnumber.d.ts +27 -0
- package/build/types/src/strokes.d.ts +33 -0
- package/build/types/src/svgcontext.d.ts +131 -0
- package/build/types/src/system.d.ts +92 -0
- package/build/types/src/tables.d.ts +96 -0
- package/build/types/src/tabnote.d.ts +44 -0
- package/build/types/src/tabslide.d.ts +34 -0
- package/build/types/src/tabstave.d.ts +7 -0
- package/build/types/src/tabtie.d.ts +18 -0
- package/build/types/src/textbracket.d.ts +55 -0
- package/build/types/src/textdynamics.d.ts +39 -0
- package/build/types/src/textformatter.d.ts +109 -0
- package/build/types/src/textnote.d.ts +49 -0
- package/build/types/src/tickable.d.ts +140 -0
- package/build/types/src/tickcontext.d.ts +82 -0
- package/build/types/src/timesigglyph.d.ts +14 -0
- package/build/types/src/timesignature.d.ts +26 -0
- package/build/types/src/timesignote.d.ts +11 -0
- package/build/types/src/tremolo.d.ts +17 -0
- package/build/types/src/tuning.d.ts +23 -0
- package/build/types/src/tuplet.d.ts +105 -0
- package/build/types/src/typeguard.d.ts +99 -0
- package/build/types/src/util.d.ts +27 -0
- package/build/types/src/version.d.ts +3 -0
- package/build/types/src/vex.d.ts +18 -0
- package/build/types/src/vibrato.d.ts +29 -0
- package/build/types/src/vibratobracket.d.ts +33 -0
- package/build/types/src/voice.d.ts +108 -0
- package/build/types/src/web.d.ts +2 -0
- package/entry/vexflow-bravura.ts +3 -3
- package/entry/vexflow-core.ts +3 -3
- package/entry/vexflow-debug-with-tests.ts +16 -2
- package/entry/vexflow-debug.ts +11 -3
- package/entry/vexflow-gonville.ts +3 -3
- package/entry/vexflow-petaluma.ts +3 -3
- package/entry/vexflow.ts +3 -3
- package/package.json +1 -1
- package/src/annotation.ts +38 -6
- package/src/articulation.ts +8 -2
- package/src/beam.ts +53 -6
- package/src/easyscore.ts +11 -1
- package/src/factory.ts +16 -2
- package/src/flow.ts +35 -20
- package/src/font.ts +0 -4
- package/src/fonts/gonville_glyphs.ts +4 -4
- package/src/formatter.ts +24 -8
- package/src/glyph.ts +8 -0
- package/src/index.ts +2 -7
- package/src/note.ts +2 -1
- package/src/staveline.ts +2 -5
- package/src/stavenote.ts +13 -9
- package/src/stavetext.ts +3 -3
- package/src/system.ts +1 -7
- package/src/textnote.ts +9 -11
|
@@ -0,0 +1,180 @@
|
|
|
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
|
+
/**
|
|
146
|
+
* @param fontName
|
|
147
|
+
* @param data optionally set the Font object's `.data` property.
|
|
148
|
+
* This is usually done when setting up a font for the first time.
|
|
149
|
+
* @param metrics optionally set the Font object's `.metrics` property.
|
|
150
|
+
* This is usually done when setting up a font for the first time.
|
|
151
|
+
* @returns a Font object with the given `fontName`.
|
|
152
|
+
* Reuse an existing Font object if a matching one is found.
|
|
153
|
+
*/
|
|
154
|
+
static load(fontName: string, data?: FontData, metrics?: FontMetrics): Font;
|
|
155
|
+
protected name: string;
|
|
156
|
+
protected data?: FontData;
|
|
157
|
+
protected metrics?: FontMetrics;
|
|
158
|
+
/**
|
|
159
|
+
* Use `Font.load(fontName)` to get a Font object.
|
|
160
|
+
* Do not call this constructor directly.
|
|
161
|
+
*/
|
|
162
|
+
private constructor();
|
|
163
|
+
getName(): string;
|
|
164
|
+
getData(): FontData;
|
|
165
|
+
getMetrics(): FontMetrics;
|
|
166
|
+
setData(data: FontData): void;
|
|
167
|
+
setMetrics(metrics: FontMetrics): void;
|
|
168
|
+
hasData(): boolean;
|
|
169
|
+
getResolution(): number;
|
|
170
|
+
getGlyphs(): Record<string, FontGlyph>;
|
|
171
|
+
/**
|
|
172
|
+
* Use the provided key to look up a value in this font's metrics file (e.g., bravura_metrics.ts, petaluma_metrics.ts).
|
|
173
|
+
* @param key is a string separated by periods (e.g., stave.endPaddingMax, clef.lineCount.'5'.shiftY).
|
|
174
|
+
* @param defaultValue is returned if the lookup fails.
|
|
175
|
+
* @returns the retrieved value (or `defaultValue` if the lookup fails).
|
|
176
|
+
*/
|
|
177
|
+
lookupMetric(key: string, defaultValue?: Record<string, any> | number): any;
|
|
178
|
+
/** For debugging. */
|
|
179
|
+
toString(): string;
|
|
180
|
+
}
|