abcjs 6.5.1 → 6.6.0

package/src/write/draw/text.js

@@ -39,7 +39,7 @@ function renderText(renderer, params, alreadyInGroup) {
 
 	// MAE 9 May 2025 for free text blocks
 	var text;
-	if (params.name == "free-text"){
+	if (params.name === "free-text"){
 		text = params.text.replace(/^[ \t]*\n/gm, ' \n');
 	}
 	else{

package/src/write/engraver-controller.js

@@ -74,6 +74,8 @@ var EngraverController = function (paper, params) {
 		this.germanAlphabet = params.germanAlphabet;
 	if (params.lineThickness)
 		this.lineThickness = params.lineThickness;
+	if (params.chordGrid)
+		this.chordGrid = params.chordGrid;
 	this.renderer.controller = this; // TODO-GD needed for highlighting
 	this.renderer.foregroundColor = params.foregroundColor ? params.foregroundColor : "currentColor";
 	if (params.ariaLabel !== undefined)
@@ -251,7 +253,7 @@ EngraverController.prototype.engraveTune = function (abcTune, tuneNumber, lineOf
 
 	var origJazzChords = this.jazzchords
 	var scale = this.setupTune(abcTune, tuneNumber);
-  
+
 	// Create all of the element objects that will appear on the page.
 	this.constructTuneElements(abcTune);
   
@@ -300,7 +302,7 @@ EngraverController.prototype.engraveTune = function (abcTune, tuneNumber, lineOf
 	}
   
 	// Do all the writing to the SVG
-	var ret = draw(this.renderer, this.classes, abcTune, this.width, maxWidth, this.responsive, scale, this.selectTypes, tuneNumber, lineOffset);
+	var ret = draw(this.renderer, this.classes, abcTune, this.width, maxWidth, this.responsive, scale, this.selectTypes, tuneNumber, lineOffset, this.chordGrid);
 	this.staffgroups = ret.staffgroups;
 	this.selectables = ret.selectables;
 	if (this.oneSvgPerLine) {

package/src/write/layout/beam.js

@@ -189,7 +189,22 @@ function createAdditionalBeams(elems, asc, beam, isGrace, dy) {
 
 
 				if (auxBeams[j].single) {
-					auxBeamEndX = (i === 0) ? x + 5 : x - 5;
+					if(i === 0) {
+						// This is the first note in the group, always draw the beam to the right
+						auxBeamEndX = x + 5;
+					} else if (i === elems.length - 1) {
+						// This is the last note in the group, always draw the beam to the left
+						auxBeamEndX = x - 5;
+					} else {
+						// This is a middle note, check the note durations of the notes to the left and right
+						if(elems[i-1].duration === elems[i+1].duration) {
+						// The notes on either side are the same duration, alternate which side the beam goes to
+						auxBeamEndX = i%2 === 0 ? x + 5 : x - 5;
+						} else {
+						// The notes on either side are different durations, draw the beam to the shorter note
+						auxBeamEndX = elems[i-1].duration > elems[i+1].duration ? x + 5 : x - 5;
+						}
+					}
 					auxBeamEndY = getBarYAt(beam.startX, beam.startY, beam.endX, beam.endY, auxBeamEndX) + sy * (j + 1);
 				}
 				var b = { startX: auxBeams[j].x, endX: auxBeamEndX, startY: auxBeams[j].y, endY: auxBeamEndY, dy: dy }

package/src/write/renderer.js

@@ -179,6 +179,10 @@ Renderer.prototype.calcY = function (ofs) {
 	return this.y - ofs * spacing.STEP;
 };
 
+Renderer.prototype.yToPitch = function (ofs) {
+	return ofs / spacing.STEP;
+};
+
 Renderer.prototype.moveY = function (em, numLines) {
 	if (numLines === undefined) numLines = 1;
 	this.y += em * numLines;

package/src/write/svg.js

@@ -168,7 +168,7 @@ Svg.prototype.rectBeneath = function (attr) {
 	this.svg.insertBefore(el, this.svg.firstChild);
 };
 
-Svg.prototype.text = function (text, attr, target) {
+Svg.prototype.text = function (text, attr, target, spanAttr) {
 	var el = document.createElementNS(svgNS, 'text');
 	el.setAttribute("stroke", "none");
 	for (var key in attr) {
@@ -185,6 +185,13 @@ Svg.prototype.text = function (text, attr, target) {
 	    }
 
 		var line = document.createElementNS(svgNS, 'tspan');
+		if (spanAttr) {
+			for (var skey in spanAttr) {
+				if (spanAttr.hasOwnProperty(skey)) {
+					line.setAttribute(skey, spanAttr[skey]);
+				}
+			}
+		}
 		line.setAttribute("x", attr.x ? attr.x : 0);
 		if (i !== 0)
 			line.setAttribute("dy", "1.2em");

package/types/index.d.ts

@@ -76,7 +76,7 @@ declare module 'abcjs' {
 	//
 	// Basic types
 	//
-	export type Selector = string | HTMLElement
+	export type Selector = string | Element
 
 	type NumberFunction = () => number;
 
@@ -266,6 +266,7 @@ declare module 'abcjs' {
 		add_classes?: boolean;
 		afterParsing?: AfterParsing;
 		ariaLabel?: string;
+		chordGrid?:'noMusic'|'withMusic';
 		clickListener?: ClickListener;
 		dragColor?: string;
 		dragging?: boolean;
@@ -321,7 +322,7 @@ declare module 'abcjs' {
 		synthControl?: SynthObjectController;
 		el: Selector;
 		cursorControl?: CursorControl;
-		options?: SynthOptions;
+		options?: SynthOptions & SynthVisualOptions;
 	}
 
 	export interface EditorOptions {
@@ -331,6 +332,7 @@ declare module 'abcjs' {
 		warnings_id?: Selector;
 		onchange?: OnChange;
 		selectionChangeCallback?: SelectionChangeCallback;
+		redrawCallback?: RedrawCallback;
 		abcjsParams?: AbcVisualParams;
 		indicate_changed?: boolean;
 		synth?: EditorSynth;
@@ -871,6 +873,29 @@ declare module 'abcjs' {
 		}
 	}
 
+	interface ChordGridSubtitle {
+		type: "subtitle";
+		subtitle: string;
+	}
+	interface ChordGridText {
+		type: "text";
+		text: string;
+	}
+	interface ChordGridMeasure {
+		chord: [string,string,string,string];
+		hasStartRepeat?:boolean;
+		hasEndRepeat?:boolean;
+		noBorder?:boolean; // for when the line isn't complete, this is a placeholder
+		ending?:number; // This bar starts an ending
+		annotations?: Array<string>;
+	}
+	interface ChordGridPart {
+		type: "part";
+		name: string;
+		lines: Array<ChordGridMeasure>;
+	}
+	type ChordGrid = ChordGridSubtitle | ChordGridText | ChordGridPart;
+
 	export interface TuneObject {
 		formatting: Formatting;
 		engraver?: EngraverController;
@@ -880,6 +905,7 @@ declare module 'abcjs' {
 		metaTextInfo: MetaTextInfo;
 		version: string;
 		warnings?: Array<string>;
+		chordGrid?: Array<ChordGrid>;
 
 		getTotalTime: NumberFunction;
 		getTotalBeats: NumberFunction;
@@ -1144,6 +1170,8 @@ declare module 'abcjs' {
 
 	export type SelectionChangeCallback = (startChar: number, endChar: number) => void;
 
+	export type RedrawCallback = (isBefore: boolean) => void;
+
 	// Audio
 	export interface CursorControl {
 		beatSubDivision?: number
@@ -1185,8 +1213,12 @@ declare module 'abcjs' {
 	//
 	// Editor
 	//
+	export class EditArea {
+		constructor(target: Selector);
+	}
+
 	export class Editor {
-		constructor(target: Selector, options: EditorOptions);
+		constructor(target: Selector | EditArea, options: EditorOptions);
 		paramChanged(options: AbcVisualParams): void;
 		synthParamChanged(options: SynthOptions): void;
 		setNotDirty(): void;
@@ -1195,6 +1227,7 @@ declare module 'abcjs' {
 		millisecondsPerMeasure(): number;
 		pauseMidi(shouldPause: boolean): void;
 		fireChanged():void;
+		getTunes():TuneObjectArray;
 	}
 
 	//

package/version.js

@@ -1,3 +1,3 @@
-var version = '6.5.1';
+var version = '6.6.0';
 
 module.exports = version;