@coderline/alphatab-language-server 1.7.0-alpha.1626

package/dist/types/alphatab/src/model/RenderStylesheet.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Lists the different modes on how the brackets/braces are drawn and extended.
+ * @public
+ */
+export declare enum BracketExtendMode {
+    /**
+     * Do not draw brackets
+     */
+    NoBrackets = 0,
+    /**
+     * Groups staves into bracket (or braces for grand staff).
+     */
+    GroupStaves = 1,
+    /**
+     * Groups similar instruments in multi-track rendering into brackets.
+     * The braces of tracks with grand-staffs break any brackets.
+     * Similar instruments means actually the same "midi program". No custom grouping is currently done.
+     */
+    GroupSimilarInstruments = 2
+}
+/**
+ * Lists the different policies on how to display the track names.
+ * @public
+ */
+export declare enum TrackNamePolicy {
+    /**
+     * Track names are hidden everywhere.
+     */
+    Hidden = 0,
+    /**
+     * Track names are displayed on the first system.
+     */
+    FirstSystem = 1,
+    /**
+     * Track names are displayed on all systems.
+     */
+    AllSystems = 2
+}
+/**
+ * Lists the different modes what text to display for track names.
+ * @public
+ */
+export declare enum TrackNameMode {
+    /**
+     * Full track names are displayed {@link Track.name}
+     */
+    FullName = 0,
+    /**
+     * Short Track names (abbreviations) are displayed {@link Track.shortName}
+     */
+    ShortName = 1
+}
+/**
+ * Lists the different orientations modes how to render the track names.
+ * @public
+ */
+export declare enum TrackNameOrientation {
+    /**
+     * Text is shown horizontally (left-to-right)
+     */
+    Horizontal = 0,
+    /**
+     * Vertically rotated (bottom-to-top)
+     */
+    Vertical = 1
+}
+/**
+ * This class represents the rendering stylesheet.
+ * It contains settings which control the display of the score when rendered.
+ * @json
+ * @json_strict
+ * @public
+ */
+export declare class RenderStylesheet {
+    /**
+     * Whether dynamics are hidden.
+     */
+    hideDynamics: boolean;
+    /**
+     * The mode in which brackets and braces are drawn.
+     */
+    bracketExtendMode: BracketExtendMode;
+    /**
+     * Whether to draw the // sign to separate systems.
+     */
+    useSystemSignSeparator: boolean;
+    /**
+     * Whether to show the tuning.
+     */
+    globalDisplayTuning: boolean;
+    /**
+     * Whether to show the tuning.(per-track)
+     */
+    perTrackDisplayTuning: Map<number, boolean> | null;
+    /**
+     * Whether to show the chord diagrams on top.
+     */
+    globalDisplayChordDiagramsOnTop: boolean;
+    /**
+     * Whether to show the chord diagrams on top. (per-track)
+     */
+    perTrackChordDiagramsOnTop: Map<number, boolean> | null;
+    /**
+     * The policy where to show track names when a single track is rendered.
+     */
+    singleTrackTrackNamePolicy: TrackNamePolicy;
+    /**
+     * The policy where to show track names when a multiple tracks are rendered.
+     */
+    multiTrackTrackNamePolicy: TrackNamePolicy;
+    /**
+     * The mode what text to display for the track name on the first system
+     */
+    firstSystemTrackNameMode: TrackNameMode;
+    /**
+     * The mode what text to display for the track name on the first system
+     */
+    otherSystemsTrackNameMode: TrackNameMode;
+    /**
+     * The orientation of the the track names on the first system
+     */
+    firstSystemTrackNameOrientation: TrackNameOrientation;
+    /**
+     * The orientation of the the track names on other systems
+     */
+    otherSystemsTrackNameOrientation: TrackNameOrientation;
+    /**
+     * If multi track: Whether to render multiple subsequent empty (or rest-only) bars together as multi-bar rest.
+     */
+    multiTrackMultiBarRest: boolean;
+    /**
+     * If single track: Whether to render multiple subsequent empty (or rest-only) bars together as multi-bar rest.
+     */
+    perTrackMultiBarRest: Set<number> | null;
+}

package/dist/types/alphatab/src/model/RepeatGroup.d.ts

