vexflow/src/tabstave.ts

A JavaScript library for rendering music notation and guitar tablature.

// [VexFlow](https://vexflow.com) - Copyright (c) Mohit Muthanna 2010.

import { Stave, StaveOptions } from './stave';
import { Category } from './typeguard';

export class TabStave extends Stave {
  static get CATEGORY(): string {
    return Category.TabStave;
  }

  constructor(x: number, y: number, width: number, options?: StaveOptions) {
    const tab_options = {
      spacing_between_lines_px: 13,
      num_lines: 6,
      top_text_position: 1,
      ...options,
    };

    super(x, y, width, tab_options);
  }

  getYForGlyphs(): number {
    return this.getYForLine(2.5);
  }

  // Deprecated
  addTabGlyph(): this {
    this.addClef('tab');
    return this;
  }
}