vexflow-musicxml
Version:
MusicXml Parser for vexflow
227 lines (74 loc) • 3.79 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: KeyVisitor</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">Class: KeyVisitor</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>KeyVisitor<span class="signature">(Key)</span><span class="type-signature"></span></h2>
<div class="class-description">This class implements a visitor used to convert MusicXML keys to VexFlow keys</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="KeyVisitor"><span class="type-signature"></span>new KeyVisitor<span class="signature">(Key)</span><span class="type-signature"></span></h4>
<div class="description">
From the docs:
Traditional key signatures are represented by the number
of flats and sharps, plus an optional mode for major/
minor/mode distinctions. Negative numbers are used for
flats and positive numbers for sharps, reflecting the
key's placement within the circle of fifths (hence the
element name).
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Key</code></td>
<td class="type">
<span class="param-type">xmlKey</span>
</td>
<td class="description last">MusicXml object to be translated</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_visitors_KeyVisitor.js.html">src/visitors/KeyVisitor.js</a>, <a href="src_visitors_KeyVisitor.js.html#line8">line 8</a>
</li></ul></dd>
</dl>
</div>
</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>