vexflow.d.ts 8.9 KB

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