vexflow 5.0.0-alpha.2 → 5.0.0-alpha.4

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 (157) 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 +528 -492
  6. package/build/cjs/vexflow-debug-with-tests.js.map +1 -1
  7. package/build/cjs/vexflow-debug.js +460 -452
  8. package/build/cjs/vexflow-debug.js.map +1 -1
  9. package/build/cjs/vexflow.js +2 -2
  10. package/build/cjs/vexflow.js.map +1 -1
  11. package/build/esm/src/accidental.js +22 -28
  12. package/build/esm/src/beam.js +24 -42
  13. package/build/esm/src/clefnote.js +6 -1
  14. package/build/esm/src/element.js +83 -101
  15. package/build/esm/src/fonts/gonville.js +1 -1
  16. package/build/esm/src/formatter.js +9 -17
  17. package/build/esm/src/fraction.js +15 -22
  18. package/build/esm/src/glyphnote.js +3 -2
  19. package/build/esm/src/metrics.js +3 -0
  20. package/build/esm/src/modifier.js +6 -21
  21. package/build/esm/src/multimeasurerest.js +16 -25
  22. package/build/esm/src/note.js +7 -0
  23. package/build/esm/src/registry.js +5 -19
  24. package/build/esm/src/stave.js +4 -6
  25. package/build/esm/src/stavenote.js +26 -40
  26. package/build/esm/src/stavetempo.js +4 -11
  27. package/build/esm/src/stavetie.js +82 -36
  28. package/build/esm/src/svgcontext.js +5 -12
  29. package/build/esm/src/tickable.js +13 -26
  30. package/build/esm/src/tickcontext.js +20 -2
  31. package/build/esm/src/version.js +3 -3
  32. package/build/esm/src/vibrato.js +6 -1
  33. package/build/esm/tests/clef_tests.js +5 -1
  34. package/build/esm/tests/glyphnote_tests.js +6 -0
  35. package/build/esm/tests/stavetie_tests.js +29 -0
  36. package/build/esm/tests/tabstave_tests.js +1 -0
  37. package/build/esm/tests/vexflow_test_helpers.js +25 -39
  38. package/build/types/src/accidental.d.ts +19 -1
  39. package/build/types/src/annotation.d.ts +1 -1
  40. package/build/types/src/beam.d.ts +12 -1
  41. package/build/types/src/clefnote.d.ts +2 -0
  42. package/build/types/src/element.d.ts +13 -3
  43. package/build/types/src/fonts/gonville.d.ts +1 -1
  44. package/build/types/src/formatter.d.ts +5 -3
  45. package/build/types/src/fraction.d.ts +12 -7
  46. package/build/types/src/modifier.d.ts +2 -1
  47. package/build/types/src/multimeasurerest.d.ts +4 -1
  48. package/build/types/src/note.d.ts +2 -0
  49. package/build/types/src/registry.d.ts +1 -1
  50. package/build/types/src/stavenote.d.ts +2 -1
  51. package/build/types/src/stavetempo.d.ts +3 -3
  52. package/build/types/src/stavetie.d.ts +39 -2
  53. package/build/types/src/svgcontext.d.ts +1 -1
  54. package/build/types/src/tickable.d.ts +2 -1
  55. package/build/types/src/tickcontext.d.ts +30 -0
  56. package/package.json +2 -4
  57. package/tests/flow.html +2 -2
  58. package/entry/vexflow-bravura.ts +0 -25
  59. package/entry/vexflow-core.ts +0 -16
  60. package/entry/vexflow-debug-with-tests.ts +0 -64
  61. package/entry/vexflow-debug.ts +0 -54
  62. package/entry/vexflow.ts +0 -47
  63. package/src/accidental.ts +0 -570
  64. package/src/annotation.ts +0 -294
  65. package/src/articulation.ts +0 -383
  66. package/src/barnote.ts +0 -95
  67. package/src/beam.ts +0 -999
  68. package/src/bend.ts +0 -268
  69. package/src/boundingbox.ts +0 -108
  70. package/src/canvascontext.ts +0 -348
  71. package/src/chordsymbol.ts +0 -473
  72. package/src/clef.ts +0 -164
  73. package/src/clefnote.ts +0 -50
  74. package/src/crescendo.ts +0 -132
  75. package/src/curve.ts +0 -195
  76. package/src/dot.ts +0 -171
  77. package/src/easyscore.ts +0 -538
  78. package/src/element.ts +0 -692
  79. package/src/factory.ts +0 -694
  80. package/src/font.ts +0 -343
  81. package/src/fonts/academico.ts +0 -2
  82. package/src/fonts/academicobold.ts +0 -2
  83. package/src/fonts/bravura.ts +0 -2
  84. package/src/fonts/gonville.ts +0 -2
  85. package/src/fonts/petaluma.ts +0 -2
  86. package/src/fonts/petalumascript.ts +0 -2
  87. package/src/formatter.ts +0 -1107
  88. package/src/fraction.ts +0 -245
  89. package/src/frethandfinger.ts +0 -180
  90. package/src/ghostnote.ts +0 -75
  91. package/src/glyphnote.ts +0 -68
  92. package/src/glyphs.ts +0 -5880
  93. package/src/gracenote.ts +0 -146
  94. package/src/gracenotegroup.ts +0 -194
  95. package/src/gracetabnote.ts +0 -30
  96. package/src/index.ts +0 -90
  97. package/src/keymanager.ts +0 -153
  98. package/src/keysignature.ts +0 -272
  99. package/src/keysignote.ts +0 -46
  100. package/src/metrics.ts +0 -222
  101. package/src/modifier.ts +0 -216
  102. package/src/modifiercontext.ts +0 -177
  103. package/src/multimeasurerest.ts +0 -229
  104. package/src/music.ts +0 -443
  105. package/src/note.ts +0 -690
  106. package/src/notehead.ts +0 -158
  107. package/src/notesubgroup.ts +0 -88
  108. package/src/ornament.ts +0 -301
  109. package/src/parenthesis.ts +0 -89
  110. package/src/parser.ts +0 -263
  111. package/src/pedalmarking.ts +0 -273
  112. package/src/registry.ts +0 -146
  113. package/src/rendercontext.ts +0 -98
  114. package/src/renderer.ts +0 -166
  115. package/src/repeatnote.ts +0 -25
  116. package/src/stave.ts +0 -885
  117. package/src/stavebarline.ts +0 -231
  118. package/src/staveconnector.ts +0 -281
  119. package/src/stavehairpin.ts +0 -209
  120. package/src/staveline.ts +0 -343
  121. package/src/stavemodifier.ts +0 -93
  122. package/src/stavenote.ts +0 -1230
  123. package/src/staverepetition.ts +0 -148
  124. package/src/stavesection.ts +0 -54
  125. package/src/stavetempo.ts +0 -162
  126. package/src/stavetext.ts +0 -69
  127. package/src/stavetie.ts +0 -235
  128. package/src/stavevolta.ts +0 -66
  129. package/src/stem.ts +0 -225
  130. package/src/stemmablenote.ts +0 -248
  131. package/src/stringnumber.ts +0 -286
  132. package/src/strokes.ts +0 -214
  133. package/src/svgcontext.ts +0 -639
  134. package/src/system.ts +0 -327
  135. package/src/tables.ts +0 -796
  136. package/src/tabnote.ts +0 -449
  137. package/src/tabslide.ts +0 -115
  138. package/src/tabstave.ts +0 -31
  139. package/src/tabtie.ts +0 -44
  140. package/src/textbracket.ts +0 -231
  141. package/src/textdynamics.ts +0 -101
  142. package/src/textnote.ts +0 -175
  143. package/src/tickable.ts +0 -374
  144. package/src/tickcontext.ts +0 -280
  145. package/src/timesignature.ts +0 -229
  146. package/src/timesignote.ts +0 -45
  147. package/src/tremolo.ts +0 -51
  148. package/src/tuning.ts +0 -90
  149. package/src/tuplet.ts +0 -349
  150. package/src/typeguard.ts +0 -136
  151. package/src/util.ts +0 -169
  152. package/src/version.ts +0 -4
  153. package/src/vexflow.ts +0 -378
  154. package/src/vibrato.ts +0 -99
  155. package/src/vibratobracket.ts +0 -81
  156. package/src/voice.ts +0 -302
  157. package/src/web.ts +0 -35
