vexflow.d.ts 8.3 KB

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