vexflow/tests/stavetie_tests.js

A JavaScript library for rendering music notation and guitar tablature

/**
 * VexFlow - StaveTie Tests
 * Copyright Mohit Muthanna 2010 <mohit@muthanna.com>
 */

VF.Test.StaveTie = (function() {
  function createTest(notesData, setupTies) {
    return function(options) {
      var vf = VF.Test.makeFactory(options, 300);
      var stave = vf.Stave();
      var score = vf.EasyScore();
      var voice = score.voice(score.notes.apply(score, notesData));
      var notes = voice.getTickables();

      setupTies(vf, notes, stave);

      vf.Formatter()
        .joinVoices([voice])
        .formatToStave([voice], stave);

      vf.draw();

      ok(true);
    };
  }

  return {
    Start: function() {
      var run = VF.Test.runTests;

      QUnit.module('StaveTie');

      run('Simple StaveTie', createTest(
        ['(cb4 e#4 a4)/2, (d4 e4 f4)', { stem: 'down' }],
        function(vf, notes) {
          vf.StaveTie({
            from: notes[0],
            to: notes[1],
            first_indices: [0, 1],
            last_indices: [0, 1],
          });
        }
      ));

      run('Chord StaveTie', createTest(
        ['(d4 e4 f4)/2, (cn4 f#4 a4)', { stem: 'down' }],
        function(vf, notes) {
          vf.StaveTie({
            from: notes[0],
            to: notes[1],
            first_indices: [0, 1, 2],
            last_indices: [0, 1, 2],
          });
        }
      ));

      run('Stem Up StaveTie', createTest(
        ['(d4 e4 f4)/2, (cn4 f#4 a4)', { stem: 'up' }],
        function(vf, notes) {
          vf.StaveTie({
            from: notes[0],
            to: notes[1],
            first_indices: [0, 1, 2],
            last_indices: [0, 1, 2],
          });
        }
      ));

      run('No End Note', createTest(
        ['(cb4 e#4 a4)/2, (d4 e4 f4)', { stem: 'down' }],
        function(vf, notes, stave) {
          stave.addEndClef('treble');
          vf.StaveTie({
            from: notes[1],
            to: null,
            first_indices: [2],
            last_indices: [2],
            text: 'slow.',
          });
        }
      ));

      run('No Start Note', createTest(
        ['(cb4 e#4 a4)/2, (d4 e4 f4)', { stem: 'down' }],
        function(vf, notes, stave) {
          stave.addClef('treble');
          vf.StaveTie({
            from: null,
            to: notes[0],
            first_indices: [2],
            last_indices: [2],
            text: 'H',
          });
        }
      ));

      run('Set Direction Down', createTest(
        ['(cb4 e#4 a4)/2, (d4 e4 f4)', { stem: 'down' }],
        function(vf, notes) {
          vf.StaveTie({
            from: notes[0],
            to: notes[1],
            first_indices: [0, 1],
            last_indices: [0, 1],
            options: {
              direction: VF.Stem.DOWN,
            },
          });
        }
      ));

      run('Set Direction Up', createTest(
        ['(cb4 e#4 a4)/2, (d4 e4 f4)', { stem: 'down' }],
        function(vf, notes) {
          vf.StaveTie({
            from: notes[0],
            to: notes[1],
            first_indices: [0, 1],
            last_indices: [0, 1],
            options: {
              direction: VF.Stem.UP,
            },
          });
        }
      ));
    },
  };
}());