UNPKG

music21j-port

Version:

A toolkit for computer-aided musicology, Javascript version

1,942 lines (859 loc) 31.1 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Music21j Class: Score</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: Score</h1> <section> <header> <h2> <span class="ancestors"><a href="music21.html">music21</a><a href="music21.stream.html">.stream</a>.</span> Score </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="Score"><span class="type-signature"></span>new Score<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Scores with multiple parts</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="music21_stream.js.html">music21/stream.js</a>, <a href="music21_stream.js.html#sunlight-1-line-2585">line 2585</a> </li> </ul> </dd> </dl> </dd> </div> <h3 class="subsection-title">Extends</h3> <ul> <li><a href="music21.stream.Stream.html">music21.stream.Stream</a></li> </ul> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name" id="estimateStaffLength"><span class="type-signature">&lt;static> </span>Score#estimateStaffLength<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4> </dt> <dd> <div class="description"> <p>Overrides the default music21.stream.Stream#estimateStaffLength</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="music21_stream.js.html">music21/stream.js</a>, <a href="music21_stream.js.html#sunlight-1-line-2667">line 2667</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">number</span> </dd> </dl> </dd> <dt> <h4 class="name" id="evenPartMeasureSpacing"><span class="type-signature">&lt;static> </span>Score#evenPartMeasureSpacing<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="music21.stream.Score.html">music21.stream.Score</a>}</span></h4> </dt> <dd> <div class="description"> <p>Fixes the part measure spacing for all parts.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="music21_stream.js.html">music21/stream.js</a>, <a href="music21_stream.js.html#sunlight-1-line-2831">line 2831</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.stream.Score.html">music21.stream.Score</a></span> </dd> </dl> </dd> <dt> <h4 class="name" id="findNoteForClick"><span class="type-signature">&lt;static> </span>Score#findNoteForClick<span class="signature">(svg, e)</span><span class="type-signature"> &rarr; {Array}</span></h4> </dt> <dd> <div class="description"> <p>Returns a list of [clickedDiatonicNoteNum, foundNote] for a<br>click event, taking into account that the note will be in different<br>Part objects (and different Systems) given the height and possibly different Systems.</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>svg</code></td> <td class="type"> <span class="param-type">DOMObject</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>e</code></td> <td class="type"> <span class="param-type">Event</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_stream.js.html">music21/stream.js</a>, <a href="music21_stream.js.html#sunlight-1-line-2787">line 2787</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>[diatonicNoteNum, m21Element]</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Array</span> </dd> </dl> </dd> <dt> <h4 class="name" id="getMaxMeasureWidths"><span class="type-signature">&lt;static> </span>Score#getMaxMeasureWidths<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>call after setSubstreamRenderOptions<br>gets the maximum measure width for each measure<br>by getting the maximum for each measure of<br>Part.getMeasureWidths();</p> <p>Does this work? I found a bug in this and fixed it that should have<br>broken it!</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="music21_stream.js.html">music21/stream.js</a>, <a href="music21_stream.js.html#sunlight-1-line-2735">line 2735</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Array<number></p> </div> </dd> <dt> <h4 class="name" id="getStreamFromScaledXandSystemIndex"><span class="type-signature">&lt;static> </span>Score#getStreamFromScaledXandSystemIndex<span class="signature">(<span class="optional">xPxScaled</span>, <span class="optional">systemIndex</span>)</span><span class="type-signature"> &rarr; {<a href="music21.stream.Stream.html">music21.stream.Stream</a>}</span></h4> </dt> <dd> <div class="description"> <p>Returns the measure that is at X location xPxScaled and system systemIndex.</p> <p>Always returns the measure of the top part...</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>xPxScaled</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> &lt;optional><br> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>systemIndex</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> &lt;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_stream.js.html">music21/stream.js</a>, <a href="music21_stream.js.html#sunlight-1-line-2623">line 2623</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>usually a Measure</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="music21.stream.Stream.html">music21.stream.Stream</a></span> </dd> </dl> </dd> <dt> <h4 class="name" id="numSystems"><span class="type-signature">&lt;static> </span>Score#numSystems<span class="signature">()</span><span class="type-signature"> &rarr; {Int}</span></h4> </dt> <dd> <div class="description"> <p>How many systems are there? Calls numSystems() on the first part.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="music21_stream.js.html">music21/stream.js</a>, <a href="music21_stream.js.html#sunlight-1-line-2819">line 2819</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Int</span> </dd> </dl> </dd> <dt> <h4 class="name" id="playStream"><span class="type-signature">&lt;static> </span>Score#playStream<span class="signature">(params)</span><span class="type-signature"> &rarr; {<a href="music21.stream.Score.html">music21.stream.Score</a>}</span></h4> </dt> <dd> <div class="description"> <p>Overrides the default music21.stream.Stream#playStream</p> <p>Works crappily -- just starts <em>n</em> midi players.</p> <p>Render scrollable score works better...</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>params</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><ul> <li>passed to each part</li> </ul></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="music21_stream.js.html">music21/stream.js</a>, <a href="music21_stream.js.html#sunlight-1-line-2697">line 2697</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.stream.Score.html">music21.stream.Score</a></span> </dd> </dl> </dd> <dt> <h4 class="name" id="setSubstreamRenderOptions"><span class="type-signature">&lt;static> </span>Score#setSubstreamRenderOptions<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="music21.stream.Score.html">music21.stream.Score</a>}</span></h4> </dt> <dd> <div class="description"> <p>overrides music21.stream.Stream#setSubstreamRenderOptions</p> <p>figures out the <code>.left</code> and <code>.top</code> attributes for all contained parts</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="music21_stream.js.html">music21/stream.js</a>, <a href="music21_stream.js.html#sunlight-1-line-2637">line 2637</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.stream.Score.html">music21.stream.Score</a></span> </dd> </dl> </dd> <dt> <h4 class="name" id="stopPlayStream"><span class="type-signature">&lt;static> </span>Score#stopPlayStream<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="music21.stream.Score.html">music21.stream.Score</a>}</span></h4> </dt> <dd> <div class="description"> <p>Overrides the default music21.stream.Stream#stopPlayScore()</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="music21_stream.js.html">music21/stream.js</a>, <a href="music21_stream.js.html#sunlight-1-line-2712">line 2712</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.stream.Score.html">music21.stream.Score</a></span> </dd> </dl> </dd> <dt> <h4 class="name" id="systemIndexAndScaledY"><span class="type-signature">&lt;static> </span>Score#systemIndexAndScaledY<span class="signature">(y)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>systemIndexAndScaledY - given a scaled Y, return the systemIndex<br>and the scaledYRelativeToSystem</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>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>the scaled Y</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_stream.js.html">music21/stream.js</a>, <a href="music21_stream.js.html#sunlight-1-line-2764">line 2764</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Array<int, number> systemIndex, scaledYRelativeToSystem</p> </div> </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>