@@ -0,0 +1,33 @@
+import type { MasterBar } from "./MasterBar";
+/**
+ * This public class can store the information about a group of measures which are repeated
+ * @public
+ */
+export declare class RepeatGroup {
+    /**
+     * All masterbars repeated within this group
+     */
+    masterBars: MasterBar[];
+    /**
+     * the masterbars which opens the group.
+     */
+    opening: MasterBar | null;
+    /**
+     * a list of masterbars which open the group.
+     * @deprecated There can only be one opening, use the opening property instead
+     */
+    get openings(): MasterBar[];
+    /**
+     * a list of masterbars which close the group.
+     */
+    closings: MasterBar[];
+    /**
+     * Gets whether this repeat group is really opened as a repeat.
+     */
+    get isOpened(): boolean;
+    /**
+     * true if the repeat group was closed well
+     */
+    isClosed: boolean;
+    addMasterBar(masterBar: MasterBar): void;
+}

package/dist/types/alphatab/src/model/Score.d.ts

@@ -0,0 +1,224 @@
+import type { MasterBar } from "./MasterBar";
+import { RenderStylesheet } from "./RenderStylesheet";
+import type { Track } from "./Track";
+import type { Settings } from "./../Settings";
+import { ElementStyle } from "./ElementStyle";
+import { TextAlign } from "./../platform/ICanvas";
+import type { BackingTrack } from "./BackingTrack";
+import { type FlatSyncPoint } from "./Automation";
+/**
+ * Lists all graphical sub elements within a {@link Score} which can be styled via {@link Score.style}
+ * @public
+ */
+export declare enum ScoreSubElement {
+    /**
+     * The title of the song
+     */
+    Title = 0,
+    /**
+     * The subtitle of the song
+     */
+    SubTitle = 1,
+    /**
+     * The artist of the song
+     */
+    Artist = 2,
+    /**
+     * The album of the song
+     */
+    Album = 3,
+    /**
+     * The word author of the song
+     */
+    Words = 4,
+    /**
+     * The Music author of the song
+     */
+    Music = 5,
+    /**
+     * The Words&Music author of the song
+     */
+    WordsAndMusic = 6,
+    /**
+     * The transcriber of the music sheet
+     */
+    Transcriber = 7,
+    /**
+     * The copyright holder of the song
+     */
+    Copyright = 8,
+    /**
+     * The second copyright line (typically something like 'All Rights Reserved')
+     */
+    CopyrightSecondLine = 9,
+    /**
+     * The chord diagram list shown on top of the score.
+     */
+    ChordDiagramList = 10
+}
+/**
+ * The additional style and display information for header and footer elements.
+ * @json
+ * @json_strict
+ * @public
+ */
+export declare class HeaderFooterStyle {
+    /**
+     * The template how the text should be formatted. Following placeholders exist and are filled from the song information:
+     * * `%TITLE%`
+     * * `%SUBTITLE%`
+     * * `%ARTIST%`
+     * * `%ALBUM%`
+     * * `%WORDS%`
+     * * `%WORDSMUSIC%`
+     * * `%MUSIC%`
+     * * `%TABBER%`
+     * * `%COPYRIGHT%`
+     */
+    template: string;
+    /**
+     * Whether the element should be visible. Overriden by {@link NotationSettings.elements} if specified.
+     */
+    isVisible?: boolean;
+    /**
+     * The alignment of the element on the page.
+     */
+    textAlign: TextAlign;
+    constructor(template?: string, isVisible?: boolean | undefined, textAlign?: TextAlign);
+    static equals(a: HeaderFooterStyle, b: HeaderFooterStyle): boolean;
+    buildText(score: Score): string;
+    private static readonly _placeholderPattern;
+}
+/**
+ * Defines the custom styles for Scores.
+ * @json
+ * @json_strict
+ * @public
+ */
+export declare class ScoreStyle extends ElementStyle<ScoreSubElement> {
+    /**
+     * Changes additional style aspects fo the of the specified sub-element.
+     */
+    headerAndFooter: Map<ScoreSubElement, HeaderFooterStyle>;
+    /**
+     * The default styles applied to headers and footers if not specified
+     */
+    static readonly defaultHeaderAndFooter: Map<ScoreSubElement, HeaderFooterStyle>;
+}
+/**
+ * The score is the root node of the complete
+ * model. It stores the basic information of
+ * a song and stores the sub components.
+ * @json
+ * @json_strict
+ * @public
+ */
+export declare class Score {
+    private _currentRepeatGroup;
+    private _openedRepeatGroups;
+    private _properlyOpenedRepeatGroups;
+    /**
+     * Resets all internal ID generators.
+     */
+    static resetIds(): void;
+    /**
+     * The album of this song.
+     */
+    album: string;
+    /**
+     * The artist who performs this song.
+     */
+    artist: string;
+    /**
+     * The owner of the copyright of this song.
+     */
+    copyright: string;
+    /**
+     * Additional instructions
+     */
+    instructions: string;
+    /**
+     * The author of the music.
+     */
+    music: string;
+    /**
+     * Some additional notes about the song.
+     */
+    notices: string;
+    /**
+     * The subtitle of the song.
+     */
+    subTitle: string;
+    /**
+     * The title of the song.
+     */
+    title: string;
+    /**
+     * The author of the song lyrics
+     */
+    words: string;
+    /**
+     * The author of this tablature.
+     */
+    tab: string;
+    /**
+     * The initial tempo of the song in BPM. The tempo might change via {@link MasterBar.tempoAutomations}.
+     */
+    get tempo(): number;
+    /**
+     * The name/label of the initial tempo.
+     */
+    get tempoLabel(): string;
+    /**
+     * Gets or sets a list of all masterbars contained in this song.
+     * @json_add addMasterBar
+     */
+    masterBars: MasterBar[];
+    /**
+     * Gets or sets a list of all tracks contained in this song.
+     * @json_add addTrack
+     */
+    tracks: Track[];
+    /**
+     * Defines how many bars are placed into the systems (rows) when displaying
+     * multiple tracks unless a value is set in the systemsLayout.
+     */
+    defaultSystemsLayout: number;
+    /**
+     * Defines how many bars are placed into the systems (rows) when displaying
+     * multiple tracks.
+     */
+    systemsLayout: number[];
+    /**
+     * Gets or sets the rendering stylesheet for this song.
+     */
+    stylesheet: RenderStylesheet;
+    /**
+     * Information about the backing track that can be used instead of the synthesized audio.
+     */
+    backingTrack: BackingTrack | undefined;
+    /**
+     * The style customizations for this item.
+     */
+    style?: ScoreStyle;
+    rebuildRepeatGroups(): void;
+    addMasterBar(bar: MasterBar): void;
+    /**
+     * Adds the given bar correctly into the current repeat group setup.
+     * @param bar
+     */
+    private _addMasterBarToRepeatGroups;
+    addTrack(track: Track): void;
+    finish(settings: Settings): void;
+    /**
+     * Applies the given list of {@link FlatSyncPoint} to this song.
+     * @param syncPoints The list of sync points to apply.
+     * @since 1.6.0
+     */
+    applyFlatSyncPoints(syncPoints: FlatSyncPoint[]): void;
+    /**
+     * Exports all sync points in this song to a {@link FlatSyncPoint} list.
+     * @since 1.6.0
+     */
+    exportFlatSyncPoints(): FlatSyncPoint[];
+}

