@coderline/alphatab 1.8.0-alpha.1669 → 1.8.0-alpha.1671

package/dist/alphaTab.d.ts

@@ -4452,6 +4452,12 @@ declare class Bar {
      * Gets or sets the type of key signature (major/minor)
      */
     keySignatureType: KeySignatureType;
+    /**
+     * How bar numbers should be displayed.
+     * If specified, overrides the value from the stylesheet on score level.
+     */
+    barNumberDisplay?: BarNumberDisplay;
+
     /**
      * The bar line to draw on the left side of the bar with an "automatic" type resolved to the actual one.
      * @param isFirstOfSystem  Whether the bar is the first one in the system.
@@ -4536,6 +4542,25 @@ declare enum BarLineStyle {
     Tick = 11
 }
 
+/**
+ * How bar numbers are displayed
+ * @public
+ */
+declare enum BarNumberDisplay {
+    /**
+     * Show bar numbers on all bars.
+     */
+    AllBars = 0,
+    /**
+     * Show bar numbers on the first bar of every system.
+     */
+    FirstOfSystem = 1,
+    /**
+     * Hide all bar numbers
+     */
+    Hide = 2
+}
+
 /**
  * Lists all beat barré types.
  * @public
@@ -4673,6 +4698,38 @@ declare enum BarSubElement {
 declare enum BeamDirection {
     Up = 0,
     Down = 1
+}
+
+/**
+ * Defines the custom beaming rules which define how beats are beamed together or split apart
+ * during the automatic beaming when displayed.
+ * @json
+ * @json_strict
+ * @public
+ *
+ * @remarks
+ * The beaming logic works like this:
+ *
+ * The time axis of the bar is sliced into even chunks. The chunk-size is defined by the respective group definition.
+ * Within these chunks groups can then be placed spanning 1 or more chunks.
+ *
+ * If beats start within the same "group" they are beamed together.
+ */
+declare class BeamingRules {
+    private _singleGroupKey?;
+    /**
+     * The the group for a given "longest duration" within the bar.
+     * @remarks
+     * The map key is the duration to which the bar will be sliced into.
+     * The map value defines the "groups" placed within the sliced.
+     */
+    groups: Map<Duration, number[]>;
+
+
+
+
+
+
 }
 
 /**
@@ -6581,6 +6638,13 @@ export declare class DisplaySettings {
      * @defaultValue `5`
      */
     trackStaffPaddingBetween: number;
+    /**
+     * The additional padding to apply between multiple lyric lines.
+     * @since 1.8.0
+     * @category Display
+     * @defaultValue `5`
+     */
+    lyricLinesPaddingBetween: number;
     /**
      * The mode used to arrange staves and systems.
      * @since 1.3.0
@@ -6933,6 +6997,13 @@ declare interface DisplaySettingsJson {
      * @defaultValue `5`
      */
     trackStaffPaddingBetween?: number;
+    /**
+     * The additional padding to apply between multiple lyric lines.
+     * @since 1.8.0
+     * @category Display
+     * @defaultValue `5`
+     */
+    lyricLinesPaddingBetween?: number;
     /**
      * The mode used to arrange staves and systems.
      * @since 1.3.0
@@ -10595,6 +10666,11 @@ declare class MasterBar {
      * Gets or sets whether this is bar has a common time signature.
      */
     timeSignatureCommon: boolean;
+    /**
+     * Defines the custom beaming rules which should be applied to this bar and all bars following.
+     */
+    beamingRules?: BeamingRules;
+
     /**
      * Gets or sets whether the bar indicates a free time playing.
      */
@@ -10680,6 +10756,7 @@ declare class MasterBar {
      * @param syncPoint  The sync point to add.
      */
     addSyncPoint(syncPoint: Automation): void;
+    finish(sharedDataBag: Map<string, unknown>): void;
 }
 
 /**
@@ -11494,6 +11571,7 @@ export declare namespace model {
         TrackNamePolicy,
         TrackNameMode,
         TrackNameOrientation,
+        BarNumberDisplay,
         RepeatGroup,
         Score,
         ScoreSubElement,
@@ -12035,7 +12113,24 @@ export declare enum NotationElement {
     /**
      * The key signature for numbered notation staff.
      */
-    EffectNumberedNotationKeySignature = 51
+    EffectNumberedNotationKeySignature = 51,
+    /**
+     * The fretboard numbers shown in chord diagrams.
+     */
+    ChordDiagramFretboardNumbers = 52,
+    /**
+     * The bar numbers.
+     */
+    BarNumber = 53,
+    /**
+     * The repeat count indicator shown above the thick bar line to describe
+     * how many repeats should be played.
+     */
+    RepeatCount = 54,
+    /**
+     * The slurs shown on bend effects within the score staff.
+     */
+    ScoreBendSlur = 55
 }
 
 /**
@@ -14120,6 +14215,11 @@ export declare namespace rendering {
 export declare class RenderingResources {
     private static _sansFont;
     private static _serifFont;
+    private static _effectFont;
+    /**
+     * The default fonts for notation elements if not specified by the user.
+     */
+    static defaultFonts: Map<NotationElement, Font>;
 
     /**
      * The SMuFL Metrics to use for rendering music symbols.
@@ -14131,50 +14231,131 @@ export declare class RenderingResources {
      * The font to use for displaying the songs copyright information in the header of the music sheet.
      * @defaultValue `bold 12px Arial, sans-serif`
      * @since 0.9.6
+     * @deprecated use {@link elementFonts} with {@link NotationElement.ScoreCopyright}
+     */
+    get copyrightFont(): Font;
+    /**
+     * @deprecated use {@link elementFonts} with {@link NotationElement.ScoreCopyright}
      */
