@coderline/alphatab-monaco 1.7.0-alpha.1626 → 1.7.0-alpha.1627

package/dist/types/alphatab/src/EngravingSettings.d.ts

@@ -1,430 +0,0 @@
-import { Duration } from "./model/Duration";
-import { MusicFontSymbol } from "./model/MusicFontSymbol";
-import type { SmuflMetadata } from "./SmuflMetadata";
-/**
- * @json
- * @json_declaration
- * @public
- */
-export declare class EngravingStemInfo {
-    /**
-     * The top Y coordinate where the stem should start/end.
-     */
-    topY: number;
-    /**
-     * The bottom Y coordinate where the stem should start/end.
-     */
-    bottomY: number;
-    /**
-     * The x-coordinate of the stem.
-     */
-    x: number;
-}
-/**
- * This class holds all all spacing, thickness and scaling metrics
- * related to engraving the music notation.
- *
- * @remarks
- * While general layout settings are configurable via the display settings,
- * these settings go deeper into how the individual music symbols are scaled and aligned targeting
- * specification compliance with the Standard Music Font Layout (SMuFL).
- *
- * Unless specified differently the settings here are available {@since 1.7.0}
- *
- * If properties are marked with a SMuFl tag, it means that the values are part of the SMuFL specification
- * and should be filled from the respective metadata files shipped with the fonts or aligned generally with the specification.
- * Other properties are custom to alphaTab.
- *
- * In SmuFL Sizes and coordinates are expressed in "staff space" units which is 1/4 of the configured font size. In this data structure
- * the values are converted to pixels.
- *
- * @json
- * @json_declaration
- * @cloneable
- * @public
- */
-export declare class EngravingSettings {
-    private static _bravuraDefaults?;
-    /**
-     * A {@link EngravingSettings} copy filled with the settings of the Bravura font used by default in alphaTab.
-     */
-    static get bravuraDefaults(): EngravingSettings;
-    /**
-     * The font size of the music font in pixel.
-     */
-    musicFontSize: number;
-    /**
-     * The staff space in pixel
-     * @smufl 1.4
-     */
-    oneStaffSpace: number;
-    /**
-     * The staff space in pixel for tablature fonts. This is typically 1.5 of the standard staff space.
-     * @smufl 1.4
-     */
-    tabLineSpacing: number;
-    /**
-     * The thickness of the line used for the shaft of an arrow
-     * @smufl 1.4
-     */
-    arrowShaftThickness: number;
-    /**
-     * The default distance between multiple thin barlines when locked together, e.g. between two thin barlines making a double barline, measured from the right-hand edge of the left barline to the left-hand edge of the right barline.
-     * @smufl 1.4
-     */
-    barlineSeparation: number;
-    /**
-     * The distance between the inner edge of the primary and outer edge of subsequent secondary beams
-     * @smufl 1.4
-     */
-    beamSpacing: number;
-    /**
-     * The thickness of a beam
-     * @smufl 1.4
-     */
-    beamThickness: number;
-    /**
-     * The thickness of the vertical line of a bracket grouping staves together
-     * @smufl 1.4
-     */
-    bracketThickness: number;
-    /**
-     * The length of the dashes to be used in a dashed barline
-     * @smufl 1.4
-     */
-    dashedBarlineDashLength: number;
-    /**
-     * The length of the gap between dashes in a dashed barline
-     */
-    dashedBarlineGapLength: number;
-    /**
-     * The thickness of a dashed barline
-     * @smufl 1.4
-     */
-    dashedBarlineThickness: number;
-    /**
-     * The thickness of a crescendo/diminuendo hairpin
-     * @smufl 1.4
-     */
-    hairpinThickness: number;
-    /**
-     * The thickness of a leger line (normally somewhat thicker than a staff line)
-     * @smufl 1.4
-     */
-    legerLineThickness: number;
-    /**
-     * The amount by which a leger line should extend either side of a notehead, scaled proportionally with the notehead's size, e.g. when scaled down as a grace note
-     * @smufl 1.4
-     */
-    legerLineExtension: number;
-    /**
-     * The thickness of the dashed line used for an octave line
-     * @smufl 1.4
-     */
-    octaveLineThickness: number;
-    /**
-     * The thickness of the line used for piano pedaling
-     * @smufl 1.4
-     */
-    pedalLineThickness: number;
-    /**
-     * The default horizontal distance between the dots and the inner barline of a repeat barline, measured from the edge of the dots to the edge of the barline.
-     * @smufl 1.4
-     */
-    repeatBarlineDotSeparation: number;
-    /**
-     * The thickness of the brackets drawn to indicate repeat endings
-     * @smufl 1.4
-     */
-    repeatEndingLineThickness: number;
-    /**
-     * The thickness of the mid-point of a slur (i.e. its thickest point)
-     * @smufl 1.4
-     */
-    slurMidpointThickness: number;
-    /**
-     * The thickness of each staff line
-     * @smufl 1.4
-     */
-    staffLineThickness: number;
-    /**
-     * The thickness of a stem
-     * @smufl 1.4
-     */
-    stemThickness: number;
-    /**
-     * The thickness of a thick barline, e.g. in a final barline or a repeat barline
-     * @smufl 1.4
-     */
-    thickBarlineThickness: number;
-    /**
-     * The thickness of a dashed barline
-     * @smufl 1.4
-     */
-    thinBarlineThickness: number;
-    /**
-     * The default distance between a pair of thin and thick barlines when locked together, e.g. between the thin and thick barlines making a final barline, or between the thick and thin barlines making a start repeat barline.
-     * @smufl 1.4
-     */
-    thinThickBarlineSeparation: number;
-    /**
-     * The thickness of the mid-point of a tie
-     * @smufl 1.4
-     */
-    tieMidpointThickness: number;
-    /**
-     * The thickness of the brackets drawn either side of tuplet numbers
-     * @smufl 1.4
-     */
-    tupletBracketThickness: number;
-    /**
-     * Holds information about where to place upwards pointing stems on glyphs.
-     * @smufl 1.4
-     */
-    stemUp: Map<MusicFontSymbol, EngravingStemInfo>;
-    /**
-     * Holds information about where to place downwards pointing stems on glyphs.
-     * @smufl 1.4
-     */
-    stemDown: Map<MusicFontSymbol, EngravingStemInfo>;
-    /**
-     * Holds the x-coordinate offsets for glyphs which are drawn repeatedly (like vibrato waves).
-     * @smufl 1.4
-     */
-    repeatOffsetX: Map<MusicFontSymbol, number>;
-    /**
-     * The standard stem length of a quarter note.
-     * @smufl 1.4
-     */
-    standardStemLength: number;
-    /**
-     * The additional offsets stems need to have enough space for flags.
-     * @smufl 1.4
-     */
-    stemFlagOffsets: Map<Duration, number>;
-    /**
-     * A lookup containing the offset from the visual top to the glyph center.
-     * The glyph center is the origin coordinate at which the glyph paths start when drawn on the alphabetic baseline.
-     * @smufl 1.4
-     */
-    glyphTop: Map<MusicFontSymbol, number>;
-    /**
-     * A lookup containing the offset from the glyph center to the visual bottom of the glyph.
-     * The glyph center is the origin coordinate at which the glyph paths start when drawn on the alphabetic baseline.
-     * @smufl 1.4
-     */
-    glyphBottom: Map<MusicFontSymbol, number>;
-    /**
-     * A lookup for the widths of the visual bounding box for the glyphs.
-     * @smufl 1.4
-     */
-    glyphWidths: Map<MusicFontSymbol, number>;
-    /**
-     * A lookup for the heights of the visual bounding box for the glyphs.
-     * @smufl 1.4
-     */
-    glyphHeights: Map<MusicFontSymbol, number>;
-    /**
-     * Checks whether a certain glyph is registered in the currently loaded engraving settings.
-     * @param symbol The symbol to check
-     * @returns true if the glyph is registered and available for use.
-     * @internal
-     */
-    hasSymbol(symbol: MusicFontSymbol): boolean;
-    /**
-     * Fills the engraving settings from the provided smufl metdata.
-     * @param smufl The metadata shipped together with the SMuFL fonts.
-     * @param musicFontSize The font size to configure in alphaTab for the music font.
-     */
-    fillFromSmufl(smufl: SmuflMetadata, musicFontSize?: number): void;
-    /**
-     * @internal
-     */
-    static smuflNameToGlyphNameMapping: Map<string, string>;
-    private static _smuflNameToMusicFontSymbol;
-    /**
-     * The size of the bars drawn in numbered notation to indicate the durations.
-     */
-    numberedBarRendererBarSize: number;
-    /**
-     * The spacing between the bars drawn in numbered notation to indicate the durations.
-     */
-    numberedBarRendererBarSpacing: number;
-    /**
-     * The size of the dashed drawn in numbered notation to indicate the durations.
-     */
-    numberedDashGlyphPadding: number;
-    /**
-     * The width of the dashed drawn in numbered notation to indicate the durations.
-     */
-    numberedDashGlyphWidth: number;
-    /**
-     * The gap between dashes on line ranged glyphs (like let-ring)
-     */
-    lineRangedGlyphDashGap: number;
-    /**
-     * The size between dashes on line ranged glyphs (like let-ring)
-     */
-    lineRangedGlyphDashSize: number;
-    /**
-     * The padding between effects and glyphs placed before the note heads, e.g. accidentals or brushes
-     */
-    preNoteEffectPadding: number;
-    /**
-     * The padding between effects and glyphs placed after the note heads, e.g. slides or bends
-     */
-    postNoteEffectPadding: number;
-    /**
-     * The padding between effects and glyphs placed above/blow the note heads e.g. staccato
-     */
-    onNoteEffectPadding: number;
-    /**
-     * The padding between the circles around string numbers.
-     */
-    stringNumberCirclePadding: number;
-    /**
-     * The outer padding for glyphs arranged in a grid like fashion, like the tunings and chord diagrams.
-     */
-    rowContainerPadding: number;
-    /**
-     * The innter gap for glyphs arranged in a grid like fashion, like the tunings and chord diagrams.
-     */
-    rowContainerGap: number;
-    /**
-     * The padding used for aligning the alternate ending brackets and texts.
-     */
-    alternateEndingsPadding: number;
-    /**
-     * The padding between the sustain pedal glyphs and lines.
-     */
-    sustainPedalLinePadding: number;
-    /**
-     * The height of ties.
-     */
-    tieHeight: number;
-    /**
-     * The padding between the border and text of beat timers.
-     */
-    beatTimerPadding: number;
-    /**
-     * The additional padding applied to helper note heads shown on bends.
-     */
-    bendNoteHeadElementPadding: number;
-    /**
-     * The width of the parenthesis shown on ghost notes and free time time signatures.
-     */
-    ghostParenthesisWidth: number;
-    /**
-     * The padding between the parenthesis and wrapped elements on ghost notes and free time time signatures
-     */
-    ghostParenthesisPadding: number;
-    /**
-     * The width of broken beams e.g. when combining a 32nd and 16th note
-     */
-    brokenBeamWidth: number;
-    /**
-     * The padding between the text and whammy lines.
-     */
-    tabWhammyTextPadding: number;
-    /**
-     * The height applied per half-note whammy.
-     */
-    tabWhammyPerHalfHeight: number;
-    /**
-     * The size of the dashes on whammys (e.g. on holds)
-     */
-    tabWhammyDashSize: number;
-    /**
-     * The height of simple dip whammys when using the songbook mode.
-     */
-    songBookWhammyDipHeight: number;
-    /**
-     * The width of the lines drawn for dead slapped beats.
-     */
-    deadSlappedLineWidth: number;
-    /**
-     * The width of ties drawn for left-hand-tapped notes.
-     */
-    leftHandTabTieWidth: number;
-    /**
-     * The size of the dashes on bends (e.g. on holds)
-     */
-    tabBendDashSize: number;
-    /**
-     * The height applied per quarter-note.
-     */
-    tabBendPerValueHeight: number;
-    /**
-     * The padding applied between the line and text of bends.
-     */
-    tabBendLabelPadding: number;
-    /**
-     * The width of simple slides like slide out down which do slide to a defined target note.
-     */
-    simpleSlideWidth: number;
-    /**
-     * The height of simple slides like slide out down which do slide to a defined target note.
-     */
-    simpleSlideHeight: number;
-    /**
-     * The horizontal padding applied to individual chord diagrams.
-     */
-    chordDiagramPaddingX: number;
-    /**
-     * The vertical padding applied to individual chord diagrams.
-     */
-    chordDiagramPaddingY: number;
-    /**
-     * The spacing between strings on chord diagrams.
-     */
-    chordDiagramStringSpacing: number;
-    /**
-     * The spacing between frets on chord diagrams.
-     */
-    chordDiagramFretSpacing: number;
-    /**
-     * The height of the nut on chord diagrams..
-     */
-    chordDiagramNutHeight: number;
-    /**
-     * The height of the individual fret lines.
-     */
-    chordDiagramFretHeight: number;
-    /**
-     * The width of all other lines drawn on chord diagrams.
-     */
-    chordDiagramLineWidth: number;
-    /**
-     * The padding between the bracket lines and numbers of tuplets
-     */
-    tripletFeelBracketPadding: number;
-    /**
-     * The horizontal padding between individual accidentals when multiple ones are applied.
-     */
-    accidentalPadding: number;
-    /**
-     * The padding between glyphs shown before any beats e.g. clefs and time signatures
-     */
-    preBeatGlyphSpacing: number;
-    /**
-     * The relative scale of the note drawn on tempo markers
-     */
-    tempoNoteScale: number;
-    /**
-     * The scale of string numbers shown on tuning glyphs.
-     */
-    tuningGlyphCircleNumberScale: number;
-    /**
-     * The scale factor applied to the width of the columns of string on tuning glyphs.
-     */
-    tuningGlyphStringColumnScale: number;
-    /**
-     * The padding between rows of strings on tuning glyphs.
-     */
-    tuningGlyphStringRowPadding: number;
-    /**
-     * The relative scale of any directions glyphs drawn like coda or segno.
-     */
-    directionsScale: number;
-    static readonly bravuraMetadata: SmuflMetadata;
-}

