vexflow.d.ts 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242
  1. declare namespace Vex {
  2. export module Flow {
  3. const RESOLUTION: any;
  4. export class Formatter {
  5. constructor(opts?: any);
  6. public hasMinTotalWidth: boolean;
  7. public minTotalWidth: number;
  8. public joinVoices(voices: Voice[]): void;
  9. public format(voices: Voice[], width: number): void;
  10. public preCalculateMinTotalWidth(voices: Voice[]): number;
  11. }
  12. export class BoundingBox {
  13. constructor(x: number, y: number, w: number, h: number);
  14. public mergeWith(bb: BoundingBox): BoundingBox;
  15. public getX(): number;
  16. public getY(): number;
  17. public getW(): number;
  18. public getH(): number;
  19. }
  20. export class Voice {
  21. constructor(time: any);
  22. public static Mode: any;
  23. public getBoundingBox(): BoundingBox;
  24. public setStave(stave: Stave): Voice;
  25. public addTickables(notes: StaveNote[]): Voice;
  26. public addTickable(note: StaveNote): Voice;
  27. public setMode(mode: any): Voice;
  28. public draw(ctx: any, stave: Stave): void;
  29. }
  30. export class StaveNote {
  31. constructor(note_struct: any);
  32. public getNoteHeadBounds(): any;
  33. public getNoteHeadBeginX(): number;
  34. public getNoteHeadEndX(): number;
  35. public addAccidental(index: number, accidental: Accidental): StaveNote;
  36. public addAnnotation(index: number, annotation: Annotation): StaveNote;
  37. public setStyle(style: any): void;
  38. public addDotToAll(): void;
  39. }
  40. export class StaveTie {
  41. constructor(notes_struct: any);
  42. public setContext(ctx: RenderContext): StaveTie;
  43. public draw(): void;
  44. }
  45. export class Stave {
  46. constructor(x: number, y: number, width: number, options: any);
  47. public setX(x: number): Stave;
  48. public setY(y: number): Stave;
  49. public getX(): number;
  50. public setBegBarType(type: any): Stave;
  51. public setEndBarType(type: any): Stave;
  52. public addClef(clefSpec: string, size: any, annotation: any, position: any): void;
  53. public setEndClef(clefSpec: string, size: any, annotation: any): void;
  54. public getModifiers(): StaveModifier[];
  55. public getYForGlyphs(): number;
  56. public getWidth(): number;
  57. public setWidth(width: number): Stave;
  58. public getNoteStartX(): number;
  59. public getNoteEndX(): number;
  60. public setNoteStartX(x: number): Stave;
  61. public setKeySignature(keySpec: any, cancelKeySpec: any, position: any): Stave;
  62. public format(): void;
  63. public getSpacingBetweenLines(): number;
  64. public getNumLines(): number;
  65. public getLineForY(y: number): number;
  66. public getModifiers(pos: any, cat: any): Clef[]; // FIXME
  67. public setContext(ctx: RenderContext): Stave;
  68. public addModifier(mod: any, pos: any): void;
  69. public draw(): void;
  70. public addTimeSignature(sig: string): void;
  71. }
  72. export class Modifier {
  73. public static Position: any;
  74. public getCategory(): string;
  75. public getWidth(): number;
  76. public getPadding(index: number): number;
  77. }
  78. export class StaveModifier extends Modifier {
  79. public static Position: any;
  80. public getPosition(): number;
  81. }
  82. export class Repetition extends StaveModifier {
  83. constructor(type: any, x: number, y_shift: number);
  84. }
  85. export class Clef extends StaveModifier {
  86. constructor(type: string, size: number, annotation: string);
  87. public static category: string;
  88. public static types: { [type: string]: any; };
  89. public glyph: any;
  90. public x: number;
  91. public stave: Stave;
  92. public getBoundingBox(): BoundingBox;
  93. public setStave(stave: Stave): void;
  94. }
  95. export class Renderer {
  96. constructor(canvas: HTMLElement, backend: number);
  97. public static Backends: {
  98. CANVAS: number,
  99. RAPHAEL: number,
  100. SVG: number,
  101. VML: number
  102. };
  103. public resize(a: number, b: number): void;
  104. public getContext(): CanvasContext|SVGContext;
  105. }
  106. export class TimeSignature extends StaveModifier {
  107. constructor(timeSpec: string, customPadding?: any);
  108. }
  109. export class KeySignature extends StaveModifier {
  110. constructor(keySpec: string, cancelKeySpec: string, alterKeySpec?: string);
  111. }
  112. export class Accidental {
  113. constructor(type: string);
  114. }
  115. export class Annotation {
  116. constructor(type: string);
  117. }
  118. export class Beam {
  119. constructor(notes: StaveNote[], auto_stem: boolean);
  120. public setContext(ctx: RenderContext): Beam;
  121. public draw(): void;
  122. }
  123. export class Tuplet {
  124. constructor(notes: StaveNote[], options: any);
  125. public setContext(ctx: RenderContext): Tuplet;
  126. public draw(): void;
  127. }
  128. export class RenderContext {
  129. public scale(x: number, y: number): RenderContext;
  130. public fillRect(x: number, y: number, width: number, height: number): RenderContext
  131. public fillText(text: string, x: number, y: number): RenderContext;
  132. public setFont(family: string, size: number, weight: string): RenderContext;
  133. public save(): RenderContext;
  134. public restore(): RenderContext;
  135. }
  136. export class CanvasContext extends RenderContext {
  137. public vexFlowCanvasContext: CanvasRenderingContext2D;
  138. }
  139. export class SVGContext extends RenderContext {
  140. public svg: SVGElement;
  141. public attributes: any;
  142. public state: any;
  143. }
  144. export class StaveConnector {
  145. constructor(top: Stave, bottom: Stave);
  146. public static type: any;
  147. public setType(type: any): StaveConnector;
  148. public setContext(ctx: RenderContext): StaveConnector;
  149. public draw(): void;
  150. }
  151. }
  152. }
  153. declare module "vexflow" {
  154. export = Vex;
  155. }