-    copyrightFont: Font;
+    set copyrightFont(value: Font);
     /**
      * The font to use for displaying the songs title in the header of the music sheet.
      * @defaultValue `32px Georgia, serif`
      * @since 0.9.6
+     * @deprecated use {@link elementFonts} with {@link NotationElement.ScoreTitle}
+     */
+    get titleFont(): Font;
+    /**
+     * @deprecated use {@link elementFonts} with {@link NotationElement.ScoreTitle}
      */
-    titleFont: Font;
+    set titleFont(value: Font);
     /**
      * The font to use for displaying the songs subtitle in the header of the music sheet.
      * @defaultValue `20px Georgia, serif`
      * @since 0.9.6
+     * @deprecated use {@link elementFonts} with {@link NotationElement.ScoreSubTitle}
      */
-    subTitleFont: Font;
+    get subTitleFont(): Font;
+    /**
+     * @deprecated use {@link elementFonts} with {@link NotationElement.ScoreSubTitle}
+     */
+    set subTitleFont(value: Font);
     /**
      * The font to use for displaying the lyrics information in the header of the music sheet.
      * @defaultValue `15px Arial, sans-serif`
      * @since 0.9.6
+     * @deprecated use {@link elementFonts} with {@link NotationElement.ScoreWords}
      */
-    wordsFont: Font;
+    get wordsFont(): Font;
     /**
-     * The font to use for displaying certain effect related elements in the music sheet.
-     * @defaultValue `italic 12px Georgia, serif`
-     * @since 0.9.6
+     * @deprecated use {@link elementFonts} with {@link NotationElement.ScoreWords}
      */
-    effectFont: Font;
+    set wordsFont(value: Font);
     /**
      * The font to use for displaying beat time information in the music sheet.
      * @defaultValue `12px Georgia, serif`
      * @since 1.4.0
+     * @deprecated use {@link elementFonts} with {@link NotationElement.EffectBeatTimer}
+     */
+    get timerFont(): Font;
+    /**
+     * @deprecated use {@link elementFonts} with {@link NotationElement.EffectBeatTimer}
      */
-    timerFont: Font;
+    set timerFont(value: Font);
     /**
      * The font to use for displaying the directions texts.
      * @defaultValue `14px Georgia, serif`
      * @since 1.4.0
+     * @deprecated use {@link elementFonts} with {@link NotationElement.EffectDirections}
+     */
+    get directionsFont(): Font;
+    /**
+     * @deprecated use {@link elementFonts} with {@link NotationElement.EffectDirections}
      */
