vexflow.d.ts 6.9 KB

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