@tspro/web-music-score 3.0.0 → 3.1.0

package/dist/{interface-CLb7xa7_.d.mts → interface-BedxdQDE.d.mts}

@@ -221,6 +221,7 @@ declare enum Clef {
 type StaffConfig = {
     type: "staff";
     clef: Clef;
+    name?: string;
     isOctaveDown?: boolean;
     minNote?: string;
     maxNote?: string;
@@ -230,6 +231,7 @@ type StaffConfig = {
 /** @public */
 type TabConfig = {
     type: "tab";
+    name?: string;
     tuning?: string | string[];
     voiceIds?: number[];
 };
@@ -276,6 +278,13 @@ declare enum Connective {
 /** @public */
 type ConnectiveSpan = number | TieType;
 /** @public */
+declare enum VerticalPosition {
+    Above = 0,
+    Below = 1,
+    Both = 2,
+    Auto = 3
+}
+/** @public */
 type NoteOptions = {
     dotted?: boolean;
     stem?: Stem;
@@ -434,9 +443,35 @@ type NotationLineObject = {
     offset?: (dx: number, dy: number) => void;
     offsetInPlace?: (dx: number, dy: number) => void;
 };
-declare class ObjStaff extends MusicObject {
+declare abstract class ObjNotationLine extends MusicObject {
+    protected readonly objects: NotationLineObject[];
+    abstract readonly id: number;
+    abstract readonly name: string;
+    private layoutGroups;
+    constructor(parent: MusicObject);
+    addObject(o: NotationLineObject): void;
+    removeObjects(): void;
+    getLayoutGroup(lauoutGroupId: LayoutGroupId): LayoutGroup;
+    resetLayoutGroups(renderer: Renderer): void;
+    layoutLayoutGroups(renderer: Renderer): void;
+    private setObjectY;
+    private alignObjectsY;
+    layoutLayoutGroup(renderer: Renderer, layoutGroup: LayoutGroup, verticalPos: VerticalPos): void;
+    abstract calcTop(): number;
+    abstract calcBottom(): number;
+    abstract getTopLineY(): number;
+    abstract getBottomLineY(): number;
+    abstract containsVoiceId(voiceId: number): boolean;
+    abstract containsDiatonicId(diatonicId: number): boolean;
+    abstract layoutWidth(renderer: Renderer): void;
+    abstract layoutHeight(renderer: Renderer): void;
+    abstract offset(dx: number, dy: number): void;
+    abstract draw(renderer: Renderer): void;
+}
+declare class ObjStaff extends ObjNotationLine {
     readonly row: ObjScoreRow;
     readonly staffConfig: StaffConfig;
+    readonly id: number;
     readonly clefImageAsset: ImageAsset;
     readonly clefLineDiatonicId: number;
     readonly topLineDiatonicId: number;
@@ -447,11 +482,11 @@ declare class ObjStaff extends MusicObject {
     private joinedGrandStaff?;
     private topLineY;
     private bottomLineY;
-    private readonly objects;
     readonly mi: MStaff;
-    constructor(row: ObjScoreRow, staffConfig: StaffConfig);
+    constructor(row: ObjScoreRow, staffConfig: StaffConfig, id: number);
     getMusicInterface(): MStaff;
     get isOctaveDown(): boolean;
+    get name(): string;
     getTopLineY(): number;
     getMiddleLineY(): number;
     getBottomLineY(): number;
@@ -468,38 +503,38 @@ declare class ObjStaff extends MusicObject {
     isGrand(): boolean;
     calcTop(): number;
     calcBottom(): number;
-    addObject(o: NotationLineObject): void;
-    removeObjects(): void;
     pick(x: number, y: number): MusicObject[];
     layoutHeight(renderer: Renderer): void;
     layoutWidth(renderer: Renderer): void;
     offset(dx: number, dy: number): void;
     draw(renderer: Renderer): void;
 }
-declare class ObjTab extends MusicObject {
+declare class ObjTab extends ObjNotationLine {
     readonly row: ObjScoreRow;
     readonly tabConfig: TabConfig;
+    readonly id: number;
     private top;
     private bottom;
-    private readonly objects;
     private readonly tuningName?;
     private readonly tuningStrings;
     readonly mi: MTab;
-    constructor(row: ObjScoreRow, tabConfig: TabConfig);
+    constructor(row: ObjScoreRow, tabConfig: TabConfig, id: number);
     getMusicInterface(): MTab;
+    get name(): string;
     getTuningName(): string | undefined;
     getTuningStrings(): ReadonlyArray<Note>;
     /** Return Y coordinate of string. */
     getStringY(stringId: number): number;
     getTopStringY(): number;
     getBottomStringY(): number;
+    getTopLineY(): number;
+    getBottomLineY(): number;
     getTop(): number;
     getBottom(): number;
     containsVoiceId(voiceId: number): boolean;
+    containsDiatonicId(diatonicId: number): boolean;
     calcTop(): number;
     calcBottom(): number;
-    addObject(o: NotationLineObject): void;
-    removeObjects(): void;
     pick(x: number, y: number): MusicObject[];
     layoutHeight(renderer: Renderer): void;
     layoutWidth(renderer: Renderer): void;
@@ -566,12 +601,13 @@ declare class ObjNoteGroup extends MusicObject {
     get row(): ObjScoreRow;
     get stemDir(): Stem.Up | Stem.Down;
     get triplet(): boolean;
-    enableConnective(line: ObjStaff | ObjTab): boolean;
+    enableConnective(line: ObjNotationLine): boolean;
     startConnective(connectiveProps: ConnectiveProps): void;
+    getStaticObjects(line: ObjNotationLine): ReadonlyArray<MusicObject>;
     pick(x: number, y: number): MusicObject[];
     getTopNote(): Note;
     getBottomNote(): Note;
-    getConnectiveAnchorPoint(connectiveProps: ConnectiveProps, line: ObjStaff | ObjTab, noteIndex: number, noteAnchor: NoteAnchor, side: "left" | "right"): {
+    getConnectiveAnchorPoint(connectiveProps: ConnectiveProps, line: ObjNotationLine, noteIndex: number, noteAnchor: NoteAnchor, side: "left" | "right"): {
         x: number;
         y: number;
     };
@@ -696,6 +732,7 @@ declare class ObjRest extends MusicObject {
     get dotted(): boolean;
     get stemDir(): Stem.Up | Stem.Down;
     get triplet(): boolean;
+    getStaticObjects(line: ObjNotationLine): ReadonlyArray<MusicObject>;
     pick(x: number, y: number): MusicObject[];
     getBeamGroup(): ObjBeamGroup | undefined;
     setBeamGroup(beam: ObjBeamGroup): void;
@@ -754,6 +791,7 @@ declare class ObjRhythmColumn extends MusicObject {
     getNextColumn(): ObjRhythmColumn | undefined;
     getTicksToNextColumn(): number;
     getShapeRects(): DivRect[];
+    getStaticObjects(line: ObjNotationLine): ReadonlyArray<MusicObject>;
     get doc(): ObjDocument;
     get row(): ObjScoreRow;
     pick(x: number, y: number): MusicObject[];
@@ -801,11 +839,11 @@ declare enum BarLineType {
     EndStartRepeat = 6
 }
 declare class ObjStaffTabBarLine extends MusicObject {
-    readonly line: ObjStaff | ObjTab;
+    readonly line: ObjNotationLine;
     lineRects: DivRect[];
     dotRects: DivRect[];
     readonly mi: MStaffTabBarLine;
-    constructor(line: ObjStaff | ObjTab);
+    constructor(line: ObjNotationLine);
     getMusicInterface(): MusicInterface;
     pick(x: number, y: number): MusicObject[];
     setRect(r: DivRect): void;
@@ -840,7 +878,7 @@ declare class ObjBarLineRight extends ObjBarLine {
 
 declare class ObjConnective extends MusicObject {
     readonly connectiveProps: ConnectiveProps;
-    readonly line: ObjStaff | ObjTab;
+    readonly line: ObjNotationLine;
     readonly measure: ObjMeasure;
     private lx;
     private ly;
@@ -857,8 +895,8 @@ declare class ObjConnective extends MusicObject {
     private readonly rightNoteId?;
     private readonly tieType?;
     readonly mi: MConnective;
-    constructor(connectiveProps: ConnectiveProps, line: ObjStaff | ObjTab, measure: ObjMeasure, leftNoteGroup: ObjNoteGroup, leftNoteId: number, rightNoteGroup: ObjNoteGroup, rightNoteId: number);
-    constructor(connectiveProps: ConnectiveProps, line: ObjStaff | ObjTab, measure: ObjMeasure, leftNoteGroup: ObjNoteGroup, leftNoteId: number, tie: TieType);
+    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;
     isInsideMeasure(): boolean;
     pick(x: number, y: number): MusicObject[];
@@ -897,7 +935,7 @@ declare class ObjMeasure extends MusicObject {
     private voiceSymbols;
     private lastAddedRhythmColumn?;
     private lastAddedRhythmSymbol?;
-    private addExtensionToMusicObject?;
+    private addExtensionToMusicObjects;
     private layoutObjects;
     private postMeasureBreakWidth;
     private passCount;
@@ -907,6 +945,7 @@ declare class ObjMeasure extends MusicObject {
     private isEndSection;
     private endRepeatPlayCount;
     private endRepeatPlayCountText?;
+    private staticObjectsCache;
     readonly mi: MMeasure;
     constructor(row: ObjScoreRow);
     getMusicInterface(): MMeasure;
@@ -940,17 +979,18 @@ declare class ObjMeasure extends MusicObject {
     hasPostMeasureBreak(): boolean;
     getPostMeasureBreakWidth(): number;
     private addLayoutObject;
-    addFermata(fermata: Fermata): void;
+    addFermata(staffTabOrGroup: number | string | undefined, fermata: Fermata): void;
     hasFermata(anchor: ObjRhythmColumn | ObjBarLineRight): boolean;
-    addNavigation(navigation: Navigation, ...args: unknown[]): void;
+    addNavigation(staffTabOrGroup: number | string | undefined, navigation: Navigation, ...args: unknown[]): void;
     hasNavigation(n: Navigation): boolean;
     getEnding(): ObjEnding | undefined;
     getEndRepeatPlayCount(): number;
     addConnective(connective: Connective.Tie, tieSpan?: number | TieType, notAnchor?: NoteAnchor): void;
     addConnective(connective: Connective.Slur, slurSpan?: number, notAnchor?: NoteAnchor): void;
     addConnective(connective: Connective.Slide, notAnchor?: NoteAnchor): void;
-    addLabel(label: Label, text: string): void;
-    addAnnotation(annotation: Annotation, text: string): void;
+    private forEachStaffGroup;
+    addLabel(staffTabOrGroup: number | string | undefined, label: Label, text: string): void;
+    addAnnotation(staffTabOrGroup: number | string | undefined, annotation: Annotation, text: string): void;
     endSong(): void;
     hasEndSong(): boolean;
     endSection(): void;
@@ -978,7 +1018,7 @@ declare class ObjMeasure extends MusicObject {
     getMinWidth(): number;
     getStaffLineLeft(): number;
     getStaffLineRight(): number;
-    getStaticObjects(): ReadonlyArray<ObjRhythmColumn | LayoutableMusicObject>;
+    getStaticObjects(line: ObjNotationLine): ReadonlyArray<MusicObject>;
     removeLayoutObjects(musicObj: MusicObject): void;
     addConnectiveObject(connective: ObjConnective): void;
     removeConnectiveObjects(): void;
@@ -1018,7 +1058,7 @@ declare class ObjScoreRow extends MusicObject {
     constructor(doc: ObjDocument, prevRow: ObjScoreRow | undefined, scoreConfig: (StaffConfig | TabConfig)[]);
     getMusicInterface(): MScoreRow;
     private createNotationLines;
-    getNotationLines(): ReadonlyArray<ObjStaff | ObjTab>;
+    getNotationLines(): ReadonlyArray<ObjNotationLine>;
     getStaves(): ReadonlyArray<ObjStaff>;
     getTabs(): ReadonlyArray<ObjTab>;
     get hasStaff(): boolean;
@@ -1026,6 +1066,8 @@ declare class ObjScoreRow extends MusicObject {
     getTopStaff(): ObjStaff;
     getBottomStaff(): ObjStaff;
     getStaff(diatonicId: number): ObjStaff | undefined;
+    resetLayoutGroups(renderer: Renderer): void;
+    layoutLayoutGroups(renderer: Renderer): void;
     pick(x: number, y: number): MusicObject[];
     getConnectivesContentRect(): DivRect;
     getDiatonicIdAt(y: number): number | undefined;
@@ -1041,12 +1083,9 @@ declare class ObjScoreRow extends MusicObject {
     requestLayout(): void;
     layout(renderer: Renderer): void;
     layoutWidth(renderer: Renderer, width: number): void;
+    updateRect(): void;
     alignStemsToBeams(): void;
     layoutPositionLines(renderer: Renderer): void;
-    updateRect(): void;
-    private setObjectY;
-    private alignObjectsY;
-    layoutLayoutGroup(renderer: Renderer, layoutGroup: LayoutGroup, verticalPos: VerticalPos): void;
     layoutPadding(renderer: Renderer): void;
     layoutDone(): void;
     offset(dx: number, dy: number): void;
@@ -1061,16 +1100,15 @@ declare class ObjDocument extends MusicObject {
     private measuresPerRow;
     private curScoreConfig;
     private header?;
-    private layoutGroups;
     private newRowRequested;
     private allConnectiveProps;
+    private staffGroups;
     private readonly mi;
     constructor();
     getMusicInterface(): MDocument;
     setScoreConfiguration(config: StaffPreset | ScoreConfiguration): void;
     setMeasuresPerRow(measuresPerRow: number): void;
     addConnectiveProps(connectiveProps: ConnectiveProps): void;
-    getLayoutGroup(lauoutGroupId: LayoutGroupId): LayoutGroup;
     setRenderer(renderer?: Renderer): void;
     setHeader(title?: string, composer?: string, arranger?: string): void;
     getTitle(): string | undefined;
@@ -1084,6 +1122,8 @@ declare class ObjDocument extends MusicObject {
     getLastRow(): ObjScoreRow;
     requestNewRow(): void;
     addMeasure(): ObjMeasure;
+    addStaffGroup(groupName: string, layoutElements: number | string | (number | string)[], verticalPosition: VerticalPosition): void;
+    getStaffGroup(groupName: string): StaffGroup | undefined;
     getVoiceSymbols(voiceId: number): ReadonlyArray<RhythmSymbol>;
     removeLayoutObjects(musicObj: MusicObject): void;
     private forEachMeasure;
@@ -1267,12 +1307,19 @@ declare enum LayoutGroupId {
     ChordLabel = 6
 }
 declare enum VerticalPos {
-    AboveStaff = 0,
-    BelowStaff = 1
+    Above = 0,
+    Below = 1
 }
 type LayoutableMusicObject = ObjText | ObjSpecialText | ObjExtensionLine | ObjFermata | ObjEnding;
+declare class StaffGroup {
+    readonly groupName: string;
+    readonly staffsTabsAndGroups: number | string | (number | string)[];
+    readonly verticalPosition: VerticalPosition;
+    constructor(groupName: string, staffsTabsAndGroups: number | string | (number | string)[], verticalPosition: VerticalPosition);
+}
 declare class LayoutObjectWrapper {
     readonly musicObj: LayoutableMusicObject;
+    readonly line: ObjNotationLine;
     readonly layoutGroupId: LayoutGroupId;
     readonly verticalPos: VerticalPos;
     readonly anchor: MusicObject;
@@ -1280,12 +1327,15 @@ declare class LayoutObjectWrapper {
     readonly row: ObjScoreRow;
     readonly layoutGroup: LayoutGroup;
     private positionResolved;
-    constructor(musicObj: LayoutableMusicObject, layoutGroupId: LayoutGroupId, verticalPos: VerticalPos);
+    constructor(musicObj: LayoutableMusicObject, line: ObjNotationLine, layoutGroupId: LayoutGroupId, verticalPos: VerticalPos);
     clearPositionResolved(): void;
     setPositionResolved(): void;
     isPositionResolved(): boolean;
     resolveClosestToStaffY(renderer: Renderer): number;
     getTextContent(): string | undefined;
+    layout(renderer: Renderer): void;
+    offset(dx: number, dy: number): void;
+    getRect(): DivRect;
 }
 declare class LayoutGroup {
     readonly layoutGroupId: number;
@@ -1345,14 +1395,15 @@ declare abstract class MusicObject {
 
 declare class ObjArpeggio extends MusicObject {
     readonly col: ObjRhythmColumn;
+    readonly line: ObjNotationLine;
     readonly arpeggioDir: Arpeggio;
     private topArrowHeight;
     private bottomArrowHeight;
-    private static NumCycles;
     private cycleHeight;
+    private numCycles;
     private color;
     readonly mi: MArpeggio;
-    constructor(col: ObjRhythmColumn, arpeggioDir: Arpeggio);
+    constructor(col: ObjRhythmColumn, line: ObjNotationLine, arpeggioDir: Arpeggio);
     getMusicInterface(): MArpeggio;
     pick(x: number, y: number): MusicObject[];
     layout(renderer: Renderer): void;
@@ -1765,4 +1816,4 @@ declare class MPlaybackButtons {
     private static addOnClickListener;
 }
 
-export { getVoiceIds as $, Annotation as A, MStaffRest as B, Connective as C, DivRect as D, MRhythmColumn as E, Fermata as F, MScoreRow as G, MStaff as H, MTab as I, MSignature as J, MSpecialText as K, Label as L, MDocument as M, type NoteOptions as N, ObjMeasure as O, MText as P, MExtensionLine as Q, type RestOptions as R, StaffPreset as S, TieType as T, MPlayer as U, MRenderer as V, MPlaybackButtons as W, Clef as X, type StaffConfig as Y, type TabConfig as Z, type VoiceId as _, type ScoreConfiguration as a, type StringNumber as a0, getStringNumbers as a1, Stem as a2, Arpeggio as a3, type ConnectiveSpan as a4, PlayState as a5, type PlayStateChangeListener as a6, Navigation as b, NoteAnchor as c, type ScoreEventType as d, ScoreEvent as e, ScoreStaffPosEvent as f, ScoreObjectEvent as g, type ScoreEventListener as h, MusicInterface as i, MAccidental as j, MConnective as k, MArpeggio as l, MBeamGroup as m, MStaffBeamGroup as n, MEnding as o, MFermata as p, MHeader as q, MImage as r, MMeasure as s, MBarLineRight as t, MBarLineLeft as u, MStaffTabBarLine as v, MNoteGroup as w, MStaffNoteGroup as x, MTabNoteGroup as y, MRest as z };
+export { getVoiceIds as $, Annotation as A, MStaffRest as B, Connective as C, DivRect as D, MRhythmColumn as E, Fermata as F, MScoreRow as G, MStaff as H, MTab as I, MSignature as J, MSpecialText as K, Label as L, MDocument as M, type NoteOptions as N, MText as O, MExtensionLine as P, MPlayer as Q, type RestOptions as R, StaffPreset as S, TieType as T, MRenderer as U, VerticalPosition as V, MPlaybackButtons as W, Clef as X, type StaffConfig as Y, type TabConfig as Z, type VoiceId as _, type ScoreConfiguration as a, type StringNumber as a0, getStringNumbers as a1, Stem as a2, Arpeggio as a3, type ConnectiveSpan as a4, PlayState as a5, type PlayStateChangeListener as a6, Navigation as b, NoteAnchor as c, type ScoreEventType as d, ScoreEvent as e, ScoreStaffPosEvent as f, ScoreObjectEvent as g, type ScoreEventListener as h, MusicInterface as i, MAccidental as j, MConnective as k, MArpeggio as l, MBeamGroup as m, MStaffBeamGroup as n, MEnding as o, MFermata as p, MHeader as q, MImage as r, MMeasure as s, MBarLineRight as t, MBarLineLeft as u, MStaffTabBarLine as v, MNoteGroup as w, MStaffNoteGroup as x, MTabNoteGroup as y, MRest as z };