@tspro/web-music-score 3.2.0 → 4.0.0

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

@@ -1,5 +1,5 @@
-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 { N as Note, A as Accidental } from './note-CcVdUFqS.js';
+import { R as RhythmProps, N as NoteLength, h as NoteLengthStr, j as TupletRatio, c as Tempo, K as KeySignature, a as TimeSignature, T as TimeSignatureString } from './tempo-r2sb6Ku2.js';
 import { Vec2 } from '@tspro/ts-utils-lib';
 
 /**
@@ -199,17 +199,17 @@ declare class DivRect {
 
 declare enum StaffPreset {
     /** Treble staff has treble (G-) clef. */
-    Treble = 1,
+    Treble = "treble",
     /** Bass staff has bass (F-) clef. */
-    Bass = 2,
+    Bass = "bass",
     /** Grand staff has both treble and bass clefs. */
-    Grand = 3,
+    Grand = "grand",
     /** GuitarTreble has treble clef but is one octave lower. */
-    GuitarTreble = 4,
+    GuitarTreble = "guitarTreble",
     /** GuitarTab has tab for guitar. */
-    GuitarTab = 8,
+    GuitarTab = "guitarTab",
     /** GuitarCombined has treble clef and tab for guitar. */
-    GuitarCombined = 12
+    GuitarCombined = "guitarCombined"
 }
 declare enum Clef {
     G = "G",
@@ -217,7 +217,7 @@ declare enum Clef {
 }
 type StaffConfig = {
     type: "staff";
-    clef: Clef;
+    clef: Clef | `${Clef}`;
     name?: string;
     isOctaveDown?: boolean;
     minNote?: string;
@@ -237,102 +237,108 @@ declare function getVoiceIds(): ReadonlyArray<VoiceId>;
 type StringNumber = 1 | 2 | 3 | 4 | 5 | 6;
 declare function getStringNumbers(): ReadonlyArray<StringNumber>;
 declare enum Stem {
-    Auto = 0,
-    Up = 1,
-    Down = 2
+    Auto = "auto",
+    Up = "up",
+    Down = "down"
 }
 declare enum Arpeggio {
-    Up = 0,
-    Down = 1
+    Up = "up",
+    Down = "down"
 }
 declare enum TieType {
-    Stub = -1,
-    ToMeasureEnd = -2
+    Stub = "stub",
+    ToMeasureEnd = "toMeasureEnd"
 }
 declare enum NoteAnchor {
-    Auto = 0,
-    Above = 1,
-    Center = 2,
-    Below = 3,
-    StemTip = 4
+    Auto = "auto",
+    Above = "above",
+    Center = "center",
+    Below = "below",
+    StemTip = "stemTip"
 }
 declare enum Connective {
-    Tie = 0,
-    Slur = 1,
-    Slide = 2
+    Tie = "tie",
+    Slur = "slur",
+    Slide = "slide"
 }
-type ConnectiveSpan = number | TieType;
 declare enum VerticalPosition {
-    Above = 0,
-    Below = 1,
-    Both = 2,
-    Auto = 3
+    Auto = "auto",
+    Above = "above",
+    Below = "below",
+    Both = "both"
 }
 type StaffTabOrGroup = number | string;
 type StaffTabOrGroups = StaffTabOrGroup | StaffTabOrGroup[];
 type NoteOptions = {
-    dotted?: boolean;
-    stem?: Stem;
+    stem?: Stem | `${Stem}`;
     color?: string;
-    arpeggio?: Arpeggio | boolean;
+    arpeggio?: boolean | Arpeggio | `${Arpeggio}`;
     staccato?: boolean;
     diamond?: boolean;
-    triplet?: boolean;
     string?: StringNumber | StringNumber[];
+    /** @deprecated - Use triplet NoteLength values instead, e.g. NoteLength.QuarterTriplet or "4t", etc. */
+    triplet?: boolean;
+    /** @deprecated - Use dotted NoteLength values instead, e.g. NoteLength.Quarter2Dots or "4..", etc. */
+    dotted?: boolean | number;
 };
 type RestOptions = {
-    dotted?: boolean;
     staffPos?: Note | string | number;
     color?: string;
     hide?: boolean;
+    /** @deprecated - Use triplet NoteLength values instead, e.g. NoteLength.QuarterTriplet or "4t", etc. */
     triplet?: boolean;
+    /** @deprecated - Use dotted NoteLength values instead, e.g. NoteLength.Quarter2Dots or "4..", etc. */
+    dotted?: boolean | number;
+};
+type TupletOptions = {
+    showRatio?: boolean;
 };
-declare enum PlayState {
-    Playing = 0,
-    Paused = 1,
-    Stopped = 2
-}
-type PlayStateChangeListener = (playState: PlayState) => void;
 declare enum Fermata {
-    AtNote = 0,
-    AtMeasureEnd = 1
+    AtNote = "atNote",
+    AtMeasureEnd = "atMeasureEnd"
 }
 declare enum Navigation {
     /** Repeat back to beginning and play to the "Fine" marking. */
-    DC_al_Fine = 0,
+    DC_al_Fine = "D.C. al Fine",
     /** Repeat back to beginning and play to the "to Coda 𝄌", then jump to the "𝄌 Coda". */
-    DC_al_Coda = 1,
+    DC_al_Coda = "D.C. al Coda",
     /** Repeat back to Segno sign (𝄋) and play to the "Fine" marking. */
-    DS_al_Fine = 2,
+    DS_al_Fine = "D.S. al Fine",
     /** Repeat back to Segno sign (𝄋) and play to the "to Coda 𝄌", then jump to the "𝄌 Coda". */
-    DS_al_Coda = 3,
+    DS_al_Coda = "D.S. al Coda",
     /** "𝄌 Coda" section. */
-    Coda = 4,
+    Coda = "Coda",
     /** From "toCoda 𝄌" jump to the "𝄌 Coda" section. */
-    toCoda = 5,
+    toCoda = "toCoda",
     /** Jump here from D.S. al Fine or D.S. al Coda. */
-    Segno = 6,
+    Segno = "Segno",
     /** Stop playing after D.C. al Fine or D.S. al Fine. */
-    Fine = 7,
+    Fine = "Fine",
     /** Start of repeat section. */
-    StartRepeat = 8,
+    StartRepeat = "startRepeat",
     /** End of repeat section. Jump to start of repeat section. */
-    EndRepeat = 9,
+    EndRepeat = "endRepeat",
     /** Jump to ending with correct passage number. */
-    Ending = 10
+    Ending = "ending"
 }
 declare enum Annotation {
     /** "ppp", "pp", "p", "mp", "m", "mf", "f", "ff", "fff", "cresc.", "decresc.", "dim." */
-    Dynamics = 0,
+    Dynamics = "dynamics",
     /** "accel.", "rit.", "a tempo" */
-    Tempo = 1
+    Tempo = "tempo"
 }
 declare enum Label {
     /** "C", "C#", "Db", "D", etc. */
-    Note = 0,
+    Note = "note",
     /** "C", "Am", "G7", etc. */
-    Chord = 1
+    Chord = "chord"
+}
+declare enum PlayState {
+    Playing = 0,
+    Paused = 1,
+    Stopped = 2
 }
+type PlayStateChangeListener = (playState: PlayState) => void;
 
 declare class AccidentalState {
     readonly measure: ObjMeasure;
@@ -345,11 +351,11 @@ declare class AccidentalState {
 
 declare class ConnectiveProps {
     readonly connective: Connective;
-    readonly span: ConnectiveSpan;
+    readonly span: number | TieType | `${TieType}`;
     noteAnchor: NoteAnchor;
     noteGroups: ObjNoteGroup[];
     arcDir: "up" | "down";
-    constructor(connective: Connective, span: ConnectiveSpan, noteAnchor: NoteAnchor, startNoteGroup: ObjNoteGroup);
+    constructor(connective: Connective, span: number | TieType | `${TieType}`, noteAnchor: NoteAnchor, startNoteGroup: ObjNoteGroup);
     getStartNoteGroup(): ObjNoteGroup;
     startsWith(noteGroup: ObjNoteGroup): boolean;
     /**
@@ -563,6 +569,7 @@ declare class ObjNoteGroup extends MusicObject {
     readonly staccato: boolean;
     readonly diamond: boolean;
     readonly arpeggio: Arpeggio | undefined;
+    readonly oldStyleTriplet: boolean;
     readonly rhythmProps: RhythmProps;
     private startConnnectives;
     private runningConnectives;
@@ -572,13 +579,12 @@ declare class ObjNoteGroup extends MusicObject {
     private readonly staffObjects;
     private readonly tabObjects;
     readonly mi: MNoteGroup;
-    constructor(col: ObjRhythmColumn, voiceId: number, notes: ReadonlyArray<Note>, noteLength: NoteLength, options?: NoteOptions);
+    constructor(col: ObjRhythmColumn, voiceId: number, notes: ReadonlyArray<Note>, noteLength: NoteLength | NoteLengthStr, options?: NoteOptions, tupletRatio?: TupletRatio);
     getMusicInterface(): MNoteGroup;
     get doc(): ObjDocument;
     get measure(): ObjMeasure;
     get row(): ObjScoreRow;
     get stemDir(): Stem.Up | Stem.Down;
-    get triplet(): boolean;
     enableConnective(line: ObjNotationLine): boolean;
     startConnective(connectiveProps: ConnectiveProps): void;
     getStaticObjects(line: ObjNotationLine): ReadonlyArray<MusicObject>;
@@ -596,7 +602,7 @@ declare class ObjNoteGroup extends MusicObject {
     removeConnectiveProps(): void;
     getPlaySlur(): "first" | "slurred" | undefined;
     getBeamGroup(): ObjBeamGroup | undefined;
-    setBeamGroup(beam: ObjBeamGroup): void;
+    setBeamGroup(beamGroup: ObjBeamGroup): void;
     resetBeamGroup(): void;
     getBeamCoords(): ({
         staff: ObjStaff;
@@ -618,15 +624,15 @@ declare class ObjNoteGroup extends MusicObject {
     offset(dx: number, dy: number): void;
     draw(renderer: Renderer): void;
     static setBeamCounts(groupNotes: (ObjNoteGroup | undefined)[]): void;
-    static setTripletBeamCounts(triplet: ObjBeamGroup): void;
+    static setTupletBeamCounts(tuplet: ObjBeamGroup): void;
     getDotVerticalDisplacement(staff: ObjStaff, diatonicId: number, stemDir: Stem): 1 | 0 | -1;
     static hasSameNotes(ng1: ObjNoteGroup, ng2: ObjNoteGroup): boolean;
 }
 
 declare enum BeamGroupType {
     RegularBeam = 0,
-    TripletBeam = 1,
-    TripletGroup = 2
+    TupletBeam = 1,
+    TupletGroup = 2
 }
 declare class BeamPoint {
     staff: ObjStaff;
@@ -643,8 +649,8 @@ declare class BeamPoint {
 declare class ObjStaffBeamGroup extends MusicObject {
     readonly staff: ObjStaff;
     readonly beamGroup: ObjBeamGroup;
-    tripletNumber?: ObjText;
-    tripletNumberOffsetY: number;
+    tupletNumber?: ObjText;
+    tupletNumberOffsetY: number;
     points: BeamPoint[];
     readonly mi: MStaffBeamGroup;
     constructor(staff: ObjStaff, beamGroup: ObjBeamGroup);
@@ -655,18 +661,21 @@ declare class ObjStaffBeamGroup extends MusicObject {
 }
 declare class ObjBeamGroup extends MusicObject {
     private readonly symbols;
+    readonly tupletRatio: TupletRatio & TupletOptions | undefined;
     readonly mi: MBeamGroup;
     private readonly type;
     private readonly staffObjects;
     private constructor();
+    private get showTupletRatio();
     static createBeam(noteGroups: ObjNoteGroup[]): void;
-    static createTriplet(symbols: RhythmSymbol[]): boolean;
+    static createOldStyleTriplet(symbols: RhythmSymbol[]): number;
+    static createTuplet(symbols: RhythmSymbol[], tupletRatio: TupletRatio & TupletOptions): void;
     getMusicInterface(): MBeamGroup;
     detach(): void;
     isEmpty(): boolean;
     pick(x: number, y: number): MusicObject[];
     getType(): BeamGroupType;
-    isTriplet(): boolean;
+    isTuplet(): boolean;
     getSymbols(): ReadonlyArray<RhythmSymbol>;
     getFirstSymbol(): RhythmSymbol | undefined;
     getLastSymbol(): RhythmSymbol | undefined;
@@ -682,7 +691,7 @@ declare class ObjStaffRest extends MusicObject {
     readonly staff: ObjStaff;
     readonly rest: ObjRest;
     restRect: DivRect;
-    dotRect?: DivRect;
+    dotRects: DivRect[];
     readonly mi: MStaffRest;
     constructor(staff: ObjStaff, rest: ObjRest);
     getMusicInterface(): MusicInterface;
@@ -697,23 +706,22 @@ declare class ObjRest extends MusicObject {
     readonly ownDiatonicId: number;
     readonly color: string;
     readonly hide: boolean;
+    readonly oldStyleTriplet: boolean;
     readonly rhythmProps: RhythmProps;
     private beamGroup?;
     readonly staffObjects: ObjStaffRest[];
     readonly mi: MRest;
-    constructor(col: ObjRhythmColumn, voiceId: number, noteLength: NoteLength, options?: RestOptions);
+    constructor(col: ObjRhythmColumn, voiceId: number, noteLength: NoteLength | NoteLengthStr, options?: RestOptions, tupletRatio?: TupletRatio);
     getMusicInterface(): MRest;
     get doc(): ObjDocument;
     get measure(): ObjMeasure;
     get row(): ObjScoreRow;
     get noteLength(): NoteLength;
-    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;
+    setBeamGroup(beamGroup: ObjBeamGroup): void;
     resetBeamGroup(): void;
     getBeamCoords(): ({
         staff: ObjStaff;
@@ -953,7 +961,7 @@ declare class ObjMeasure extends MusicObject {
     setTimeSignature(timeSignature: TimeSignature | TimeSignatureString): void;
     updateTimeSignature(): void;
     getTempo(): Tempo;
-    setTempo(beatsPerMinute: number, beatLength?: NoteLength, dotted?: boolean): void;
+    setTempo(beatsPerMinute: number, beatLength?: NoteLength | NoteLengthStr, dotted?: boolean | number): void;
     updateTempo(): void;
     hasPostMeasureBreak(): boolean;
     getPostMeasureBreakWidth(): number;
@@ -968,7 +976,7 @@ declare class ObjMeasure extends MusicObject {
     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;
-    addExtension(extensionLength: number, extensionVisible: boolean): void;
+    addExtension(extensionLength: number | NoteLengthStr | (NoteLengthStr | number)[], extensionVisible: boolean): void;
     private enableExtension;
     private disableExtension;
     getEnding(): ObjEnding | undefined;
@@ -979,8 +987,8 @@ declare class ObjMeasure extends MusicObject {
     hasEndSection(): boolean;
     endRow(): void;
     private addRhythmSymbol;
-    addNoteGroup(voiceId: number, notes: (Note | string)[], noteLength: NoteLength, options?: NoteOptions): void;
-    addRest(voiceId: number, restLength: NoteLength, options?: RestOptions): void;
+    addNoteGroup(voiceId: number, notes: (Note | string)[], noteLength: NoteLength | NoteLengthStr, options?: NoteOptions, tupletRatio?: TupletRatio): ObjNoteGroup;
+    addRest(voiceId: number, restLength: NoteLength | NoteLengthStr, options?: RestOptions, tupletRatio?: TupletRatio): ObjRest;
     /**
      *
      * @param positionTicks - get ObjRhythmColumn with positionTicks. Insert new if necessary.
@@ -988,7 +996,7 @@ declare class ObjMeasure extends MusicObject {
      */
     private getRhythmColumn;
     getMeasureTicks(): number;
-    getConsumedTicks(voiceId?: number): number;
+    getConsumedTicks(voiceId?: VoiceId): number;
     getColumnsContentRect(): DivRect;
     getLeftSolidAreaWidth(): number;
     getMinColumnsAreaWidth(): number;
@@ -1010,7 +1018,7 @@ declare class ObjMeasure extends MusicObject {
     getBarLineLeft(): ObjBarLineLeft;
     getBarLineRight(): ObjBarLineRight;
     getVoiceSymbols(voiceId: number): ReadonlyArray<RhythmSymbol>;
-    completeRests(voiceId?: number): void;
+    completeRests(voiceId?: VoiceId | VoiceId[]): void;
     requestLayout(): void;
     layout(renderer: Renderer): void;
     layoutWidth(renderer: Renderer, width: number): void;
@@ -1796,4 +1804,4 @@ declare class MPlaybackButtons {
     private static addOnClickListener;
 }
 
-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 };
+export { type StaffConfig as $, Annotation as A, MStaffNoteGroup as B, Connective as C, DivRect as D, MTabNoteGroup as E, Fermata as F, MRest as G, MStaffRest as H, MRhythmColumn as I, MScoreRow as J, MStaff as K, Label as L, MDocument as M, type NoteOptions as N, MTab as O, MSignature as P, MSpecialText as Q, type RestOptions as R, StaffPreset as S, type TupletOptions as T, MText as U, type VoiceId as V, MExtensionLine as W, MPlayer as X, MRenderer as Y, MPlaybackButtons as Z, Clef as _, type ScoreConfiguration as a, type TabConfig as a0, getVoiceIds as a1, type StringNumber as a2, getStringNumbers as a3, Stem as a4, Arpeggio as a5, type StaffTabOrGroup as a6, PlayState as a7, type PlayStateChangeListener as a8, type StaffTabOrGroups as b, Navigation as c, TieType as d, NoteAnchor as e, VerticalPosition as f, type ScoreEventType as g, ScoreEvent as h, ScoreStaffPosEvent as i, ScoreObjectEvent as j, type ScoreEventListener as k, MusicInterface as l, MAccidental as m, MConnective as n, MArpeggio as o, MBeamGroup as p, MStaffBeamGroup as q, MEnding as r, MFermata as s, MHeader as t, MImage as u, MMeasure as v, MBarLineRight as w, MBarLineLeft as x, MStaffTabBarLine as y, MNoteGroup as z };