-    directionsFont: Font;
+    set directionsFont(value: Font);
     /**
      * The font to use for displaying the fretboard numbers in chord diagrams.
      * @defaultValue `11px Arial, sans-serif`
      * @since 0.9.6
+     * @deprecated use {@link elementFonts} with {@link NotationElement.ChordDiagramFretboardNumbers}
+     */
+    get fretboardNumberFont(): Font;
+    /**
+     * @deprecated use {@link elementFonts} with {@link NotationElement.ChordDiagramFretboardNumbers}
+     */
+    set fretboardNumberFont(value: Font);
+    /**
+     * Unused, see deprecation note.
+     * @defaultValue `14px Georgia, serif`
+     * @since 0.9.6
+     * @deprecated Since 1.7.0 alphaTab uses the glyphs contained in the SMuFL font
+     * @json_ignore
+     */
+    fingeringFont: Font;
+    /**
+     * Unused, see deprecation note.
+     * @defaultValue `12px Georgia, serif`
+     * @since 1.4.0
+     * @deprecated Since 1.7.0 alphaTab uses the glyphs contained in the SMuFL font
+     * @json_ignore
+     */
+    inlineFingeringFont: Font;
+    /**
+     * The font to use for section marker labels shown above the music sheet.
+     * @defaultValue `bold 14px Georgia, serif`
+     * @since 0.9.6
+     * @deprecated use {@link elementFonts} with {@link NotationElement.EffectMarker}
+     */
+    get markerFont(): Font;
+    /**
+     * @deprecated use {@link elementFonts} with {@link NotationElement.EffectMarker}
+     */
+    set markerFont(value: Font);
+    /**
+     * Ununsed, see deprecation note.
+     * @defaultValue `italic 12px Georgia, serif`
+     * @since 0.9.6
+     * @deprecated use {@link elementFonts} with the respective
+     * @json_ignore
+     */
+    effectFont: Font;
+    /**
+     * The font to use for displaying the bar numbers above the music sheet.
+     * @defaultValue `11px Arial, sans-serif`
+     * @since 0.9.6
+     * @deprecated use {@link elementFonts} with {@link NotationElement.BarNumber}
      */
-    fretboardNumberFont: Font;
+    get barNumberFont(): Font;
+    /**
+     * @deprecated use {@link elementFonts} with {@link NotationElement.BarNumber}
+     */
+    set barNumberFont(value: Font);
+    /**
+     * The fonts used by individual elements. Check {@link defaultFonts} for the elements which have custom fonts.
+     * Removing fonts from this map can lead to unexpected side effects and errors. Only update it with new values.
+     * @json_immutable
+     */
+    readonly elementFonts: Map<NotationElement, Font>;
     /**
      * The font to use for displaying the numbered music notation in the music sheet.
      * @defaultValue `14px Arial, sans-serif`
@@ -14211,38 +14392,12 @@ export declare class RenderingResources {
      * @since 0.9.6
      */
     barSeparatorColor: Color;
-    /**
-     * The font to use for displaying the bar numbers above the music sheet.
-     * @defaultValue `11px Arial, sans-serif`
-     * @since 0.9.6
-     */
-    barNumberFont: Font;
     /**
      * The color to use for displaying the bar numbers above the music sheet.
      * @defaultValue `rgb(200, 0, 0)`
      * @since 0.9.6
      */
     barNumberColor: Color;
-    /**
-     * The font to use for displaying finger information in the music sheet.
-     * @defaultValue `14px Georgia, serif`
-     * @since 0.9.6
-     * @deprecated Since 1.7.0 alphaTab uses the glyphs contained in the SMuFL font
-     */
-    fingeringFont: Font;
-    /**
-     * The font to use for displaying finger information when inline into the music sheet.
-     * @defaultValue `12px Georgia, serif`
-     * @since 1.4.0
-     * @deprecated Since 1.7.0 alphaTab uses the glyphs contained in the SMuFL font
-     */
-    inlineFingeringFont: Font;
-    /**
-     * The font to use for section marker labels shown above the music sheet.
-     * @defaultValue `bold 14px Georgia, serif`
-     * @since 0.9.6
-     */
-    markerFont: Font;
     /**
      * The color to use for music notation elements of the primary voice.
      * @defaultValue `rgb(0, 0, 0)`
@@ -14261,6 +14416,7 @@ export declare class RenderingResources {
      * @since 0.9.6
      */
     scoreInfoColor: Color;
+    constructor();
 
 }
 