package/dist/types/alphatab/src/model/Section.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This public class is used to describe the beginning of a
+ * section within a song. It acts like a marker.
+ * @json
+ * @json_strict
+ * @public
+ */
+export declare class Section {
+    /**
+     * Gets or sets the marker ID for this section.
+     */
+    marker: string;
+    /**
+     * Gets or sets the descriptional text of this section.
+     */
+    text: string;
+}

package/dist/types/alphatab/src/model/SimileMark.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Lists all simile mark types as they are assigned to bars.
+ * @public
+ */
+export declare enum SimileMark {
+    /**
+     * No simile mark is applied
+     */
+    None = 0,
+    /**
+     * A simple simile mark. The previous bar is repeated.
+     */
+    Simple = 1,
+    /**
+     * A double simile mark. This value is assigned to the first
+     * bar of the 2 repeat bars.
+     */
+    FirstOfDouble = 2,
+    /**
+     * A double simile mark. This value is assigned to the second
+     * bar of the 2 repeat bars.
+     */
+    SecondOfDouble = 3
+}

package/dist/types/alphatab/src/model/SlideInType.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This public enum lists all different types of finger slide-ins on a string.
+ * @public
+ */
+export declare enum SlideInType {
+    /**
+     * No slide.
+     */
+    None = 0,
+    /**
+     * Slide into the note from below on the same string.
+     */
+    IntoFromBelow = 1,
+    /**
+     * Slide into the note from above on the same string.
+     */
+    IntoFromAbove = 2
+}

