vexflow.d.ts 8.6 KB

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