barnote.js

VexFlow - Copyright (c) Mohit Muthanna 2010.

Description

A BarNote is used to render bar lines (from barline.js). BarNotes can be added to a voice and rendered in the middle of a stave. Since it has no duration, it consumes no ticks, and is dealt with appropriately by the formatter.

See tests/barnote_tests.js for usage examples.

import { Vex } from './vex';
import { Note } from './note';
import { Barline } from './stavebarline';
import { BoundingBox } from './boundingbox';

To enable logging for this class. Set Vex.Flow.BarNote.DEBUG to true.

function L(...args) { if (BarNote.DEBUG) Vex.L('Vex.Flow.BarNote', args); }

export class BarNote extends Note {
  constructor(type) {
    super({ duration: 'b' });
    this.attrs.type = 'BarNote';

    const TYPE = Barline.type;
    this.metrics = {
      widths: {},
    };

Defined this way to prevent lint errors.

    this.metrics.widths[TYPE.SINGLE] = 8;
    this.metrics.widths[TYPE.DOUBLE] = 12;
    this.metrics.widths[TYPE.END] = 15;
    this.metrics.widths[TYPE.REPEAT_BEGIN] = 14;
    this.metrics.widths[TYPE.REPEAT_END] = 14;
    this.metrics.widths[TYPE.REPEAT_BOTH] = 18;
    this.metrics.widths[TYPE.NONE] = 0;

Tell the formatter that bar notes have no duration.

    this.ignore_ticks = true;
    this.type = type === undefined ? TYPE.SINGLE : type;

Set width to width of relevant Barline.

    this.setWidth(this.metrics.widths[this.type]);
  }

Get and set the type of Bar note. type must be one of Vex.Flow.Barline.type.

  getType() { return this.type; }
  setType(type) {
    this.type = type;
    this.setWidth(this.metrics.widths[this.type]);
    return this;
  }

  getBoundingBox() {
    return new BoundingBox(0, 0, 0, 0);
  }

  addToModifierContext() {
    /* overridden to ignore */
    return this;
  }

  preFormat() {
    /* overridden to ignore */
    this.setPreFormatted(true);
    return this;
  }

Render note to stave.

  draw() {
    this.checkContext();
    if (!this.stave) throw new Vex.RERR('NoStave', "Can't draw without a stave.");
    L('Rendering bar line at: ', this.getAbsoluteX());
    const barline = new Barline(this.type);
    barline.setX(this.getAbsoluteX());
    barline.draw(this.stave);
  }
}

barnote.js

Table of Contents

Description