music21j-port

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Music21j Source: music21/layout.js</title>  <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="span12"> <div id="main"> <h1 class="page-title">Source: music21/layout.js</h1> <section> <article> <pre class="sunlight-highlight-javascript linenums">// future -- rewrite of Score and Part to Page, System, SystemPart // not currently used // import * as $ from 'jquery'; // // import { base } from './base.js'; // import { renderOptions } from './renderOptions.js'; import { stream } from './stream.js'; // import { common } from './common.js'; /** * Does not work yet, so not documented * */ export const layout = {}; layout.makeLayoutFromScore = function makeLayoutFromScore( score, containerWidth ) { /* * Divide a part up into systems and fix the measure * widths so that they are all even. * * Note that this is done on the part level even though * the measure widths need to be consistent across parts. * * This is possible because the system is deterministic and * will come to the same result for each part. Opportunity * for making more efficient through this... */ // var systemHeight = score.systemHeight; /* part.show() called... */ // var systemPadding = score.systemPadding; const parts = score.parts; // console.log(parts); const numParts = parts.length; const partZero = parts[0]; const numMeasures = partZero.length; const measureWidths = partZero.getMeasureWidths(); const maxSystemWidth = containerWidth || score.maxSystemWidth; /* of course fix! */ const layoutScore = new layout.LayoutScore(); const currentPage = new layout.Page(); // to-do multiple pages... currentPage.measureStart = 1; currentPage.measureEnd = numMeasures; layoutScore.insert(0, currentPage); let currentSystem = new layout.System(); let currentSystemNumber = 1; currentSystem.measureStart = 1; let currentStaves = []; const staffMaker = (staffHolder, numParts, measureStart) => { for (let pNum = 0; pNum < numParts; pNum++) { const staff = new layout.Staff(); staff.measureStart = measureStart; staff.staffNumber = pNum + 1; staffHolder.push(staff); } }; staffMaker(currentStaves, numParts, 1); const systemCurrentWidths = []; const systemBreakIndexes = []; let lastSystemBreak = 0; /* needed to ensure each line has at least one measure */ const startLeft = 20; /* TODO: make it obtained elsewhere */ let currentLeft = startLeft; // let currentSystemTop = 0; // var partTopOffsets = []; // const ignoreSystemsInCalculatingScoreHeight = true; // const systemHeight = score.estimateStreamHeight(ignoreSystemsInCalculatingScoreHeight); for (let i = 0; i < measureWidths.length; i++) { const currentRight = currentLeft + measureWidths[i]; /* console.log("left: " + currentLeft + " ; right: " + currentRight + " ; m: " + i); */ if (currentRight > maxSystemWidth && lastSystemBreak !== i) { // new system... for (let j = 0; j < currentStaves.length; j++) { currentStaves.measureEnd = i; currentSystem.insert(0, currentStaves[j]); } currentStaves = []; staffMaker(currentStaves, numParts, i + 1); // currentSystemTop += systemHeight; currentSystem.measureEnd = i; currentPage.insert(0, currentSystem); currentSystemNumber += 1; currentSystem = new layout.System(); currentSystem.measureStart = i + 1; currentSystem.systemNumber = currentSystemNumber; systemBreakIndexes.push(i - 1); systemCurrentWidths.push(currentLeft); console.log( 'setting new width at ' + currentLeft + ' measure ' + i ); currentLeft = startLeft + measureWidths[i]; lastSystemBreak = i; } else { currentLeft = currentRight; } for (let pNum = 0; pNum < currentStaves.length; pNum++) { currentStaves[pNum].append(parts[pNum].get(i)); } } for (let j = 0; j < currentStaves.length; j++) { currentStaves.measureEnd = measureWidths.length - 1; currentSystem.insert(0, currentStaves[j]); } currentPage.insert(0, currentSystem); return layoutScore; }; export class LayoutScore extends stream.Score { constructor() { super(); this.scoreLayout = undefined; this.measureStart = undefined; this.measureEnd = undefined; this._width = undefined; this.height = undefined; this.top = 0; this.left = 0; } get pages() { return this.getElementsByClass('Page'); } get width() { if (this._width) { return this._width; } else if (this.activeSite) { return this.activeSite.width; } else { return undefined; } } /** * return a tuple of (top, bottom) for a staff, specified by a given pageId, * systemId, and staffId in PIXELS. * @param pageId * @param systemId * @param staffId * @param units -- "pixels" or "tenths" (not supported) */ getPositionForStaff(pageId, systemId, staffId, units) { units = units || 'pixels'; } } layout.LayoutScore = LayoutScore; /** * All music must currently be on page 1. */ export class Page extends stream.Score { constructor() { super(); this.pageNumber = 1; this.measureStart = undefined; this.measureEnd = undefined; this.systemStart = undefined; this.systemEnd = undefined; this.pageLayout = undefined; } get systems() { return this.getElementsByClass('System'); } get width() { if (this._width) { return this._width; } else if (this.activeSite) { return this.activeSite.width; } else { return undefined; } } } layout.Page = Page; export class System extends stream.Score { constructor() { super(); this.systemNumber = 1; this.systemLayout = undefined; this.measureStart = undefined; this.measureEnd = undefined; this._width = undefined; this.height = undefined; this.top = undefined; this.left = undefined; } get staves() { return this.getElementsByClass('Staff'); } get width() { if (this._width) { return this._width; } else if (this.activeSite) { return this.activeSite.width; } else { return undefined; } } } layout.System = System; export class Staff extends stream.Part { constructor() { super(); this.staffNumber = 1; this.optimized = 0; this.top = undefined; this.left = undefined; this._width = undefined; this.height = undefined; this.inheritedHeight = undefined; this.staffLayout = undefined; } get width() { if (this._width) { return this._width; } else if (this.activeSite) { return this.activeSite.width; } else { return undefined; } } } layout.Staff = Staff; </pre> </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> <br clear="both"> </div> </div>  <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>   </body> </html>