vexflow/src/timesignote.ts

A JavaScript library for rendering music notation and guitar tablature.

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

import { ModifierContext } from './modifiercontext';
import { Note } from './note';
import { TimeSignature, TimeSignatureInfo } from './timesignature';
import { Category } from './typeguard';

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

  protected timeSigInfo: TimeSignatureInfo;

  constructor(timeSpec: string, customPadding?: number) {
    super({ duration: 'b' });

    const timeSignature = new TimeSignature(timeSpec, customPadding);
    this.timeSigInfo = timeSignature.getInfo();
    this.setWidth(this.timeSigInfo.glyph.getMetrics().width);

    // Note properties
    this.ignore_ticks = true;
  }

  /* Overridden to ignore */
  // eslint-disable-next-line
  addToModifierContext(mc: ModifierContext): this {
    // DO NOTHING.
    return this;
  }

  preFormat(): this {
    this.preFormatted = true;
    return this;
  }

  draw(): void {
    const stave = this.checkStave();
    const ctx = this.checkContext();
    this.setRendered();

    if (!this.timeSigInfo.glyph.getContext()) {
      this.timeSigInfo.glyph.setContext(ctx);
    }

    this.timeSigInfo.glyph.setStave(stave);
    this.timeSigInfo.glyph.setYShift(stave.getYForLine(2) - stave.getYForGlyphs());
    this.timeSigInfo.glyph.renderToStave(this.getAbsoluteX());
  }
}