package/dist/types/alphatab/src/model/SlideOutType.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This public enum lists all different types of finger slide-outs on a string.
+ * @public
+ */
+export declare enum SlideOutType {
+    /**
+     * No slide.
+     */
+    None = 0,
+    /**
+     * Shift slide to next note on same string
+     */
+    Shift = 1,
+    /**
+     * Legato slide to next note on same string.
+     */
+    Legato = 2,
+    /**
+     * Slide out from the note from upwards on the same string.
+     */
+    OutUp = 3,
+    /**
+     * Slide out from the note from downwards on the same string.
+     */
+    OutDown = 4,
+    /**
+     * Pickslide down on this note
+     */
+    PickSlideDown = 5,
+    /**
+     * Pickslide up on this note
+     */
+    PickSlideUp = 6
+}

package/dist/types/alphatab/src/model/Staff.d.ts

@@ -0,0 +1,100 @@
+import type { Bar } from "./Bar";
+import type { Chord } from "./Chord";
+import type { Track } from "./Track";
+import type { Settings } from "./../Settings";
+import { Tuning } from "./Tuning";
+/**
+ * This class describes a single staff within a track. There are instruments like pianos
+ * where a single track can contain multiple staves.
+ * @json
+ * @json_strict
+ * @public
+ */
+export declare class Staff {
+    static readonly DefaultStandardNotationLineCount = 5;
+    /**
+     * Gets or sets the zero-based index of this staff within the track.
+     * @json_ignore
+     */
+    index: number;
+    /**
+     * Gets or sets the reference to the track this staff belongs to.
+     * @json_ignore
+     */
+    track: Track;
+    /**
+     * Gets or sets a list of all bars contained in this staff.
+     * @json_add addBar
+     */
+    bars: Bar[];
+    /**
+     * Gets or sets a list of all chords defined for this staff. {@link Beat.chordId} refers to entries in this lookup.
+     * @json_add addChord
+     */
+    chords: Map<string, Chord> | null;
+    /**
+     * Gets or sets the fret on which a capo is set.
+     */
+    capo: number;
+    /**
+     * Gets or sets the number of semitones this track should be
+     * transposed. This applies to rendering and playback.
+     */
+    transpositionPitch: number;
+    /**
+     * Gets or sets the number of semitones this track should be
+     * transposed. This applies only to rendering.
+     */
+    displayTranspositionPitch: number;
+    /**
+     * Get or set the guitar tuning of the guitar. This tuning also indicates the number of strings shown in the
+     * guitar tablature. Unlike the {@link Note.string} property this array directly represents
+     * the order of the tracks shown in the tablature. The first item is the most top tablature line.
+     */
+    stringTuning: Tuning;
+    /**
+     * Get or set the values of the related guitar tuning.
+     */
+    get tuning(): number[];
+    /**
+     * Gets or sets the name of the tuning.
+     */
+    get tuningName(): string;
+    get isStringed(): boolean;
+    /**
+     * Gets or sets whether the slash notation is shown.
+     */
+    showSlash: boolean;
+    /**
+     * Gets or sets whether the numbered notation is shown.
+     */
+    showNumbered: boolean;
+    /**
+     * Gets or sets whether the tabs are shown.
+     */
+    showTablature: boolean;
+    /**
+     * Gets or sets whether the standard notation is shown.
+     */
+    showStandardNotation: boolean;
+    /**
+     * Gets or sets whether the staff contains percussion notation
+     */
+    isPercussion: boolean;
+    /**
+     * The number of lines shown for the standard notation.
+     * For some percussion instruments this number might vary.
+     */
+    standardNotationLineCount: number;
+    private _filledVoices;
+    /**
+     * The indexes of the non-empty voices in this staff..
+     * @json_ignore
+     */
+    get filledVoices(): Set<number>;
+    finish(settings: Settings, sharedDataBag?: Map<string, unknown> | null): void;
+    addChord(chordId: string, chord: Chord): void;
+    hasChord(chordId: string): boolean;
+    getChord(chordId: string): Chord | null;
+    addBar(bar: Bar): void;
+}