@tspro/web-music-score 5.4.2 → 5.5.0

package/dist/{music-objects-T8u8bnNP.d.ts → music-objects-l5Ai97QA.d.ts}

@@ -1,5 +1,5 @@
-import { N as Note, A as Accidental } from './note-RVXvpfyV.js';
-import { R as RhythmProps, N as NoteLength, i as NoteLengthStr, l as TupletRatio, d as Tempo, K as KeySignature, b as TimeSignature } from './tempo-DwuZsv2T.js';
+import { N as Note, A as Accidental } from './note-CJuq5aBy.js';
+import { R as RhythmProps, N as NoteLength, i as NoteLengthStr, l as TupletRatio, d as Tempo, K as KeySignature, b as TimeSignature } from './tempo-BnUjm25M.js';
 import { AnchoredRect, UniMap, Rect, Vec } from '@tspro/ts-utils-lib';
 
 /** Staff preset values for score configuration. */
@@ -32,7 +32,13 @@ type BaseConfig = {
     voiceId?: VoiceId | VoiceId[];
     /** @deprecated - Use `voiceId` instead. */
     voiceIds?: VoiceId | VoiceId[];
-    /** Staves/tabs with same instrument name a re grouped together with left brace. */
+    /**
+     * Instrument name for this staf/tab.<br />
+     * Consecutive staves/tabs with the same name are grouped together.<br />
+     * Hint!<br />
+     * `"!Piano"` hides name.<br />
+     * `"!{Piano"` hides both name and left brace of the group.
+     * */
     instrument?: string;
 };
 /** Staff config to add staff notation line in score configuration. */
@@ -362,14 +368,33 @@ declare class ObjText extends MusicObject {
     constructor(parent: MusicObject, text: TextProps, anchorX: number, anchorY: number);
     getMusicInterface(): MText;
     getText(): string;
-    updateAnchorX(anchorX: number): void;
-    updateAnchorY(anchorY: number): void;
     pick(x: number, y: number): MusicObject[];
     layout(ctx: RenderContext): void;
     offset(dx: number, dy: number): void;
     draw(ctx: RenderContext): void;
 }
 
