@tspro/web-music-score 3.1.0 → 3.2.0

package/dist/{interface-DprVf__B.d.ts → interface-BlNl69uT.d.ts}

@@ -1,10 +1,8 @@
-import { N as Note, A as Accidental } from './note-B5ZtlHc8.js';
-import { R as RhythmProps, N as NoteLength, c as Tempo, K as KeySignature, a as TimeSignature, T as TimeSignatureString } from './tempo-DoJd-UYT.js';
+import { N as Note, A as Accidental } from './note-BFa43I86.js';
+import { R as RhythmProps, N as NoteLength, c as Tempo, K as KeySignature, a as TimeSignature, T as TimeSignatureString } from './tempo-DgqDEsn0.js';
 import { Vec2 } from '@tspro/ts-utils-lib';
 
 /**
- * @public
- *
  * DivRect class, left, top, right, bottom rectangle divided into four sections by centerX, centerY.
  */
 declare class DivRect {
@@ -199,7 +197,6 @@ declare class DivRect {
     getRect(): DivRect;
 }
 
-/** @public */
 declare enum StaffPreset {
     /** Treble staff has treble (G-) clef. */
     Treble = 1,
@@ -209,15 +206,15 @@ declare enum StaffPreset {
     Grand = 3,
     /** GuitarTreble has treble clef but is one octave lower. */
     GuitarTreble = 4,
+    /** GuitarTab has tab for guitar. */
     GuitarTab = 8,
+    /** GuitarCombined has treble clef and tab for guitar. */
     GuitarCombined = 12
 }
-/** @public */
 declare enum Clef {
     G = "G",
     F = "F"
 }
-/** @public */
 type StaffConfig = {
     type: "staff";
     clef: Clef;
@@ -228,40 +225,30 @@ type StaffConfig = {
     voiceIds?: number[];
     isGrand?: boolean;
 };
-/** @public */
 type TabConfig = {
     type: "tab";
     name?: string;
     tuning?: string | string[];
     voiceIds?: number[];
 };
-/** @public */
 type ScoreConfiguration = StaffConfig | TabConfig | (StaffConfig | TabConfig)[];
-/** @public */
 type VoiceId = 0 | 1 | 2 | 3;
-/** @public */
 declare function getVoiceIds(): ReadonlyArray<VoiceId>;
-/** @public */
 type StringNumber = 1 | 2 | 3 | 4 | 5 | 6;
-/** @public */
 declare function getStringNumbers(): ReadonlyArray<StringNumber>;
-/** @public */
 declare enum Stem {
     Auto = 0,
     Up = 1,
     Down = 2
 }
-/** @public */
 declare enum Arpeggio {
     Up = 0,
     Down = 1
 }
-/** @public */
 declare enum TieType {
     Stub = -1,
     ToMeasureEnd = -2
 }
-/** @public */
 declare enum NoteAnchor {
     Auto = 0,
     Above = 1,
@@ -269,22 +256,20 @@ declare enum NoteAnchor {
     Below = 3,
     StemTip = 4
 }
-/** @public */
 declare enum Connective {
     Tie = 0,
     Slur = 1,
     Slide = 2
 }
-/** @public */
 type ConnectiveSpan = number | TieType;
-/** @public */
 declare enum VerticalPosition {
     Above = 0,
     Below = 1,
     Both = 2,
     Auto = 3
 }
-/** @public */
+type StaffTabOrGroup = number | string;
+type StaffTabOrGroups = StaffTabOrGroup | StaffTabOrGroup[];
 type NoteOptions = {
     dotted?: boolean;
     stem?: Stem;
@@ -295,7 +280,6 @@ type NoteOptions = {
     triplet?: boolean;
     string?: StringNumber | StringNumber[];
 };
-/** @public */
 type RestOptions = {
     dotted?: boolean;
     staffPos?: Note | string | number;
@@ -303,20 +287,16 @@ type RestOptions = {
     hide?: boolean;
     triplet?: boolean;
 };
-/** @public */
 declare enum PlayState {
     Playing = 0,
     Paused = 1,
     Stopped = 2
 }
-/** @public */
 type PlayStateChangeListener = (playState: PlayState) => void;
-/** @public */
 declare enum Fermata {
     AtNote = 0,
     AtMeasureEnd = 1
 }
-/** @public */
 declare enum Navigation {
     /** Repeat back to beginning and play to the "Fine" marking. */
     DC_al_Fine = 0,
@@ -341,14 +321,12 @@ declare enum Navigation {
     /** Jump to ending with correct passage number. */
     Ending = 10
 }
-/** @public */
 declare enum Annotation {
     /** "ppp", "pp", "p", "mp", "m", "mf", "f", "ff", "fff", "cresc.", "decresc.", "dim." */
     Dynamics = 0,
     /** "accel.", "rit.", "a tempo" */
     Tempo = 1
 }
-/** @public */
 declare enum Label {
     /** "C", "C#", "Db", "D", etc. */
     Note = 0,
@@ -839,11 +817,12 @@ declare enum BarLineType {
     EndStartRepeat = 6
 }
 declare class ObjStaffTabBarLine extends MusicObject {
+    readonly barLine: ObjBarLine;
     readonly line: ObjNotationLine;
     lineRects: DivRect[];
     dotRects: DivRect[];
     readonly mi: MStaffTabBarLine;
-    constructor(line: ObjNotationLine);
+    constructor(barLine: ObjBarLine, line: ObjNotationLine);
     getMusicInterface(): MusicInterface;
     pick(x: number, y: number): MusicObject[];
     setRect(r: DivRect): void;
@@ -979,26 +958,26 @@ declare class ObjMeasure extends MusicObject {
     hasPostMeasureBreak(): boolean;
     getPostMeasureBreakWidth(): number;
     private addLayoutObject;
-    addFermata(staffTabOrGroup: number | string | undefined, fermata: Fermata): void;
+    private forEachStaffGroup;
+    addFermata(staffTabOrGroups: StaffTabOrGroups | undefined, fermata: Fermata): void;
     hasFermata(anchor: ObjRhythmColumn | ObjBarLineRight): boolean;
-    addNavigation(staffTabOrGroup: number | string | undefined, navigation: Navigation, ...args: unknown[]): void;
+    addNavigation(staffTabOrGroups: StaffTabOrGroups | undefined, navigation: Navigation, ...args: unknown[]): void;
     hasNavigation(n: Navigation): boolean;
-    getEnding(): ObjEnding | undefined;
-    getEndRepeatPlayCount(): number;
+    addAnnotation(staffTabOrGroups: StaffTabOrGroups | undefined, annotation: Annotation, text: string): void;
+    addLabel(staffTabOrGroups: StaffTabOrGroups | undefined, label: Label, text: string): void;
     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;
-    private forEachStaffGroup;
-    addLabel(staffTabOrGroup: number | string | undefined, label: Label, text: string): void;
-    addAnnotation(staffTabOrGroup: number | string | undefined, annotation: Annotation, text: string): void;
+    addExtension(extensionLength: number, extensionVisible: boolean): void;
+    private enableExtension;
+    private disableExtension;
+    getEnding(): ObjEnding | undefined;
+    getEndRepeatPlayCount(): number;
     endSong(): void;
     hasEndSong(): boolean;
     endSection(): void;
     hasEndSection(): boolean;
     endRow(): void;
-    private enableExtension;
-    private disableExtension;
-    addExtension(extensionLength: number, extensionVisible: boolean): void;
     private addRhythmSymbol;
     addNoteGroup(voiceId: number, notes: (Note | string)[], noteLength: NoteLength, options?: NoteOptions): void;
     addRest(voiceId: number, restLength: NoteLength, options?: RestOptions): void;
@@ -1025,6 +1004,7 @@ declare class ObjMeasure extends MusicObject {
     createExtensions(): void;
     addBeamGroup(beam: ObjBeamGroup): void;
     requestBeamsUpdate(): void;
+    private createOldStyleTriplets;
     createBeams(): void;
     private static setupBeamGroup;
     getBarLineLeft(): ObjBarLineLeft;
@@ -1120,6 +1100,8 @@ declare class ObjDocument extends MusicObject {
     private addNewRow;
     getFirstRow(): ObjScoreRow;
     getLastRow(): ObjScoreRow;
+    getRows(): ReadonlyArray<ObjScoreRow>;
+    getMeasures(): ReadonlyArray<ObjMeasure>;
     requestNewRow(): void;
     addMeasure(): ObjMeasure;
     addStaffGroup(groupName: string, layoutElements: number | string | (number | string)[], verticalPosition: VerticalPosition): void;
@@ -1281,11 +1263,12 @@ 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, extension: Extension, leftObj: ExtensionLineLeftObj, rightObj: ExtensionLineRightObj);
+    constructor(measure: ObjMeasure, line: ObjNotationLine, extension: Extension, leftObj: ExtensionLineLeftObj, rightObj: ExtensionLineRightObj);
     get row(): ObjScoreRow;
     getMusicInterface(): MExtensionLine;
     private getLineLeft;
@@ -1467,21 +1450,17 @@ declare class ObjSignature extends MusicObject {
     draw(renderer: Renderer): void;
 }
 
-/** @public */
 type ScoreEventType = "enter" | "leave" | "click";
-/** @public */
 declare abstract class ScoreEvent {
     readonly type: ScoreEventType;
     constructor(type: ScoreEventType);
 }
-/** @public */
 declare class ScoreStaffPosEvent extends ScoreEvent {
     readonly renderer: MRenderer;
     readonly scoreRow: MScoreRow;
     readonly diatonicId: number;
     constructor(type: ScoreEventType, renderer: MRenderer, scoreRow: MScoreRow, diatonicId: number);
 }
-/** @public */
 declare class ScoreObjectEvent extends ScoreEvent {
     readonly renderer: MRenderer;
     readonly objects: MusicInterface[];
@@ -1489,10 +1468,8 @@ declare class ScoreObjectEvent extends ScoreEvent {
     get topObject(): MusicInterface;
     findObject(fn: (obj: MusicInterface) => boolean): MusicInterface | undefined;
 }
-/** @public */
 type ScoreEventListener = (event: ScoreEvent) => void;
 
-/** @public */
 declare abstract class MusicInterface {
     readonly name: string;
     constructor(name: string);
@@ -1500,7 +1477,6 @@ declare abstract class MusicInterface {
     abstract getMusicObject(): MusicObject;
     getParent(): MusicInterface | undefined;
 }
-/** @public */
 declare class MAccidental extends MusicInterface {
     private readonly obj;
     static readonly Name = "Accidental";
@@ -1510,7 +1486,6 @@ declare class MAccidental extends MusicInterface {
     getMusicObject(): ObjAccidental;
     getAccidental(): Accidental;
 }
-/** @public */
 declare class MConnective extends MusicInterface {
     private readonly obj;
     static readonly Name = "Connective";
@@ -1519,7 +1494,6 @@ declare class MConnective extends MusicInterface {
     /** @internal */
     getMusicObject(): ObjConnective;
 }
-/** @public */
 declare class MArpeggio extends MusicInterface {
     private readonly obj;
     static readonly Name = "Arpeggio";
@@ -1527,8 +1501,9 @@ declare class MArpeggio extends MusicInterface {
     constructor(obj: ObjArpeggio);
     /** @internal */
     getMusicObject(): ObjArpeggio;
+    getRhythmColumn(): MRhythmColumn;
+    getNotationLine(): MStaff | MTab;
 }
-/** @public */
 declare class MBeamGroup extends MusicInterface {
     private readonly obj;
     static readonly Name = "BeamGroup";
@@ -1537,7 +1512,6 @@ declare class MBeamGroup extends MusicInterface {
     /** @internal */
     getMusicObject(): ObjBeamGroup;
 }
-/** @public */
 declare class MStaffBeamGroup extends MusicInterface {
     private readonly obj;
     static readonly Name = "StaffBeamGroup";
@@ -1545,8 +1519,8 @@ declare class MStaffBeamGroup extends MusicInterface {
     constructor(obj: ObjStaffBeamGroup);
     /** @internal */
     getMusicObject(): ObjStaffBeamGroup;
+    getStaff(): MStaff;
 }
-/** @public */
 declare class MDocument extends MusicInterface {
     private readonly obj;
     static readonly Name = "Document";
@@ -1557,9 +1531,10 @@ declare class MDocument extends MusicInterface {
     getTitle(): string | undefined;
     getComposer(): string | undefined;
     getArranger(): string | undefined;
+    getRows(): ReadonlyArray<MScoreRow>;
+    getMeasures(): ReadonlyArray<MMeasure>;
     play(fn?: PlayStateChangeListener): MPlayer;
 }
-/** @public */
 declare class MEnding extends MusicInterface {
     private readonly obj;
     static readonly Name = "Ending";
@@ -1570,7 +1545,6 @@ declare class MEnding extends MusicInterface {
     getPassages(): ReadonlyArray<number>;
     hasPassage(passage: number): boolean;
 }
-/** @public */
 declare class MFermata extends MusicInterface {
     private readonly obj;
     static readonly Name = "Fermata";
@@ -1579,7 +1553,6 @@ declare class MFermata extends MusicInterface {
     /** @internal */
     getMusicObject(): ObjFermata;
 }
-/** @public */
 declare class MHeader extends MusicInterface {
     private readonly obj;
     static readonly Name = "Header";
@@ -1591,7 +1564,6 @@ declare class MHeader extends MusicInterface {
     getComposer(): string | undefined;
     getArranger(): string | undefined;
 }
-/** @public */
 declare class MImage extends MusicInterface {
     private readonly obj;
     static readonly Name = "Image";
@@ -1600,7 +1572,6 @@ declare class MImage extends MusicInterface {
     /** @internal */
     getMusicObject(): ObjImage;
 }
-/** @public */
 declare class MMeasure extends MusicInterface {
     private readonly obj;
     static readonly Name = "Measure";
@@ -1610,8 +1581,8 @@ declare class MMeasure extends MusicInterface {
     getMusicObject(): ObjMeasure;
     getMeasureNumber(): number;
     getRhythmColumns(): ReadonlyArray<MRhythmColumn>;
+    getRow(): MScoreRow;
 }
-/** @public */
 declare class MBarLineRight extends MusicInterface {
     private readonly obj;
     static readonly Name = "BarLineRight";
@@ -1620,7 +1591,6 @@ declare class MBarLineRight extends MusicInterface {
     /** @internal */
     getMusicObject(): ObjBarLineRight;
 }
-/** @public */
 declare class MBarLineLeft extends MusicInterface {
     private readonly obj;
     static readonly Name = "BarLineLeft";
@@ -1629,7 +1599,6 @@ declare class MBarLineLeft extends MusicInterface {
     /** @internal */
     getMusicObject(): ObjBarLineLeft;
 }
-/** @public */
 declare class MStaffTabBarLine extends MusicInterface {
     private readonly obj;
     static readonly Name = "StaffTabBarLine";
@@ -1637,8 +1606,9 @@ declare class MStaffTabBarLine extends MusicInterface {
     constructor(obj: ObjStaffTabBarLine);
     /** @internal */
     getMusicObject(): ObjStaffTabBarLine;
+    getBarLine(): MBarLineLeft | MBarLineRight;
+    getNotationLine(): MStaff | MTab;
 }
-/** @public */
 declare class MNoteGroup extends MusicInterface {
     private readonly obj;
     static readonly Name = "NoteGroup";
@@ -1648,8 +1618,9 @@ declare class MNoteGroup extends MusicInterface {
     getMusicObject(): ObjNoteGroup;
     getNotes(): ReadonlyArray<Note>;
     getRhythmProps(): RhythmProps;
+    getRhythmColumn(): MRhythmColumn;
+    getMeasure(): MMeasure;
 }
-/** @public */
 declare class MStaffNoteGroup extends MusicInterface {
     private readonly obj;
     static readonly Name = "StaffNoteGroup";
@@ -1658,8 +1629,10 @@ declare class MStaffNoteGroup extends MusicInterface {
     /** @internal */
     getMusicObject(): ObjStaffNoteGroup;
     getNoteGroup(): MNoteGroup;
+    getRhythmColumn(): MRhythmColumn;
+    getMeasure(): MMeasure;
+    getStaff(): MStaff;
 }
-/** @public */
 declare class MTabNoteGroup extends MusicInterface {
     private readonly obj;
     static readonly Name = "TabNoteGroup";
@@ -1668,8 +1641,10 @@ declare class MTabNoteGroup extends MusicInterface {
     /** @internal */
     getMusicObject(): ObjTabNoteGroup;
     getNoteGroup(): MNoteGroup;
+    getRhythmColumn(): MRhythmColumn;
+    getMeasure(): MMeasure;
+    getTab(): MTab;
 }
-/** @public */
 declare class MRest extends MusicInterface {
     private readonly obj;
     static readonly Name = "Rest";
@@ -1678,8 +1653,9 @@ declare class MRest extends MusicInterface {
     /** @internal */
     getMusicObject(): ObjRest;
     getRhythmProps(): RhythmProps;
+    getRhythmColumn(): MRhythmColumn;
+    getMeasure(): MMeasure;
 }
-/** @public */
 declare class MStaffRest extends MusicInterface {
     private readonly obj;
     static readonly Name = "StaffRest";
@@ -1688,8 +1664,10 @@ declare class MStaffRest extends MusicInterface {
     /** @internal */
     getMusicObject(): ObjStaffRest;
     getRest(): MRest;
+    getRhythmColumn(): MRhythmColumn;
+    getMeasure(): MMeasure;
+    getStaff(): MStaff;
 }
-/** @public */
 declare class MRhythmColumn extends MusicInterface {
     private readonly obj;
     static readonly Name = "RhythmColumn";
@@ -1698,8 +1676,9 @@ declare class MRhythmColumn extends MusicInterface {
     /** @internal */
     getMusicObject(): ObjRhythmColumn;
     getRhythmSymbol(voiceId: number): MNoteGroup | MRest | undefined;
+    getMeasure(): MMeasure;
+    getVoiceSymbol(voiceId: VoiceId): MNoteGroup | MRest | undefined;
 }
-/** @public */
 declare class MScoreRow extends MusicInterface {
     private readonly obj;
     static readonly Name = "ScoreRow";
@@ -1707,9 +1686,10 @@ declare class MScoreRow extends MusicInterface {
     constructor(obj: ObjScoreRow);
     /** @internal */
     getMusicObject(): ObjScoreRow;
+    getDocument(): MDocument;
     getMeasures(): ReadonlyArray<MMeasure>;
+    getNotationLines(): ReadonlyArray<MStaff | MTab>;
 }
-/** @public */
 declare class MStaff extends MusicInterface {
     private readonly obj;
     static readonly Name = "Staff";
@@ -1717,8 +1697,10 @@ declare class MStaff extends MusicInterface {
     constructor(obj: ObjStaff);
     /** @internal */
     getMusicObject(): ObjStaff;
+    getId(): number;
+    getName(): string | undefined;
+    getRow(): MScoreRow;
 }
-/** @public */
 declare class MTab extends MusicInterface {
     private readonly obj;
     static readonly Name = "Tab";
@@ -1726,8 +1708,10 @@ declare class MTab extends MusicInterface {
     constructor(obj: ObjTab);
     /** @internal */
     getMusicObject(): ObjTab;
+    getId(): number;
+    getName(): string | undefined;
+    getRow(): MScoreRow;
 }
-/** @public */
 declare class MSignature extends MusicInterface {
     private readonly obj;
     static readonly Name = "Signature";
@@ -1735,8 +1719,8 @@ declare class MSignature extends MusicInterface {
     constructor(obj: ObjSignature);
     /** @internal */
     getMusicObject(): ObjSignature;
+    getStaff(): MStaff;
 }
-/** @public */
 declare class MSpecialText extends MusicInterface {
     private readonly obj;
     static readonly Name = "SpecialText";
@@ -1744,8 +1728,8 @@ declare class MSpecialText extends MusicInterface {
     constructor(obj: ObjSpecialText);
     /** @internal */
     getMusicObject(): ObjSpecialText;
+    getText(): string;
 }
-/** @public */
 declare class MText extends MusicInterface {
     private readonly obj;
     static readonly Name = "Text";
@@ -1755,7 +1739,6 @@ declare class MText extends MusicInterface {
     getMusicObject(): ObjText;
     getText(): string;
 }
-/** @public */
 declare class MExtensionLine extends MusicInterface {
     private readonly obj;
     static readonly Name = "ExtensionLine";
@@ -1764,7 +1747,6 @@ declare class MExtensionLine extends MusicInterface {
     /** @internal */
     getMusicObject(): ObjExtensionLine;
 }
-/** @public */
 declare class MPlayer {
     private static currentlyPlaying;
     private readonly player;
@@ -1774,7 +1756,6 @@ declare class MPlayer {
     pause(): this;
     stop(): this;
 }
-/** @public */
 declare class MRenderer {
     private readonly renderer;
     constructor();
@@ -1788,7 +1769,6 @@ declare class MRenderer {
     }): void;
     draw(): void;
 }
-/** @public */
 declare class MPlaybackButtons {
     private playButton?;
     private stopButton?;
@@ -1816,4 +1796,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, 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 };
+export { type VoiceId as $, Annotation as A, MRest as B, Connective as C, DivRect as D, MStaffRest as E, Fermata as F, MRhythmColumn as G, MScoreRow as H, MStaff as I, MTab as J, MSignature as K, Label as L, MDocument as M, type NoteOptions as N, MSpecialText as O, MText as P, MExtensionLine as Q, type RestOptions as R, StaffPreset as S, TieType as T, MPlayer as U, VerticalPosition as V, MRenderer as W, MPlaybackButtons as X, Clef as Y, type StaffConfig as Z, type TabConfig as _, type ScoreConfiguration as a, getVoiceIds as a0, type StringNumber as a1, getStringNumbers as a2, Stem as a3, Arpeggio as a4, type ConnectiveSpan as a5, type StaffTabOrGroup as a6, PlayState as a7, type PlayStateChangeListener as a8, type StaffTabOrGroups as b, Navigation as c, NoteAnchor as d, type ScoreEventType as e, ScoreEvent as f, ScoreStaffPosEvent as g, ScoreObjectEvent as h, type ScoreEventListener as i, MusicInterface as j, MAccidental as k, MConnective as l, MArpeggio as m, MBeamGroup as n, MStaffBeamGroup as o, MEnding as p, MFermata as q, MHeader as r, MImage as s, MMeasure as t, MBarLineRight as u, MBarLineLeft as v, MStaffTabBarLine as w, MNoteGroup as x, MStaffNoteGroup as y, MTabNoteGroup as z };