vexflow.d.ts 7.1 KB

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