+declare class ObjScoreRowGroup extends MusicObject {
+    readonly lines: readonly ObjNotationLine[];
+    private space;
+    readonly instrument: string;
+    readonly hasBrace: boolean;
+    private readonly instrText;
+    private braceRect;
+    readonly mi: MScoreRowGroup;
+    constructor(lines: readonly ObjNotationLine[]);
+    getMusicInterface(): MScoreRowGroup;
+    get row(): ObjScoreRow;
+    get hasInstrument(): boolean;
+    hasNotationLine(line: ObjNotationLine): boolean;
+    pick(x: number, y: number): MusicObject[];
+    updateRect(): void;
+    layout(ctx: RenderContext): void;
+    layoutToNotationLines(): void;
+    offset(dx: number, dy: number): void;
+    draw(ctx: RenderContext): void;
+}
+
 type NotationLineObject = {
     getRect: () => AnchoredRect;
     offset?: (dx: number, dy: number) => void;
@@ -382,6 +407,7 @@ declare abstract class ObjNotationLine extends MusicObject {
     abstract readonly name: string;
     private layoutGroups;
     constructor(row: ObjScoreRow);
+    getRowGroup(): ObjScoreRowGroup;
     addObject(o: NotationLineObject): void;
     removeObjects(): void;
     getLayoutGroup(lauoutGroupId: LayoutGroupId): LayoutGroup;
@@ -390,6 +416,7 @@ declare abstract class ObjNotationLine extends MusicObject {
     private setObjectY;
     private alignObjectsY;
     layoutLayoutGroup(ctx: RenderContext, layoutGroup: LayoutGroup, verticalPos: VerticalPos): void;
+    drawVerticalLine(ctx: RenderContext, left: number, width: number, isSystemBarLine?: boolean): void;
     abstract getConfig(): StaffConfig | TabConfig;
     abstract calcTop(): number;
     abstract calcBottom(): number;
@@ -403,7 +430,6 @@ declare abstract class ObjNotationLine extends MusicObject {
     abstract draw(ctx: RenderContext): void;
 }
 declare class ObjStaff extends ObjNotationLine {
-    readonly row: ObjScoreRow;
     readonly staffConfig: StaffConfig;
     readonly id: number;
     readonly clefImageAsset: ImageAsset;
@@ -426,6 +452,8 @@ declare class ObjStaff extends ObjNotationLine {
     getMiddleLineY(): number;
     getBottomLineY(): number;
     joinGrandStaff(staff: ObjStaff): void;
+    isGrandTreble(): boolean;
+    isGrandBass(): boolean;
     getLineSpacing(): number;
     getDiatonicSpacing(): number;
     containsDiatonicId(diatonicId: number): boolean;
@@ -444,7 +472,6 @@ declare class ObjStaff extends ObjNotationLine {
     draw(ctx: RenderContext): void;
 }
 declare class ObjTab extends ObjNotationLine {
-    readonly row: ObjScoreRow;
     readonly tabConfig: TabConfig;
     readonly id: number;
     private top;
@@ -583,7 +610,7 @@ declare class ObjNoteGroup extends MusicObject {
     setStemTipY(staff: ObjStaff, stemTipY: number): void;
     offset(dx: number, dy: number): void;
     draw(ctx: RenderContext): void;
-    getDotVerticalDisplacement(staff: ObjStaff, diatonicId: number, stemDir: Stem): 0 | 1 | -1;
+    getDotVerticalDisplacement(staff: ObjStaff, diatonicId: number, stemDir: Stem): 1 | 0 | -1;
     static hasSameNotes(ng1: ObjNoteGroup, ng2: ObjNoteGroup): boolean;
 }
 
@@ -639,7 +666,7 @@ declare class ObjBeamGroup extends MusicObject {
     getSymbols(): ReadonlyArray<RhythmSymbol>;
     getFirstSymbol(): RhythmSymbol | undefined;
     getLastSymbol(): RhythmSymbol | undefined;
-    get color(): string;
+    private get color();
     layout(ctx: RenderContext): void;
     updateRect(): void;
     updateStemTips(): void;
@@ -805,26 +832,6 @@ declare class PlayerColumnProps {
     getFermataHoldTicks(): number;
 }
 
-declare class ObjScoreRowGroup extends MusicObject {
-    readonly lines: readonly ObjNotationLine[];
-    private space;
-    readonly instrument: string;
-    private readonly instrText;
-    private braceRect;
-    readonly mi: MScoreRowGroup;
-    constructor(lines: readonly ObjNotationLine[]);
-    getMusicInterface(): MScoreRowGroup;
-    get row(): ObjScoreRow;
-    get hasBrace(): boolean;
-    get hasInstrument(): boolean;
-    pick(x: number, y: number): MusicObject[];
-    updateRect(): void;
-    layout(ctx: RenderContext): void;
-    layoutToNotationLines(): void;
-    offset(dx: number, dy: number): void;
-    draw(ctx: RenderContext): void;
-}
-
 declare enum BarLineType {
     None = 0,
     Single = 1,
@@ -837,6 +844,7 @@ declare enum BarLineType {
 declare class ObjStaffBarLine extends MusicObject {
     readonly barLine: ObjBarLine;
     readonly line: ObjNotationLine;
+    readonly rowGroup: ObjScoreRowGroup;
     vlines: {
         left: number;
         width: number;
@@ -847,7 +855,7 @@ declare class ObjStaffBarLine extends MusicObject {
         r: number;
     }[];
     readonly mi: MStaffBarLine;
-    constructor(barLine: ObjBarLine, line: ObjNotationLine);
+    constructor(barLine: ObjBarLine, line: ObjNotationLine, rowGroup: ObjScoreRowGroup);
     getMusicInterface(): MusicInterface;
     pick(x: number, y: number): MusicObject[];
     updateRect(): void;
@@ -860,6 +868,8 @@ declare abstract class ObjBarLine extends MusicObject {
     protected barLineType: BarLineType;
     constructor(measure: ObjMeasure);
     abstract solveBarLineType(): BarLineType;
+    get doc(): ObjDocument;
+    get row(): ObjScoreRow;
     pick(x: number, y: number): MusicObject[];
     layout(ctx: RenderContext): void;
     updateRect(): void;
@@ -903,6 +913,7 @@ declare class ObjConnective extends MusicObject {
     constructor(connectiveProps: ConnectiveProps, line: ObjNotationLine, measure: ObjMeasure, leftNoteGroup: ObjNoteGroup, leftNoteId: number, rightNoteGroup: ObjNoteGroup, rightNoteId: number);
     constructor(connectiveProps: ConnectiveProps, line: ObjNotationLine, measure: ObjMeasure, leftNoteGroup: ObjNoteGroup, leftNoteId: number, tie: TieType);
     getMusicInterface(): MConnective;
+    get doc(): ObjDocument;
     isInsideMeasure(): boolean;
     pick(x: number, y: number): MusicObject[];
     layout(ctx: RenderContext): void;
@@ -910,6 +921,73 @@ declare class ObjConnective extends MusicObject {
     draw(ctx: RenderContext): void;
 }
 
+declare class ObjSpecialText extends MusicObject {
+    readonly text: string;
+    readonly color: string;
+    static toCoda: string;
+    static Coda: string;
+    static Segno: string;
+    private components;
+    readonly mi: MSpecialText;
+    constructor(parent: MusicObject, text: string, color?: string);
+    getMusicInterface(): MSpecialText;
+    getText(): string;
+    pick(x: number, y: number): MusicObject[];
+    layout(ctx: RenderContext): void;
+    offset(dx: number, dy: number): void;
+    draw(ctx: RenderContext): void;
+}
+
+type ExtensionStartObject = ObjText | ObjSpecialText;
+type ExtensionLineLeftObject = ObjBarLineLeft | MusicObject;
+type ExtensionLineRightObject = ObjRhythmColumn | ObjBarLineRight;
+type ExtensionStopObject = ObjBarLineRight | ObjText | ObjSpecialText;
+type ExtensionObjectAll = ExtensionStartObject | ExtensionLineLeftObject | ExtensionLineRightObject | ExtensionStopObject;
+declare class ObjExtensionLine extends MusicObject {
+    readonly measure: ObjMeasure;
+    readonly line: ObjNotationLine;
+    readonly extension: Extension;
+    readonly cols: ExtensionObjectAll[];
+    readonly mi: MExtensionLine;
+    constructor(measure: ObjMeasure, line: ObjNotationLine, extension: Extension, cols: ExtensionObjectAll[]);
+    get row(): ObjScoreRow;
+    getMusicInterface(): MExtensionLine;
+    private getLineLeft;
+    private getLineRight;
+    layoutFitToMeasure(ctx: RenderContext): void;
+    pick(x: number, y: number): MusicObject[];
+    layout(ctx: RenderContext): void;
+    offset(dx: number, dy: number): void;
+    draw(ctx: RenderContext): void;
+}
+
+type ExtensionLineStyle = "solid" | "dashed";
+type ExtensionLinePos = "bottom" | "middle";
+declare class ExtensionRange {
+    readonly startColumn: ObjRhythmColumn;
+    readonly columnRange: ObjRhythmColumn[];
+    stopObject?: ExtensionStopObject;
+    constructor(startColumn: ObjRhythmColumn);
+    get endColumn(): ObjRhythmColumn;
+    addColumn(col: ObjRhythmColumn): void;
+    setStopObject(obj: ExtensionStopObject): void;
+}
+declare class Extension extends MusicObjectLink {
+    readonly headObj: LayoutObjectWrapper;
+    private readonly length;
+    private readonly visible;
+    private readonly lineStyle;
+    private readonly linePos;
+    private readonly startColumn;
+    constructor(headObj: LayoutObjectWrapper, startColumn: ObjRhythmColumn, length: number, visible: boolean, lineStyle: ExtensionLineStyle, linePos: ExtensionLinePos);
+    isVisible(): boolean;
+    getLineStyle(): ExtensionLineStyle;
+    getLinePos(): ExtensionLinePos;
+    private static StopNavigations;
+    private whatStopped;
+    getRange(): ExtensionRange;
+}
+
 declare class ObjMeasure extends MusicObject {
     readonly row: ObjScoreRow;
     private readonly options;
@@ -934,7 +1012,7 @@ declare class ObjMeasure extends MusicObject {
     private voiceSymbols;
     private lastAddedRhythmColumn?;
     private lastAddedRhythmSymbol?;
-    private addExtensionToMusicObjects;
+    private addExtensionTo;
     private layoutObjects;
     private postMeasureBreakWidth;
     private passCount;
@@ -967,6 +1045,8 @@ declare class ObjMeasure extends MusicObject {
     getColumn(columnId: number): ObjRhythmColumn | undefined;
     isFirstMeasure(): boolean;
     isLastMeasure(): boolean;
+    isFirstMeasureInRow(): boolean;
+    isLastMeasureInRow(): boolean;
     getNextMeasure(): ObjMeasure | undefined;
     getPrevMeasure(): ObjMeasure | undefined;
     getKeySignature(): KeySignature;
@@ -1073,6 +1153,7 @@ declare class ObjScoreRow extends MusicObject {
     private readonly staves;
     private readonly tabs;
     private readonly measures;
+    private rowGroupByLine;
     private needLayout;
     readonly mi: MScoreRow;
     constructor(doc: ObjDocument, prevRow: ObjScoreRow | undefined, scoreConfig: (StaffConfig | TabConfig)[]);
@@ -1080,6 +1161,7 @@ declare class ObjScoreRow extends MusicObject {
     private createNotationLines;
     getNotationLines(): ReadonlyArray<ObjNotationLine>;
     getRowGroups(): ReadonlyArray<ObjScoreRowGroup>;
+    getRowGroupByLineId(id: number): ObjScoreRowGroup;
     findMatchingLine(line: ObjNotationLine): ObjNotationLine | undefined;
     get regions(): ScoreRowRegions;
     getStaves(): ReadonlyArray<ObjStaff>;
@@ -1111,6 +1193,7 @@ declare class ObjScoreRow extends MusicObject {
     layoutSetNotationLines(ctx: RenderContext): void;
     layoutDone(): void;
     offset(dx: number, dy: number): void;
+    getStaffLineLeft(): number | undefined;
     draw(ctx: RenderContext): void;
 }
 
@@ -1194,8 +1277,9 @@ declare class RenderContext {
     constructor(mi: MRenderContext);
     getMusicInterface(): MRenderContext;
     get doc(): ObjDocument | undefined;
-    private finishImageAsset;
-    getImageAsset(imageAsset: ImageAsset): HTMLImageElement | undefined;
+    getImageAsset(asset: ImageAsset, color?: string): HTMLImageElement | undefined;
+    private forceDraw;
+    private onImageLoaded;
     setDocument(mdoc?: MDocument): void;
     setCanvas(canvas: HTMLCanvasElement): void;
     setScoreEventListener(fn: ScoreEventListener): void;
@@ -1207,7 +1291,6 @@ declare class RenderContext {
     onMouseMove(e: MouseEvent): void;
     onMouseLeave(e: MouseEvent): void;
     onTouchEnd(e: TouchEvent): void;
-    onLoad(): void;
     hilightObject(obj?: MusicObject): void;
     hilightStaffPos(staffPos?: {
         scoreRow: ObjScoreRow;
@@ -1262,11 +1345,12 @@ declare class RenderContext {
 
 declare class ObjEnding extends MusicObject {
     readonly measure: ObjMeasure;
+    readonly color: string;
     readonly passages: number[];
     private endingText;
     private shapeRects;
     readonly mi: MEnding;
-    constructor(measure: ObjMeasure, passages: number[]);
+    constructor(measure: ObjMeasure, color: string, passages: number[]);
     getMusicInterface(): MEnding;
     getShapeRects(): AnchoredRect[];
     isSingleMeasureEnding(): boolean;
@@ -1281,9 +1365,9 @@ declare class ObjEnding extends MusicObject {
 
 declare class ObjFermata extends MusicObject {
     readonly pos: VerticalPos;
-    private color;
+    readonly color: string;
     readonly mi: MFermata;
-    constructor(parent: ObjRhythmColumn | ObjBarLineRight, pos: VerticalPos);
+    constructor(parent: ObjRhythmColumn | ObjBarLineRight, pos: VerticalPos, color: string);
     getMusicInterface(): MFermata;
     static getFermataPositions(anchor: ObjRhythmColumn | ObjBarLineRight): VerticalPos[];
     pick(x: number, y: number): MusicObject[];
@@ -1292,66 +1376,6 @@ declare class ObjFermata extends MusicObject {
     draw(ctx: RenderContext): void;
 }
 
-declare class ObjSpecialText extends MusicObject {
-    readonly text: string;
-    static toCoda: string;
-    static Coda: string;
-    static Segno: string;
-    private components;
-    readonly mi: MSpecialText;
-    constructor(parent: MusicObject, text: string);
-    getMusicInterface(): MSpecialText;
-    getText(): string;
-    pick(x: number, y: number): MusicObject[];
-    layout(ctx: RenderContext): void;
-    offset(dx: number, dy: number): void;
-    draw(ctx: RenderContext): void;
-}
-
-type ExtensionLineStyle = "solid" | "dashed";
-type ExtensionLinePos = "bottom" | "middle";
-type ExtensionRangeInfo = {
-    startColumn: ObjRhythmColumn;
-    endColumn: ObjRhythmColumn;
-    columnRange: ObjRhythmColumn[];
-    extensionBreakText?: string;
-};
-declare class Extension extends MusicObjectLink {
-    private readonly length;
-    private readonly visible;
-    private readonly lineStyle;
-    private readonly linePos;
-    private readonly startColumn;
-    private readonly context;
-    constructor(head: MusicObject, startColumn: ObjRhythmColumn, length: number, visible: boolean, lineStyle: ExtensionLineStyle, linePos: ExtensionLinePos);
-    isVisible(): boolean;
-    getLineStyle(): ExtensionLineStyle;
-    getLinePos(): ExtensionLinePos;
-    private getSpanBreakText;
-    getExtensionRangeInfo(): ExtensionRangeInfo;
-}
-
-type ExtensionLineLeftObj = ObjBarLineLeft | MusicObject;
-type ExtensionLineRightObj = ObjRhythmColumn | ObjBarLineRight;
-declare class ObjExtensionLine extends MusicObject {
-    readonly measure: ObjMeasure;
-    readonly line: ObjNotationLine;
-    readonly extension: Extension;
-    readonly leftObj: ExtensionLineLeftObj;
-    readonly rightObj: ExtensionLineRightObj;
-    readonly mi: MExtensionLine;
-    constructor(measure: ObjMeasure, line: ObjNotationLine, extension: Extension, leftObj: ExtensionLineLeftObj, rightObj: ExtensionLineRightObj);
-    get row(): ObjScoreRow;
-    getMusicInterface(): MExtensionLine;
-    private getLineLeft;
-    private getLineRight;
-    layoutFitToMeasure(ctx: RenderContext): void;
-    pick(x: number, y: number): MusicObject[];
-    layout(ctx: RenderContext): void;
-    offset(dx: number, dy: number): void;
-    draw(ctx: RenderContext): void;
-}
-
 declare class ObjTabRhythm extends MusicObject {
     readonly measure: ObjMeasure;
     readonly tab: ObjTab;
@@ -1359,6 +1383,7 @@ declare class ObjTabRhythm extends MusicObject {
     readonly mi: MTabRhythm;
     constructor(measure: ObjMeasure, tab: ObjTab);
     getMusicInterface(): MTabRhythm;
+    get doc(): ObjDocument;
     pick(x: number, y: number): MusicObject[];
     layout(ctx: RenderContext): void;
     private hasTuplets;
@@ -1407,7 +1432,6 @@ declare class LayoutObjectWrapper {
     setPositionResolved(): void;
     isPositionResolved(): boolean;
     resolveClosestToStaffY(ctx: RenderContext): number;
-    getTextContent(): string | undefined;
     layout(ctx: RenderContext): void;
     offset(dx: number, dy: number): void;
     setAnchorY(y: number): void;
@@ -1440,6 +1464,7 @@ declare abstract class MusicObject {
     protected readonly parent: MusicObject | undefined;
     private anchoredLayoutObjects;
     private link?;
+    readonly userData: Record<string, unknown>;
     constructor(parent: MusicObject | undefined);
     abstract getMusicInterface(): MusicInterface;
     getParent(): MusicObject | undefined;
@@ -1547,6 +1572,7 @@ declare class ObjStaffSignature extends MusicObject {
     private tempoText?;
     readonly mi: MStaffSignature;
     constructor(measure: ObjMeasure, staff: ObjStaff);
+    get doc(): ObjDocument;
     getMusicInterface(): MStaffSignature;
     updateClefImage(ctx: RenderContext, showClef: boolean): void;
     updateMeasureNumber(showMeasureNumber: boolean): void;
@@ -1569,6 +1595,7 @@ declare class ObjTabSignature extends MusicObject {
     readonly mi: MTabSignature;
     constructor(measure: ObjMeasure, tab: ObjTab);
     getMusicInterface(): MTabSignature;
+    get doc(): ObjDocument;
     updateMeasureNumber(showMeasureNumber: boolean): void;
     updateTimeSignature(showTimeSignature: boolean): void;
     updateTempo(showTempo: boolean): void;

package/dist/{note-RVXvpfyV.d.ts → note-CJuq5aBy.d.ts}

@@ -300,7 +300,7 @@ declare class Note {
      * @param b - Note b.
      * @returns - -1, 0 or 1.
      */
-    static compareFunc(a: Note, b: Note): 1 | 0 | -1;
+    static compareFunc(a: Note, b: Note): 1 | -1 | 0;
 }
 
 export { type Accidental as A, DefaultPitchNotation as D, GuitarNoteLabel as G, Note as N, type ParsedNote as P, SymbolSet as S, type NoteLetter as a, PitchNotation as b, PitchNotationList as c, DefaultGuitarNoteLabel as d, GuitarNoteLabelList as e, validateGuitarNoteLabel as f, getPitchNotationName as g, validatePitchNotation as v };

package/dist/pieces/index.d.mts

@@ -1,8 +1,15 @@
-import { M as MDocument } from '../music-objects-DqoO-Sfv.mjs';
+import { M as MDocument } from '../music-objects-CcJvZxS6.mjs';
 import '../note-CJuq5aBy.mjs';
 import '../tempo-Cxu8vusu.mjs';
 import '@tspro/ts-utils-lib';
 
+/**
+ * Create Andante by A. Diabelli music piece.
+ *
+ * @returns - Music document.
+ */
+declare function createAndanteByDiabelli(): MDocument;
+
 /**
  * Create Canon in D by Pachelbel music piece.<br />
  * <br />
@@ -31,10 +38,9 @@ declare function createFrereJacques(): MDocument;
 declare function createGreensleeves(): MDocument;
 
 /**
- * Create Andante by A. Diabelli music piece.
- *
- * @returns - Music document.
+ * Create all music pieces.
+ * @returns - Array of music documents containing all available pieces.
  */
-declare function createAndanteByDiabelli(): MDocument;
+declare function createAll(): readonly MDocument[];
 
-export { createAndanteByDiabelli, createCanonInD, createFrereJacques, createGreensleeves };
+export { createAll, createAndanteByDiabelli, createCanonInD, createFrereJacques, createGreensleeves };

package/dist/pieces/index.d.ts

@@ -1,8 +1,15 @@
-import { M as MDocument } from '../music-objects-T8u8bnNP.js';
-import '../note-RVXvpfyV.js';
-import '../tempo-DwuZsv2T.js';
+import { M as MDocument } from '../music-objects-l5Ai97QA.js';
+import '../note-CJuq5aBy.js';
+import '../tempo-BnUjm25M.js';
 import '@tspro/ts-utils-lib';
 
+/**
+ * Create Andante by A. Diabelli music piece.
+ *
+ * @returns - Music document.
+ */
+declare function createAndanteByDiabelli(): MDocument;
+
 /**
  * Create Canon in D by Pachelbel music piece.<br />
  * <br />
@@ -31,10 +38,9 @@ declare function createFrereJacques(): MDocument;
 declare function createGreensleeves(): MDocument;
 
 /**
- * Create Andante by A. Diabelli music piece.
- *
- * @returns - Music document.
+ * Create all music pieces.
+ * @returns - Array of music documents containing all available pieces.
  */
-declare function createAndanteByDiabelli(): MDocument;
+declare function createAll(): readonly MDocument[];
 
-export { createAndanteByDiabelli, createCanonInD, createFrereJacques, createGreensleeves };
+export { createAll, createAndanteByDiabelli, createCanonInD, createFrereJacques, createGreensleeves };