abcjs 6.2.1 → 6.2.3

package/src/write/interactive/selection.js

@@ -127,6 +127,8 @@ function keyboardSelection(ev) {
 }
 
 function findElementInHistory(selectables, el) {
+	if (!el)
+		return -1;
 	for (var i = 0; i < selectables.length; i++) {
 		if (el.dataset.index === selectables[i].svgEl.dataset.index)
 			return i;
@@ -195,9 +197,13 @@ function getBestMatchCoordinates(dim, ev, scale) {
 
 function getTarget(target) {
 	// This searches up the dom for the first item containing the attribute "selectable", or stopping at the SVG.
+	if (!target)
+		return null;
 	if (target.tagName === "svg")
 		return target;
 
+	if (!target.getAttribute)
+		return null;	
 	var found = target.getAttribute("selectable");
 	while (!found) {
 		if (!target.parentElement)

package/src/write/layout/layout.js

@@ -3,7 +3,7 @@ var setUpperAndLowerElements = require('./set-upper-and-lower-elements');
 var layoutStaffGroup = require('./staff-group');
 var getLeftEdgeOfStaff = require('./get-left-edge-of-staff');
 
-var layout = function (renderer, abctune, width, space) {
+var layout = function (renderer, abctune, width, space, expandToWidest) {
 	var i;
 	var abcLine;
 	// Adjust the x-coordinates to their absolute positions
@@ -11,8 +11,14 @@ var layout = function (renderer, abctune, width, space) {
 	for (i = 0; i < abctune.lines.length; i++) {
 		abcLine = abctune.lines[i];
 		if (abcLine.staff) {
-			setXSpacing(renderer, width, space, abcLine.staffGroup, abctune.formatting, i === abctune.lines.length - 1, false);
-			if (abcLine.staffGroup.w > maxWidth) maxWidth = abcLine.staffGroup.w;
+			// console.log("=== line", i)
+			var thisWidth = setXSpacing(renderer, maxWidth, space, abcLine.staffGroup, abctune.formatting, i === abctune.lines.length - 1, false);
+			// console.log(thisWidth, maxWidth)
+			if (Math.round(thisWidth) > Math.round(maxWidth)) { // to take care of floating point weirdness
+				maxWidth = thisWidth
+				if (expandToWidest)
+					i = -1 // do the calculations over with the new width
+			}
 		}
 	}
 
@@ -41,15 +47,39 @@ var setXSpacing = function (renderer, width, space, staffGroup, formatting, isLa
 	var leftEdge = getLeftEdgeOfStaff(renderer, staffGroup.getTextSize, staffGroup.voices, staffGroup.brace, staffGroup.bracket);
 	var newspace = space;
 	for (var it = 0; it < 8; it++) { // TODO-PER: shouldn't need multiple passes, but each pass gets it closer to the right spacing. (Only affects long lines: normal lines break out of this loop quickly.)
+		// console.log("iteration", it)
+		// dumpGroup("before", staffGroup)
 		var ret = layoutStaffGroup(newspace, renderer, debug, staffGroup, leftEdge);
+		// dumpGroup("after",staffGroup)
 		newspace = calcHorizontalSpacing(isLastLine, formatting.stretchlast, width + renderer.padding.left, staffGroup.w, newspace, ret.spacingUnits, ret.minSpace, renderer.padding.left + renderer.padding.right);
 		if (debug)
 			console.log("setXSpace", it, staffGroup.w, newspace, staffGroup.minspace);
 		if (newspace === null) break;
 	}
 	centerWholeRests(staffGroup.voices);
+	return staffGroup.w - leftEdge
 };
 
+// function dumpGroup(label, staffGroup) {
+// 	var output = {
+// 		line: staffGroup.line,
+// 		w: staffGroup.w,
+// 		voice: {
+// 			i: staffGroup.voices[0].i,
+// 			minx: staffGroup.voices[0].minx,
+// 			nextx: staffGroup.voices[0].nextx,
+// 			spacingduration: staffGroup.voices[0].spacingduration,
+// 			w: staffGroup.voices[0].w,
+// 			children: [],
+// 		}
+// 	}
+// 	for (var i = 0; i < staffGroup.voices[0].children.length; i++) {
+// 		var child = staffGroup.voices[0].children[i]
+// 		output.voice.children.push({ fixedW: child.fixed.w, w: child.w, x: child.x, type: child.type })
+// 	}
+// 	console.log(label,output)
+// }
+
 function calcHorizontalSpacing(isLastLine, stretchLast, targetWidth, lineWidth, spacing, spacingUnits, minSpace, padding) {
 	if (isLastLine) {
 		if (stretchLast === undefined) {

package/src/write/svg.js

@@ -345,6 +345,16 @@ Svg.prototype.pathToBack = function (attr) {
 	return el;
 };
 
+Svg.prototype.lineToBack = function (attr) {
+	var el = document.createElementNS(svgNS, 'line');
+	var keys = Object.keys(attr)
+	for (var i = 0; i < keys.length; i++)
+		el.setAttribute(keys[i], attr[keys[i]]);
+	this.prepend(el);
+	return el;
+};
+
+
 Svg.prototype.append = function (el) {
 	if (this.currentGroup.length > 0)
 		this.currentGroup[0].appendChild(el);

package/types/index.d.ts

@@ -71,6 +71,8 @@ declare module 'abcjs' {
 		"mark" | "marcato" | "umarcato" |
 		"D.C.alcoda" | "D.C.alfine" | "D.S.alcoda" | "D.S.alfine" | "editorial" | "courtesy"
 
+	export type TablatureInstrument = 'guitar' | 'mandolin' | 'fiddle' | 'violin' | '';
+
 	//
 	// Basic types
 	//
@@ -251,6 +253,14 @@ declare module 'abcjs' {
 		minSpacingLimit?: number;
 	}
 
+	export interface Tablature {
+		instrument?: TablatureInstrument,
+		capo?: number
+		label?: string,
+		tuning?: Array<string>,
+		highestNote?: string,
+	}
+
 	export interface AbcVisualParams {
 		add_classes?: boolean;
 		afterParsing?: AfterParsing;
@@ -258,8 +268,9 @@ declare module 'abcjs' {
 		clickListener?: ClickListener;
 		dragColor?: string;
 		dragging?: boolean;
+		expandToWidest?: boolean;
 		foregroundColor?: string;
-		format?: { [attr in FormatAttributes]: any };
+		format?: { [attr in FormatAttributes]?: any };
 		header_only?: boolean;
 		initialClef?: boolean;
 		jazzchords?: boolean;
@@ -282,6 +293,7 @@ declare module 'abcjs' {
 		staffwidth?: number;
 		startingTune?: number;
 		stop_on_warning?: boolean;
+		tablature?: Array<Tablature>;
 		textboxpadding?: number;
 		viewportHorizontal?: boolean;
 		viewportVertical?: boolean;
@@ -399,7 +411,7 @@ declare module 'abcjs' {
 	//
 
 	// renderAbc
-	interface NoteTimingEvent {
+	export interface NoteTimingEvent {
 		milliseconds: number;
 		millisecondsPerMeasure: number;
 		type: NoteTimingEventType;
@@ -421,6 +433,11 @@ declare module 'abcjs' {
 		measureStart?: boolean;
 	}
 
+	// make an alias for backwards compatibility
+	export interface TimingEvent extends NoteTimingEvent {
+
+	}
+
 	export interface PercMapElement {
 		sound: number;
 		noteHead: NoteHeadType;
@@ -571,6 +588,7 @@ declare module 'abcjs' {
 		wordsfont: Font;
 	}
 
+	// Caution: The contents of this object may change at any time. If you reference this, be sure you retest for each abcjs release.
 	export interface EngraverController {
 		classes: any;
 		dragColor: string;
@@ -679,6 +697,7 @@ declare module 'abcjs' {
 
 	export interface VoiceItemBar {
 		el_type: "bar";
+		type: 'bar_dbl_repeat' | 'bar_right_repeat' | 'bar_left_repeat' |'bar_invisible' | 'bar_thick_thin' | 'bar_thin_thin' | 'bar_thin' | 'bar_thin_thick';
 		barNumber?: number;
 		chord?: Array<ChordProperties>;
 		decoration: Array<Decorations>;
@@ -829,6 +848,7 @@ declare module 'abcjs' {
 		setTiming: (bpm?: number, measuresOfDelay? : number) => void;
 		setUpAudio: (options: SynthOptions) => AudioTracks;
 		makeVoicesArray: () => Array<Selectable[]>
+		deline: () => Array<TuneLine>;
 		lineBreaks?: Array<number>;
 		visualTranspose?: number;
 	}
@@ -913,22 +933,6 @@ declare module 'abcjs' {
 		endTimings: Array<LineEndInfo>;
 	}
 
-	export interface TimingEvent {
-		type: "event";
-		milliseconds: number;
-		millisecondsPerMeasure: number;
-		line: number;
-		measureNumber: number;
-		top: number;
-		height: number;
-		left: number;
-		width: number;
-		elements: Array< HTMLElement>;
-		startCharArray: Array<number>;
-		endCharArray: Array<number>;
-		midiPitches: MidiPitches
-	}
-
 	export interface TimingCallbacksPosition {
 		top: number;
 		left: number;
@@ -1068,9 +1072,11 @@ declare module 'abcjs' {
 	// TimingCallbacks
 	export type BeatCallback = (beatNumber: number, totalBeats: number, totalTime: number, position: TimingCallbacksPosition, debugInfo: TimingCallbacksDebug) => void;
 
-	export type EventCallback = (event: TimingEvent) => void;
+	type EventCallbackReturn = "continue" | Promise<"continue"> | undefined
+
+	export type EventCallback = (event: NoteTimingEvent | null) => EventCallbackReturn;
 
-	export type LineEndCallback = (info : LineEndInfo, event: TimingEvent, details: LineEndDetails) => void;
+	export type LineEndCallback = (info : LineEndInfo, event: NoteTimingEvent, details: LineEndDetails) => void;
 
 	// Editor
 	export type OnChange = (editor: Editor) => void;
@@ -1125,6 +1131,7 @@ declare module 'abcjs' {
 		pause(shouldPause: boolean): void;
 		millisecondsPerMeasure(): number;
 		pauseMidi(shouldPause: boolean): void;
+		fireChanged():void;
 	}
 
 	//
@@ -1149,6 +1156,7 @@ declare module 'abcjs' {
 		seek(position: number, units?: ProgressUnit): void
 		stop(): number
 		download(): string // returns audio buffer in wav format as a reference to a blob
+		getIsRunning(): boolean
 	}
 
 	export interface SynthInitResponse {
@@ -1192,7 +1200,7 @@ declare module 'abcjs' {
 		export function activeAudioContext(): AudioContext
 		export function CreateSynthControl(element: Selector, options: AbcVisualParams): AudioControl
 		export function getMidiFile(source: string | TuneObject, options?: MidiFileOptions): MidiFile;
-		export function playEvent(pitches: MidiPitches, graceNotes: MidiGracePitches | undefined, milliSecondsPerMeasure: number): Promise<void>;
+		export function playEvent(pitches: MidiPitches, graceNotes: MidiGracePitches | undefined, milliSecondsPerMeasure: number, soundFontUrl? : string, debugCallback?: (message: string) => void): Promise<void>;
 		export function sequence(visualObj: TuneObject, options: AbcVisualParams): AudioSequence
 	}
 

package/version.js

@@ -1,3 +1,3 @@
-var version = '6.2.1';
+var version = '6.2.3';
 
 module.exports = version;