@@ -1,98 +0,0 @@
1
- // Copyright (c) 2023-present VexFlow contributors: https://github.com/vexflow/vexflow/graphs/contributors
2
- // MIT License
3
-
4
- import { FontInfo } from './font';
5
- import { Category } from './typeguard';
6
-
7
- export interface TextMeasure {
8
- x: number;
9
- y: number;
10
- width: number;
11
- height: number;
12
- }
13
-
14
- export abstract class RenderContext {
15
- static get CATEGORY(): string {
16
- return Category.RenderContext;
17
- }
18
-
19
- abstract clear(): void;
20
- abstract setFillStyle(style: string): this;
21
- abstract setBackgroundFillStyle(style: string): this;
22
- abstract setStrokeStyle(style: string): this;
23
- abstract setShadowColor(color: string): this;
24
- abstract setShadowBlur(blur: number): this;
25
- abstract setLineWidth(width: number): this;
26
- abstract setLineCap(capType: CanvasLineCap): this;
27
- abstract setLineDash(dashPattern: number[]): this;
28
- abstract scale(x: number, y: number): this;
29
- abstract rect(x: number, y: number, width: number, height: number): this;
30
- abstract resize(width: number, height: number): this;
31
- abstract fillRect(x: number, y: number, width: number, height: number): this;
32
- abstract clearRect(x: number, y: number, width: number, height: number): this;
33
- abstract pointerRect(x: number, y: number, width: number, height: number): this;
34
- abstract beginPath(): this;
35
- abstract moveTo(x: number, y: number): this;
36
- abstract lineTo(x: number, y: number): this;
37
- abstract bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number): this;
38
- abstract quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): this;
39
- abstract arc(
40
- x: number,
41
- y: number,
42
- radius: number,
43
- startAngle: number,
44
- endAngle: number,
45
- counterclockwise: boolean
46
- ): this;
47
- // eslint-disable-next-line
48
- abstract fill(attributes?: any): this;
49
- abstract stroke(): this;
50
- abstract closePath(): this;
51
- abstract fillText(text: string, x: number, y: number): this;
52
- abstract save(): this;
53
- abstract restore(): this;
54
- // eslint-disable-next-line
55
- abstract openGroup(cls?: string, id?: string): any;
56
- abstract closeGroup(): void;
57
- abstract openRotation(angleDegrees: number, x: number, y: number): void;
58
- abstract closeRotation(): void;
59
-
60
- // eslint-disable-next-line
61
- abstract add(child: any): void;
62
- abstract measureText(text: string): TextMeasure;
63
-
64
- abstract set fillStyle(style: string | CanvasGradient | CanvasPattern);
65
- abstract get fillStyle(): string | CanvasGradient | CanvasPattern;
66
-
67
- abstract set strokeStyle(style: string | CanvasGradient | CanvasPattern);
68
- abstract get strokeStyle(): string | CanvasGradient | CanvasPattern;
69
-
70
- abstract setFont(f?: string | FontInfo, size?: string | number, weight?: string | number, style?: string): this;
71
- abstract getFont(): string;
72
-
73
- set font(f: string) {
74
- this.setFont(f);
75
- }
76
- get font(): string {
77
- return this.getFont();
78
- }
79
- }
80
-
81
- /**
82
- * Draw a tiny dot marker on the specified context. A great debugging aid.
83
- * @param ctx context
84
- * @param x dot x coordinate
85
- * @param y dot y coordinate
86
- * @param color
87
- */
88
- export function drawDot(ctx: RenderContext, x: number, y: number, color = '#F55'): void {
89
- ctx.save();
90
- ctx.setFillStyle(color);
91
-
92
- // draw a circle
93
- ctx.beginPath();
94
- ctx.arc(x, y, 3, 0, Math.PI * 2, false);
95
- ctx.closePath();
96
- ctx.fill();
97
- ctx.restore();
98
- }
package/src/renderer.ts DELETED
@@ -1,166 +0,0 @@
1
- // Copyright (c) 2023-present VexFlow contributors: https://github.com/vexflow/vexflow/graphs/contributors
2
- // MIT License
3
-
4
- import { CanvasContext } from './canvascontext';
5
- import { RenderContext } from './rendercontext';
6
- import { SVGContext } from './svgcontext';
7
- import { isRenderContext } from './typeguard';
8
- import { RuntimeError } from './util';
9
- import { isHTMLCanvas, isHTMLDiv } from './web';
10
-
11
- // A ContextBuilder is either Renderer.getSVGContext or Renderer.getCanvasContext.
12
- export type ContextBuilder = typeof Renderer.getSVGContext | typeof Renderer.getCanvasContext;
13
-
14
- export enum RendererBackends {
15
- CANVAS = 1,
16
- SVG = 2,
17
- }
18
-
19
- // End of line types
20
- export enum RendererLineEndType {
21
- NONE = 1, // No leg
22
- UP = 2, // Upward leg
23
- DOWN = 3, // Downward leg
24
- }
25
-
26
- /**
27
- * Support Canvas & SVG rendering contexts.
28
- */
29
- export class Renderer {
30
- static Backends = RendererBackends;
31
-
32
- static LineEndType = RendererLineEndType;
33
-
34
- // Used by vexflow_test_helpers.ts
35
- // Should this be private?
36
- // Can we do this in a cleaner way?
37
- static lastContext?: RenderContext = undefined;
38
-
39
- static buildContext(
40
- elementId: string | HTMLCanvasElement | HTMLDivElement,
41
- backend: number,
42
- width: number,
43
- height: number,
44
- background: string = '#FFF'
45
- ): RenderContext {
46
- const renderer = new Renderer(elementId, backend);
47
- if (width && height) {
48
- renderer.resize(width, height);
49
- }
50
-
51
- const ctx = renderer.getContext();
52
- ctx.setBackgroundFillStyle(background);
53
- Renderer.lastContext = ctx;
54
- return ctx;
55
- }
56
-
57
- static getCanvasContext(elementId: string, width: number, height: number, background?: string): RenderContext {
58
- return Renderer.buildContext(elementId, Renderer.Backends.CANVAS, width, height, background);
59
- }
60
-
61
- static getSVGContext(elementId: string, width: number, height: number, background?: string): RenderContext {
62
- return Renderer.buildContext(elementId, Renderer.Backends.SVG, width, height, background);
63
- }
64
-
65
- // Draw a dashed line (horizontal, vertical or diagonal
66
- // dashPattern = [3,3] draws a 3 pixel dash followed by a three pixel space.
67
- // setting the second number to 0 draws a solid line.
68
- static drawDashedLine(
69
- context: RenderContext,
70
- fromX: number,
71
- fromY: number,
72
- toX: number,
73
- toY: number,
74
- dashPattern: number[]
75
- ): void {
76
- context.beginPath();
77
-
78
- const dx = toX - fromX;
79
- const dy = toY - fromY;
80
- const angle = Math.atan2(dy, dx);
81
- let x = fromX;
82
- let y = fromY;
83
- context.moveTo(fromX, fromY);
84
- let idx = 0;
85
- let draw = true;
86
- while (!((dx < 0 ? x <= toX : x >= toX) && (dy < 0 ? y <= toY : y >= toY))) {
87
- const dashLength = dashPattern[idx++ % dashPattern.length];
88
- const nx = x + Math.cos(angle) * dashLength;
89
- x = dx < 0 ? Math.max(toX, nx) : Math.min(toX, nx);
90
- const ny = y + Math.sin(angle) * dashLength;
91
- y = dy < 0 ? Math.max(toY, ny) : Math.min(toY, ny);
92
- if (draw) {
93
- context.lineTo(x, y);
94
- } else {
95
- context.moveTo(x, y);
96
- }
97
- draw = !draw;
98
- }
99
-
100
- context.closePath();
101
- context.stroke();
102
- }
103
-
104
- protected ctx: RenderContext;
105
-
106
- /**
107
- * @param canvasId can be:
108
- * - a string element ID (of a canvas or div element)
109
- * - a canvas element
110
- * - a div element, which will contain the SVG output
111
- * @param backend Renderer.Backends.CANVAS or Renderer.Backends.SVG
112
- */
113
- constructor(context: RenderContext);
114
- constructor(canvas: string | HTMLCanvasElement | HTMLDivElement, backend: number);
115
- constructor(arg0: string | HTMLCanvasElement | HTMLDivElement | RenderContext, arg1?: number) {
116
- if (isRenderContext(arg0)) {
117
- // The user has provided what looks like a RenderContext, let's just use it.
118
- this.ctx = arg0;
119
- } else {
120
- if (arg1 === undefined) {
121
- // The backend must be specified if the render context isn't directly provided.
122
- throw new RuntimeError('InvalidArgument', 'Missing backend argument');
123
- }
124
- const backend: number = arg1;
125
-
126
- let element: HTMLElement;
127
- if (typeof arg0 === 'string') {
128
- const maybeElement = document.getElementById(arg0);
129
- if (!maybeElement) {
130
- throw new RuntimeError('BadElementId', `Can't find element with ID "${maybeElement}"`);
131
- }
132
- element = maybeElement;
133
- } else {
134
- element = arg0 as HTMLElement;
135
- }
136
-
137
- // Verify backend and create context
138
- if (backend === Renderer.Backends.CANVAS) {
139
- if (!isHTMLCanvas(element)) {
140
- throw new RuntimeError('BadElement', 'CANVAS context requires an HTMLCanvasElement.');
141
- }
142
- const context = element.getContext('2d', { willReadFrequently: true });
143
- if (!context) {
144
- throw new RuntimeError('BadElement', "Can't get canvas context");
145
- }
146
- this.ctx = new CanvasContext(context);
147
- } else if (backend === Renderer.Backends.SVG) {
148
- if (!isHTMLDiv(element)) {
149
- throw new RuntimeError('BadElement', 'SVG context requires an HTMLDivElement.');
150
- }
151
- this.ctx = new SVGContext(element);
152
- } else {
153
- throw new RuntimeError('InvalidBackend', `No support for backend: ${backend}`);
154
- }
155
- }
156
- }
157
-
158
- resize(width: number, height: number): this {
159
- this.ctx.resize(width, height);
160
- return this;
161
- }
162
-
163
- getContext(): RenderContext {
164
- return this.ctx;
165
- }
166
- }
package/src/repeatnote.ts DELETED
@@ -1,25 +0,0 @@
1
- // Copyright (c) 2023-present VexFlow contributors: https://github.com/vexflow/vexflow/graphs/contributors
2
-
3
- import { GlyphNote, GlyphNoteOptions } from './glyphnote';
4
- import { Glyphs } from './glyphs';
5
- import { NoteStruct } from './note';
6
- import { Category } from './typeguard';
7
-
8
- // Map `type` to SMuFL glyph code.
9
- const CODES: Record<string, string> = {
10
- '1': Glyphs.repeat1Bar,
11
- '2': Glyphs.repeat2Bars,
12
- '4': Glyphs.repeat4Bars,
13
- slash: Glyphs.repeatBarSlash,
14
- };
15
-
16
- export class RepeatNote extends GlyphNote {
17
- static get CATEGORY(): string {
18
- return Category.RepeatNote;
19
- }
20
-
21
- constructor(type: string, noteStruct?: NoteStruct, options?: GlyphNoteOptions) {
22
- const glyphCode = CODES[type] || '\uE500'; /*repeat1Bar*/
23
- super(glyphCode, { duration: 'q', alignCenter: type !== 'slash', ...noteStruct }, options);
24
- }
25
- }