vexflow.d.ts 9.0 KB

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