music21j-port
Version:
A toolkit for computer-aided musicology, Javascript version
2,214 lines • 34.9 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Music21j Class: Keyboard</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.spruce.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Music21j</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="music21.html">music21</a>
</li>
<li>
<a href="music21.articulations.html">music21.articulations</a>
</li>
<li>
<a href="music21.audioSearch.html">music21.audioSearch</a>
</li>
<li>
<a href="music21.base.html">music21.base</a>
</li>
<li>
<a href="music21.beam.html">music21.beam</a>
</li>
<li>
<a href="music21.chord.html">music21.chord</a>
</li>
<li>
<a href="music21.clef.html">music21.clef</a>
</li>
<li>
<a href="music21.common.html">music21.common</a>
</li>
<li>
<a href="music21.duration.html">music21.duration</a>
</li>
<li>
<a href="music21.dynamics.html">music21.dynamics</a>
</li>
<li>
<a href="music21.expressions.html">music21.expressions</a>
</li>
<li>
<a href="music21.fromPython.html">music21.fromPython</a>
</li>
<li>
<a href="music21.instrument.html">music21.instrument</a>
</li>
<li>
<a href="music21.interval.html">music21.interval</a>
</li>
<li>
<a href="music21.key.html">music21.key</a>
</li>
<li>
<a href="music21.keyboard.html">music21.keyboard</a>
</li>
<li>
<a href="music21.meter.html">music21.meter</a>
</li>
<li>
<a href="music21.miditools.html">music21.miditools</a>
</li>
<li>
<a href="music21.note.html">music21.note</a>
</li>
<li>
<a href="music21.pitch.html">music21.pitch</a>
</li>
<li>
<a href="music21.prebase.html">music21.prebase</a>
</li>
<li>
<a href="music21.renderOptions.html">music21.renderOptions</a>
</li>
<li>
<a href="music21.roman.html">music21.roman</a>
</li>
<li>
<a href="music21.scale.html">music21.scale</a>
</li>
<li>
<a href="music21.sites.html">music21.sites</a>
</li>
<li>
<a href="music21.stream.html">music21.stream</a>
</li>
<li>
<a href="music21.tempo.html">music21.tempo</a>
</li>
<li>
<a href="music21.tie.html">music21.tie</a>
</li>
<li>
<a href="music21.tinyNotation.html">music21.tinyNotation</a>
</li>
<li>
<a href="music21.vfShow.html">music21.vfShow</a>
</li>
<li>
<a href="music21.webmidi.html">music21.webmidi</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="music21.articulations.Accent.html">music21.articulations.Accent</a>
</li>
<li>
<a href="music21.articulations.Articulation.html">music21.articulations.Articulation</a>
</li>
<li>
<a href="music21.articulations.DynamicArticulation.html">music21.articulations.DynamicArticulation</a>
</li>
<li>
<a href="music21.articulations.LengthArticulation.html">music21.articulations.LengthArticulation</a>
</li>
<li>
<a href="music21.articulations.Marcato.html">music21.articulations.Marcato</a>
</li>
<li>
<a href="music21.articulations.PitchArticulation.html">music21.articulations.PitchArticulation</a>
</li>
<li>
<a href="music21.articulations.Spiccato.html">music21.articulations.Spiccato</a>
</li>
<li>
<a href="music21.articulations.Staccatissimo.html">music21.articulations.Staccatissimo</a>
</li>
<li>
<a href="music21.articulations.Staccato.html">music21.articulations.Staccato</a>
</li>
<li>
<a href="music21.articulations.StrongAccent.html">music21.articulations.StrongAccent</a>
</li>
<li>
<a href="music21.articulations.Tenuto.html">music21.articulations.Tenuto</a>
</li>
<li>
<a href="music21.articulations.TimbreArticulation.html">music21.articulations.TimbreArticulation</a>
</li>
<li>
<a href="music21.base.Music21Object.html">music21.base.Music21Object</a>
</li>
<li>
<a href="music21.beam.Beam.html">music21.beam.Beam</a>
</li>
<li>
<a href="music21.beam.Beams.html">music21.beam.Beams</a>
</li>
<li>
<a href="music21.chord.Chord.html">music21.chord.Chord</a>
</li>
<li>
<a href="music21.clef.AltoClef.html">music21.clef.AltoClef</a>
</li>
<li>
<a href="music21.clef.BassClef.html">music21.clef.BassClef</a>
</li>
<li>
<a href="music21.clef.Clef.html">music21.clef.Clef</a>
</li>
<li>
<a href="music21.clef.MezzoSopranoClef.html">music21.clef.MezzoSopranoClef</a>
</li>
<li>
<a href="music21.clef.PercussionClef.html">music21.clef.PercussionClef</a>
</li>
<li>
<a href="music21.clef.SopranoClef.html">music21.clef.SopranoClef</a>
</li>
<li>
<a href="music21.clef.TenorClef.html">music21.clef.TenorClef</a>
</li>
<li>
<a href="music21.clef.Treble8vaClef.html">music21.clef.Treble8vaClef</a>
</li>
<li>
<a href="music21.clef.Treble8vbClef.html">music21.clef.Treble8vbClef</a>
</li>
<li>
<a href="music21.clef.TrebleClef.html">music21.clef.TrebleClef</a>
</li>
<li>
<a href="music21.duration.Duration.html">music21.duration.Duration</a>
</li>
<li>
<a href="music21.duration.Tuplet.html">music21.duration.Tuplet</a>
</li>
<li>
<a href="music21.dynamics.Dynamic.html">music21.dynamics.Dynamic</a>
</li>
<li>
<a href="music21.expressions.Expression.html">music21.expressions.Expression</a>
</li>
<li>
<a href="music21.expressions.Fermata.html">music21.expressions.Fermata</a>
</li>
<li>
<a href="music21.fromPython.Converter.html">music21.fromPython.Converter</a>
</li>
<li>
<a href="music21.instrument.Instrument.html">music21.instrument.Instrument</a>
</li>
<li>
<a href="music21.interval.ChromaticInterval.html">music21.interval.ChromaticInterval</a>
</li>
<li>
<a href="music21.interval.DiatonicInterval.html">music21.interval.DiatonicInterval</a>
</li>
<li>
<a href="music21.interval.GenericInterval.html">music21.interval.GenericInterval</a>
</li>
<li>
<a href="music21.interval.Interval.html">music21.interval.Interval</a>
</li>
<li>
<a href="music21.key.Key.html">music21.key.Key</a>
</li>
<li>
<a href="music21.key.KeySignature.html">music21.key.KeySignature</a>
</li>
<li>
<a href="music21.keyboard.BlackKey.html">music21.keyboard.BlackKey</a>
</li>
<li>
<a href="music21.keyboard.Key.html">music21.keyboard.Key</a>
</li>
<li>
<a href="music21.keyboard.Keyboard.html">music21.keyboard.Keyboard</a>
</li>
<li>
<a href="music21.keyboard.WhiteKey.html">music21.keyboard.WhiteKey</a>
</li>
<li>
<a href="music21.meter.TimeSignature.html">music21.meter.TimeSignature</a>
</li>
<li>
<a href="music21.miditools.Event.html">music21.miditools.Event</a>
</li>
<li>
<a href="music21.miditools.MidiPlayer.html">music21.miditools.MidiPlayer</a>
</li>
<li>
<a href="music21.note.GeneralNote.html">music21.note.GeneralNote</a>
</li>
<li>
<a href="music21.note.Lyric.html">music21.note.Lyric</a>
</li>
<li>
<a href="music21.note.Note.html">music21.note.Note</a>
</li>
<li>
<a href="music21.note.NotRest.html">music21.note.NotRest</a>
</li>
<li>
<a href="music21.note.Rest.html">music21.note.Rest</a>
</li>
<li>
<a href="music21.pitch.Accidental.html">music21.pitch.Accidental</a>
</li>
<li>
<a href="music21.pitch.Pitch.html">music21.pitch.Pitch</a>
</li>
<li>
<a href="music21.prebase.ProtoM21Object.html">music21.prebase.ProtoM21Object</a>
</li>
<li>
<a href="music21.renderOptions.RenderOptions.html">music21.renderOptions.RenderOptions</a>
</li>
<li>
<a href="music21.roman.RomanNumeral.html">music21.roman.RomanNumeral</a>
</li>
<li>
<a href="music21.stream.Measure.html">music21.stream.Measure</a>
</li>
<li>
<a href="music21.stream.Part.html">music21.stream.Part</a>
</li>
<li>
<a href="music21.stream.Score.html">music21.stream.Score</a>
</li>
<li>
<a href="music21.stream.Stream.html">music21.stream.Stream</a>
</li>
<li>
<a href="music21.stream.Voice.html">music21.stream.Voice</a>
</li>
<li>
<a href="music21.tempo.Metronome.html">music21.tempo.Metronome</a>
</li>
<li>
<a href="music21.tie.Tie.html">music21.tie.Tie</a>
</li>
<li>
<a href="music21.vfShow.Renderer.html">music21.vfShow.Renderer</a>
</li>
<li>
<a href="music21.vfShow.RenderStack.html">music21.vfShow.RenderStack</a>
</li>
<li>
<a href="Notation.html">Notation</a>
</li>
<li>
<a href="Page.html">Page</a>
</li>
<li>
<a href="Recorder.html">Recorder</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="global.html#getM21attribute">getM21attribute</a>
</li>
<li>
<a href="global.html#layout">layout</a>
</li>
<li>
<a href="global.html#midiNumDiffFromFrequency">midiNumDiffFromFrequency</a>
</li>
<li>
<a href="global.html#recorderWorkerJs">recorderWorkerJs</a>
</li>
<li>
<a href="global.html#unpickler">unpickler</a>
</li>
<li>
<a href="global.html#warnBanner">warnBanner</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: Keyboard</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="music21.html">music21</a><a href="music21.keyboard.html">.keyboard</a>.</span>
Keyboard
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Keyboard"><span class="type-signature"></span>new Keyboard<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A Class representing a whole Keyboard full of keys.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>whiteKeyWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>default 23</p></td>
</tr>
<tr>
<td class="name"><code>scaleFactor</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>default 1</p></td>
</tr>
<tr>
<td class="name"><code>keyObjects</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>a mapping of id to <a href="music21.keyboard.Key.html"><code>music21.keyboard.Key</code></a> objects</p></td>
</tr>
<tr>
<td class="name"><code>svgObj</code></td>
<td class="type">
<span class="param-type">DOMObject</span>
</td>
<td class="description last"><p>the SVG object of the keyboard</p></td>
</tr>
<tr>
<td class="name"><code>markC</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"><p>default true</p></td>
</tr>
<tr>
<td class="name"><code>showNames</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"><p>default false</p></td>
</tr>
<tr>
<td class="name"><code>showOctaves</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"><p>default false</p></td>
</tr>
<tr>
<td class="name"><code>startPitch</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>default "C3"</p></td>
</tr>
<tr>
<td class="name"><code>endPitch</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>default "C5"</p></td>
</tr>
<tr>
<td class="name"><code>hideable</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"><p>default false -- add a way to hide and show keyboard</p></td>
</tr>
<tr>
<td class="name"><code>scrollable</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"><p>default false -- add scroll bars to change octave</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="music21_keyboard.js.html">music21/keyboard.js</a>,
<a href="music21_keyboard.js.html#sunlight-1-line-257">line 257</a>
</li>
</ul>
</dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt class="name" id="callbacks">
<h4><span class="type-signature"></span>callbacks<span class="type-signature"> :object</span></h4>
</dt>
<dd>
<div class="description">
<p>An object of callbacks on events.</p>
<p>default:</p>
<ul>
<li>click: this.clickhandler</li>
</ul>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="music21_keyboard.js.html">music21/keyboard.js</a>,
<a href="music21_keyboard.js.html#sunlight-1-line-295">line 295</a>
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="appendHideableKeyboard"><span class="type-signature"></span>appendHideableKeyboard<span class="signature">(where, keyboardSVG)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Puts a hideable keyboard inside a Div with the proper controls.</p>
<p>Do not call this directly, just use createSVG after changing the<br>hideable property on the keyboard to True.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>where</code></td>
<td class="type">
<span class="param-type">DOMObject</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>keyboardSVG</code></td>
<td class="type">
<span class="param-type">DOMObject</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="music21_keyboard.js.html">music21/keyboard.js</a>,
<a href="music21_keyboard.js.html#sunlight-1-line-593">line 593</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="appendKeyboard"><span class="type-signature"></span>appendKeyboard<span class="signature">(<span class="optional">where</span>)</span><span class="type-signature"> → {<a href="music21.keyboard.Keyboard.html">music21.keyboard.Keyboard</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Appends a keyboard to the <code>where</code> parameter</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>where</code></td>
<td class="type">
<span class="param-type">JQueryDOMObject</span>
|
<span class="param-type">DOMObject</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="music21_keyboard.js.html">music21/keyboard.js</a>,
<a href="music21_keyboard.js.html#sunlight-1-line-335">line 335</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="music21.keyboard.Keyboard.html">music21.keyboard.Keyboard</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="clickhandler"><span class="type-signature"></span>clickhandler<span class="signature">(keyRect)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Handle a click on a given SVG object</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>keyRect</code></td>
<td class="type">
<span class="param-type">DOMObject</span>
</td>
<td class="description last"><p>the dom object with the keyboard.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="music21_keyboard.js.html">music21/keyboard.js</a>,
<a href="music21_keyboard.js.html#sunlight-1-line-363">line 363</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="createSVG"><span class="type-signature"></span>createSVG<span class="signature">()</span><span class="type-signature"> → {DOMObject}</span></h4>
</dt>
<dd>
<div class="description">
<p>Draws the SVG associated with this Keyboard</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="music21_keyboard.js.html">music21/keyboard.js</a>,
<a href="music21_keyboard.js.html#sunlight-1-line-391">line 391</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>new svgDOM</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">DOMObject</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="markMiddleC"><span class="type-signature"></span>markMiddleC<span class="signature">(<span class="optional">strokeColor</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Puts a circle on middle c.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>strokeColor</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'red'
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="music21_keyboard.js.html">music21/keyboard.js</a>,
<a href="music21_keyboard.js.html#sunlight-1-line-506">line 506</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="markNoteNames"><span class="type-signature"></span>markNoteNames<span class="signature">(<span class="optional">labelOctaves</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Puts note names on every white key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>labelOctaves</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="music21_keyboard.js.html">music21/keyboard.js</a>,
<a href="music21_keyboard.js.html#sunlight-1-line-518">line 518</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="redrawSVG"><span class="type-signature"></span>redrawSVG<span class="signature">()</span><span class="type-signature"> → {DOMObject}</span></h4>
</dt>
<dd>
<div class="description">
<p>Redraws the SVG associated with this Keyboard</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="music21_keyboard.js.html">music21/keyboard.js</a>,
<a href="music21_keyboard.js.html#sunlight-1-line-318">line 318</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>new svgDOM</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">DOMObject</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="removeNoteNames"><span class="type-signature"></span>removeNoteNames<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Remove note names on the keys, if they exist</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="music21_keyboard.js.html">music21/keyboard.js</a>,
<a href="music21_keyboard.js.html#sunlight-1-line-534">line 534</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="wrapScrollable"><span class="type-signature"></span>wrapScrollable<span class="signature">(svgDOM)</span><span class="type-signature"> → {JQueryDOMObject}</span></h4>
</dt>
<dd>
<div class="description">
<p>Wraps the SVG object inside a scrollable set of buttons</p>
<p>Do not call this directly, just use createSVG after changing the<br>scrollable property on the keyboard to True.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>svgDOM</code></td>
<td class="type">
<span class="param-type">DOMObject</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="music21_keyboard.js.html">music21/keyboard.js</a>,
<a href="music21_keyboard.js.html#sunlight-1-line-548">line 548</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">JQueryDOMObject</span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Music21j, Copyright © 2013-2018 Michael Scott Cuthbert and cuthbertLab.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Wed Jul 4th 2018 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<!--<script src="scripts/sunlight.js"></script>-->
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : "100px"
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
// $( ".tutorial-section pre, .readme-section pre" ).addClass( "sunlight-highlight-javascript" ).addClass( "linenums" );
$( ".tutorial-section pre, .readme-section pre" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
lang = "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
</body>
</html>