@tspro/web-music-score 1.0.0 → 1.1.0

package/dist/index.d.ts

@@ -172,8 +172,10 @@ declare namespace DefaultExport {
         Arpeggio,
         TieLength,
         ArcPos,
+        StringNumber,
         NoteOptions,
         RestOptions,
+        DocumentOptions,
         PickedPitch,
         ClickPitchListener,
         ClickObjectSelector,
@@ -220,6 +222,10 @@ declare namespace DefaultExport {
         MaxNoteLength,
         MinNoteLength,
         RhythmProps,
+        validateTuningName,
+        getTuningStrings,
+        TuningNameList,
+        DefaultTuningName,
         validatePitchNotation,
         validateGuitarNoteLabel,
         SymbolSet,
@@ -236,10 +242,7 @@ declare namespace DefaultExport {
         GuitarComponentProps,
         GuitarComponentState,
         GuitarComponent,
-        validateTuningName,
         validateHandedness,
-        TuningNameList,
-        DefaultTuningName,
         Handedness,
         DefaultHandedness,
         GuitarNote,
@@ -466,6 +469,12 @@ export declare class DivRect {
     scaleCopy(scaleX: number, scaleY?: number): DivRect;
 }
 
+/** @public */
+export declare type DocumentOptions = {
+    measuresPerRow?: number;
+    tuning?: string;
+};
+
 /** @public */
 export declare enum Fermata {
     AtNote = 0,
@@ -496,6 +505,12 @@ export declare function getScaleFactoryList(filter?: (scaleType: ScaleType) => b
 /** @public */
 export declare function getTempoString(tempo: Tempo): string;
 
+/**
+ * @public
+ * @returns Array of open string notes, note for each string.
+ */
+export declare function getTuningStrings(tuningName: string): ReadonlyArray<Note>;
+
 /** @public */
 export declare class GuitarComponent extends React_2.Component<GuitarComponentProps, GuitarComponentState> {
     state: GuitarComponentState;
@@ -535,7 +550,7 @@ export declare class GuitarContext {
     readonly guitarNoteLabel: GuitarNoteLabel;
     readonly maxFretId: number;
     private readonly guitarNoteTable;
-    private readonly stringTunings;
+    private readonly tuningStrings;
     constructor(tuningName: string, scale: Scale, handedness: Handedness, pitchNotation: PitchNotation, guitarNoteLabel: GuitarNoteLabel);
     getGuitarNote(stringId: number, fretId: number): Readonly<GuitarNote>;
     getStringTuning(stringId: number): Note;
@@ -685,7 +700,7 @@ export declare class MBeamGroup extends MusicInterface {
 /** @public */
 export declare class MDocument extends MusicInterface {
     static readonly Name = "Document";
-    constructor(staffKind: StaffKind, measuresPerRow?: number);
+    constructor(staffKind: StaffKind, options?: DocumentOptions | number);
     setHeader(title?: string, composer?: string, arranger?: string): void;
     getTitle(): string | undefined;
     addMeasure(): MMeasure;
@@ -984,7 +999,7 @@ export declare type NoteOptions = {
     dotted?: boolean;
     stem?: Stem;
     color?: string;
-    arpeggio?: Arpeggio;
+    arpeggio?: Arpeggio | boolean;
     staccato?: boolean;
     diamond?: boolean;
     tieSpan?: number | TieLength;
@@ -992,6 +1007,7 @@ export declare type NoteOptions = {
     slurSpan?: number;
     slurPos?: ArcPos;
     triplet?: boolean;
+    string?: StringNumber | StringNumber[];
 };
 
 /** @public */
@@ -1166,13 +1182,17 @@ export declare enum ScaleType {
 /** @public */
 export declare enum StaffKind {
     /** Treble staff has treble (G-) clef. */
-    Treble = 0,
-    /** TrebleForGuitar has treble clef but is one octave lower. */
-    TrebleForGuitar = 1,
+    Treble = 1,
     /** Bass staff has bass (F-) clef. */
     Bass = 2,
     /** Grand staff has both treble and bass clefs. */
-    Grand = 3
+    Grand = 3,
+    /** GuitarTreble has treble clef but is one octave lower. */
+    GuitarTreble = 4,
+    GuitarTab = 8,
+    GuitarTrebleAndTab = 12,
+    /** @deprecated TrebleForGuitar was replaced by GuitarTreble. */
+    TrebleForGuitar = 4
 }
 
 /** @public */
@@ -1182,6 +1202,9 @@ export declare enum Stem {
     Down = 2
 }
 
+/** @public */
+export declare type StringNumber = 1 | 2 | 3 | 4 | 5 | 6;
+
 /** @public */
 export declare enum SymbolSet {
     Ascii = 0,