vexflow.d.ts 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  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 Note extends Tickable {
  39. }
  40. export class Stem {
  41. public static UP: number;
  42. public static DOWN: number;
  43. }
  44. export class StemmableNote extends Note {
  45. public getStemDirection(): number;
  46. public setStemDirection(direction: number): StemmableNote;
  47. }
  48. export class StaveNote extends StemmableNote {
  49. constructor(note_struct: any);
  50. public getNoteHeadBounds(): any;
  51. public getNoteHeadBeginX(): number;
  52. public getNoteHeadEndX(): number;
  53. public getGlyphWidth(): number;
  54. public addAccidental(index: number, accidental: Accidental): StaveNote;
  55. public addAnnotation(index: number, annotation: Annotation): StaveNote;
  56. public addModifier(index: number, modifier: Modifier): StaveNote;
  57. public setStyle(style: any): void;
  58. public addDotToAll(): void;
  59. }
  60. export class StaveTie {
  61. constructor(notes_struct: any);
  62. public setContext(ctx: RenderContext): StaveTie;
  63. public draw(): void;
  64. }
  65. export class Stave {
  66. constructor(x: number, y: number, width: number, options: any);
  67. public setX(x: number): Stave;
  68. public setY(y: number): Stave;
  69. public getX(): number;
  70. public setBegBarType(type: any): Stave;
  71. public setEndBarType(type: any): Stave;
  72. public addClef(clefSpec: string, size: any, annotation: any, position: any): void;
  73. public setEndClef(clefSpec: string, size: any, annotation: any): void;
  74. public getModifiers(): StaveModifier[];
  75. public getYForGlyphs(): number;
  76. public getWidth(): number;
  77. public setWidth(width: number): Stave;
  78. public getNoteStartX(): number;
  79. public getModifierXShift(): number;
  80. public getNoteEndX(): number;
  81. public setNoteStartX(x: number): Stave;
  82. public setKeySignature(keySpec: any, cancelKeySpec: any, position: any): Stave;
  83. public setText(text: string, position: number, options: any): void;
  84. public format(): void;
  85. public getSpacingBetweenLines(): number;
  86. public getNumLines(): number;
  87. public getLineForY(y: number): number;
  88. public getYForLine(y: number): number;
  89. public getModifiers(pos: any, cat: any): Clef[]; // FIXME
  90. public setContext(ctx: RenderContext): Stave;
  91. public addModifier(mod: any, pos: any): void;
  92. public draw(): void;
  93. public addTimeSignature(sig: string): void;
  94. }
  95. export class Modifier {
  96. public static Position: any;
  97. public getCategory(): string;
  98. public getWidth(): number;
  99. public getPadding(index: number): number;
  100. public getPosition(): number;
  101. public setPosition(position: number): Modifier;
  102. }
  103. export class StaveModifier extends Modifier {
  104. public static get Position() {
  105. return {
  106. LEFT: 1,
  107. RIGHT: 2,
  108. ABOVE: 3,
  109. BELOW: 4,
  110. BEGIN: 5,
  111. END: 6,
  112. };
  113. }
  114. public getPosition(): number;
  115. }
  116. export class Repetition extends StaveModifier {
  117. constructor(type: any, x: number, y_shift: number);
  118. }
  119. export class Clef extends StaveModifier {
  120. constructor(type: string, size: number, annotation: string);
  121. public static category: string;
  122. public static types: { [type: string]: any; };
  123. public glyph: any;
  124. public x: number;
  125. public stave: Stave;
  126. public getBoundingBox(): BoundingBox;
  127. public setStave(stave: Stave): void;
  128. }
  129. export class Renderer {
  130. constructor(canvas: HTMLElement, backend: number);
  131. public static Backends: {
  132. CANVAS: number,
  133. RAPHAEL: number,
  134. SVG: number,
  135. VML: number
  136. };
  137. public resize(a: number, b: number): void;
  138. public getContext(): CanvasContext | SVGContext;
  139. }
  140. export class TimeSignature extends StaveModifier {
  141. constructor(timeSpec: string, customPadding?: any);
  142. }
  143. export class KeySignature extends StaveModifier {
  144. constructor(keySpec: string, cancelKeySpec: string, alterKeySpec?: string);
  145. }
  146. export class Accidental {
  147. constructor(type: string);
  148. }
  149. export class Annotation {
  150. constructor(type: string);
  151. }
  152. export class Articulation extends Modifier {
  153. constructor(type: string);
  154. }
  155. export class Beam {
  156. constructor(notes: StaveNote[], auto_stem: boolean);
  157. public setContext(ctx: RenderContext): Beam;
  158. public draw(): void;
  159. }
  160. export class Tuplet {
  161. constructor(notes: StaveNote[], options: any);
  162. public setContext(ctx: RenderContext): Tuplet;
  163. public draw(): void;
  164. }
  165. export class RenderContext {
  166. public scale(x: number, y: number): RenderContext;
  167. public fillRect(x: number, y: number, width: number, height: number): RenderContext
  168. public fillText(text: string, x: number, y: number): RenderContext;
  169. public setFont(family: string, size: number, weight: string): RenderContext;
  170. public save(): RenderContext;
  171. public restore(): RenderContext;
  172. }
  173. export class CanvasContext extends RenderContext {
  174. public vexFlowCanvasContext: CanvasRenderingContext2D;
  175. }
  176. export class SVGContext extends RenderContext {
  177. public svg: SVGElement;
  178. public attributes: any;
  179. public state: any;
  180. }
  181. export class StaveConnector {
  182. constructor(top: Stave, bottom: Stave);
  183. public static type: any;
  184. public setType(type: any): StaveConnector;
  185. public setContext(ctx: RenderContext): StaveConnector;
  186. public setXShift(shift: number): StaveConnector;
  187. public top_stave: Stave;
  188. public bottom_stave: Stave;
  189. public thickness: number;
  190. public width: number;
  191. public x_shift: number;
  192. public draw(): void;
  193. }
  194. }
  195. }
  196. declare module "vexflow" {
  197. export = Vex;
  198. }