vexflow.d.ts 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  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 setStyle(style: any): void;
  37. public addDotToAll(): void;
  38. }
  39. export class StaveTie {
  40. constructor(notes_struct: any);
  41. public setContext(ctx: CanvasContext): StaveTie;
  42. public draw(): void;
  43. }
  44. export class Stave {
  45. constructor(x: number, y: number, width: number, options: any);
  46. public setX(x: number): Stave;
  47. public setY(y: number): Stave;
  48. public getX(): number;
  49. public addClef(clefSpec: string, size: any, annotation: any, position: any): void;
  50. public setEndClef(clefSpec: string, size: any, annotation: any): void;
  51. public getModifiers(): StaveModifier[];
  52. public getYForGlyphs(): number;
  53. public getWidth(): number;
  54. public setWidth(width: number): Stave;
  55. public getNoteStartX(): number;
  56. public getNoteEndX(): number;
  57. public setNoteStartX(x: number): Stave;
  58. public setKeySignature(keySpec: any, cancelKeySpec: any, position: any): Stave;
  59. public format(): void;
  60. public getSpacingBetweenLines(): number;
  61. public getNumLines(): number;
  62. public getLineForY(y: number): number;
  63. public getModifiers(pos: any, cat: any): Clef[]; // FIXME
  64. public setContext(ctx: CanvasContext): Stave;
  65. public addModifier(mod: any, pos: any): void;
  66. public draw(): void;
  67. public addTimeSignature(sig: string): void;
  68. }
  69. export class Modifier {
  70. public static Position: any;
  71. public getCategory(): string;
  72. public getWidth(): number;
  73. public getPadding(index: number): number;
  74. }
  75. export class StaveModifier extends Modifier {
  76. }
  77. export class Clef extends StaveModifier {
  78. constructor(type: any);
  79. public static category: string;
  80. public static types: { [type: string]: any; };
  81. public glyph: any;
  82. public x: number;
  83. public stave: Stave;
  84. public getBoundingBox(): BoundingBox;
  85. public setStave(stave: Stave): void;
  86. }
  87. export class Renderer {
  88. constructor(canvas: HTMLCanvasElement, backend: any);
  89. public static Backends: any;
  90. public resize(a: number, b: number): void;
  91. public getContext(): CanvasContext;
  92. }
  93. export class TimeSignature {
  94. constructor(timeSpec: string, customPadding?: any);
  95. }
  96. export class KeySignature {
  97. constructor(keySpec: string, cancelKeySpec: string, alterKeySpec?: string);
  98. }
  99. export class Accidental {
  100. constructor(type: string);
  101. }
  102. export class Beam {
  103. constructor(notes: StaveNote[], auto_stem: boolean);
  104. public setContext(ctx: CanvasContext): Beam;
  105. public draw(): void;
  106. }
  107. export class CanvasContext {
  108. public scale(x: number, y: number): CanvasContext;
  109. }
  110. export class StaveConnector {
  111. constructor(top: Stave, bottom: Stave);
  112. public static type: any;
  113. public setType(type: any): StaveConnector;
  114. public setContext(ctx: CanvasContext): StaveConnector;
  115. public draw(): void;
  116. }
  117. }
  118. }
  119. declare module "vexflow" {
  120. export = Vex;
  121. }