vexflow-musicxml
Version:
MusicXml Parser for vexflow
212 lines (172 loc) • 6.5 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: src/xml/Note.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: src/xml/Note.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>import { XmlObject } from './XmlObject.js';
import { MusicXmlError } from './Errors.js';
import { Notation } from './Notation.js';
/**
* Class representation of a Note
* @extends XmlObject
*/
export class Note extends XmlObject {
/**
* Create a note from an XML node
* @param {NodeObject} node - the XML Node representing the note
* @param {Number} divisions - The divisions entry from the measure node
*/
constructor(node, attributes) {
super(node);
if (node.tagName !== 'note') {
throw new MusicXmlError('ne_001', 'Wrong XML type inserted into Note class!');
}
/**
* Private property to store attributes before this note
* @prop {Number} Note.mAttributes
*/
this.mAttributes = attributes;
this.lastNote = {
Clef: {},
mAttributes: {},
};
/**
* Private property to store measures divions units
* @prop {Number} Note.mDivisions
*/
this.mDivisions = attributes.Divisions;
/**
* Shows if this note is a rest
* @prop {Boolean} Note.isRest
*/
this.isRest = this.childExists('rest');
/**
* Shows if this note is part of a chord
* @prop {Boolean} Note.isInChord
*/
this.isInChord = this.childExists('chord');
/**
* Shows if this Note is before a backup element or the last in the measure
* @prop {Boolean} Note.isLast
*/
this.isLast = this.Node.nextElementSibling === null ||
this.Node.nextElementSibling === undefined ||
this.Node.nextElementSibling.tagName === 'backup';
/**
* The note's staff number
* @prop {Number} Note.Staff
*/
const tStaff = this.getNum('staff');
this.Staff = Number.isNaN(tStaff) ? 1 : tStaff;
/**
* The duration of the note
* @prop {Number} Note.Duration
*/
this.Duration = this.getNum('duration');
/**
* The notes type of representation (8th, whole, ...)
* @prop {String} Note.Type
*/
this.Type = this.getText('type');
/**
* The notes stem direction (up, down)
* @prop {String} Note.Stem
*/
this.Stem = this.getText('stem');
/**
* The notes beam state. It indicates if a beam starts or ends here
* @prop {Array} Note.Beam is an array of beams. They can be 'begin', 'end',
* 'continue' or 'none'
*/
// FIXME: Description doesn't match implementation
this.BeamState = this.getTextArray('beam').indexOf('begin') > -1 ||
this.getTextArray('beam').indexOf('continue') > -1 ||
this.getTextArray('beam').indexOf('end') > -1;
/**
* Indicates if this is the last not in a beam.
* @prop {Boolean} Note.isLastBeamNote is an boolean that indicates the last
* not in a beam
*/
this.isLastBeamNote = this.getTextArray('beam').every(b => b.indexOf('end') > -1);
/**
* Percussion notes don't have absolute values and are called "unpitched"
* @param {Boolean} Note.isUnpitched defines if note is a percussion note
*/
this.isUnpitched = this.childExists('unpitched');
/**
* The note's length. It is defined by the duration divided by the divisions
* in this measure.
* @param {Number} Note.NoteLength defines the note's length
*/
this.NoteLength = this.Duration / this.mDivisions;
this.Dots = this.NoteLength >= 1 && this.NoteLength % 1 === 0.5;
}
/**
* The note's voice number
* @returns {Number} voice Number of the voice
*/
get Voice() {
const voice = this.getNum('voice');
return Number.isNaN(voice) ? 1 : voice;
}
/**
* The notes pitch. It is defined by a step and the octave.
* @prop {Object} .Step: Step inside octave
* .Octave: Octave of the note
*/
get Pitch() {
const stepName = this.isUnpitched ? 'display-step' : 'step';
const octaveName = this.isUnpitched ? 'display-octave' : 'octave';
return {
Step: this.childExists(stepName) ? this.getText(stepName) : undefined,
Octave: this.getNum(octaveName),
};
}
get Notation() {
return this.childExists('notations') ? new Notation(this.getChild('notations')) : null;
}
get IsLastSlur() {
let res = false;
if (this.Notation && this.Notation.Slur) {
res = this.Notation.Slur.type === 'stop';
}
return res;
}
get Accidental() {
return this.getText('accidental');
}
get Clef() {
return this.mAttributes.Clef.filter(c => c.Number === this.Staff)[0];
}
get hasClefChange() {
return JSON.stringify(this.Clef) !== JSON.stringify(this.lastNote.Clef);
}
}
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Test.html">Test</a></li></ul><h3>Classes</h3><ul><li><a href="ClefVisitor.html">ClefVisitor</a></li><li><a href="Key_Key.html">Key</a></li><li><a href="KeyVisitor.html">KeyVisitor</a></li><li><a href="Measure.html">Measure</a></li><li><a href="MeasureVisitor.html">MeasureVisitor</a></li><li><a href="MusicXmlRenderer.html">MusicXmlRenderer</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteVisitor.html">NoteVisitor</a></li><li><a href="Part.html">Part</a></li><li><a href="TimeSignatureVisitor.html">TimeSignatureVisitor</a></li><li><a href="TimeVisitor.html">TimeVisitor</a></li><li><a href="XmlObject.html">XmlObject</a></li><li><a href="XmlSerializer_XmlSerializer.html">XmlSerializer</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Nov 20 2017 21:30:34 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>