@@ -14280,53 +14436,35 @@ declare interface RenderingResourcesJson {
      */
     engravingSettings?: EngravingSettingsJson;
     /**
-     * The font to use for displaying the songs copyright information in the header of the music sheet.
-     * @defaultValue `bold 12px Arial, sans-serif`
-     * @since 0.9.6
-     */
-    copyrightFont?: FontJson;
-    /**
-     * The font to use for displaying the songs title in the header of the music sheet.
-     * @defaultValue `32px Georgia, serif`
-     * @since 0.9.6
-     */
-    titleFont?: FontJson;
-    /**
-     * The font to use for displaying the songs subtitle in the header of the music sheet.
-     * @defaultValue `20px Georgia, serif`
+     * Unused, see deprecation note.
+     * @defaultValue `14px Georgia, serif`
      * @since 0.9.6
+     * @deprecated Since 1.7.0 alphaTab uses the glyphs contained in the SMuFL font
+     * @json_ignore
      */
-    subTitleFont?: FontJson;
+    fingeringFont?: FontJson;
     /**
-     * The font to use for displaying the lyrics information in the header of the music sheet.
-     * @defaultValue `15px Arial, sans-serif`
-     * @since 0.9.6
+     * Unused, see deprecation note.
+     * @defaultValue `12px Georgia, serif`
+     * @since 1.4.0
+     * @deprecated Since 1.7.0 alphaTab uses the glyphs contained in the SMuFL font
+     * @json_ignore
      */
-    wordsFont?: FontJson;
+    inlineFingeringFont?: FontJson;
     /**
-     * The font to use for displaying certain effect related elements in the music sheet.
+     * Ununsed, see deprecation note.
      * @defaultValue `italic 12px Georgia, serif`
      * @since 0.9.6
+     * @deprecated use {@link elementFonts} with the respective
+     * @json_ignore
      */
     effectFont?: FontJson;
     /**
-     * The font to use for displaying beat time information in the music sheet.
-     * @defaultValue `12px Georgia, serif`
-     * @since 1.4.0
-     */
-    timerFont?: FontJson;
-    /**
-     * The font to use for displaying the directions texts.
-     * @defaultValue `14px Georgia, serif`
-     * @since 1.4.0
-     */
-    directionsFont?: FontJson;
-    /**
-     * The font to use for displaying the fretboard numbers in chord diagrams.
-     * @defaultValue `11px Arial, sans-serif`
-     * @since 0.9.6
+     * The fonts used by individual elements. Check {@link defaultFonts} for the elements which have custom fonts.
+     * Removing fonts from this map can lead to unexpected side effects and errors. Only update it with new values.
+     * @json_immutable
      */
-    fretboardNumberFont?: FontJson;
+    elementFonts?: Map<NotationElement | keyof typeof NotationElement | Lowercase<keyof typeof NotationElement>, FontJson>;
     /**
      * The font to use for displaying the numbered music notation in the music sheet.
      * @defaultValue `14px Arial, sans-serif`
@@ -14363,38 +14501,12 @@ declare interface RenderingResourcesJson {
      * @since 0.9.6
      */
     barSeparatorColor?: ColorJson;
-    /**
-     * The font to use for displaying the bar numbers above the music sheet.
-     * @defaultValue `11px Arial, sans-serif`
-     * @since 0.9.6
-     */
-    barNumberFont?: FontJson;
     /**
      * The color to use for displaying the bar numbers above the music sheet.
      * @defaultValue `rgb(200, 0, 0)`
      * @since 0.9.6
      */
     barNumberColor?: ColorJson;
-    /**
-     * The font to use for displaying finger information in the music sheet.
-     * @defaultValue `14px Georgia, serif`
-     * @since 0.9.6
-     * @deprecated Since 1.7.0 alphaTab uses the glyphs contained in the SMuFL font
-     */
-    fingeringFont?: FontJson;
-    /**
-     * The font to use for displaying finger information when inline into the music sheet.
-     * @defaultValue `12px Georgia, serif`
-     * @since 1.4.0
-     * @deprecated Since 1.7.0 alphaTab uses the glyphs contained in the SMuFL font
-     */
-    inlineFingeringFont?: FontJson;
-    /**
-     * The font to use for section marker labels shown above the music sheet.
-     * @defaultValue `bold 14px Georgia, serif`
-     * @since 0.9.6
-     */
-    markerFont?: FontJson;
     /**
      * The color to use for music notation elements of the primary voice.
      * @defaultValue `rgb(0, 0, 0)`
@@ -14508,6 +14620,10 @@ declare class RenderStylesheet {
      * {@link hideEmptyStaves}
      */
     showSingleStaffBrackets: boolean;
+    /**
+     * How bar numbers should be displayed.
+     */
+    barNumberDisplay: BarNumberDisplay;
 }
 
 /**
@@ -16207,6 +16323,7 @@ declare class Voice {
      * Gets or sets a value indicating whether this voice is empty.
      */
     get isRestOnly(): boolean;
+
     insertBeat(after: Beat, newBeat: Beat): void;
     addBeat(beat: Beat): void;
     private _chain;