package/dist/types/alphatab/src/Environment.d.ts

@@ -1,230 +0,0 @@
-import type { ScoreImporter } from "./importer/ScoreImporter";
-import { LayoutMode } from "./LayoutMode";
-import type { Font } from "./model/Font";
-import type { ICanvas } from "./platform/ICanvas";
-import { WebPlatform } from "./platform/javascript/WebPlatform";
-import type { BarRendererFactory } from "./rendering/BarRendererFactory";
-import type { ScoreLayout } from "./rendering/layout/ScoreLayout";
-import type { ScoreRenderer } from "./rendering/ScoreRenderer";
-import type { Settings } from "./Settings";
-import { StaveProfile } from "./StaveProfile";
-/**
- * A factory for custom layout engines.
- * @internal
- */
-export declare class LayoutEngineFactory {
-    /**
-     * Whether the layout is considered "vertical" (affects mainly scrolling behavior).
-     */
-    readonly vertical: boolean;
-    /**
-     * Creates a new layout instance.
-     */
-    readonly createLayout: (renderer: ScoreRenderer) => ScoreLayout;
-    constructor(vertical: boolean, createLayout: (renderer: ScoreRenderer) => ScoreLayout);
-}
-/**
- * A factory for custom render engines.
- * Note for Web: To use a custom engine in workers you have to ensure the engine and registration to the environment are
- * also done in the background worker files (e.g. when bundling)
- * @public
- */
-export declare class RenderEngineFactory {
-    /**
-     * Whether the layout supports background workers.
-     */
-    readonly supportsWorkers: boolean;
-    readonly createCanvas: () => ICanvas;
-    constructor(supportsWorkers: boolean, canvas: () => ICanvas);
-}
-/**
- * This public class represents the global alphaTab environment where
- * alphaTab looks for information like available layout engines
- * staves etc.
- * This public class represents the global alphaTab environment where
- * alphaTab looks for information like available layout engines
- * staves etc.
- * @partial
- * @public
- */
-export declare class Environment {
-    private static readonly _staffIdBeforeSlashAlways;
-    private static readonly _staffIdBeforeScoreAlways;
-    private static readonly _staffIdBeforeScoreHideable;
-    private static readonly _staffIdBeforeNumberedAlways;
-    private static readonly _staffIdBeforeTabAlways;
-    private static readonly _staffIdBeforeTabHideable;
-    private static readonly _staffIdBeforeEndAlways;
-    /**
-     * The scaling factor to use when rending raster graphics for sharper rendering on high-dpi displays.
-     * @internal
-     */
-    static highDpiFactor: number;
-    /**
-     * @target web
-     */
-    private static _globalThis;
-    /**
-     * @target web
-     * @internal
-     */
-    static get globalThis(): any;
-    /**
-     * @target web
-     */
-    static readonly webPlatform: WebPlatform;
-    /**
-     * @target web
-     */
-    static readonly isWebPackBundled: boolean;
-    /**
-     * @target web
-     */
-    static readonly isViteBundled: boolean;
-    /**
-     * @target web
-     */
-    static readonly scriptFile: string | null;
-    /**
-     * @target web
-     */
-    static readonly fontDirectory: string | null;
-    /**
-     * @target web
-     */
-    static get isRunningInWorker(): boolean;
-    /**
-     * @target web
-     */
-    static get isRunningInAudioWorklet(): boolean;
-    /**
-     * @target web
-     * @internal
-     */
-    static createWebWorker: (settings: Settings) => Worker;
-    /**
-     * @target web
-     * @internal
-     */
-    static createAudioWorklet: (context: AudioContext, settings: Settings) => Promise<void>;
-    /**
-     * @target web
-     * @partial
-     */
-    static throttle(action: () => void, delay: number): () => void;
-    /**
-     * @target web
-     */
-    private static _detectScriptFile;
-    /**
-     * @target web
-     * @internal
-     */
-    static ensureFullUrl(relativeUrl: string | null): string;
-    private static _appendScriptName;
-    /**
-     * @target web
-     */
-    private static _detectFontDirectory;
-    /**
-     * @target web
-     */
-    private static _registerJQueryPlugin;
-    static readonly renderEngines: Map<string, RenderEngineFactory>;
-    /**
-     * @internal
-     */
-    static readonly layoutEngines: Map<LayoutMode, LayoutEngineFactory>;
-    /**
-     * @internal
-     */
-    static readonly staveProfiles: Map<StaveProfile, BarRendererFactory[]>;
-    static getRenderEngineFactory(engine: string): RenderEngineFactory;
-    /**
-     * @internal
-     */
-    static getLayoutEngineFactory(layoutMode: LayoutMode): LayoutEngineFactory;
-    /**
-     * Gets all default ScoreImporters
-     * @returns
-     */
-    static buildImporters(): ScoreImporter[];
-    private static _createDefaultRenderEngines;
-    /**
-     * Enables the usage of alphaSkia as rendering backend.
-     * @param musicFontData The raw binary data of the music font.
-     * @param alphaSkia The alphaSkia module.
-     */
-    static enableAlphaSkia(musicFontData: ArrayBuffer, alphaSkia: unknown): void;
-    /**
-     * Registers a new custom font for the usage in the alphaSkia rendering backend.
-     * @param fontData The raw binary data of the font.
-     * @returns The font info under which the font was registered.
-     */
-    static registerAlphaSkiaCustomFont(fontData: Uint8Array): Font;
-    /**
-     * @target web
-     * @partial
-     */
-    private static _createPlatformSpecificRenderEngines;
-    private static _createDefaultRenderers;
-    private static _createDefaultStaveProfiles;
-    private static _createDefaultLayoutEngines;
-    /**
-     * @target web
-     */
-    static initializeMain(createWebWorker: (settings: Settings) => Worker, createAudioWorklet: (context: AudioContext, settings: Settings) => Promise<void>): void;
-    /**
-     * @target web
-     * @internal
-     */
-    static get alphaTabWorker(): any;
-    /**
-     * @target web
-     * @internal
-     */
-    static get alphaTabUrl(): any;
-    /**
-     * @target web
-     */
-    static initializeWorker(): void;
-    /**
-     * @target web
-     */
-    static initializeAudioWorklet(): void;
-    /**
-     * @target web
-     */
-    private static _detectWebPack;
-    /**
-     * @target web
-     */
-    private static _detectVite;
-    /**
-     * @target web
-     */
-    private static _detectWebPlatform;
-    /**
-     * Prints the environment information for easier troubleshooting.
-     * @param force Whether to force printing.
-     */
-    static printEnvironmentInfo(force?: boolean): void;
-    /**
-     * @target web
-     * @partial
-     */
-    private static _printPlatformInfo;
-    /**
-     * Prepares the given object to be sent to workers. Web Frameworks like Vue might
-     * create proxy objects for all objects used. This code handles the necessary unwrapping.
-     * @internal
-     * @target web
-     */
-    static prepareForPostMessage<T>(object: T): T;
-    /**
-     * @internal
-     * @target web
-     * @partial
-     */
-    static quoteJsonString(text: string): string;
-}