\ No newline at end of file
+
diff --git a/docs/reference/alphasynth.mdx b/docs/reference/alphasynth.mdx
deleted file mode 100644
index 74f75ff34..000000000
--- a/docs/reference/alphasynth.mdx
+++ /dev/null
@@ -1,17 +0,0 @@
----
-title: AlphaSynth
----
-
-import { ReferenceTable } from '@site/src/components/ReferenceTable';
-
-`AlphaSynth` is one of the low level APIs that can be used if no full alphaTab API object with UI interaction
-can be used or is needed. It is the audio synthesis engine of alphaTab which is used to play a midi file
-using a generated midi file and a SoundFont as input.
-
-This page describes all methods, properties and events exposed by this class. Most of the API methods exposed by
-the `IAlphaSynth` interface are also directly available on the normal API object. That's why many documentation pages
-delegate to the related documentation pages there.
-
-import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
-
-{"playedBeatChanged"} event this event contains the beats of all tracks and voices independent of them being rendered.
-{"activeBeatsChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"ActiveBeatsChangedEventArgs"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"ActiveBeatsChangedEventArgs"}{">"}{" "}{"ActiveBeatsChanged"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"activeBeatsChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"ActiveBeatsChangedEventArgs"}{">"}{"beatMouseDown"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{" "}{"BeatMouseDown"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"beatMouseDown"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{"beatMouseMove"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{" "}{"BeatMouseMove"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"beatMouseMove"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{"beatMouseUp"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{" "}{"|"}{" "}{"null"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"Beat"}{"?"}{">"}{" "}{"BeatMouseUp"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"beatMouseUp"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{"?"}{">"}{"boundsLookup"} on {"renderer"}.
+
+After the rendering completed alphaTab exposes via this lookup the location of the individual
+notation elements. The lookup provides fast access to the bars and beats at a given location.
+If the {"CoreSettings.includeNoteBounds"} option was activated also the location of the individual notes can be obtained.
+
+The property contains a `BoundsLookup` instance which follows a hierarchical structure that represents
+the tree of rendered elements.
+
+The hierarchy is: `staffSystems > bars(1) > bars(2) > beats > notes`
+
+* `staffSystems` - Represent the bounds of the individual systems ("rows") where staves are contained.
+* `bars(1)` - Represent the bounds of all bars for a particular master bar across all tracks.
+* `bars(2)` - Represent the bounds of an individual bar of a track. The bounds on y-axis span the region of the staff and notes might exceed this bounds.
+* `beats` - Represent the bounds of the individual beats within a track. The bounds on y-axis are equal to the bar bounds.
+* `notes` - Represent the bounds of the individual note heads/numbers within a track.
+
+Each bounds hierarchy have a `visualBounds` and `realBounds`.
+
+* `visualBounds` - Represent the area covering all visually visible elements
+* `realBounds` - Represents the actual bounds of the elements in this beat including whitespace areas.
+* `noteHeadBounds` (only on `notes` level) - Represents the area of the note heads or number based on the staff
+
+You can check out the individual sizes and regions.
+
+{"readonly"}{" "}{"boundsLookup"}{":"}{" "}{"BoundsLookup"}{" "}{"|"}{" "}{"null"}{";"}{"BoundsLookup"}{"?"}{" "}{"BoundsLookup"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}{"val"}{" "}{"boundsLookup"}{":"}{" "}{"BoundsLookup"}{"?"}{"readonly"}{" "}{"canvasElement"}{":"}{" "}{"IContainer"}{";"}{"IContainer"}{" "}{"CanvasElement"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}{"val"}{" "}{"canvasElement"}{":"}{" "}{"IContainer"}{"changeTrackMute"}{"("}{"tracks"}{":"}{" "}{"Track"}{"[]"}{","}{" "}{"mute"}{":"}{" "}{"boolean"}{")"}{":"}{" "}{"void"}{"void"}{" "}{"ChangeTrackMute"}{"("}{"IList"}{"<"}{"Track"}{">"}{" "}{"tracks"}{","}{" "}{"bool"}{" "}{"mute"}{")"}{"fun"}{" "}{"changeTrackMute"}{"("}{"tracks"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"Track"}{">"}{","}{" "}{"mute"}{":"}{" "}{"Boolean"}{")"}{":"}{" "}{"Unit"}{"changeTrackSolo"}{"("}{"tracks"}{":"}{" "}{"Track"}{"[]"}{","}{" "}{"solo"}{":"}{" "}{"boolean"}{")"}{":"}{" "}{"void"}{"void"}{" "}{"ChangeTrackSolo"}{"("}{"IList"}{"<"}{"Track"}{">"}{" "}{"tracks"}{","}{" "}{"bool"}{" "}{"solo"}{")"}{"fun"}{" "}{"changeTrackSolo"}{"("}{"tracks"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"Track"}{">"}{","}{" "}{"solo"}{":"}{" "}{"Boolean"}{")"}{":"}{" "}{"Unit"}{"changeTrackTranspositionPitch"}{"("}{"tracks"}{":"}{" "}{"Track"}{"[]"}{","}{" "}{"semitones"}{":"}{" "}{"number"}{")"}{":"}{" "}{"void"}{"void"}{" "}{"ChangeTrackTranspositionPitch"}{"("}{"IList"}{"<"}{"Track"}{">"}{" "}{"tracks"}{","}{" "}{"double"}{" "}{"semitones"}{")"}{"fun"}{" "}{"changeTrackTranspositionPitch"}{"("}{"tracks"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"Track"}{">"}{","}{" "}{"semitones"}{":"}{" "}{"Double"}{")"}{":"}{" "}{"Unit"}{"changeTrackVolume"}{"("}{"tracks"}{":"}{" "}{"Track"}{"[]"}{","}{" "}{"volume"}{":"}{" "}{"number"}{")"}{":"}{" "}{"void"}{"void"}{" "}{"ChangeTrackVolume"}{"("}{"IList"}{"<"}{"Track"}{">"}{" "}{"tracks"}{","}{" "}{"double"}{" "}{"volume"}{")"}{"fun"}{" "}{"changeTrackVolume"}{"("}{"tracks"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"Track"}{">"}{","}{" "}{"volume"}{":"}{" "}{"Double"}{")"}{":"}{" "}{"Unit"}{"readonly"}{" "}{"container"}{":"}{" "}{"IContainer"}{";"}{"IContainer"}{" "}{"Container"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}{"val"}{" "}{"container"}{":"}{" "}{"IContainer"}{"countInVolume"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}{"double"}{" "}{"CountInVolume"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}{"var"}{" "}{"countInVolume"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}{"destroy"}{"("}{")"}{":"}{" "}{"void"}{"void"}{" "}{"Destroy"}{"("}{")"}{"fun"}{" "}{"destroy"}{"("}{")"}{":"}{" "}{"Unit"}{"downloadMidi"}{"("}{"format"}{"?"}{":"}{" "}{"MidiFileFormat"}{")"}{":"}{" "}{"void"}{"setOutputDevice"} to change dynamically the output device on which
+the sound is played.
+
+In the web version this functionality relies on experimental APIs and might not yet be available in all browsers. https://caniuse.com/mdn-api_audiocontext_sinkid
+
+{"enumerateOutputDevices"}{"("}{")"}{":"}{" "}{"Promise"}{"<"}{"ISynthOutputDevice"}{"[]"}{">"}{"System.Threading.Task"}{"<"}{"IList"}{"<"}{"ISynthOutputDevice"}{">"}{">"}{" "}{"EnumerateOutputDevices"}{"("}{")"}{"suspend"}{" "}{"fun"}{" "}{"enumerateOutputDevices"}{"("}{")"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"ISynthOutputDevice"}{">"}{"error"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Error"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"System.Exception"}{">"}{" "}{"Error"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"error"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"kotlin.Throwable"}{">"}{\"setOutputDevice\"}."
+sidebar_custom_props:
+ kind: method
+ category: Methods - Player
+ since: 1.5.0
+---
+
+import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable';
+import CodeBlock from '@theme/CodeBlock';
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import { CodeBadge } from '@site/src/components/CodeBadge';
+import { SinceBadge } from '@site/src/components/SinceBadge';
+import DynHeading from '@site/src/components/DynHeading';
+import Link from '@docusaurus/Link';
+
+{"setOutputDevice"}. Assumes {"setOutputDevice"} has been used.
+In the web version this functionality relies on experimental APIs and might not yet be available in all browsers. https://caniuse.com/mdn-api_audiocontext_sinkid
+
+{"getOutputDevice"}{"("}{")"}{":"}{" "}{"Promise"}{"<"}{"ISynthOutputDevice"}{" "}{"|"}{" "}{"null"}{">"}{"System.Threading.Task"}{"<"}{"ISynthOutputDevice"}{"?"}{">"}{" "}{"GetOutputDevice"}{"("}{")"}{"suspend"}{" "}{"fun"}{" "}{"getOutputDevice"}{"("}{")"}{":"}{" "}{"ISynthOutputDevice"}{"?"}{"setOutputDevice"} or `null`
+if the default outputDevice is used.
+The output device might change dynamically if devices are connected/disconnected (e.g. bluetooth headset).
+
+
+## Examples
+
+{"isLooping"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}{"bool"}{" "}{"IsLooping"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}{"var"}{" "}{"isLooping"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}{"readonly"}{" "}{"isReadyForPlayback"}{":"}{" "}{"boolean"}{";"}{"bool"}{" "}{"IsReadyForPlayback"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}{"val"}{" "}{"isReadyForPlayback"}{":"}{" "}{"Boolean"}{"load"}{"("}{"scoreData"}{":"}{" "}{"unknown"}{","}{" "}{"trackIndexes"}{"?"}{":"}{" "}{"number"}{"[]"}{")"}{":"}{" "}{"boolean"}{"bool"}{" "}{"Load"}{"("}{"object"}{" "}{"scoreData"}{","}{" "}{"IList"}{"<"}{"double"}{">"}{"?"}{" "}{"trackIndexes"}{")"}{"fun"}{" "}{"load"}{"("}{"scoreData"}{":"}{" "}{"Any"}{","}{" "}{"trackIndexes"}{":"}{" "}{"alphaTab.collections.DoubleList"}{"?"}{")"}{":"}{" "}{"Boolean"}{"IUiFacade"}. The supported types is depending on the platform:
+
+ * A `alphaTab.model.Score` instance (all platforms)
+ * A `ArrayBuffer` or `Uint8Array` containing one of the supported file formats (all platforms, native byte array or input streams on other platforms)
+ * A url from where to download the binary data of one of the supported file formats (browser only)
{"loadSoundFont"}{"("}{"data"}{":"}{" "}{"unknown"}{","}{" "}{"append"}{"?"}{":"}{" "}{"boolean"}{")"}{":"}{" "}{"boolean"}{"bool"}{" "}{"LoadSoundFont"}{"("}{"object"}{" "}{"data"}{","}{" "}{"bool"}{"?"}{" "}{"append"}{")"}{"fun"}{" "}{"loadSoundFont"}{"("}{"data"}{":"}{" "}{"Any"}{","}{" "}{"append"}{":"}{" "}{"Boolean"}{"?"}{")"}{":"}{" "}{"Boolean"}{"loadSoundFontFromUrl"}{"("}{"url"}{":"}{" "}{"string"}{","}{" "}{"append"}{":"}{" "}{"boolean"}{")"}{":"}{" "}{"void"}{"masterVolume"}{":"}{" "}{"number"}{";"}{"double"}{" "}{"MasterVolume"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"masterVolume"}{":"}{" "}{"Double"}{"metronomeVolume"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}{"double"}{" "}{"MetronomeVolume"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}{"var"}{" "}{"metronomeVolume"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}{"midiEventsPlayed"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"MidiEventsPlayedEventArgs"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"MidiEventsPlayedEventArgs"}{">"}{" "}{"MidiEventsPlayed"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"midiEventsPlayed"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"MidiEventsPlayedEventArgs"}{">"}{"midiEventsPlayedFilter"}{":"}{" "}{"MidiEventType"}{"[]"}{" "}{"="}{" "}{"[]"}{";"}{"IList"}{"<"}{"MidiEventType"}{">"}{" "}{"MidiEventsPlayedFilter"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"[]"}{"var"}{" "}{"midiEventsPlayedFilter"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"MidiEventType"}{">"}{" "}{"="}{" "}{"[]"}{"midiLoad"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"MidiFile"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"MidiFile"}{">"}{" "}{"MidiLoad"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"midiLoad"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"MidiFile"}{">"}{"midiLoaded"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PositionChangedEventArgs"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"PositionChangedEventArgs"}{">"}{" "}{"MidiLoaded"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"midiLoaded"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PositionChangedEventArgs"}{">"}{"CoreSettings.includeNoteBounds"} was set to `true` because
+only then this hit detection can be done. A click on a note is considered if the note head or the note number on tabs are clicked as documented in {"boundsLookup"}.
-## Types
-
-{"noteMouseDown"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Note"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"Note"}{">"}{" "}{"NoteMouseDown"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"noteMouseDown"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Note"}{">"}{"CoreSettings.includeNoteBounds"} was set to `true` because
+only then this hit detection can be done. A click on a note is considered if the note head or the note number on tabs are clicked as documented in {"boundsLookup"}
-## Types
-
-{"noteMouseMove"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Note"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"Note"}{">"}{" "}{"NoteMouseMove"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"noteMouseMove"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Note"}{">"}{"CoreSettings.includeNoteBounds"} was set to `true` because
+only then this hit detection can be done. A click on a note is considered if the note head or the note number on tabs are clicked as documented in the {"boundsLookup"}.
-## Types
-
-{"noteMouseUp"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Note"}{" "}{"|"}{" "}{"null"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"Note"}{"?"}{">"}{" "}{"NoteMouseUp"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"noteMouseUp"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Note"}{"?"}{">"}{"pause"}{"("}{")"}{":"}{" "}{"void"}{"void"}{" "}{"Pause"}{"("}{")"}{"fun"}{" "}{"pause"}{"("}{")"}{":"}{" "}{"Unit"}{"play"}{"("}{")"}{":"}{" "}{"boolean"}{"bool"}{" "}{"Play"}{"("}{")"}{"fun"}{" "}{"play"}{"("}{")"}{":"}{" "}{"Boolean"}| Property | -Type | -Summary | -
|---|---|---|
|
- - - |
- int |
- - The position in midi ticks from where the song should start - | -
|
- - - |
- int |
- - The position in midi ticks to where the song should be played. - | -
{"playbackRange"}{":"}{" "}{"PlaybackRange"}{" "}{"|"}{" "}{"null"}{" "}{"="}{" "}{"null"}{";"}{"PlaybackRange"}{"?"}{" "}{"PlaybackRange"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"null"}{"var"}{" "}{"playbackRange"}{":"}{" "}{"PlaybackRange"}{"?"}{" "}{"="}{" "}{"null"}{"playbackRangeChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PlaybackRangeChangedEventArgs"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"PlaybackRangeChangedEventArgs"}{">"}{" "}{"PlaybackRangeChanged"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"playbackRangeChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PlaybackRangeChangedEventArgs"}{">"}{"playbackSpeed"}{":"}{" "}{"number"}{" "}{"="}{" "}{"1"}{";"}{"double"}{" "}{"PlaybackSpeed"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"1"}{"var"}{" "}{"playbackSpeed"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"1"}{"playBeat"}{"("}{"beat"}{":"}{" "}{"Beat"}{")"}{":"}{" "}{"void"}{"void"}{" "}{"PlayBeat"}{"("}{"Beat"}{" "}{"beat"}{")"}{"fun"}{" "}{"playBeat"}{"("}{"beat"}{":"}{" "}{"Beat"}{")"}{":"}{" "}{"Unit"}{"playedBeatChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{" "}{"PlayedBeatChanged"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"playedBeatChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{"IAlphaSynth"} that is used for the audio playback.
-## Types
+{"player"}{":"}{" "}{"IAlphaSynth"}{" "}{"|"}{" "}{"null"}{";"}{"IAlphaSynth"}{"?"}{" "}{"Player"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"player"}{":"}{" "}{"IAlphaSynth"}{"?"}{"playerFinished"}{":"}{" "}{"IEventEmitter"}{";"}{"IEventEmitter"}{" "}{"PlayerFinished"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"playerFinished"}{":"}{" "}{"IEventEmitter"}{"playerPositionChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PositionChangedEventArgs"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"PositionChangedEventArgs"}{">"}{" "}{"PlayerPositionChanged"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"playerPositionChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PositionChangedEventArgs"}{">"}{"playerReady"}{":"}{" "}{"IEventEmitter"}{";"}{"IEventEmitter"}{" "}{"PlayerReady"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"playerReady"}{":"}{" "}{"IEventEmitter"}{"readonly"}{" "}{"playerState"}{":"}{" "}{"PlayerState"}{";"}{"PlayerState"}{" "}{"PlayerState"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}{"val"}{" "}{"playerState"}{":"}{" "}{"PlayerState"}- `1` for playing -
{"playerStateChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PlayerStateChangedEventArgs"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"PlayerStateChangedEventArgs"}{">"}{" "}{"PlayerStateChanged"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"playerStateChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PlayerStateChangedEventArgs"}{">"}- `0` - Paused - `1` - Playing -
{"playNote"}{"("}{"note"}{":"}{" "}{"Note"}{")"}{":"}{" "}{"void"}{"void"}{" "}{"PlayNote"}{"("}{"Note"}{" "}{"note"}{")"}{"fun"}{" "}{"playNote"}{"("}{"note"}{":"}{" "}{"Note"}{")"}{":"}{" "}{"Unit"}{"playPause"}{"("}{")"}{":"}{" "}{"void"}{"void"}{" "}{"PlayPause"}{"("}{")"}{"fun"}{" "}{"playPause"}{"("}{")"}{":"}{" "}{"Unit"}{"CoreSettings.enableLazyLoading"} is enabled not all partial images of the music sheet might be rendered.
+In this case the `renderFinished` event rather represents that the whole music sheet has been layouted and arranged
+and every partial image can be requested for rendering. If you neeed more fine-grained access
+to the actual layouting and rendering progress, you need to look at the low-level apis {"partialLayoutFinished"} and
+{"partialRenderFinished"} accessible via {"renderer"}.
-{"postRenderFinished"}{":"}{" "}{"IEventEmitter"}{";"}{"IEventEmitter"}{" "}{"PostRenderFinished"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"postRenderFinished"}{":"}{" "}{"IEventEmitter"}{"print"}{"("}{"width"}{"?"}{":"}{" "}{"string"}{","}{" "}{"additionalSettings"}{"?"}{":"}{" "}{"unknown"}{")"}{":"}{" "}{"void"}{"render"}{"("}{")"}{":"}{" "}{"void"}{"void"}{" "}{"Render"}{"("}{")"}{"fun"}{" "}{"render"}{"("}{")"}{":"}{" "}{"Unit"}{"IScoreRenderer"} that is used for the rendering.
+
+{"readonly"}{" "}{"renderer"}{":"}{" "}{"IScoreRenderer"}{";"}{"IScoreRenderer"}{" "}{"Renderer"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}{"val"}{" "}{"renderer"}{":"}{" "}{"IScoreRenderer"}{"renderFinished"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"RenderFinishedEventArgs"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"RenderFinishedEventArgs"}{">"}{" "}{"RenderFinished"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"renderFinished"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"RenderFinishedEventArgs"}{">"}{"renderScore"}{"("}{"score"}{":"}{" "}{"Score"}{","}{" "}{"trackIndexes"}{"?"}{":"}{" "}{"number"}{"[]"}{")"}{":"}{" "}{"void"}{"void"}{" "}{"RenderScore"}{"("}{"Score"}{" "}{"score"}{","}{" "}{"IList"}{"<"}{"double"}{">"}{"?"}{" "}{"trackIndexes"}{")"}{"fun"}{" "}{"renderScore"}{"("}{"score"}{":"}{" "}{"Score"}{","}{" "}{"trackIndexes"}{":"}{" "}{"alphaTab.collections.DoubleList"}{"?"}{")"}{":"}{" "}{"Unit"}{"renderStarted"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"boolean"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"bool"}{">"}{" "}{"RenderStarted"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"renderStarted"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Boolean"}{">"}{"renderTracks"}{"("}{"tracks"}{":"}{" "}{"Track"}{"[]"}{")"}{":"}{" "}{"void"}{"void"}{" "}{"RenderTracks"}{"("}{"IList"}{"<"}{"Track"}{">"}{" "}{"tracks"}{")"}{"fun"}{" "}{"renderTracks"}{"("}{"tracks"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"Track"}{">"}{")"}{":"}{" "}{"Unit"}{"resetSoundFonts"}{"("}{")"}{":"}{" "}{"void"}{"void"}{" "}{"ResetSoundFonts"}{"("}{")"}{"fun"}{" "}{"resetSoundFonts"}{"("}{")"}{":"}{" "}{"Unit"}{"resize"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"ResizeEventArgs"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"ResizeEventArgs"}{">"}{" "}{"Resize"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"resize"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"ResizeEventArgs"}{">"}{"readonly"}{" "}{"score"}{":"}{" "}{"Score"}{" "}{"|"}{" "}{"null"}{";"}{"Score"}{"?"}{" "}{"Score"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}{"val"}{" "}{"score"}{":"}{" "}{"Score"}{"?"}{"renderScore"} or {"renderTracks"} calls.
+It is fired after the transposition midi pitches from the settings were applied, but before any midi is generated or rendering is started.
+This allows any modification of the score before further processing.
-## Types
-
-{"scoreLoaded"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Score"}{">"}{";"}{"IEventEmitterOfT"}{"<"}{"Score"}{">"}{" "}{"ScoreLoaded"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"scoreLoaded"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Score"}{">"}{"scrollToCursor"}{"("}{")"}{":"}{" "}{"void"}{"void"}{" "}{"ScrollToCursor"}{"("}{")"}{"fun"}{" "}{"scrollToCursor"}{"("}{")"}{":"}{" "}{"Unit"}{"enumerateOutputDevices"} to load the list of available devices.
+
+In the web version this functionality relies on experimental APIs and might not yet be available in all browsers. https://caniuse.com/mdn-api_audiocontext_sinkid
+
+{"setOutputDevice"}{"("}{"device"}{":"}{" "}{"ISynthOutputDevice"}{" "}{"|"}{" "}{"null"}{")"}{":"}{" "}{"Promise"}{"<"}{"void"}{">"}{"System.Threading.Task"}{"<"}{"void"}{">"}{" "}{"SetOutputDevice"}{"("}{"ISynthOutputDevice"}{"?"}{" "}{"device"}{")"}{"suspend"}{" "}{"fun"}{" "}{"setOutputDevice"}{"("}{"device"}{":"}{" "}{"ISynthOutputDevice"}{"?"}{")"}{":"}{" "}{"Unit"}AlphaTab.Settings object that is currently used by AlphaTab.
-
import { PropertyDescription } from '@site/src/components/PropertyDescription';
{"Settings"} object that is currently used by alphaTab.
-## Types
+{"settings"}{":"}{" "}{"Settings"}{";"}{"Settings"}{" "}{"Settings"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"settings"}{":"}{" "}{"Settings"}{"soundFontLoad"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"ProgressEventArgs"}{">"}{";"}{"soundFontLoaded"}{":"}{" "}{"IEventEmitter"}{";"}{"IEventEmitter"}{" "}{"SoundFontLoaded"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"soundFontLoaded"}{":"}{" "}{"IEventEmitter"}{"stop"}{"("}{")"}{":"}{" "}{"void"}{"void"}{" "}{"Stop"}{"("}{")"}{"fun"}{" "}{"stop"}{"("}{")"}{":"}{" "}{"Unit"}{"tex"}{"("}{"tex"}{":"}{" "}{"string"}{","}{" "}{"tracks"}{"?"}{":"}{" "}{"number"}{"[]"}{")"}{":"}{" "}{"void"}{"void"}{" "}{"Tex"}{"("}{"string"}{" "}{"tex"}{","}{" "}{"IList"}{"<"}{"double"}{">"}{"?"}{" "}{"tracks"}{")"}{"fun"}{" "}{"tex"}{"("}{"tex"}{":"}{" "}{"String"}{","}{" "}{"tracks"}{":"}{" "}{"alphaTab.collections.DoubleList"}{"?"}{")"}{":"}{" "}{"Unit"}{"Score"} for later playback. During this generation this tick cache is filled with the
+exact midi ticks when beats are played.
-## Types
-
-{"findBeat"} method allows a lookup of the beat related to a given input midi tick.
+{"readonly"}{" "}{"tickCache"}{":"}{" "}{"MidiTickLookup"}{" "}{"|"}{" "}{"null"}{";"}{"MidiTickLookup"}{"?"}{" "}{"TickCache"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}{"val"}{" "}{"tickCache"}{":"}{" "}{"MidiTickLookup"}{"?"}{"tickPosition"}{":"}{" "}{"number"}{";"}{"double"}{" "}{"TickPosition"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"tickPosition"}{":"}{" "}{"Double"}{"timePosition"}{":"}{" "}{"number"}{";"}{"double"}{" "}{"TimePosition"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{"var"}{" "}{"timePosition"}{":"}{" "}{"Double"}{"readonly"}{" "}{"tracks"}{":"}{" "}{"Track"}{"[]"}{";"}{"IList"}{"<"}{"Track"}{">"}{" "}{"Tracks"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}{"val"}{" "}{"tracks"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"Track"}{">"}{"readonly"}{" "}{"uiFacade"}{":"}{" "}{"IUiFacade"}{"<"}{"TSettings"}{">"}{";"}{"IUiFacade"}{"<"}{"TSettings"}{">"}{" "}{"UiFacade"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}{"val"}{" "}{"uiFacade"}{":"}{" "}{"IUiFacade"}{"<"}{"TSettings"}{">"}{"renderer"} about any new values to consider.
By default alphaTab will not trigger any re-rendering or settings update just if the settings object itself was changed. This method must be called
-to trigger an update of the settings in all components. Then a re-rendering can be initiated using the `Render()` method.
-
-## Signatures
+to trigger an update of the settings in all components. Then a re-rendering can be initiated using the {"render"} method.
-{"updateSettings"}{"("}{")"}{":"}{" "}{"void"}{"void"}{" "}{"UpdateSettings"}{"("}{")"}{"fun"}{" "}{"updateSettings"}{"("}{")"}{":"}{" "}{"Unit"}{"enableLazyLoading"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}{"bool"}{" "}{"EnableLazyLoading"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}{"var"}{" "}{"enableLazyLoading"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}- `html5` - Uses HTML5 canvas elements to render the music notation. -
- `gdi` - Only available desktop .net. Uses [GDI+](https://docs.microsoft.com/en-us/dotnet/framework/winforms/advanced/graphics-and-drawing-in-windows-forms) for rendering
- `svg` - Available on all .net platforms. Outputs SVG strings. -
- `android` - Uses [android.graphics.Canvas](https://developer.android.com/reference/android/graphics/Canvas) for rendering
- `svg` - Outputs SVG strings. -
{"engine"}{":"}{" "}{"string"}{" "}{"="}{" "}{"\"default\""}{";"}{"string"}{" "}{"Engine"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"\"default\""}{"var"}{" "}{"engine"}{":"}{" "}{"String"}{" "}{"="}{" "}{"\"default\""}{"file"}{":"}{" "}{"string"}{" "}{"|"}{" "}{"null"}{" "}{"="}{" "}{"null"}{";"}{"fontDirectory"}{":"}{" "}{"string"}{" "}{"|"}{" "}{"null"}{" "}{"="}{" "}{"\"${AlphaTabScriptFolder}/font/\""}{";"}{\"BoundsLookup\"} also the position and area of each individual note is provided."
sidebar_custom_props:
jsOnParent: true
category: Core
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-{"BoundsLookup"} also the position and area of each individual note is provided. AlphaTab collects the position of the rendered music notation elements during the rendering process. This way some level of interactivity can be provided like the feature that seeks to the corresponding position when clicking on a beat.
+By default the position of the individual notes is not collected due to performance reasons. If access to note position information is needed, this setting can enable it.
-## Default Value
+{"includeNoteBounds"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}{"bool"}{" "}{"IncludeNoteBounds"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}{"var"}{" "}{"includeNoteBounds"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}- `Debug` - Debug level (internal details are displayed)
- `Info` - Info level (only important details are shown)
- `Warning`
- `Error` -
- `debug`
- `info`
- `warning`
- `error` -
- `1` - Debug
- `2` - Info
- `3` - Warning
- `4` - Error -
- `Debug`
- `Info`
- `Warning`
- `Error` -
- `Debug`
- `Info`
- `Warning`
- `Error` -
{"logLevel"}{":"}{" "}{"LogLevel"}{" "}{"="}{" "}{"LogLevel.Info"}{";"}{"LogLevel"}{" "}{"LogLevel"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"LogLevel.Info"}{"var"}{" "}{"logLevel"}{":"}{" "}{"LogLevel"}{" "}{"="}{" "}{"LogLevel.Info"}{"scriptFile"}{":"}{" "}{"string"}{" "}{"|"}{" "}{"null"}{" "}{"="}{" "}{"Absolute url to JavaScript file containing alphaTab. (auto detected)"}{";"}{"tex"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}\title "Simple alphaTex init" . 3.3*4
+\title "Simple alphaTex init" . 3.3*4
```
-
-{"file"} or {"tex"} option. It controls which of the tracks
of the initially loaded file should be displayed.
-{"tracks"}{":"}{" "}{"number"}{" "}{"|"}{" "}{"number"}{"[]"}{" "}{"|"}{" "}{"'all'"}{" "}{"="}{" "}{"null"}{";"}{"useWorkers"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}{"bool"}{" "}{"UseWorkers"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}{"var"}{" "}{"useWorkers"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}{"accoladeBarPaddingRight"}{":"}{" "}{"number"}{" "}{"="}{" "}{"3"}{";"}{"double"}{" "}{"AccoladeBarPaddingRight"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"3"}{"var"}{" "}{"accoladeBarPaddingRight"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"3"}{"barCount"}{":"}{" "}{"number"}{" "}{"="}{" "}{"-1"}{";"}{"double"}{" "}{"BarCount"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"-1"}{"var"}{" "}{"barCount"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"-1"}{"barCountPerPartial"}{":"}{" "}{"number"}{" "}{"="}{" "}{"10"}{";"}{"double"}{" "}{"BarCountPerPartial"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"10"}{"var"}{" "}{"barCountPerPartial"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"10"}{"Page"} where bars are aligned in systems. [Demo](/docs/showcase/layouts#page-layout-5-bars-per-row).
-## Default Value
+{"barsPerRow"}{":"}{" "}{"number"}{" "}{"="}{" "}{"-1"}{";"}{"double"}{" "}{"BarsPerRow"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"-1"}{"var"}{" "}{"barsPerRow"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"-1"}{"effectStaffPaddingBottom"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}{"double"}{" "}{"EffectStaffPaddingBottom"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}{"var"}{" "}{"effectStaffPaddingBottom"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}{"effectStaffPaddingTop"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}{"double"}{" "}{"EffectStaffPaddingTop"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}{"var"}{" "}{"effectStaffPaddingTop"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}{"firstStaffPaddingLeft"}{":"}{" "}{"number"}{" "}{"="}{" "}{"6"}{";"}{"double"}{" "}{"FirstStaffPaddingLeft"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"6"}{"var"}{" "}{"firstStaffPaddingLeft"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"6"}{"firstSystemPaddingTop"}{":"}{" "}{"number"}{" "}{"="}{" "}{"5"}{";"}{"double"}{" "}{"FirstSystemPaddingTop"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"5"}{"var"}{" "}{"firstSystemPaddingTop"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"5"}{"justifyLastSystem"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}{"bool"}{" "}{"JustifyLastSystem"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}{"var"}{" "}{"justifyLastSystem"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}{"lastSystemPaddingBottom"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}{"double"}{" "}{"LastSystemPaddingBottom"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}{"var"}{" "}{"lastSystemPaddingBottom"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}- `Horizontal` - The bars are aligned in a [left-to-right](/docs/showcase/layouts#horizontal-layout) -
- `horizontal` -
- `1` - Horizontal -
- `Horizontal` -
- `Horizontal` -
{"layoutMode"}{":"}{" "}{"LayoutMode"}{" "}{"="}{" "}{"LayoutMode.Page"}{";"}{"LayoutMode"}{" "}{"LayoutMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"LayoutMode.Page"}{"var"}{" "}{"layoutMode"}{":"}{" "}{"LayoutMode"}{" "}{"="}{" "}{"LayoutMode.Page"}{"notationStaffPaddingBottom"}{":"}{" "}{"number"}{" "}{"="}{" "}{"5"}{";"}{"double"}{" "}{"NotationStaffPaddingBottom"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"5"}{"var"}{" "}{"notationStaffPaddingBottom"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"5"}{"notationStaffPaddingTop"}{":"}{" "}{"number"}{" "}{"="}{" "}{"5"}{";"}{"double"}{" "}{"NotationStaffPaddingTop"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"5"}{"var"}{" "}{"notationStaffPaddingTop"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"5"}{"padding"}{":"}{" "}{"number"}{"[]"}{" "}{"="}{" "}{"[35, 35]"}{";"}{"IList"}{"<"}{"double"}{">"}{" "}{"Padding"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"[35, 35]"}{"var"}{" "}{"padding"}{":"}{" "}{"alphaTab.collections.DoubleList"}{" "}{"="}{" "}{"[35, 35]"}-
-
-
| Resource | -Type | -Default | -Summary | -
|---|
` |
-| HTML | `data-resources-` | `
` |
| .net | `Display.Resources.` | `settings.Display.Resources.WordsFonts = ...` |
| Android | `display.resources.` | `settings.display.resources.wordsFonts = ...` |
-
-
-## Resources
-Following resources exist for adjusting the style.
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+import ManualDocs from './_resources.mdx';
+
+
-
- `1.0` - 100%
- `1.2` - 120%
- `0.8` - 80% -
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`1.0`
\ No newline at end of file
diff --git a/docs/reference/settings/display/staffpaddingleft.mdx b/docs/reference/settings/display/staffpaddingleft.mdx
index ccbc46a08..d7ce7d1ac 100644
--- a/docs/reference/settings/display/staffpaddingleft.mdx
+++ b/docs/reference/settings/display/staffpaddingleft.mdx
@@ -1,31 +1,37 @@
---
title: display.staffPaddingLeft
-description: The left padding applied between the left line and the first glyph in the following staff in a system.
+description: "The left padding applied between the left line and the first glyph in the following staff in a system."
sidebar_custom_props:
jsOnParent: true
category: Display
since: 1.4.0
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`2`
\ No newline at end of file
diff --git a/docs/reference/settings/display/startbar.mdx b/docs/reference/settings/display/startbar.mdx
index 73e90d3a2..e08579190 100644
--- a/docs/reference/settings/display/startbar.mdx
+++ b/docs/reference/settings/display/startbar.mdx
@@ -1,34 +1,40 @@
---
title: display.startBar
-description: The bar start index to start layouting with.
+description: "The bar start index to start layouting with."
sidebar_custom_props:
jsOnParent: true
category: Display
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`1`
\ No newline at end of file
diff --git a/docs/reference/settings/display/staveprofile.mdx b/docs/reference/settings/display/staveprofile.mdx
index 9848b4652..8172bde62 100644
--- a/docs/reference/settings/display/staveprofile.mdx
+++ b/docs/reference/settings/display/staveprofile.mdx
@@ -1,64 +1,38 @@
---
title: display.staveProfile
-description: The stave profile defining which staves are shown for the music sheet.
+description: "The stave profile defining which staves are shown for the music sheet."
sidebar_custom_props:
jsOnParent: true
category: Display
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
- `Default` - The profile is auto detected by the track configurations.
- `ScoreTab` - Standard music notation and guitar tablature are rendered.
- `Score` - Only standard music notation is rendered.
- `Tab` - Only guitar tablature is rendered.
- `TabMixed` - Only guitar tablature is rendered, but also rests and time signatures are not shown. This profile is typically used in multi-track scenarios.
-
-
- `default`
- `scoretab`
- `score`
- `tab`
- `tabmixed` -
-
- `0` - Default
- `1` - ScoreTab
- `2` - Score
- `3` - Tab
- `4` - TabMixed -
-
- `Default`
- `ScoreTab`
- `Score`
- `Tab`
- `TabMixed`
-
-
- `Default`
- `ScoreTab`
- `Score`
- `Tab`
- `TabMixed`
-
-
+### Description
+The stave profile defining which staves are shown for the music sheet. AlphaTab has various stave profiles that define which staves will be shown in for the rendered tracks. Its recommended
+to keep this on
+
+
+
+
+
+
+
+
+
+
-`Default`
diff --git a/docs/reference/settings/display/stretchforce.mdx b/docs/reference/settings/display/stretchforce.mdx
index ad2e7502f..6e88bf864 100644
--- a/docs/reference/settings/display/stretchforce.mdx
+++ b/docs/reference/settings/display/stretchforce.mdx
@@ -1,39 +1,42 @@
---
title: display.stretchForce
-description: The default stretch force to use for layouting.
+description: "The default stretch force to use for layouting."
sidebar_custom_props:
jsOnParent: true
category: Display
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
- `1.0`
- `1.5`
- `0.5`
-
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`1.0`
\ No newline at end of file
diff --git a/docs/reference/settings/display/systemlabelpaddingleft.mdx b/docs/reference/settings/display/systemlabelpaddingleft.mdx
index 8dd2d691d..2ef07cb4c 100644
--- a/docs/reference/settings/display/systemlabelpaddingleft.mdx
+++ b/docs/reference/settings/display/systemlabelpaddingleft.mdx
@@ -1,31 +1,37 @@
---
title: display.systemLabelPaddingLeft
-description: The padding left to the track name label of the system.
+description: "The padding left to the track name label of the system."
sidebar_custom_props:
jsOnParent: true
category: Display
since: 1.4.0
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-
-
+### Description
+The padding left to the track name label of the system.
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`0`
\ No newline at end of file
diff --git a/docs/reference/settings/display/systemlabelpaddingright.mdx b/docs/reference/settings/display/systemlabelpaddingright.mdx
index 5ebf3ae8a..980e0d07f 100644
--- a/docs/reference/settings/display/systemlabelpaddingright.mdx
+++ b/docs/reference/settings/display/systemlabelpaddingright.mdx
@@ -1,31 +1,37 @@
---
title: display.systemLabelPaddingRight
-description: The padding left to the track name label of the system.
+description: "The padding left to the track name label of the system."
sidebar_custom_props:
jsOnParent: true
category: Display
since: 1.4.0
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-
-
+### Description
+The padding left to the track name label of the system.
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`5`
\ No newline at end of file
diff --git a/docs/reference/settings/display/systempaddingbottom.mdx b/docs/reference/settings/display/systempaddingbottom.mdx
index bf4d5ace6..e7f09eea5 100644
--- a/docs/reference/settings/display/systempaddingbottom.mdx
+++ b/docs/reference/settings/display/systempaddingbottom.mdx
@@ -1,31 +1,37 @@
---
title: display.systemPaddingBottom
-description: The bottom padding applied to systems.
+description: "The bottom padding applied to systems beside the last one."
sidebar_custom_props:
jsOnParent: true
category: Display
since: 1.4.0
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-
-
+### Description
+The bottom padding applied to systems beside the last one.
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`20`
\ No newline at end of file
diff --git a/docs/reference/settings/display/systempaddingtop.mdx b/docs/reference/settings/display/systempaddingtop.mdx
index 69511730e..4e66e9783 100644
--- a/docs/reference/settings/display/systempaddingtop.mdx
+++ b/docs/reference/settings/display/systempaddingtop.mdx
@@ -1,31 +1,37 @@
---
title: display.systemPaddingTop
-description: The top padding applied to systems.
+description: "The top padding applied systems beside the first one."
sidebar_custom_props:
jsOnParent: true
category: Display
since: 1.4.0
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`10`
\ No newline at end of file
diff --git a/docs/reference/settings/display/systemslayoutmode.mdx b/docs/reference/settings/display/systemslayoutmode.mdx
index 83bfbae26..eb48e74a8 100644
--- a/docs/reference/settings/display/systemslayoutmode.mdx
+++ b/docs/reference/settings/display/systemslayoutmode.mdx
@@ -1,72 +1,45 @@
---
title: display.systemsLayoutMode
-description: The mode used to arrange staves and systems.
+description: "The mode used to arrange staves and systems."
sidebar_custom_props:
jsOnParent: true
category: Display
- since: 1.3.0-alpha.671
+ since: 1.3.0
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
- `Automatic`
- `UseModelLayout` -
-
- `automatic`
- `usemodellayout` -
-
- `0` - Automatic
- `1` - UseModelLayout -
-
- `Automatic`
- `UseModelLayout` -
-
- `Automatic`
- `UseModelLayout` -
-
-
-## Default Value
-
-`automatic`
-
## Supported File Formats:
-
-* Guitar Pro 6-8 1.3.0-alpha.671
-
-If you want/need support for more file formats to respect the sizing information feel free to [open a discussion](https://github.com/CoderLine/alphaTab/discussions/new?category=ideas) on GitHub.
+* Guitar Pro 6-8 
+
The page layout does not use `displayWidth`. The use of absolute widths would break the proper alignments needed for this kind of display.
-Also note that the sizing is including any glyphs and notation elements within the bar. e.g. if there are clefs in the bar, they are still "squeezed" into the available size.
+Also note that the sizing is including any glyphs and notation elements within the bar. e.g. if there are clefs in the bar, they are still "squeezed" into the available size.
It is not the case that the actual notes with their lengths are sized accordingly. This fits the sizing system of Guitar Pro and when files are customized there,
-alphaTab will match this layout quite close.
+alphaTab will match this layout quite close.
### Horizontal Layout
-The horizontal layout uses the `displayWidth` to scale the bars to size the bars exactly as specified. This kind of sizing and layout can be useful for usecases like:
+The horizontal layout uses the `displayWidth` to scale the bars to size the bars exactly as specified. This kind of sizing and layout can be useful for usecases like:
* Comparing files against each other (top/bottom comparison)
* Aligning the playback of multiple files on one screen assuming the same tempo (e.g. one file per track).
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/reference/settings/importer/beattextaslyrics.mdx b/docs/reference/settings/importer/beattextaslyrics.mdx
index 9833a6025..663329cc5 100644
--- a/docs/reference/settings/importer/beattextaslyrics.mdx
+++ b/docs/reference/settings/importer/beattextaslyrics.mdx
@@ -1,52 +1,57 @@
---
title: importer.beatTextAsLyrics
-description: Enables detecting lyrics from beat texts
+description: "Enables detecting lyrics from beat texts"
sidebar_custom_props:
category: Importer
since: 1.2.0
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
+
-## Default Value
-`false`
+**Disabled**
-## Example
+
-**Enabled**
-
+
+
+
+
+
+
+
+
+
+
+
-**Disabled**
- 
\ No newline at end of file
diff --git a/docs/reference/settings/importer/encoding.mdx b/docs/reference/settings/importer/encoding.mdx
index 4818e7aee..d70e04f01 100644
--- a/docs/reference/settings/importer/encoding.mdx
+++ b/docs/reference/settings/importer/encoding.mdx
@@ -1,20 +1,26 @@
---
title: importer.encoding
-description: The text encoding to use when decoding strings.
+description: "The text encoding to use when decoding strings."
sidebar_custom_props:
category: Importer
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
- `utf-8`
- `Windows-1252` -
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`utf-8`
\ No newline at end of file
diff --git a/docs/reference/settings/importer/mergepartgroupsinmusicxml.mdx b/docs/reference/settings/importer/mergepartgroupsinmusicxml.mdx
index 5e4f054bf..8940b0fe9 100644
--- a/docs/reference/settings/importer/mergepartgroupsinmusicxml.mdx
+++ b/docs/reference/settings/importer/mergepartgroupsinmusicxml.mdx
@@ -1,28 +1,36 @@
---
title: importer.mergePartGroupsInMusicXml
-description: If part-groups should be merged into a single track (MusicXML).
+description: "If part-groups should be merged into a single track (MusicXML)."
sidebar_custom_props:
category: Importer
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-## Default Value
-`false`
\ No newline at end of file
diff --git a/docs/reference/settings/notation/displaytranspositionpitches.mdx b/docs/reference/settings/notation/displaytranspositionpitches.mdx
index 1a1cec00e..f435c112f 100644
--- a/docs/reference/settings/notation/displaytranspositionpitches.mdx
+++ b/docs/reference/settings/notation/displaytranspositionpitches.mdx
@@ -1,36 +1,43 @@
---
title: notation.displayTranspositionPitches
-description: The transposition pitch offsets for the individual tracks used for rendering only.
+description: "The transposition pitch offsets for the individual tracks used for rendering only."
sidebar_custom_props:
category: Notation
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`(empty)`
\ No newline at end of file
diff --git a/docs/reference/settings/notation/elements.mdx b/docs/reference/settings/notation/elements.mdx
index cb99791b1..eb4c5bcfb 100644
--- a/docs/reference/settings/notation/elements.mdx
+++ b/docs/reference/settings/notation/elements.mdx
@@ -1,276 +1,59 @@
---
title: notation.elements
-description: Render the song information or not.
+description: "Whether music notation elements are visible or not."
sidebar_custom_props:
category: Notation
since: 0.9.8
---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
+import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable';
+import CodeBlock from '@theme/CodeBlock';
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import { CodeBadge } from '@site/src/components/CodeBadge';
import { SinceBadge } from '@site/src/components/SinceBadge';
+import DynHeading from '@site/src/components/DynHeading';
+import Link from '@docusaurus/Link';
-
-
-
+
+
+
+
+
+
+
+
+
+
+
## Examples
-
-
-Internally the setting is a [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) where the key must be a `alphaTab.NotationElement` enumeration value.
-For JSON input the usual enumeration serialization applies where also the names can be used. The names
-are case insensitive.
+ defaultValue="javascript"
+ values={[
+ { label: "JavaScript", value: "javascript"},
+ { label: "C#", value: "csharp"},
+ { label: "Android", value: "android"}
+ ]}
+>
+
+Internally the setting is a [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) where the key must be a
-
-
-For data attributes currently a full object must be embedded in the attribute value.
-
-```js
-
-```
-
-
-
-
+
```cs
var settings = new AlphaTab.Settings();
settings.Notation.Elements[AlphaTab.NotationElement.ScoreTitle] = false;
settings.Notation.Elements[AlphaTab.NotationElement.TrackNames] = false;
```
-
-
\ No newline at end of file
+
+```kotlin
+val settings = AlphaTab.Settings();
+settings.notation.elements[alphaTab.NotationElement.ScoreTitle] = false;
+settings.notation.elements[alphaTab.NotationElement.TrackNames] = false;
+```
+
+
diff --git a/docs/reference/settings/notation/extendbendarrowsontiednotes.mdx b/docs/reference/settings/notation/extendbendarrowsontiednotes.mdx
index b44f150bf..464a14a73 100644
--- a/docs/reference/settings/notation/extendbendarrowsontiednotes.mdx
+++ b/docs/reference/settings/notation/extendbendarrowsontiednotes.mdx
@@ -1,34 +1,40 @@
---
title: notation.extendBendArrowsOnTiedNotes
-description: If set to true bend arrows expand to the end of the last tied note of the string. Otherwise they end on the next beat.
+description: "If set to true bend arrows expand to the end of the last tied note of the string. Otherwise they end on the next beat."
sidebar_custom_props:
category: Notation
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`true`
\ No newline at end of file
diff --git a/docs/reference/settings/notation/extendlineeffectstobeatend.mdx b/docs/reference/settings/notation/extendlineeffectstobeatend.mdx
index 76d13eb23..6e7c844c2 100644
--- a/docs/reference/settings/notation/extendlineeffectstobeatend.mdx
+++ b/docs/reference/settings/notation/extendlineeffectstobeatend.mdx
@@ -1,33 +1,40 @@
---
title: notation.extendLineEffectsToBeatEnd
-description: If set to true, line effects like w/bar and let-ring are drawn until the end of the beat instead of the start
+description: "If set to true, line effects like w/bar and let-ring are drawn until the end of the beat instead of the start"
sidebar_custom_props:
category: Notation
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-## Default Value
-`false`
\ No newline at end of file
diff --git a/docs/reference/settings/notation/fingeringmode.mdx b/docs/reference/settings/notation/fingeringmode.mdx
index 63534c6f2..97dbdc974 100644
--- a/docs/reference/settings/notation/fingeringmode.mdx
+++ b/docs/reference/settings/notation/fingeringmode.mdx
@@ -1,53 +1,41 @@
---
title: notation.fingeringMode
-description: The fingering mode to use.
+description: "The fingering mode to use."
sidebar_custom_props:
category: Notation
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
- `Score`
- `SingleNoteEffectBand` -
-
- `score`
- `effectband` -
-
- `0` - Score
- `1` - SingleNoteEffectBand -
-
- `Score`
- `SingleNoteEffectBand` -
-
- `Score`
- `SingleNoteEffectBand` -
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`Score`
\ No newline at end of file
diff --git a/docs/reference/settings/notation/notationmode.mdx b/docs/reference/settings/notation/notationmode.mdx
index 1057e5de5..8d53bfe55 100644
--- a/docs/reference/settings/notation/notationmode.mdx
+++ b/docs/reference/settings/notation/notationmode.mdx
@@ -1,37 +1,43 @@
---
title: notation.notationMode
-description: The mode to use for display and play music notation elements.
+description: "The mode to use for display and play music notation elements."
sidebar_custom_props:
category: Notation
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
- `SongBook`
- `GuitarPro` -
-
- `SongBook`
- `GuitarPro` -
-
- `0` - SongBook
- `1` - GuitarPro -
-
- `SongBook`
- `GuitarPro` -
-
- `SongBook`
- `GuitarPro` -
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`GuitarPro`
\ No newline at end of file
diff --git a/docs/reference/settings/notation/rhythmheight.mdx b/docs/reference/settings/notation/rhythmheight.mdx
index 47b3ccb0f..8bfae5076 100644
--- a/docs/reference/settings/notation/rhythmheight.mdx
+++ b/docs/reference/settings/notation/rhythmheight.mdx
@@ -1,29 +1,36 @@
---
title: notation.rhythmHeight
-description: Controls how high the ryhthm notation is rendered below the tab staff
+description: "Controls how high the ryhthm notation is rendered below the tab staff"
sidebar_custom_props:
category: Notation
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
+### Description
+Controls how high the ryhthm notation is rendered below the tab staff This setting can be used in combination with the
+
+
+
+
+
+
+
+
+
+
-`15`
\ No newline at end of file
diff --git a/docs/reference/settings/notation/rhythmmode.mdx b/docs/reference/settings/notation/rhythmmode.mdx
index e014db4fd..0107c5454 100644
--- a/docs/reference/settings/notation/rhythmmode.mdx
+++ b/docs/reference/settings/notation/rhythmmode.mdx
@@ -1,53 +1,37 @@
---
title: notation.rhythmMode
-description: Controls how the rhythm notation is rendered for tab staves.
+description: "Controls how the rhythm notation is rendered for tab staves."
sidebar_custom_props:
category: Notation
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
- `Hidden` - No rhythm notation is shown
- `ShowWithBeams` - Rhythm notation is rendered with all beats having individual beams
- `ShowWithBars` - Rhythm notation is rendered with normal bars like on standard notation -
-
- `hidden`
- `showwithbeams`
- `showwithbars` -
-
- `0` - Hidden
- `1` - ShowWithBeams
- `2` - ShowWithBars -
-
- `Hidden`
- `ShowWithBeams`
- `ShowWithBars` -
-
- `Hidden`
- `ShowWithBeams`
- `ShowWithBars` -
-
+### Description
+Controls how the rhythm notation is rendered for tab staves. This setting enables the display of rhythm notation on tab staffs. [Demo](/docs/showcase/guitar-tabs)
+
+
+
+
+
+
+
+
+
+
+
-`hidden`
\ No newline at end of file
diff --git a/docs/reference/settings/notation/slurheight.mdx b/docs/reference/settings/notation/slurheight.mdx
index 52807f9f9..5226637dd 100644
--- a/docs/reference/settings/notation/slurheight.mdx
+++ b/docs/reference/settings/notation/slurheight.mdx
@@ -1,37 +1,40 @@
---
title: notation.slurHeight
-description: The height scale factor for slurs
+description: "The height scale factor for slurs"
sidebar_custom_props:
category: Notation
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
- `7`
- `14`
- `3.5` -
-
+
+
+
+
+
+
+
+
+
+
+
-## Default Value
-`7`
\ No newline at end of file
diff --git a/docs/reference/settings/notation/smallgracetabnotes.mdx b/docs/reference/settings/notation/smallgracetabnotes.mdx
index e80415c1f..f04bba007 100644
--- a/docs/reference/settings/notation/smallgracetabnotes.mdx
+++ b/docs/reference/settings/notation/smallgracetabnotes.mdx
@@ -1,33 +1,39 @@
---
title: notation.smallGraceTabNotes
-description: If set to true the guitar tabs on grace beats are rendered smaller.
+description: "If set to true the guitar tabs on grace beats are rendered smaller."
sidebar_custom_props:
category: Notation
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`true`
\ No newline at end of file
diff --git a/docs/reference/settings/notation/transpositionpitches.mdx b/docs/reference/settings/notation/transpositionpitches.mdx
index 4d497f70f..08042b335 100644
--- a/docs/reference/settings/notation/transpositionpitches.mdx
+++ b/docs/reference/settings/notation/transpositionpitches.mdx
@@ -1,30 +1,37 @@
---
title: notation.transpositionPitches
-description: The transposition pitch offsets for the individual tracks used for rendering and playback.
+description: "The transposition pitch offsets for the individual tracks used for rendering and playback."
sidebar_custom_props:
category: Notation
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
+### Description
+The transposition pitch offsets for the individual tracks used for rendering and playback. This setting allows transposing of tracks for display and playback.
+The `transpositionPitches` setting allows defining an additional pitch offset per track, that is then considered when displaying the music sheet.
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`(empty)`
\ No newline at end of file
diff --git a/docs/reference/settings/player/_slide.mdx b/docs/reference/settings/player/_slide.mdx
new file mode 100644
index 000000000..ce77005f7
--- /dev/null
+++ b/docs/reference/settings/player/_slide.mdx
@@ -0,0 +1,5 @@
+## Slide Settings
+
+import SlideDocs from '@site/docs/reference/types/slideplaybacksettings/index.mdx'
+
+
-
- `5000`
- `1000` -
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`500`
\ No newline at end of file
diff --git a/docs/reference/settings/player/enableanimatedbeatcursor.mdx b/docs/reference/settings/player/enableanimatedbeatcursor.mdx
index e9d9adc44..e078a2293 100644
--- a/docs/reference/settings/player/enableanimatedbeatcursor.mdx
+++ b/docs/reference/settings/player/enableanimatedbeatcursor.mdx
@@ -1,30 +1,37 @@
---
title: player.enableAnimatedBeatCursor
-description: Whether the beat cursor should be animated or just ticking.
+description: "Whether the beat cursor should be animated or just ticking."
sidebar_custom_props:
category: Player
since: 1.2.3
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`true`
\ No newline at end of file
diff --git a/docs/reference/settings/player/enablecursor.mdx b/docs/reference/settings/player/enablecursor.mdx
index 5a797a320..a9082146c 100644
--- a/docs/reference/settings/player/enablecursor.mdx
+++ b/docs/reference/settings/player/enablecursor.mdx
@@ -1,29 +1,36 @@
---
title: player.enableCursor
-description: Whether playback cursors should be displayed.
+description: "Whether playback cursors should be displayed."
sidebar_custom_props:
category: Player
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
+### Description
+Whether playback cursors should be displayed. This setting configures whether the playback cursors are shown or not. In case a developer decides to built an own cursor system the default one can be disabled with this setting. Enabling the cursor also requires the player to be active.
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`true`
\ No newline at end of file
diff --git a/docs/reference/settings/player/enableelementhighlighting.mdx b/docs/reference/settings/player/enableelementhighlighting.mdx
index 8450cf009..295f0f49a 100644
--- a/docs/reference/settings/player/enableelementhighlighting.mdx
+++ b/docs/reference/settings/player/enableelementhighlighting.mdx
@@ -1,30 +1,37 @@
---
title: player.enableElementHighlighting
-description: Whether the notation elements of the currently played beat should be highlighted.
+description: "Whether the notation elements of the currently played beat should be highlighted."
sidebar_custom_props:
category: Player
since: 1.2.3
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`true`
\ No newline at end of file
diff --git a/docs/reference/settings/player/enableplayer.mdx b/docs/reference/settings/player/enableplayer.mdx
index 2bcfc35e5..07430d7ba 100644
--- a/docs/reference/settings/player/enableplayer.mdx
+++ b/docs/reference/settings/player/enableplayer.mdx
@@ -1,33 +1,40 @@
---
title: player.enablePlayer
-description: Whether the player should be enabled.
+description: "Whether the player should be enabled."
sidebar_custom_props:
category: Player
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`false`
\ No newline at end of file
diff --git a/docs/reference/settings/player/enableuserinteraction.mdx b/docs/reference/settings/player/enableuserinteraction.mdx
index 988ed6788..062739398 100644
--- a/docs/reference/settings/player/enableuserinteraction.mdx
+++ b/docs/reference/settings/player/enableuserinteraction.mdx
@@ -1,31 +1,37 @@
---
title: player.enableUserInteraction
-description: Whether the default user interaction behavior should be active or not.
+description: "Whether the default user interaction behavior should be active or not."
sidebar_custom_props:
category: Player
since: 0.9.7
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
+### Description
+Whether the default user interaction behavior should be active or not. This setting configures whether alphaTab provides the default user interaction features like selection of the playback range and "seek on click".
+By default users can select the desired playback range with the mouse and also jump to individual beats by click. This behavior can be contolled with this setting.
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`true`
\ No newline at end of file
diff --git a/docs/reference/settings/player/nativebrowsersmoothscroll.mdx b/docs/reference/settings/player/nativebrowsersmoothscroll.mdx
index ec561658c..562f7fc66 100644
--- a/docs/reference/settings/player/nativebrowsersmoothscroll.mdx
+++ b/docs/reference/settings/player/nativebrowsersmoothscroll.mdx
@@ -1,32 +1,29 @@
---
title: player.nativeBrowserSmoothScroll
-description: Whether the native browser smooth scroll mechanism should be used over a custom animation.
+description: "Whether the native browser smooth scroll mechanism should be used over a custom animation."
sidebar_custom_props:
javaScriptOnly: true
category: Player
since: 1.2.3
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
+If this setting is enabled, options like
-`true`
\ No newline at end of file
diff --git a/docs/reference/settings/player/outputmode.mdx b/docs/reference/settings/player/outputmode.mdx
index cef38819b..3f7136c84 100644
--- a/docs/reference/settings/player/outputmode.mdx
+++ b/docs/reference/settings/player/outputmode.mdx
@@ -1,41 +1,27 @@
---
title: player.outputMode
-description: The mode used for playing audio samples
+description: "The mode used for playing audio samples"
sidebar_custom_props:
javaScriptOnly: true
category: Player - JavaScript Specific
since: 1.3.0
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
- `WebAudioAudioWorklets` - If [audio worklets](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Using_AudioWorklet) are available, they are used. If not fallback to the ScriptProcessorNode
- `WebAudioScriptProcessor` - Using the [ScriptProcessorNode](https://developer.mozilla.org/en-US/docs/Web/API/ScriptProcessorNode) for playback
-
-
- `webaudioaudioworklets`
- `webaudioscriptprocessor` -
-
- `0` - WebAudioAudioWorklets
- `1` - WebAudioScriptProcessor
-
-
+### Description
+The mode used for playing audio samples Controls how alphaTab will play the audio samples in the browser.
-## Default Value
+
-`WebAudioAudioWorklets`
\ No newline at end of file
diff --git a/docs/reference/settings/player/playtripletfeel.mdx b/docs/reference/settings/player/playtripletfeel.mdx
index 919056f14..9d256f2aa 100644
--- a/docs/reference/settings/player/playtripletfeel.mdx
+++ b/docs/reference/settings/player/playtripletfeel.mdx
@@ -1,29 +1,36 @@
---
title: player.playTripletFeel
-description: Whether the triplet feel should be played or only displayed.
+description: "Whether the triplet feel should be played or only displayed."
sidebar_custom_props:
category: Player
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
+### Description
+Whether the triplet feel should be played or only displayed. If this setting is enabled alphaTab will play the triplet feels accordingly, if it is disabled the triplet feel is only displayed but not played.
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`true`
\ No newline at end of file
diff --git a/docs/reference/settings/player/scrollelement.mdx b/docs/reference/settings/player/scrollelement.mdx
index 7eed4c6fe..b8d6918b4 100644
--- a/docs/reference/settings/player/scrollelement.mdx
+++ b/docs/reference/settings/player/scrollelement.mdx
@@ -1,35 +1,29 @@
---
title: player.scrollElement
-description: The element to apply the scrolling on.
+description: "The element to apply the scrolling on."
sidebar_custom_props:
javaScriptOnly: true
category: Player - JavaScript Specific
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
- A selector for `document.querySelector`
-
-
+selector.
-## Default Value
+
-`html,body`
\ No newline at end of file
diff --git a/docs/reference/settings/player/scrollmode.mdx b/docs/reference/settings/player/scrollmode.mdx
index c568cd6de..be6984568 100644
--- a/docs/reference/settings/player/scrollmode.mdx
+++ b/docs/reference/settings/player/scrollmode.mdx
@@ -1,54 +1,36 @@
---
title: player.scrollMode
-description: The mode how to scroll.
+description: "The mode how to scroll."
sidebar_custom_props:
category: Player
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
- `Off` - No automatic scrolling is done
- `Continuous` - Scrolling happens as soon the offsets of the cursors change
- `OffScreen` - Scrolling happens as soon the cursors exceed the displayed range -
-
- `off`
- `continuous`
- `offscreen` -
-
- `0` - Off
- `1` - Continuous
- `2` - OffScreen -
-
- `Off`
- `Continuous`
- `OffScreen` -
-
- `Off`
- `Continuous`
- `OffScreen` -
+
+### Description
+The mode how to scroll. This setting controls how alphaTab behaves for scrolling.
-## Default Value
+
+
+
+
+
+
+
+
+
+
+
-`Continuous`
\ No newline at end of file
diff --git a/docs/reference/settings/player/scrolloffsetx.mdx b/docs/reference/settings/player/scrolloffsetx.mdx
index 1969415a2..7d68f617e 100644
--- a/docs/reference/settings/player/scrolloffsetx.mdx
+++ b/docs/reference/settings/player/scrolloffsetx.mdx
@@ -1,34 +1,38 @@
---
-title: player.playerOffsetX
-description: The X-offset to add when scrolling.
+title: player.scrollOffsetX
+description: "The X-offset to add when scrolling."
sidebar_custom_props:
category: Player
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
- `-10`
- `20` -
-
-
-## Default Value
+import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable';
+import CodeBlock from '@theme/CodeBlock';
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import { CodeBadge } from '@site/src/components/CodeBadge';
+import { SinceBadge } from '@site/src/components/SinceBadge';
+import DynHeading from '@site/src/components/DynHeading';
+import Link from '@docusaurus/Link';
+
+import { SettingsHeader } from '@site/src/components/SettingsHeader';
+
+
+
+
+
+
+
+
+
+
+
+
-`0`
\ No newline at end of file
diff --git a/docs/reference/settings/player/scrolloffsety.mdx b/docs/reference/settings/player/scrolloffsety.mdx
index 15daa2014..8147d1ed3 100644
--- a/docs/reference/settings/player/scrolloffsety.mdx
+++ b/docs/reference/settings/player/scrolloffsety.mdx
@@ -1,34 +1,38 @@
---
title: player.scrollOffsetY
-description: The Y-offset to add when scrolling.
+description: "The Y-offset to add when scrolling."
sidebar_custom_props:
category: Player
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
- `-10`
- `20` -
-
-
-## Default Value
+import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable';
+import CodeBlock from '@theme/CodeBlock';
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import { CodeBadge } from '@site/src/components/CodeBadge';
+import { SinceBadge } from '@site/src/components/SinceBadge';
+import DynHeading from '@site/src/components/DynHeading';
+import Link from '@docusaurus/Link';
+
+import { SettingsHeader } from '@site/src/components/SettingsHeader';
+
+
+
+
+
+
+
+
+
+
+
+
-`0`
\ No newline at end of file
diff --git a/docs/reference/settings/player/scrollspeed.mdx b/docs/reference/settings/player/scrollspeed.mdx
index a9236dd75..45d1bfa7f 100644
--- a/docs/reference/settings/player/scrollspeed.mdx
+++ b/docs/reference/settings/player/scrollspeed.mdx
@@ -1,34 +1,38 @@
---
title: player.scrollSpeed
-description: How fast the scrolling to the new position should happen.
+description: "How fast the scrolling to the new position should happen."
sidebar_custom_props:
category: Player
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
- `200`
- `300`
- `100` -
-
+Note that
+
+
+
+
+
+
+
+
+
+
-## Default Value
-`300`
\ No newline at end of file
diff --git a/docs/reference/settings/player/slide.mdx b/docs/reference/settings/player/slide.mdx
index 508709f57..c4a5a2882 100644
--- a/docs/reference/settings/player/slide.mdx
+++ b/docs/reference/settings/player/slide.mdx
@@ -1,93 +1,27 @@
---
title: player.slide
-description: The slide settings allow control how the different slide types are generated for audio.
+description: "The slide settings allow control how the different slide types are generated for audio."
sidebar_custom_props:
- domWildCard: true
+ domWildcard: true
category: Player
- since: 0.9.9
+ since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-
-
-
-
-
-
- {setting.defaultValue}
-
- {setting.description}
-
-
- );
-}
-
-export function SlideTable() {
- const settings = SlideSettings.map(c =>
-
-
- );
-}
-
+import { SettingsHeader } from '@site/src/components/SettingsHeader';
-## Description
+
+
+
+
+
+
+
+
+
+
+
+
-## Slide Settings
+import ManualDocs from './_slide.mdx';
-
-
- `75`
- `120`
- `250` -
-
-
-## Default Value
+import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable';
+import CodeBlock from '@theme/CodeBlock';
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import { CodeBadge } from '@site/src/components/CodeBadge';
+import { SinceBadge } from '@site/src/components/SinceBadge';
+import DynHeading from '@site/src/components/DynHeading';
+import Link from '@docusaurus/Link';
+
+import { SettingsHeader } from '@site/src/components/SettingsHeader';
+
+
+
+
+
+
+
+
+
+
+
+
-`75`
\ No newline at end of file
diff --git a/docs/reference/settings/player/songbookdipduration.mdx b/docs/reference/settings/player/songbookdipduration.mdx
index 0e63d1a92..28dfb2fac 100644
--- a/docs/reference/settings/player/songbookdipduration.mdx
+++ b/docs/reference/settings/player/songbookdipduration.mdx
@@ -1,35 +1,38 @@
---
title: player.songBookDipDuration
-description: The duration of whammy dips in milliseconds for songbook whammys.
+description: "The duration of whammy dips in milliseconds for songbook whammys."
sidebar_custom_props:
category: Player
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
- `75`
- `120`
- `250` -
-
-
-## Default Value
+import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable';
+import CodeBlock from '@theme/CodeBlock';
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import { CodeBadge } from '@site/src/components/CodeBadge';
+import { SinceBadge } from '@site/src/components/SinceBadge';
+import DynHeading from '@site/src/components/DynHeading';
+import Link from '@docusaurus/Link';
+
+import { SettingsHeader } from '@site/src/components/SettingsHeader';
+
+
+
+
+
+
+
+
+
+
+
+
-`150`
\ No newline at end of file
diff --git a/docs/reference/settings/player/soundfont.mdx b/docs/reference/settings/player/soundfont.mdx
index 908dcef6c..f9f6d0d27 100644
--- a/docs/reference/settings/player/soundfont.mdx
+++ b/docs/reference/settings/player/soundfont.mdx
@@ -1,30 +1,27 @@
---
title: player.soundFont
-description: The sound font file to load for the player.
+description: "The sound font file to load for the player."
sidebar_custom_props:
javaScriptOnly: true
category: Player - JavaScript Specific
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
+### Description
+The sound font file to load for the player. When the player is enabled the soundfont from this URL will be loaded automatically after the player is ready.
-## Default Value
+
-`null`
\ No newline at end of file
diff --git a/docs/reference/settings/player/vibrato.mdx b/docs/reference/settings/player/vibrato.mdx
index e974b4df4..58fdb1f6a 100644
--- a/docs/reference/settings/player/vibrato.mdx
+++ b/docs/reference/settings/player/vibrato.mdx
@@ -1,118 +1,47 @@
---
title: player.vibrato
-description: The Vibrato settings allow control how the different vibrato types are generated for audio.
+description: "The Vibrato settings allow control how the different vibrato types are generated for audio."
sidebar_custom_props:
- domWildCard: true
category: Player
since: 0.9.6
---
-import { SinceBadge } from '@site/src/components/SinceBadge';
-
-
-
-
-
-
-
-
-
-
- {setting.defaultValue}
-
- {setting.description}
-
-
- );
-}
-
-export function VibratoTable() {
- const settings = VibratoSettings.map(c =>
-
-
- );
-}
-
+import { SettingsHeader } from '@site/src/components/SettingsHeader';
-## Description
+
+
+
+
+
+
+
+
+
+
+
+
+
+import ManualDocs from './_vibrato.mdx';
-{`
+\\multiBarRest
+.
+\\track "Piano 1" "pno1"
+ \\staff {score}
+ C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | C4
+
+\\track "Piano 2" "pno1"
+ \\staff {score}
+ C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | r |
+`}
+
+#### rendering: Coloring of individual notation elements
+https://github.com/CoderLine/alphaTab/pull/1936
+
+With this release we added a long requested feature to allow styling of individual notation elements.
+There is quite a list of individual items which might want to be colored and defining the colors accordingly
+can be tricky. If done wrong it can have a significant impact to rendering performance.
+
+We think we solved this challenge and now you can color individual items of beats, bars etc. as you prefer.
+
+This feature is useful when you want to color elements in lessons to give hints to the player what to pay attention to.
+
+[Learn more about this feature here](/docs/guides/coloring)
+
+import { ColoringExample } from '@site/src/components/ColoringExample';
+
+{`
+\\instrument piano
+.
+\\track "Overlapping"
+ \\staff
+ \\barlineleft dashed
+ \\barlineright dotted
+ |
+ \\barlineleft heavyheavy
+ \\barlineright heavyheavy
+
+ \\staff
+ \\barlineleft lightlight
+ \\barlineright lightheavy
+ |
+ \\barlineleft heavylight
+ \\barlineright dashed
+\\track "All Styles"
+ \\staff
+ \\barlineright dashed |
+ \\barlineright dotted |
+ \\barlineright heavy |
+ \\barlineright heavyHeavy |
+ \\barlineright heavyLight |
+ \\barlineright lightHeavy |
+ \\barlineright lightlight |
+ \\barlineright none |
+ \\barlineright regular |
+ \\barlineright short |
+ \\barlineright tick |
+`}
+
+#### rendering: More Dynamic Values
+https://github.com/CoderLine/alphaTab/pull/2030
+
+This feature was added as part of extending the MusicXML support but also has landed for alphaTex.
+It extends the range of dynamic values to the full predefined range defined by [MusicXML](https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/dynamics/)
+
+{`
+\\instrument piano
+.
+C4 {dy ffffff} C4 {dy mp}
+`}
+
+
+#### rendering: Different key signatures across staves
+https://github.com/CoderLine/alphaTab/pull/2034
+
+Up to this release alphaTab had the same restriction as Guitar Pro that key signatures had to be the same across all tracks and staves.
+In this release we allow now different key signatures on every staff and track.
+
+{`
+\\track T1
+ \\staff
+ \\ks D
+ C4 D4 E4 F4
+ \\staff
+ \\clef F4
+ \\ks E
+ C3 D3 E3 F3
+\\track T2
+ \\staff
+ \\ks C
+ C4 D4 E4 F4
+`}
+
+#### rendering: Use alphaSkia 3.x.135
+https://github.com/CoderLine/alphaTab/pull/2052
+
+We integrated alphaSkia 3.x.135 in alphaTab which brings a variety of improvements for C# and Kotlin rendering.
+
+Highlights:
+
+* Underneath is upgrades Skia m120 to m135.
+* alphaSkia can now use font fallbacks on texts allowing to render special unicode fonts and emojis if fonts are registered and specified accordingly.
+* alphaSkia can now measure texts precisely (including the height) allowing more concise music sheets without overlaps on texts.
+
+
+
+### Player
+
+### player: Allow Changing of output device
+https://github.com/CoderLine/alphaTab/pull/1924
+
+alphaTab exposes now an API to get a list of available output devices for playback and changing the used device.
+If required by the platform the required permissions are requested.
+
+* On browsers it depends on a currently experimental API with only limited support. https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/setSinkId#browser_compatibility
+* On C# (Windows) it will load all system output devices via NAudio.
+* On Android it will request permissions and load all audio sinks.
+
+New APIs:
+
+* [`enumerateOutputDevices`](/docs/reference/api/enumerateoutputdevices/)
+* [`setOutputDevice`](/docs/reference/api/enumerateoutputdevices/)
+* [`getOutputDevice`](/docs/reference/api/enumerateoutputdevices/)
+
+### alphaTex Extensions
+
+### alphatex: Score Info - Formatting templates
+https://github.com/CoderLine/alphaTab/pull/2002
+
+Text templates and alignments for song info can be specified via alphaTex.
+
+See [AlphaTex Metadata](/docs/alphatex/metadata).
+
+### alphatex: Bar Line customizations
+https://github.com/CoderLine/alphaTab/pull/2031
+
+The new barlines styles can also be activated via alphaTex.
+
+See [AlphaTex Bar Metadata](/docs/alphatex/bar-metadata#bar-lines).
+
+### alphatex: More Dynamic Values
+https://github.com/CoderLine/alphaTab/pull/2030
+
+The list of possible dynamic values (as defined by MusicXML) can also be specified in alphaTex.
+
+See [AlphaTex Beat Effects](/docs/alphatex/beat-effects#dynamics).
+
+### alphatex: Different key signatures across staves
+https://github.com/CoderLine/alphaTab/pull/2034
+
+The possiblity to define key signatures per staff / track is also available in alphaTex.
+
+The `\ks` bar meta now only impacts the current bar not all.
+
+### MusicXML Extensions
+
+### musicxml: Reimplemented Base Parser
+https://github.com/CoderLine/alphaTab/pull/1977
+
+This is one of the highlight features in this release. We reimplemented the whole base parser of MusicXML files ensuring
+we are following the specification accordingly. This rewrite brings improvements like:
+
+* We now support partwise and timewise files
+* We respect aspects like `backup` and `forward` when writing multi staff and multi voice files.
+* We ensure `measure` tags result in the expected order across parts.
+* We try to detect and fill the song information from a variety of tags (e.g. `credit` and `identification`)
+* We try to respect instrument details like midi programs, channels etc. closer.
+
+See [Music XML Compatibility](/docs/formats/musicxml) for more details on what we support.
+
+### musicxml: Read supported notation elements
+https://github.com/CoderLine/alphaTab/pull/1994
+
+On top of the new parser we aimed to increase the support of the music notation contained in MusicXML.
+If alphaTab supports a certain music notation, we now fill it from MusicXML accordingly.
+MusicXML supports a lot more than alphaTab does, so there is still a lot to do to have full support of the format. We hope to gradually extend alphaTab itself to support more music notation to eventually fill it from formats like MusicXML but also alphaTex.
+
+We still primarily focus on loading the **semantic** music notation information from MusicXML but have only sparse support for adjusting only visual or sound aspects.
+e.g. we do not support yet aspects where elements are visually shifted in the layout or sizes are customized.
+
+See [Music XML Compatibility](/docs/formats/musicxml) for more details on what we support.
+
+### musicxml: Percussion Support
+https://github.com/CoderLine/alphaTab/pull/2009
+
+Percussion in MusicXML needs special considerations in the data model and reading of the information. MusicXML uses the `unpitched` element in combination with `notehead` to define how
+the notes are visually represented on the staff. Additionally the played midi key is separately defined (e.g. as `instrument`).
+
+We now use the information contained MusicXML files to show and play drums correctly. With this we added some general features to alphaTab which we plan to also bring for other formats:
+
+* Separation of displayed note from played note information.
+* Customization of Note Heads
+
+### Improvements & Bugfixes
+
+#### player: Broken Cursor Display for repeats
+https://github.com/CoderLine/alphaTab/pull/1934
+
+On repeats the bar cursor could behave rather strange moving back to the repeat start instead of transitioning to the end of the bar to the repeat end sign.
+With this fix the beat cursor should correctly move again in such scenarios.
+
+#### player: Wrong beat cursor placement when scaling score
+https://github.com/CoderLine/alphaTab/pull/1934
+
+When drawing scores at non 100%, the beat cursor was placed wrongly.
+
+#### tooling: Version and Environment Info
+https://github.com/CoderLine/alphaTab/pull/2015
+
+alphaTab has now a special API to print detailed information about the environment. With the new `alphaTab.Environment.printEnvironmentInfo()` all important details about the used version, browser, operating system etc. is printed to the console.
+And the info is printed always if the log level is increased to `debug`.
+
+This should make it easier to provide the correct information about the platform when reporting bugs or asking questions.
+
+#### rendering: Wrong staff ID for numbered bar renderer
+https://github.com/CoderLine/alphaTab/pull/2057
+
+Internally the bar renderer for numbered notations was registered wrongly. In some scenarios this could lead to wrong placement of music notation (like ties).
+
+#### export: Wrong instrument articulations in Guitar Pro exported from alphaTex
+https://github.com/CoderLine/alphaTab/pull/2058
+
+With the addition of percussion tabs in v1.4 we didn't consider correctly the export into Guitar Pro files.
+We wrote wrong information about the instrument articulations defining details like the used note head, note placement and played midi key.
+
+This was fixed and exported files now show correct percussion tabs in Guitar Pro.
+Unfortunately Guitar Pro is very sensitive to the used names for articulations and will not display the elements in the "Drumkit view".
+They already do not show all items of their own drumkit in the rendered staff.
+
+### Infrastructure
+
+#### docs: Move reference documentation into code
+https://github.com/CoderLine/alphaTab/pull/1960
+
+We hope with this change keeping the reference docs up-to-date is a lot easier. Previously we were writing the docs for all APIs, settings and data model manually.
+This had two problems:
+
+* The code documentation in the IDE was lacking information.
+* The website documentation was potentially out-of-date or incomplete.
+
+With this item we moved all markdown docs into the code. At the same time we now generate the reference documentation from the compile output (TSDoc).
+
+This has now following benefits and improvements to our docs:
+
+* All API properties and settings are guaranteed to be listed in the docs.
+* We can now generate docs for all our classes, enums and interfaces we have, and we can cross reference to them in our docs.
+
+Even if we have not advanced examples or full descriptions for the whole codebase, it helps checking what is be available.
+We have plans to generally improve marking what docs are considered public (stable), low-level (stable but use at own risk), experimental (subject to change) or internal (not meant to be used by the public).
+
+#### tooling: Use Vite as bundler
+https://github.com/CoderLine/alphaTab/pull/1931
+
+We replaced Rollup with Vite as our bundler to build alphaTab. This brings us some benefits during development with the use of the Vite Dev Server allowing faster development (e.g. hot-reload and more incremental compilation).
+It makes our general builds a bit smaller due to some limitations in Vite but its worth the benefit when working on alphaTab itself.
+
+#### tooling: Move from Prettier to Biome
+https://github.com/CoderLine/alphaTab/pull/2011
+
+We faced quite some issues with using Prettier as formatter for alphaTab due to its opinionated behaviors. These were not only problems on how things are formatted, but also on whether to format at all.
+The underlying `typescript-estree` project decided to add custom semantic checks on top of the TypeScript parser, and do not rely on what the TypeScript compiler offers.
+We have custom transformers and might write special code in TypeScript for the use in C# and Kotlin. While syntactically correct, we mute some parts via `@ts-ignore` or `@ts-expect-error` as we know it will be ultimately valid code in the output.
+
+Unfortunately Prettier cannot format such semantically invalid (but syntactically valid) files because `typescript-estree` already throws an error while parsing the AST.
+
+Hence we decided to move to Biome, as it:
+
+1. Offers a way to format files if they are considered invalid by their analyzer.
+2. Offers also a linter in the same tooling and config (reducing problems with inconsistent checking across tools).
+
+This will become especially relevant when we'll move some runtime type implementations (e.g. Maps and Lists) into the TypeScript codebase instead of maintaining it per-language (C# / Kotlin).
+
+#### rendering: Change to OTF Fonts
+https://github.com/CoderLine/alphaTab/pull/2002
+
+Previously we were using TTF Fonts (like for Bravura or Noto) but it showed that it had some flaws in positioning. Wherever TTFs where used, we use now OTFs if they are available.
+This impacts mainly the .net and Android versions of alphaTab and our internal test setup.
\ No newline at end of file
diff --git a/docs/showcase/layouts.mdx b/docs/showcase/layouts.mdx
index a423441e1..9bb063e05 100644
--- a/docs/showcase/layouts.mdx
+++ b/docs/showcase/layouts.mdx
@@ -69,4 +69,26 @@ You can also filter the rendered bars using this layout.
startBar: 5,
barCount: 4
}
-} } />
\ No newline at end of file
+} } />
+
+
+## Multi-Bar Rests
+
+alphaTab can load the information whether Multi-Bar rests should be used from input files and then merge the bars when displaying accordingly.
+The bars are automatically merged if they are empty or contain only rests.
+
+For Guitar Pro files the format is loaded from the files and for alphaTex it can be specified with a range of metadata options.
+The available options on the stylesheet are:
+
+
+{`
+\\multiBarRest
+.
+\\track "Piano 1" "pno1"
+ \\staff {score}
+ C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | C4
+
+\\track "Piano 2" "pno1"
+ \\staff {score}
+ C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | r |
+`}
diff --git a/docs/tutorial-web/player.mdx b/docs/tutorial-web/player.mdx
index 2f7269d3f..f7b507a56 100644
--- a/docs/tutorial-web/player.mdx
+++ b/docs/tutorial-web/player.mdx
@@ -118,7 +118,7 @@ api.playerReady.on(()=>{
First we add a placeholder in which we will show the percentage value.
Then we will use the [`soundFontLoad`](/docs/reference/api/soundfontload) event to indicate the load progress of the (usually larger) SoundFont.
-The [`playerReady`](/docs/reference/api/readyforplayback) will tell us when to hide the indicator.
+The [`playerReady`](/docs/reference/api/playerready.mdx) will tell us when to hide the indicator.
## Main player controls
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
index c8e2a8551..0a234cf01 100644
--- a/docusaurus.config.ts
+++ b/docusaurus.config.ts
@@ -5,6 +5,7 @@ import type {
NormalizedSidebarItem,
SidebarItemsGeneratorDoc,
} from "@docusaurus/plugin-content-docs/src/sidebars/types.js";
+import remarkGithubAdmonitionsToDirectives from "remark-github-admonitions-to-directives";
import * as path from "path";
import * as fs from "fs";
@@ -32,7 +33,7 @@ function getSortValue(
prop: string,
docs: Map,
item: NormalizedSidebarItem
-): string | number {
+): string | number | undefined {
if (prop in item) {
return item[prop];
}
@@ -76,8 +77,8 @@ function getSortValue(
}
}
- console.warn(`Could not get sort prop '${prop}' on sidebar item`, item);
- return "";
+ // console.warn(`Could not get sort prop '${prop}' on sidebar item`, item);
+ return undefined;
}
const config: Config = {
@@ -108,6 +109,7 @@ const config: Config = {
docs: {
sidebarPath: "./sidebars.ts",
editUrl: "https://github.com/CoderLine/alphaTabWebsite/tree/main/",
+ beforeDefaultRemarkPlugins: [remarkGithubAdmonitionsToDirectives],
async sidebarItemsGenerator({
defaultSidebarItemsGenerator,
...args
@@ -115,8 +117,12 @@ const config: Config = {
const sidebarItems = await defaultSidebarItemsGenerator(args);
if (Array.isArray(args.item.customProps?.["sort"])) {
- const ascending = args.item.customProps?.["sort"][1] !== "desc";
- const prop = args.item.customProps?.["sort"][0];
+ let props = args.item.customProps?.["sort"] as
+ | [string, string]
+ | [string, string][];
+ if (!Array.isArray(props[0])) {
+ props = [props as [string, string]];
+ }
const docsLookup = new Map(
args.docs.map((d) => [d.id, d])
@@ -125,27 +131,45 @@ const config: Config = {
// Reverse items in categories
sidebarItems.sort((a, b) => {
- let av = getSortValue(prop, docsLookup, a);
- let bv = getSortValue(prop, docsLookup, b);
+ for (const prop of props) {
+ const ascending = prop[1] !== "desc";
- if (typeof av !== typeof bv) {
- av = String(av);
- bv = String(bv);
- }
+ let av = getSortValue(prop[0], docsLookup, a);
+ let bv = getSortValue(prop[0], docsLookup, b);
- if (typeof av === "string") {
- if (ascending) {
- return av.localeCompare(bv as string);
- } else {
- return (bv as string).localeCompare(av);
+ if (typeof av !== typeof bv) {
+ av = av === undefined ? av : String(av);
+ bv = bv === undefined ? bv : String(bv);
}
- } else {
- if (ascending) {
- return av - (bv as number);
+
+ var result = 0;
+
+ if (av === undefined && bv === undefined) {
+ // continue
+ } else if (av === undefined) {
+ return -1;
+ } else if (bv === undefined) {
+ return 1;
+ } else if (typeof av === "string") {
+ if (ascending) {
+ result = av.localeCompare(bv as string);
+ } else {
+ result = (bv as string).localeCompare(av);
+ }
} else {
- return (bv as number) - av;
+ if (ascending) {
+ result = av - (bv as number);
+ } else {
+ result = (bv as number) - av;
+ }
+ }
+
+ if (result !== 0) {
+ return result;
}
}
+
+ return 0;
});
}
@@ -319,16 +343,14 @@ const config: Config = {
const sassLoader = sassRule!.use[sassLoaderIndex] as RuleSetRule;
sassLoader.options = {
...((sassLoader.options as object | undefined) ?? {}),
- sourceMap: true // force sourcemaps
+ sourceMap: true, // force sourcemaps
};
-
// insert resolve-url-loader before SASS loader to fix relative URLs
sassRule!.use.splice(sassLoaderIndex, 0, {
loader: "resolve-url-loader",
});
-
return {
plugins: [
// Copy the Font and SoundFont Files to the output
diff --git a/package-lock.json b/package-lock.json
index 94066b46b..8d8f162cb 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -8,7 +8,7 @@
"name": "alphatab-website",
"version": "0.0.0",
"dependencies": {
- "@coderline/alphatab": "^1.4.0-alpha.1326",
+ "@coderline/alphatab": "^1.5.0-alpha.1394",
"@docusaurus/core": "^3.7.0",
"@docusaurus/preset-classic": "^3.7.0",
"@docusaurus/theme-mermaid": "^3.7.0",
@@ -33,8 +33,11 @@
"babel-plugin-macros": "^3.1.0",
"copy-webpack-plugin": "^12.0.2",
"docusaurus-plugin-sass": "^0.2.6",
+ "prettier": "^3.5.3",
+ "remark-github-admonitions-to-directives": "^2.1.0",
"resolve-url-loader": "^5.0.0",
"sass": "^1.85.1",
+ "tsx": "^4.19.3",
"typescript": "^5.7.3"
},
"engines": {
@@ -601,12 +604,13 @@
}
},
"node_modules/@babel/helpers": {
- "version": "7.26.9",
- "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.26.9.tgz",
- "integrity": "sha512-Mz/4+y8udxBKdmzt/UjPACs4G3j5SshJJEFFKxlCGPydG4JAHXxjWjAwjd09tf6oINvl1VfMJo+nB7H2YKQ0dA==",
+ "version": "7.26.10",
+ "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.26.10.tgz",
+ "integrity": "sha512-UPYc3SauzZ3JGgj87GgZ89JVdC5dj0AoetR5Bw6wj4niittNyFh6+eOGonYvJ1ao6B8lEa3Q3klS7ADZ53bc5g==",
+ "license": "MIT",
"dependencies": {
"@babel/template": "^7.26.9",
- "@babel/types": "^7.26.9"
+ "@babel/types": "^7.26.10"
},
"engines": {
"node": ">=6.9.0"
@@ -1803,9 +1807,10 @@
}
},
"node_modules/@babel/runtime": {
- "version": "7.26.9",
- "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.26.9.tgz",
- "integrity": "sha512-aA63XwOkcl4xxQa3HjPMqOP6LiK0ZDv3mUPYEFXkpHbaFjtGggE1A61FjFzJnB+p7/oy2gA8E+rcBNl/zC1tMg==",
+ "version": "7.26.10",
+ "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.26.10.tgz",
+ "integrity": "sha512-2WJMeRQPHKSPemqk/awGrAiuFfzBmOIPXKizAsVhWH9YJqLZ0H+HS4c8loHGgW6utJ3E/ejXQUsiGaQy2NZ9Fw==",
+ "license": "MIT",
"dependencies": {
"regenerator-runtime": "^0.14.0"
},
@@ -1814,9 +1819,10 @@
}
},
"node_modules/@babel/runtime-corejs3": {
- "version": "7.26.9",
- "resolved": "https://registry.npmjs.org/@babel/runtime-corejs3/-/runtime-corejs3-7.26.9.tgz",
- "integrity": "sha512-5EVjbTegqN7RSJle6hMWYxO4voo4rI+9krITk+DWR+diJgGrjZjrIBnJhjrHYYQsFgI7j1w1QnrvV7YSKBfYGg==",
+ "version": "7.26.10",
+ "resolved": "https://registry.npmjs.org/@babel/runtime-corejs3/-/runtime-corejs3-7.26.10.tgz",
+ "integrity": "sha512-uITFQYO68pMEYR46AHgQoyBg7KPPJDAbGn4jUTIRgCFJIp88MIBUianVOplhZDEec07bp9zIyr4Kp0FCyQzmWg==",
+ "license": "MIT",
"dependencies": {
"core-js-pure": "^3.30.2",
"regenerator-runtime": "^0.14.0"
@@ -1856,9 +1862,10 @@
}
},
"node_modules/@babel/types": {
- "version": "7.26.9",
- "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.9.tgz",
- "integrity": "sha512-Y3IR1cRnOxOCDvMmNiym7XpXQ93iGDDPHx+Zj+NM+rg0fBaShfQLkg+hKPaZCEvg5N/LeCo4+Rj/i3FuJsIQaw==",
+ "version": "7.26.10",
+ "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.10.tgz",
+ "integrity": "sha512-emqcG3vHrpxUKTrxcblR36dcrcoRDvKmnL/dCL6ZsHaShW80qxCAcNhzQZrpeM765VzEos+xOi4s+r4IXzTwdQ==",
+ "license": "MIT",
"dependencies": {
"@babel/helper-string-parser": "^7.25.9",
"@babel/helper-validator-identifier": "^7.25.9"
@@ -1907,14 +1914,9 @@
"integrity": "sha512-YslZMgtJUyuMbZ+aKvfF3x1f5liK4mWNxghFRv7jqRR9C3R3fAOGTTKvxXDa2Y1s9zSbcpuO0cAxDYsc9SrXoQ=="
},
"node_modules/@coderline/alphatab": {
- "version": "1.4.0-alpha.1326",
- "resolved": "https://registry.npmjs.org/@coderline/alphatab/-/alphatab-1.4.0-alpha.1326.tgz",
- "integrity": "sha512-vS1Kxujq2jEzlT2HwAju8cCIKrEb+jgHEYCKkUaiVJjcD0bF/PQ4ti0yd8U6CEj38Hi/VGh1Oy6+pGh+EE2FTw==",
- "dependencies": {
- "@types/express": "^5.0.0",
- "@types/node": "^22.13.4",
- "@types/opener": "^1.4.3"
- },
+ "version": "1.5.0-alpha.1394",
+ "resolved": "https://registry.npmjs.org/@coderline/alphatab/-/alphatab-1.5.0-alpha.1394.tgz",
+ "integrity": "sha512-R4Dnvs0xvgCZEPc/jsHZc9VaGlGx7OWFghJBeLlwes6j1Sh55dpnV+kiDKZP+/AlUplQhYfzNqKOIWSNyAAuJw==",
"engines": {
"node": ">=6.0.0"
}
@@ -3775,6 +3777,406 @@
"node": ">=18.0"
}
},
+ "node_modules/@esbuild/aix-ppc64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.1.tgz",
+ "integrity": "sha512-kfYGy8IdzTGy+z0vFGvExZtxkFlA4zAxgKEahG9KE1ScBjpQnFsNOX8KTU5ojNru5ed5CVoJYXFtoxaq5nFbjQ==",
+ "cpu": [
+ "ppc64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "aix"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/android-arm": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.1.tgz",
+ "integrity": "sha512-dp+MshLYux6j/JjdqVLnMglQlFu+MuVeNrmT5nk6q07wNhCdSnB7QZj+7G8VMUGh1q+vj2Bq8kRsuyA00I/k+Q==",
+ "cpu": [
+ "arm"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "android"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/android-arm64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.1.tgz",
+ "integrity": "sha512-50tM0zCJW5kGqgG7fQ7IHvQOcAn9TKiVRuQ/lN0xR+T2lzEFvAi1ZcS8DiksFcEpf1t/GYOeOfCAgDHFpkiSmA==",
+ "cpu": [
+ "arm64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "android"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/android-x64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.1.tgz",
+ "integrity": "sha512-GCj6WfUtNldqUzYkN/ITtlhwQqGWu9S45vUXs7EIYf+7rCiiqH9bCloatO9VhxsL0Pji+PF4Lz2XXCES+Q8hDw==",
+ "cpu": [
+ "x64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "android"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/darwin-arm64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.1.tgz",
+ "integrity": "sha512-5hEZKPf+nQjYoSr/elb62U19/l1mZDdqidGfmFutVUjjUZrOazAtwK+Kr+3y0C/oeJfLlxo9fXb1w7L+P7E4FQ==",
+ "cpu": [
+ "arm64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "darwin"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/darwin-x64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.1.tgz",
+ "integrity": "sha512-hxVnwL2Dqs3fM1IWq8Iezh0cX7ZGdVhbTfnOy5uURtao5OIVCEyj9xIzemDi7sRvKsuSdtCAhMKarxqtlyVyfA==",
+ "cpu": [
+ "x64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "darwin"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/freebsd-arm64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.1.tgz",
+ "integrity": "sha512-1MrCZs0fZa2g8E+FUo2ipw6jw5qqQiH+tERoS5fAfKnRx6NXH31tXBKI3VpmLijLH6yriMZsxJtaXUyFt/8Y4A==",
+ "cpu": [
+ "arm64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "freebsd"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/freebsd-x64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.1.tgz",
+ "integrity": "sha512-0IZWLiTyz7nm0xuIs0q1Y3QWJC52R8aSXxe40VUxm6BB1RNmkODtW6LHvWRrGiICulcX7ZvyH6h5fqdLu4gkww==",
+ "cpu": [
+ "x64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "freebsd"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/linux-arm": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.1.tgz",
+ "integrity": "sha512-NdKOhS4u7JhDKw9G3cY6sWqFcnLITn6SqivVArbzIaf3cemShqfLGHYMx8Xlm/lBit3/5d7kXvriTUGa5YViuQ==",
+ "cpu": [
+ "arm"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/linux-arm64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.1.tgz",
+ "integrity": "sha512-jaN3dHi0/DDPelk0nLcXRm1q7DNJpjXy7yWaWvbfkPvI+7XNSc/lDOnCLN7gzsyzgu6qSAmgSvP9oXAhP973uQ==",
+ "cpu": [
+ "arm64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/linux-ia32": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.1.tgz",
+ "integrity": "sha512-OJykPaF4v8JidKNGz8c/q1lBO44sQNUQtq1KktJXdBLn1hPod5rE/Hko5ugKKZd+D2+o1a9MFGUEIUwO2YfgkQ==",
+ "cpu": [
+ "ia32"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/linux-loong64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.1.tgz",
+ "integrity": "sha512-nGfornQj4dzcq5Vp835oM/o21UMlXzn79KobKlcs3Wz9smwiifknLy4xDCLUU0BWp7b/houtdrgUz7nOGnfIYg==",
+ "cpu": [
+ "loong64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/linux-mips64el": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.1.tgz",
+ "integrity": "sha512-1osBbPEFYwIE5IVB/0g2X6i1qInZa1aIoj1TdL4AaAb55xIIgbg8Doq6a5BzYWgr+tEcDzYH67XVnTmUzL+nXg==",
+ "cpu": [
+ "mips64el"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/linux-ppc64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.1.tgz",
+ "integrity": "sha512-/6VBJOwUf3TdTvJZ82qF3tbLuWsscd7/1w+D9LH0W/SqUgM5/JJD0lrJ1fVIfZsqB6RFmLCe0Xz3fmZc3WtyVg==",
+ "cpu": [
+ "ppc64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/linux-riscv64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.1.tgz",
+ "integrity": "sha512-nSut/Mx5gnilhcq2yIMLMe3Wl4FK5wx/o0QuuCLMtmJn+WeWYoEGDN1ipcN72g1WHsnIbxGXd4i/MF0gTcuAjQ==",
+ "cpu": [
+ "riscv64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/linux-s390x": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.1.tgz",
+ "integrity": "sha512-cEECeLlJNfT8kZHqLarDBQso9a27o2Zd2AQ8USAEoGtejOrCYHNtKP8XQhMDJMtthdF4GBmjR2au3x1udADQQQ==",
+ "cpu": [
+ "s390x"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/linux-x64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.1.tgz",
+ "integrity": "sha512-xbfUhu/gnvSEg+EGovRc+kjBAkrvtk38RlerAzQxvMzlB4fXpCFCeUAYzJvrnhFtdeyVCDANSjJvOvGYoeKzFA==",
+ "cpu": [
+ "x64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/netbsd-arm64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.1.tgz",
+ "integrity": "sha512-O96poM2XGhLtpTh+s4+nP7YCCAfb4tJNRVZHfIE7dgmax+yMP2WgMd2OecBuaATHKTHsLWHQeuaxMRnCsH8+5g==",
+ "cpu": [
+ "arm64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "netbsd"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/netbsd-x64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.1.tgz",
+ "integrity": "sha512-X53z6uXip6KFXBQ+Krbx25XHV/NCbzryM6ehOAeAil7X7oa4XIq+394PWGnwaSQ2WRA0KI6PUO6hTO5zeF5ijA==",
+ "cpu": [
+ "x64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "netbsd"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/openbsd-arm64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.1.tgz",
+ "integrity": "sha512-Na9T3szbXezdzM/Kfs3GcRQNjHzM6GzFBeU1/6IV/npKP5ORtp9zbQjvkDJ47s6BCgaAZnnnu/cY1x342+MvZg==",
+ "cpu": [
+ "arm64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "openbsd"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/openbsd-x64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.1.tgz",
+ "integrity": "sha512-T3H78X2h1tszfRSf+txbt5aOp/e7TAz3ptVKu9Oyir3IAOFPGV6O9c2naym5TOriy1l0nNf6a4X5UXRZSGX/dw==",
+ "cpu": [
+ "x64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "openbsd"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/sunos-x64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.1.tgz",
+ "integrity": "sha512-2H3RUvcmULO7dIE5EWJH8eubZAI4xw54H1ilJnRNZdeo8dTADEZ21w6J22XBkXqGJbe0+wnNJtw3UXRoLJnFEg==",
+ "cpu": [
+ "x64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "sunos"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/win32-arm64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.1.tgz",
+ "integrity": "sha512-GE7XvrdOzrb+yVKB9KsRMq+7a2U/K5Cf/8grVFRAGJmfADr/e/ODQ134RK2/eeHqYV5eQRFxb1hY7Nr15fv1NQ==",
+ "cpu": [
+ "arm64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "win32"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/win32-ia32": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.1.tgz",
+ "integrity": "sha512-uOxSJCIcavSiT6UnBhBzE8wy3n0hOkJsBOzy7HDAuTDE++1DJMRRVCPGisULScHL+a/ZwdXPpXD3IyFKjA7K8A==",
+ "cpu": [
+ "ia32"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "win32"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@esbuild/win32-x64": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.1.tgz",
+ "integrity": "sha512-Y1EQdcfwMSeQN/ujR5VayLOJ1BHaK+ssyk0AEzPjC+t1lITgsnccPqFjb6V+LsTp/9Iov4ysfjxLaGJ9RPtkVg==",
+ "cpu": [
+ "x64"
+ ],
+ "dev": true,
+ "optional": true,
+ "os": [
+ "win32"
+ ],
+ "engines": {
+ "node": ">=18"
+ }
+ },
"node_modules/@floating-ui/core": {
"version": "1.6.9",
"resolved": "https://registry.npmjs.org/@floating-ui/core/-/core-1.6.9.tgz",
@@ -5172,14 +5574,6 @@
"@types/node": "*"
}
},
- "node_modules/@types/opener": {
- "version": "1.4.3",
- "resolved": "https://registry.npmjs.org/@types/opener/-/opener-1.4.3.tgz",
- "integrity": "sha512-g7TYSmy2RKZkU3QT/9pMISrhVmQtMNaYq6Aojn3Y6pht29Nu9VuijJCYIjofRj7ZaFtKdxh1I8xf3vdW4l86fg==",
- "dependencies": {
- "@types/node": "*"
- }
- },
"node_modules/@types/parse-json": {
"version": "4.0.2",
"resolved": "https://registry.npmjs.org/@types/parse-json/-/parse-json-4.0.2.tgz",
@@ -8517,6 +8911,46 @@
"url": "https://opencollective.com/unified"
}
},
+ "node_modules/esbuild": {
+ "version": "0.25.1",
+ "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.1.tgz",
+ "integrity": "sha512-BGO5LtrGC7vxnqucAe/rmvKdJllfGaYWdyABvyMoXQlfYMb2bbRuReWR5tEGE//4LcNJj9XrkovTqNYRFZHAMQ==",
+ "dev": true,
+ "hasInstallScript": true,
+ "bin": {
+ "esbuild": "bin/esbuild"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "optionalDependencies": {
+ "@esbuild/aix-ppc64": "0.25.1",
+ "@esbuild/android-arm": "0.25.1",
+ "@esbuild/android-arm64": "0.25.1",
+ "@esbuild/android-x64": "0.25.1",
+ "@esbuild/darwin-arm64": "0.25.1",
+ "@esbuild/darwin-x64": "0.25.1",
+ "@esbuild/freebsd-arm64": "0.25.1",
+ "@esbuild/freebsd-x64": "0.25.1",
+ "@esbuild/linux-arm": "0.25.1",
+ "@esbuild/linux-arm64": "0.25.1",
+ "@esbuild/linux-ia32": "0.25.1",
+ "@esbuild/linux-loong64": "0.25.1",
+ "@esbuild/linux-mips64el": "0.25.1",
+ "@esbuild/linux-ppc64": "0.25.1",
+ "@esbuild/linux-riscv64": "0.25.1",
+ "@esbuild/linux-s390x": "0.25.1",
+ "@esbuild/linux-x64": "0.25.1",
+ "@esbuild/netbsd-arm64": "0.25.1",
+ "@esbuild/netbsd-x64": "0.25.1",
+ "@esbuild/openbsd-arm64": "0.25.1",
+ "@esbuild/openbsd-x64": "0.25.1",
+ "@esbuild/sunos-x64": "0.25.1",
+ "@esbuild/win32-arm64": "0.25.1",
+ "@esbuild/win32-ia32": "0.25.1",
+ "@esbuild/win32-x64": "0.25.1"
+ }
+ },
"node_modules/escalade": {
"version": "3.2.0",
"resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz",
@@ -8667,9 +9101,10 @@
}
},
"node_modules/estree-util-value-to-estree": {
- "version": "3.3.2",
- "resolved": "https://registry.npmjs.org/estree-util-value-to-estree/-/estree-util-value-to-estree-3.3.2.tgz",
- "integrity": "sha512-hYH1aSvQI63Cvq3T3loaem6LW4u72F187zW4FHpTrReJSm6W66vYTFNO1vH/chmcOulp1HlAj1pxn8Ag0oXI5Q==",
+ "version": "3.3.3",
+ "resolved": "https://registry.npmjs.org/estree-util-value-to-estree/-/estree-util-value-to-estree-3.3.3.tgz",
+ "integrity": "sha512-Db+m1WSD4+mUO7UgMeKkAwdbfNWwIxLt48XF2oFU9emPfXkIu+k5/nlOj313v7wqtAPo0f9REhUvznFrPkG8CQ==",
+ "license": "MIT",
"dependencies": {
"@types/estree": "^1.0.0"
},
@@ -9449,6 +9884,18 @@
"url": "https://github.com/sponsors/sindresorhus"
}
},
+ "node_modules/get-tsconfig": {
+ "version": "4.10.0",
+ "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.10.0.tgz",
+ "integrity": "sha512-kGzZ3LWWQcGIAmg6iWvXn0ei6WDtV26wzHRMwDSzmAbcXrTEXxHy6IehI6/4eT6VRKyMP1eF1VqwrVUmE/LR7A==",
+ "dev": true,
+ "dependencies": {
+ "resolve-pkg-maps": "^1.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/privatenumber/get-tsconfig?sponsor=1"
+ }
+ },
"node_modules/github-slugger": {
"version": "1.5.0",
"resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-1.5.0.tgz",
@@ -10602,9 +11049,10 @@
}
},
"node_modules/image-size": {
- "version": "1.2.0",
- "resolved": "https://registry.npmjs.org/image-size/-/image-size-1.2.0.tgz",
- "integrity": "sha512-4S8fwbO6w3GeCVN6OPtA9I5IGKkcDMPcKndtUlpJuCwu7JLjtj7JZpwqLuyY2nrmQT3AWsCJLSKPsc2mPBSl3w==",
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/image-size/-/image-size-1.2.1.tgz",
+ "integrity": "sha512-rH+46sQJ2dlwfjfhCyNx5thzrv+dtmBIhPHk0zgRUukHzZ/kRueTJXoYYsclBaKcSMBWuGbOFXtioLpzTb5euw==",
+ "license": "MIT",
"dependencies": {
"queue": "6.0.2"
},
@@ -15883,6 +16331,21 @@
"postcss": "^8.4.31"
}
},
+ "node_modules/prettier": {
+ "version": "3.5.3",
+ "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.5.3.tgz",
+ "integrity": "sha512-QQtaxnoDJeAkDvDKWCLiwIXkTgRhwYDEQCghU9Z6q03iyek/rxRh/2lC3HB7P8sWT2xC/y5JDctPLBIGzHKbhw==",
+ "dev": true,
+ "bin": {
+ "prettier": "bin/prettier.cjs"
+ },
+ "engines": {
+ "node": ">=14"
+ },
+ "funding": {
+ "url": "https://github.com/prettier/prettier?sponsor=1"
+ }
+ },
"node_modules/pretty-error": {
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/pretty-error/-/pretty-error-4.0.0.tgz",
@@ -16731,6 +17194,21 @@
"url": "https://opencollective.com/unified"
}
},
+ "node_modules/remark-github-admonitions-to-directives": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/remark-github-admonitions-to-directives/-/remark-github-admonitions-to-directives-2.1.0.tgz",
+ "integrity": "sha512-bI3E4Oj1pKY3ym2IQrrVCdORgEu0+mSrWgpCYFNy8QvytfnLs/nAacVPjkWU/JzDMUiQio2k4nTFP7bsIr9TSA==",
+ "dev": true,
+ "dependencies": {
+ "@types/mdast": "^4.0.0",
+ "mdast-util-directive": "^3.0.0",
+ "unified": "^11.0.0",
+ "unist-util-visit": "^5.0.0"
+ },
+ "engines": {
+ "pnpm": ">=9.0.0"
+ }
+ },
"node_modules/remark-mdx": {
"version": "3.1.0",
"resolved": "https://registry.npmjs.org/remark-mdx/-/remark-mdx-3.1.0.tgz",
@@ -16948,6 +17426,15 @@
"resolved": "https://registry.npmjs.org/resolve-pathname/-/resolve-pathname-3.0.0.tgz",
"integrity": "sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng=="
},
+ "node_modules/resolve-pkg-maps": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz",
+ "integrity": "sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==",
+ "dev": true,
+ "funding": {
+ "url": "https://github.com/privatenumber/resolve-pkg-maps?sponsor=1"
+ }
+ },
"node_modules/resolve-url-loader": {
"version": "5.0.0",
"resolved": "https://registry.npmjs.org/resolve-url-loader/-/resolve-url-loader-5.0.0.tgz",
@@ -18229,6 +18716,25 @@
"resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz",
"integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w=="
},
+ "node_modules/tsx": {
+ "version": "4.19.3",
+ "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.19.3.tgz",
+ "integrity": "sha512-4H8vUNGNjQ4V2EOoGw005+c+dGuPSnhpPBPHBtsZdGZBk/iJb4kguGlPWaZTZ3q5nMtFOEsY0nRDlh9PJyd6SQ==",
+ "dev": true,
+ "dependencies": {
+ "esbuild": "~0.25.0",
+ "get-tsconfig": "^4.7.5"
+ },
+ "bin": {
+ "tsx": "dist/cli.mjs"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ },
+ "optionalDependencies": {
+ "fsevents": "~2.3.3"
+ }
+ },
"node_modules/type-fest": {
"version": "2.19.0",
"resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.19.0.tgz",
@@ -18280,9 +18786,9 @@
}
},
"node_modules/typescript": {
- "version": "5.7.3",
- "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.7.3.tgz",
- "integrity": "sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw==",
+ "version": "5.8.2",
+ "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.2.tgz",
+ "integrity": "sha512-aJn6wq13/afZp/jT9QZmwEjDqqvSGp1VT5GVg+f/t6/oVyrgXM6BY1h9BRh/O5p3PlUPAe+WuiEZOmb/49RqoQ==",
"bin": {
"tsc": "bin/tsc",
"tsserver": "bin/tsserver"
diff --git a/package.json b/package.json
index 16f950f51..4bca40c06 100644
--- a/package.json
+++ b/package.json
@@ -12,10 +12,11 @@
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
- "typecheck": "tsc"
+ "typecheck": "tsc",
+ "generate-alphatabdoc": "tsx scripts/generate-alphatabdoc.mts"
},
"dependencies": {
- "@coderline/alphatab": "^1.4.0-alpha.1326",
+ "@coderline/alphatab": "^1.5.0-alpha.1394",
"@docusaurus/core": "^3.7.0",
"@docusaurus/preset-classic": "^3.7.0",
"@docusaurus/theme-mermaid": "^3.7.0",
@@ -40,8 +41,11 @@
"babel-plugin-macros": "^3.1.0",
"copy-webpack-plugin": "^12.0.2",
"docusaurus-plugin-sass": "^0.2.6",
+ "prettier": "^3.5.3",
+ "remark-github-admonitions-to-directives": "^2.1.0",
"resolve-url-loader": "^5.0.0",
"sass": "^1.85.1",
+ "tsx": "^4.19.3",
"typescript": "^5.7.3"
},
"browserslist": {
diff --git a/scripts/generate-alphatabdoc.mts b/scripts/generate-alphatabdoc.mts
new file mode 100644
index 000000000..40460b039
--- /dev/null
+++ b/scripts/generate-alphatabdoc.mts
@@ -0,0 +1,157 @@
+import path from "path";
+import url from "url";
+import ts, { JSDocParsingMode } from "typescript";
+import { generateSettings } from "./generate-settings.mjs";
+import { GenerateContext } from "./typeschema.mjs";
+import { generateTypeDocs } from "./generate-typedocs.mjs";
+import { cconsole } from "./generate-common.mjs";
+import { generateApiDocs } from "./generate-api.mjs";
+
+const alphaTabEntryFile = url.fileURLToPath(
+ import.meta.resolve("@coderline/alphatab")
+);
+const alphaTabDir = path.resolve(alphaTabEntryFile, "..", "..");
+
+const dts = path.resolve(alphaTabDir, "dist", "alphaTab.d.ts");
+const host = ts.createCompilerHost({}, true);
+host.jsDocParsingMode = JSDocParsingMode.ParseAll;
+
+const program = ts.createProgram({
+ rootNames: [dts],
+ options: {},
+ host: host,
+});
+
+const ast = program.getSourceFile(dts);
+
+const lookup = new Map();
+
+const context: GenerateContext = {
+ checker: program.getTypeChecker(),
+ dts: dts,
+ flatExports: new Map(),
+ nameToExportName: new Map(),
+ settings: null!,
+};
+
+function walkModuleDeclaration(
+ d: ts.ModuleDeclaration,
+ exportedName: string,
+ handler: (
+ exportName: string,
+ internalName: string,
+ d: ts.DeclarationStatement
+ ) => void
+) {
+ if (!d.body || !ts.isModuleBlock(d.body)) {
+ cconsole.warn("Unsupported module declaration", exportedName);
+ return;
+ }
+
+ for (const s of d.body.statements) {
+ if (
+ ts.isExportDeclaration(s) &&
+ s.exportClause &&
+ ts.isNamedExports(s.exportClause)
+ ) {
+ for (const nested of s.exportClause.elements) {
+ let exportName = "";
+ let typeName = "";
+ if (nested.propertyName) {
+ typeName = (nested.propertyName as ts.Identifier).text;
+ exportName = (nested.name as ts.Identifier).text;
+ } else {
+ typeName = (nested.name as ts.Identifier).text;
+ exportName = typeName;
+ }
+
+ if (lookup.has(typeName)) {
+ walkExports(
+ lookup.get(typeName)!,
+ exportedName + "." + exportName,
+ typeName,
+ handler
+ );
+ } else {
+ cconsole.warn("Unresolved export", typeName, "in", exportedName);
+ }
+ }
+ } else {
+ cconsole.warn(
+ "Unsupported statement",
+ ts.SyntaxKind[s.kind],
+ "in",
+ exportedName
+ );
+ }
+ }
+}
+
+async function walkExports(
+ d: ts.DeclarationStatement,
+ exportName: string,
+ internalName: string,
+ handler: (
+ exportName: string,
+ internalName: string,
+ d: ts.DeclarationStatement
+ ) => void
+) {
+ if (!d.name || !ts.isIdentifier(d.name)) {
+ return;
+ }
+
+ if (ts.isModuleDeclaration(d)) {
+ walkModuleDeclaration(d, exportName, handler);
+ } else {
+ handler(exportName, internalName, d);
+ }
+}
+
+const exports: { d: ts.DeclarationStatement; identifier: string }[] = [];
+for (const d of ast!.statements) {
+ if (!ts.isDeclarationStatement(d) || !ts.canHaveModifiers(d)) {
+ continue;
+ }
+ const isExported = !!d.modifiers?.some(
+ (m) => m.kind === ts.SyntaxKind.ExportKeyword
+ );
+
+ let identifier = "";
+ if (d.name) {
+ if (ts.isIdentifier(d.name)) {
+ identifier = d.name.text;
+ }
+ }
+
+ if (identifier) {
+ lookup.set(identifier, d);
+ }
+
+ if (isExported) {
+ exports.push({ d, identifier });
+ }
+}
+
+for (const { d, identifier } of exports) {
+ walkExports(d, "alphaTab." + identifier, identifier, async (e, i, d) => {
+ if (
+ ts.isEnumDeclaration(d) ||
+ ts.isClassDeclaration(d) ||
+ ts.isInterfaceDeclaration(d) ||
+ ts.isTypeAliasDeclaration(d)
+ ) {
+ context.flatExports.set(e, d);
+ context.nameToExportName.set(i, e);
+ }
+ });
+}
+
+context.settings = context.flatExports.get(
+ "alphaTab.Settings"
+) as ts.ClassDeclaration;
+await generateSettings(context);
+await generateTypeDocs(context);
+await generateApiDocs(context);
+
+// TODO: run prettier on MDX files
\ No newline at end of file
diff --git a/scripts/generate-api.mts b/scripts/generate-api.mts
new file mode 100644
index 000000000..b31dcba91
--- /dev/null
+++ b/scripts/generate-api.mts
@@ -0,0 +1,199 @@
+import path from "path";
+import fs from "fs";
+import { GenerateContext, repositoryRoot } from "./typeschema.mjs";
+import {
+ collectMembers,
+ getCategory,
+ getJsDocTagText,
+ getSummary,
+ isEvent,
+ isTargetWeb,
+ writeCommonImports,
+ writeEventDetails,
+ writeMethodDetails,
+ writePropertyDetails,
+} from "./generate-common.mjs";
+import ts from "typescript";
+import { FileStream, openFileStream } from "./util.mjs";
+
+export async function generateApiDocs(context: GenerateContext) {
+ const basePath = path.join(repositoryRoot, "docs", "reference", "api");
+ await fs.promises.mkdir(basePath, { recursive: true });
+
+ const properties: (
+ | ts.PropertyDeclaration
+ | ts.PropertySignature
+ | ts.GetAccessorDeclaration
+ )[] = [];
+
+ const events: (
+ | ts.PropertyDeclaration
+ | ts.PropertySignature
+ | ts.GetAccessorDeclaration
+ )[] = [];
+
+ const methods: (ts.MethodDeclaration | ts.MethodSignature)[] = [];
+
+ const members: Map = new Map();
+ collectMembers(context, members, context.flatExports.get(
+ "alphaTab.AlphaTabApiBase"
+ ) as ts.ClassDeclaration, false);
+ collectMembers(context, members, context.flatExports.get(
+ "alphaTab.AlphaTabApi"
+ ) as ts.ClassDeclaration, false);
+
+ for (const m of Array.from(members.values())) {
+ if (isEvent(context, m)) {
+ events.push(m as (typeof events)[0]);
+ } else if (
+ ts.isPropertyDeclaration(m) ||
+ ts.isPropertySignature(m) ||
+ ts.isGetAccessorDeclaration(m)
+ ) {
+ properties.push(m);
+ } else if (ts.isMethodDeclaration(m) || ts.isMethodSignature(m)) {
+ methods.push(m);
+ }
+ }
+
+ await writeProperties(context, basePath, properties);
+ await writeMethods(context, basePath, methods);
+ await writeEvents(context, basePath, events);
+}
+
+async function writeProperties(
+ context: GenerateContext,
+ basePath: string,
+ properties: (
+ | ts.PropertyDeclaration
+ | ts.PropertySignature
+ | ts.GetAccessorDeclaration
+ )[]
+) {
+ for (const member of properties) {
+ await writePropertyPage(context, basePath, member);
+ }
+}
+
+async function writeMethods(
+ context: GenerateContext,
+ basePath: string,
+ methods: (ts.MethodDeclaration | ts.MethodSignature)[]
+) {
+ for (const member of methods) {
+ await writeMethodPage(context, basePath, member);
+ }
+}
+
+async function writeEvents(
+ context: GenerateContext,
+ basePath: string,
+ events: (
+ | ts.PropertyDeclaration
+ | ts.PropertySignature
+ | ts.GetAccessorDeclaration
+ )[]
+) {
+ for (const member of events) {
+ await writeEventPage(context, basePath, member);
+ }
+}
+
+async function writeFrontMatter(
+ context: GenerateContext,
+ fileStream: FileStream,
+ memberName: string,
+ member: ts.ClassElement | ts.TypeElement,
+ kind: string
+) {
+ await fileStream.write("---\n");
+ await fileStream.write(`title: ${memberName}\n`);
+ await fileStream.write(
+ `description: ${JSON.stringify(getSummary(context, member, false))}\n`
+ );
+ await fileStream.write(`sidebar_custom_props:\n`);
+ await fileStream.write(` kind: ${kind}\n`);
+
+ const isWebOnly = isTargetWeb(context, member);
+ if (isWebOnly) {
+ await fileStream.write(` javaScriptOnly: true\n`);
+ }
+
+ await fileStream.write(
+ ` category: ${getCategory(context, member, " - Core")}\n`
+ );
+
+ const since = getJsDocTagText(context, member, "since");
+ if (since) {
+ await fileStream.write(` since: ${since}\n`);
+ }
+
+ await fileStream.write("---\n");
+
+ await writeCommonImports(fileStream);
+
+ if (since) {
+ await fileStream.write(`(
+ context: GenerateContext,
+ node: ts.Node,
+ selector: (baseNode: ts.Node) => T | undefined
+): T | undefined {
+ let baseTypes: (ts.ClassDeclaration | ts.InterfaceDeclaration)[];
+
+ switch (node.kind) {
+ case ts.SyntaxKind.ClassDeclaration:
+ case ts.SyntaxKind.InterfaceDeclaration:
+ baseTypes = getBaseTypeList(
+ context,
+ node as ts.ClassDeclaration | ts.InterfaceDeclaration
+ );
+
+ for (const t of baseTypes) {
+ const v = selector(t);
+ if (v !== undefined) {
+ return v;
+ }
+ }
+ return undefined;
+
+ case ts.SyntaxKind.MethodSignature:
+ case ts.SyntaxKind.MethodDeclaration:
+ case ts.SyntaxKind.PropertyDeclaration:
+ case ts.SyntaxKind.PropertySignature:
+ case ts.SyntaxKind.GetAccessor:
+ case ts.SyntaxKind.SetAccessor:
+ baseTypes = getBaseTypeList(
+ context,
+ node.parent as ts.ClassDeclaration | ts.InterfaceDeclaration
+ );
+
+ for (const t of baseTypes) {
+ const member = t.members.find(
+ (m) =>
+ m.name?.getText() ===
+ (node as ts.ClassElement | ts.TypeElement).name?.getText()
+ );
+ if (member) {
+ const v = selector(member);
+ if (v !== undefined) {
+ return v;
+ }
+ }
+ }
+
+ break;
+ }
+
+ return undefined;
+}
+
+export function getJSDocCommentsAndTags(
+ context: GenerateContext,
+ node: ts.Node
+) {
+ if (hasJSDocInheritDocTag(node)) {
+ const base = findBaseOfDeclaration(context, node, (baseNode) => {
+ if (hasJSDocInheritDocTag(baseNode)) {
+ return undefined;
+ }
+ const docs = ts.getJSDocCommentsAndTags(baseNode);
+ if (docs.length === 0) {
+ return undefined;
+ }
+ return docs;
+ });
+ if (base) {
+ return base;
+ }
+ }
+ return ts.getJSDocCommentsAndTags(node);
+}
+
+export function getJSDocTags(context: GenerateContext, node: ts.Node) {
+ if (hasJSDocInheritDocTag(node)) {
+ const base = findBaseOfDeclaration(context, node, (baseNode) => {
+ if (hasJSDocInheritDocTag(baseNode)) {
+ return undefined;
+ }
+ const tags = ts.getJSDocTags(baseNode);
+ if (tags.length > 0) {
+ return tags;
+ }
+ return undefined;
+ });
+ if (base) {
+ return base;
+ }
+ }
+ return ts.getJSDocTags(node);
+}
+
+export function getJsDocTagText(
+ context: GenerateContext,
+ node: ts.Node,
+ tagName: string
+): string {
+ return jsDocCommentToMarkdown(
+ context,
+ getJSDocTags(context, node).find((t) => t.tagName.text === tagName)?.comment
+ );
+}
+
+export function getSummary(
+ context: GenerateContext,
+ node: ts.Node,
+ resolveLinks: boolean,
+ shorten: boolean = true
+): string {
+ const jsDoc = getJSDocCommentsAndTags(context, node);
+ if ((jsDoc.length > 1 && ts.isJSDoc(jsDoc[0])) || jsDoc.length === 1) {
+ const text = jsDocCommentToMarkdown(
+ context,
+ jsDoc[0].comment,
+ resolveLinks
+ );
+ if (shorten) {
+ return (
+ text
+ .split("\n")
+ .find((l) => l.trim().length > 0)
+ ?.trim() ?? ""
+ );
+ } else {
+ return text;
+ }
+ }
+
+ return "";
+}
+
+let warnOnMissingDescription = false;
+export function enableWarningsOnMissingDocs() {
+ warnOnMissingDescription = true;
+}
+
+export function disableWarningsOnMissingDocs() {
+ warnOnMissingDescription = false;
+}
+
+export function getFullDescription(context: GenerateContext, node: ts.Node) {
+ const description = `${getSummary(
+ context,
+ node,
+ true,
+ false
+ )} ${getJsDocTagText(context, node, "remarks")}`.trim();
+
+ if (!description) {
+ const isOwn =
+ path.basename(node.getSourceFile().fileName) ===
+ path.basename(context.dts);
+ if (isOwn && warnOnMissingDescription) {
+ let name =
+ "name" in node ? (node.name as ts.Node).getText() : node.getText();
+
+ if (ts.isParameter(node)) {
+ name =
+ (node.parent.parent as ts.NamedDeclaration).name!.getText() +
+ "." +
+ node.parent.name!.getText() +
+ "(" +
+ name +
+ ")";
+ } else if (
+ ts.isClassDeclaration(node.parent) ||
+ ts.isInterfaceDeclaration(node.parent)
+ ) {
+ name = node.parent.name!.getText() + "." + name;
+ }
+
+ cconsole.warn(
+ "Missing description for",
+ name,
+ "at",
+ node.getSourceFile().fileName,
+ node.getSourceFile().getLineAndCharacterOfPosition(node.pos)
+ );
+ }
+
+ return "(no description)";
+ }
+
+ return description;
+}
+
+function rewriteJsDocText(s: string): string {
+ return s
+ .replaceAll("https://alphatab.net/", "/")
+ .replaceAll("https://www.alphatab.net/", "/")
+ .replaceAll(/\{@since ([^}]+)\}/g, (_, since) => {
+ return ` where
+ // all identifiers get their own links.
+
+ if (
+ element.fullString === "any" ||
+ element.fullString === "unknown" ||
+ element.fullString === "void"
+ ) {
+ return "";
+ } else if (element.isPrimitiveType || element.isTypedArray) {
+ return "";
+ } else if (element.isArray) {
+ return getTypeReferenceUrl(context, element.arrayItemType!);
+ } else if (element.isFunctionType) {
+ return "";
+ } else if (element.isTypeLiteral) {
+ return "";
+ } else if (element.isOwnType) {
+ let declaration = valueOrFirstDeclarationInDts(context, element.symbol!);
+ if (declaration) {
+ return getTypeReferenceUrl(context, declaration as any);
+ }
+ } else if (element.typeArguments) {
+ // currently we mostly have one own type in generics (e.g. maps, sets etc.)
+ for (const a of element.typeArguments) {
+ if (a.isOwnType || a.isUnionType) {
+ const reference = getTypeReferenceUrl(context, a, false);
+ if (reference) {
+ return reference;
+ }
+ }
+ }
+
+ // there are maps with only primitives
+ return "";
+ } else if (element.isUnionType) {
+ for (const a of element.unionTypes!) {
+ const reference = getTypeReferenceUrl(context, a, false);
+ if (reference) {
+ return reference;
+ }
+ }
+ } else {
+ let declaration = valueOrFirstDeclarationInDts(context, element.symbol!);
+ if (declaration) {
+ return getDeclarationReferenceUrl(context, declaration as any);
+ }
+ }
+
+ if (warnOnMissingReference) {
+ cconsole.error("Failed to resolve reference link for type ", element);
+ }
+ return "";
+}
+
+export async function writeExamples(
+ fileStream: FileStream,
+ context: GenerateContext,
+ element: ts.Node
+) {
+ const examples = collectExamples(context, element);
+ if (examples.length === 1) {
+ await fileStream.write(`\n## Example - ${examples[0].title}\n\n`);
+ await fileStream.write(`${examples[0].markdown}\n`);
+ } else if (examples.length > 1) {
+ await fileStream.write(`\n## Examples\n\n`);
+ await fileStream.write("\n`);
+
+ for (const example of examples) {
+ await fileStream.write(
+ `\n`
+ );
+
+ await fileStream.write(`${example.markdown}\n`);
+
+ await fileStream.write(` \n`);
+ }
+
+ await fileStream.write(`\n`);
+ }
+}
+
+function isInternal(context: GenerateContext, node: ts.Node) {
+ const tags = getJSDocTags(context, node);
+
+ if (tags.find((t) => t.tagName.text === "internal")) {
+ return true;
+ }
+
+ return false;
+}
+
+export async function writeEventDetails(
+ context: GenerateContext,
+ fileStream: FileStream,
+ member:
+ | ts.PropertySignature
+ | ts.PropertyDeclaration
+ | ts.GetAccessorDeclaration
+) {
+ await writeCommonDescription(context, fileStream, member);
+
+ await writeEventSignatures(context, fileStream, member);
+
+ await writeManualDocs(fileStream, member);
+
+ await writeExamples(fileStream, context, member);
+}
+
+export async function writeEventSignatures(
+ context: GenerateContext,
+ fileStream: FileStream,
+ member:
+ | ts.PropertySignature
+ | ts.PropertyDeclaration
+ | ts.GetAccessorDeclaration
+) {
+ await writePropertySignatures(context, fileStream, member);
+}
+
+export async function writeMethodDetails(
+ context: GenerateContext,
+ fileStream: FileStream,
+ member: ts.MethodDeclaration | ts.MethodSignature
+) {
+ await writeCommonDescription(context, fileStream, member);
+
+ await writeMethodSignatures(context, fileStream, member);
+ await writeMethodParameters(context, fileStream, member);
+ await writeMethodReturn(context, fileStream, member);
+
+ await writeManualDocs(fileStream, member);
+
+ await writeExamples(fileStream, context, member);
+}
+
+export async function writeMethodReturn(
+ context: GenerateContext,
+ fileStream: FileStream,
+ m: ts.MethodDeclaration | ts.MethodSignature
+) {
+ const returnsDoc = getJsDocTagText(context, m, "returns");
+ if (returnsDoc) {
+ await fileStream.write(`### Returns \n`);
+ await fileStream.write(`${returnsDoc} \n\n`);
+ }
+}
+
+export async function writeMethodParameters(
+ context: GenerateContext,
+ fileStream: FileStream,
+ m: ts.MethodDeclaration | ts.MethodSignature
+) {
+ if (m.parameters.length > 0) {
+ await fileStream.write(`\n\n`);
+
+ for (let i = 0; i < m.parameters.length; i++) {
+ await fileStream.write(
+ ` \n`
+ );
+
+ for (const line of getFullDescription(context, m.parameters[i]).split(
+ "\n"
+ )) {
+ await fileStream.write(` ${line}\n`);
+ }
+
+ await fileStream.write(` \n`);
+ }
+ await fileStream.write(` \n\n`);
+ }
+}
+
+export async function writeMethodSignatures(
+ context: GenerateContext,
+ fileStream: FileStream,
+ m: ts.MethodDeclaration | ts.MethodSignature
+) {
+ const isWebOnly = isTargetWeb(context, m);
+
+ if (!isWebOnly) {
+ await fileStream.writeLine(
+ ``
+ );
+ await fileStream.writeLine(``);
+ }
+
+ const builder = new TypeReferencedCodeBuilder(context);
+ if (m.modifiers) {
+ for (const mod of m.modifiers) {
+ builder.keyword(mod.getText());
+ builder.whitespace(" ");
+ }
+ }
+
+ builder.identifier(m.name.getText());
+ builder.token("(");
+
+ for (let i = 0; i < m.parameters.length; i++) {
+ if (i > 0) {
+ builder.token(",");
+ builder.whitespace(" ");
+ }
+
+ builder.identifier(m.parameters[i].name.getText());
+ if (m.parameters[i].questionToken) {
+ builder.token("?");
+ }
+
+ builder.token(":");
+ builder.whitespace(" ");
+ builder.type(
+ getTypeWithNullableInfo(context, m.parameters[i].type, true, false)
+ );
+
+ if (m.parameters[i].initializer) {
+ builder.whitespace(" ");
+ builder.token("=");
+ builder.whitespace(" ");
+ builder.identifier(m.parameters[i].initializer!.getText());
+ }
+ }
+
+ builder.token(")");
+ builder.token(":");
+ builder.whitespace(" ");
+ builder.type(getTypeWithNullableInfo(context, m.type, true, false));
+
+ await fileStream.writeLine(builder.toMdx("js", "block"));
+
+ if (!isWebOnly) {
+ await fileStream.writeLine(` `);
+ await fileStream.writeLine(``);
+
+ builder.reset();
+ if (m.modifiers) {
+ for (const mod of m.modifiers) {
+ switch (mod.kind) {
+ case ts.SyntaxKind.StaticKeyword:
+ case ts.SyntaxKind.AbstractKeyword:
+ case ts.SyntaxKind.OverrideKeyword:
+ builder.keyword(mod.getText());
+ builder.whitespace(" ");
+ break;
+ }
+ }
+ }
+
+ builder.type(getTypeWithNullableInfo(context, m.type, false, false));
+ builder.whitespace(" ");
+ builder.identifier(toPascalCase(m.name!.getText()));
+ builder.token("(");
+ for (let i = 0; i < m.parameters.length; i++) {
+ if (i > 0) {
+ builder.token(",");
+ builder.whitespace(" ");
+ }
+
+ builder.type(
+ getTypeWithNullableInfo(
+ context,
+ m.parameters[i].type,
+ false,
+ !!m.parameters[i].questionToken
+ )
+ );
+
+ builder.whitespace(" ");
+ builder.identifier(m.parameters[i].name.getText());
+
+ if (m.parameters[i].initializer) {
+ builder.whitespace(" ");
+ builder.token("=");
+ builder.whitespace(" ");
+ builder.identifier(m.parameters[i].initializer!.getText());
+ }
+ }
+ builder.token(")");
+
+ await fileStream.writeLine(builder.toMdx("c#", "block"));
+
+ await fileStream.writeLine(` `);
+ await fileStream.writeLine(``);
+
+ builder.reset();
+
+ if (m.type!.getText().startsWith("Promise<")) {
+ builder.identifier("suspend");
+ builder.whitespace(" ");
+ }
+
+ builder.identifier("fun");
+ builder.whitespace(" ");
+ builder.identifier(m.name!.getText());
+ builder.token("(");
+
+ for (let i = 0; i < m.parameters.length; i++) {
+ if (i > 0) {
+ builder.token(",");
+ builder.whitespace(" ");
+ }
+
+ builder.identifier(m.parameters[i].name.getText());
+ builder.token(":");
+ builder.whitespace(" ");
+ builder.type(
+ getTypeWithNullableInfo(
+ context,
+ m.parameters[i].type,
+ false,
+ !!m.parameters[i].questionToken
+ )
+ );
+ }
+
+ builder.token(")");
+ builder.token(":");
+ builder.whitespace(" ");
+ builder.type(getTypeWithNullableInfo(context, m.type, false, false));
+
+ await fileStream.writeLine(builder.toMdx("kotlin", "block"));
+
+ await fileStream.writeLine(` `);
+ await fileStream.writeLine(` `);
+ }
+
+ await fileStream.writeLine();
+}
+
+export async function writeCommonImports(fileStream: FileStream) {
+ await fileStream.writeLine();
+ await fileStream.writeLine(
+ "import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable';"
+ );
+ await fileStream.writeLine("import CodeBlock from '@theme/CodeBlock';");
+ await fileStream.writeLine('import Tabs from "@theme/Tabs";');
+ await fileStream.writeLine('import TabItem from "@theme/TabItem";');
+ await fileStream.writeLine(
+ "import { CodeBadge } from '@site/src/components/CodeBadge';"
+ );
+ await fileStream.writeLine(
+ "import { SinceBadge } from '@site/src/components/SinceBadge';"
+ );
+ await fileStream.writeLine(
+ "import DynHeading from '@site/src/components/DynHeading';"
+ );
+ await fileStream.writeLine("import Link from '@docusaurus/Link';");
+
+ await fileStream.writeLine();
+}
+
+async function writeCommonDescription(
+ context: GenerateContext,
+ fileStream: FileStream,
+ member: ts.TypeElement | ts.ClassElement
+) {
+ await fileStream.write(`\n### Description\n`);
+ await fileStream.write(`${getFullDescription(context, member)}\n\n`);
+}
+
+export async function writeManualDocs(
+ fileStream: FileStream,
+ member: ts.TypeElement | ts.ClassElement
+) {
+ try {
+ const importFile = path.join(
+ path.dirname(fileStream.path),
+ "_" + member.name!.getText().toLowerCase() + ".mdx"
+ );
+ await fs.promises.access(importFile, fs.constants.R_OK);
+
+ await fileStream.write(
+ `\nimport ManualDocs from './_${member
+ .name!.getText()
+ .toLowerCase()}.mdx';\n`
+ );
+ await fileStream.write("\n");
+ await fileStream.write(`,
+ exportedType: ts.ClassDeclaration | ts.InterfaceDeclaration,
+ collectBase: boolean = true
+) {
+ for (const m of exportedType.members) {
+ if (shouldGenerateMember(context, m) && !members.has(m.name!.getText())) {
+ members.set(m.name!.getText(), m);
+ }
+ }
+
+ const extendsClause = exportedType.heritageClauses?.find(
+ (c) => c.token === ts.SyntaxKind.ExtendsKeyword
+ );
+ if (extendsClause && collectBase) {
+ const symbol = context.checker.getTypeAtLocation(
+ extendsClause.types[0]
+ ).symbol;
+ const baseType = valueOrFirstDeclarationInDts(context, symbol);
+ if (
+ baseType &&
+ (ts.isClassDeclaration(baseType) || ts.isInterfaceDeclaration(baseType))
+ ) {
+ collectMembers(context, members, baseType);
+ } else if (symbol.members) {
+ for (const [_, member] of symbol.members) {
+ const decl = valueOrFirstDeclarationInDts(context, member);
+ if (decl) {
+ if (ts.isClassElement(decl) || ts.isTypeElement(decl)) {
+ if (
+ shouldGenerateMember(context, decl) &&
+ !members.has(decl.name!.getText())
+ ) {
+ members.set(decl.name!.getText(), decl);
+ }
+ }
+ }
+ }
+ }
+ }
+}
+
+async function writePropertySignatures(
+ context: GenerateContext,
+ fileStream: FileStream,
+ m: ts.PropertySignature | ts.PropertyDeclaration | ts.GetAccessorDeclaration
+) {
+ const isWebOnly = isTargetWeb(context, m);
+
+ if (!isWebOnly) {
+ await fileStream.writeLine(
+ ``
+ );
+ await fileStream.writeLine(``);
+ }
+
+ const builder = new TypeReferencedCodeBuilder(context);
+
+ if (m.modifiers) {
+ for (const mod of m.modifiers) {
+ switch (mod.kind) {
+ case ts.SyntaxKind.AccessorKeyword:
+ break;
+ default:
+ builder.keyword(mod.getText());
+ builder.whitespace(" ");
+ break;
+ }
+ }
+ }
+
+ const isReadonlyAccessor =
+ ts.isGetAccessor(m) &&
+ !(m.parent as ts.ClassDeclaration | ts.InterfaceDeclaration).members.some(
+ (p) => ts.isSetAccessor(p) && p.name.getText() === m.name.getText()
+ );
+
+ if (isReadonlyAccessor) {
+ builder.keyword("readonly");
+ builder.whitespace(" ");
+ }
+
+ builder.identifier(m.name.getText());
+ if (m.questionToken) {
+ builder.token("?");
+ }
+ builder.token(":");
+ builder.whitespace(" ");
+ builder.type(getTypeWithNullableInfo(context, m.type, true, false));
+
+ let defaultValue = getJsDocTagText(context, m, "defaultValue");
+ let defaultValueIsCode =
+ defaultValue.startsWith("`") && defaultValue.endsWith("`");
+ if (defaultValueIsCode) {
+ defaultValue = defaultValue.substring(1, defaultValue.length - 1);
+ }
+ if ((m.parent as ts.NamedDeclaration).name!?.getText().endsWith("Json")) {
+ defaultValue = "";
+ }
+
+ if (defaultValue) {
+ builder.whitespace(" ");
+ builder.token("=");
+ builder.whitespace(" ");
+ builder.identifier(defaultValue);
+ }
+
+ builder.token(";");
+
+ await fileStream.writeLine(builder.toMdx("js", "block"));
+
+ if (!isWebOnly) {
+ await fileStream.writeLine(` `);
+ await fileStream.writeLine(``);
+
+ const isReadonly =
+ m.modifiers?.some((mod) => mod.kind === ts.SyntaxKind.ReadonlyKeyword) ||
+ (ts.isGetAccessor(m) &&
+ !(
+ m.parent as ts.ClassDeclaration | ts.InterfaceDeclaration
+ ).members.some(
+ (p) => ts.isSetAccessor(p) && p.name.getText() === m.name.getText()
+ ));
+ const isStatic = m.modifiers?.some(
+ (mod) => mod.kind === ts.SyntaxKind.StaticKeyword
+ );
+ const isAbstract = m.modifiers?.some(
+ (mod) => mod.kind === ts.SyntaxKind.AbstractKeyword
+ );
+
+ builder.reset();
+ if (isStatic) {
+ builder.keyword("static");
+ builder.whitespace(" ");
+ }
+
+ if (isAbstract) {
+ builder.keyword("abstract");
+ builder.whitespace(" ");
+ }
+
+ builder.type(getTypeWithNullableInfo(context, m.type, false, false));
+ builder.whitespace(" ");
+ builder.identifier(toPascalCase(m.name!.getText()));
+ builder.whitespace(" ");
+ builder.token("{");
+ builder.whitespace(" ");
+ builder.keyword("get");
+ builder.token(";");
+ builder.whitespace(" ");
+
+ if (!isReadonly) {
+ builder.keyword("set");
+ builder.token(";");
+ builder.whitespace(" ");
+ }
+
+ builder.token("}");
+
+ if (defaultValue) {
+ builder.whitespace(" ");
+ builder.token("=");
+ builder.whitespace(" ");
+ builder.identifier(defaultValue);
+ }
+
+ await fileStream.writeLine(builder.toMdx("c#", "block"));
+
+ await fileStream.writeLine(` `);
+ await fileStream.writeLine(``);
+
+ builder.reset();
+ if (isStatic) {
+ builder.keyword("companion");
+ builder.whitespace(" ");
+ builder.keyword("object");
+ builder.whitespace(" ");
+ builder.token("{");
+ builder.whitespace(" ");
+ }
+
+ if (isAbstract) {
+ builder.keyword("abstract");
+ builder.whitespace(" ");
+ }
+
+ builder.keyword(isReadonly ? "val" : "var");
+ builder.whitespace(" ");
+ builder.identifier(m.name!.getText());
+ builder.token(":");
+ builder.whitespace(" ");
+ builder.type(getTypeWithNullableInfo(context, m.type, false, false));
+
+ if (defaultValue) {
+ builder.whitespace(" ");
+ builder.token("=");
+ builder.whitespace(" ");
+ builder.identifier(defaultValue);
+ }
+
+ if (isStatic) {
+ builder.whitespace(" ");
+ builder.token("}");
+ }
+
+ await fileStream.writeLine(builder.toMdx("kotlin", "block"));
+
+ await fileStream.writeLine(` `);
+ await fileStream.writeLine(` `);
+ }
+
+ await fileStream.writeLine();
+}
+
+type TypeReferencedCodeLink = { link: string; linkText: string };
+type TypeReferencedCodeToken = {
+ kind: "identifier" | "token" | "keyword" | "whitespace" | "type" | "link";
+ content: string | TypeWithNullableInfo | TypeReferencedCodeLink;
+};
+
+type TypeReferencedCodeLanguage = "js" | "c#" | "kotlin";
+
+export class TypeReferencedCodeBuilder {
+ private chunks: TypeReferencedCodeToken[] = [];
+
+ public constructor(private context: GenerateContext) {}
+
+ public identifier(s: string) {
+ this.chunks.push({ kind: "identifier", content: s });
+ }
+
+ public whitespace(s: string) {
+ this.chunks.push({ kind: "whitespace", content: s });
+ }
+
+ public token(s: string) {
+ this.chunks.push({ kind: "token", content: s });
+ }
+
+ public keyword(s: string) {
+ this.chunks.push({ kind: "keyword", content: s });
+ }
+
+ public type(t: TypeWithNullableInfo) {
+ this.chunks.push({ kind: "type", content: t });
+ }
+
+ public declaration(t: ts.NamedDeclaration, linkText?: string) {
+ linkText ??= t.name?.getText() ?? "UnknownReference";
+
+ const referenceUrl = getDeclarationReferenceUrl(this.context, t as any);
+ if (referenceUrl) {
+ this.chunks.push({
+ kind: "link",
+ content: { link: referenceUrl, linkText },
+ });
+ } else {
+ // cconsole.error(
+ // `Could not resolve setting or declaration link ${linkText} for declaration `,
+ // t
+ // );
+ this.chunks.push({
+ kind: "identifier",
+ content: linkText,
+ });
+ }
+ }
+
+ public settingOrDeclaration(s: ts.Symbol, text: string) {
+ const settingsLink = tryGetSettingsUrl(this.context, s);
+ if (settingsLink) {
+ this.chunks.push({
+ kind: "link",
+ content: { link: settingsLink, linkText: text },
+ });
+ } else {
+ let declaration = valueOrFirstDeclarationInDts(this.context, s);
+ if (declaration) {
+ if (!("name" in declaration)) {
+ cconsole.error("Unsupported declaration type", declaration);
+ return;
+ }
+
+ this.declaration(declaration! as ts.NamedDeclaration);
+ } else {
+ cconsole.error(
+ `Could not resolve setting or declaration link ${text} for symbol `,
+ s
+ );
+ cconsole.warn();
+ this.chunks.push({
+ kind: "identifier",
+ content: text,
+ });
+ }
+ }
+ }
+
+ public reset() {
+ this.chunks = [];
+ }
+
+ public toMdx(
+ language: TypeReferencedCodeLanguage,
+ style: "block" | "inline"
+ ) {
+ // NOTE: no dark theme
+ const theme = prismThemes.github;
+ const lookup = new Map();
+
+ lookup.set("identifier", theme.plain);
+ lookup.set("token", theme.plain);
+ lookup.set("keyword", theme.plain);
+ lookup.set("whitespace", theme.plain);
+
+ for (const styles of theme.styles) {
+ if (styles.types.includes("variable")) {
+ lookup.set("identifier", styles.style);
+ }
+ if (styles.types.includes("punctuation")) {
+ lookup.set("token", styles.style);
+ }
+ if (styles.types.includes("keyword")) {
+ lookup.set("keyword", styles.style);
+ }
+ }
+
+ let code = "";
+
+ switch (style) {
+ case "inline":
+ code += `
{"resources"}{":"}{" "}{"RenderingResources"}{" "}{"="}{" "}{"false"}{";"}{"RenderingResources"}{" "}{"Resources"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}{"var"}{" "}{"resources"}{":"}{" "}{"RenderingResources"}{" "}{"="}{" "}{"false"}- `1.2` - 120%
- `0.8` - 80% -
{"scale"}{":"}{" "}{"number"}{" "}{"="}{" "}{"1.0"}{";"}{"double"}{" "}{"Scale"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"1.0"}{"var"}{" "}{"scale"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"1.0"}{"staffPaddingLeft"}{":"}{" "}{"number"}{" "}{"="}{" "}{"2"}{";"}{"double"}{" "}{"StaffPaddingLeft"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"2"}{"var"}{" "}{"staffPaddingLeft"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"2"}{"startBar"}{":"}{" "}{"number"}{" "}{"="}{" "}{"1"}{";"}{"double"}{" "}{"StartBar"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"1"}{"var"}{" "}{"startBar"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"1"}- `ScoreTab` - Standard music notation and guitar tablature are rendered.
- `Score` - Only standard music notation is rendered.
- `Tab` - Only guitar tablature is rendered.
- `TabMixed` - Only guitar tablature is rendered, but also rests and time signatures are not shown. This profile is typically used in multi-track scenarios.
-
- `scoretab`
- `score`
- `tab`
- `tabmixed` -
- `1` - ScoreTab
- `2` - Score
- `3` - Tab
- `4` - TabMixed -
- `ScoreTab`
- `Score`
- `Tab`
- `TabMixed`
-
- `ScoreTab`
- `Score`
- `Tab`
- `TabMixed`
-
{"Default"} and rather rely on the options available ob {"Staff"} level
-## Default Value
+{"staveProfile"}{":"}{" "}{"StaveProfile"}{" "}{"="}{" "}{"StaveProfile.Default"}{";"}{"StaveProfile"}{" "}{"StaveProfile"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"StaveProfile.Default"}{"var"}{" "}{"staveProfile"}{":"}{" "}{"StaveProfile"}{" "}{"="}{" "}{"StaveProfile.Default"}- `1.5`
- `0.5`
-
{"stretchForce"}{":"}{" "}{"number"}{" "}{"="}{" "}{"1"}{";"}{"double"}{" "}{"StretchForce"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"1"}{"var"}{" "}{"stretchForce"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"1"}{"systemLabelPaddingLeft"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}{"double"}{" "}{"SystemLabelPaddingLeft"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}{"var"}{" "}{"systemLabelPaddingLeft"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}{"systemLabelPaddingRight"}{":"}{" "}{"number"}{" "}{"="}{" "}{"3"}{";"}{"double"}{" "}{"SystemLabelPaddingRight"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"3"}{"var"}{" "}{"systemLabelPaddingRight"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"3"}{"systemPaddingBottom"}{":"}{" "}{"number"}{" "}{"="}{" "}{"20"}{";"}{"double"}{" "}{"SystemPaddingBottom"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"20"}{"var"}{" "}{"systemPaddingBottom"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"20"}{"systemPaddingTop"}{":"}{" "}{"number"}{" "}{"="}{" "}{"10"}{";"}{"double"}{" "}{"SystemPaddingTop"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"10"}{"var"}{" "}{"systemPaddingTop"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"10"}- `UseModelLayout` -
- `usemodellayout` -
- `1` - UseModelLayout -
- `UseModelLayout` -
- `UseModelLayout` -
+
The page layout does not use `displayWidth`. The use of absolute widths would break the proper alignments needed for this kind of display.
-Also note that the sizing is including any glyphs and notation elements within the bar. e.g. if there are clefs in the bar, they are still "squeezed" into the available size.
+Also note that the sizing is including any glyphs and notation elements within the bar. e.g. if there are clefs in the bar, they are still "squeezed" into the available size.
It is not the case that the actual notes with their lengths are sized accordingly. This fits the sizing system of Guitar Pro and when files are customized there,
-alphaTab will match this layout quite close.
+alphaTab will match this layout quite close.
### Horizontal Layout
-The horizontal layout uses the `displayWidth` to scale the bars to size the bars exactly as specified. This kind of sizing and layout can be useful for usecases like:
+The horizontal layout uses the `displayWidth` to scale the bars to size the bars exactly as specified. This kind of sizing and layout can be useful for usecases like:
* Comparing files against each other (top/bottom comparison)
* Aligning the playback of multiple files on one screen assuming the same tempo (e.g. one file per track).
+{"systemsLayoutMode"}{":"}{" "}{"SystemsLayoutMode"}{" "}{"="}{" "}{"1"}{";"}{"SystemsLayoutMode"}{" "}{"SystemsLayoutMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"1"}{"var"}{" "}{"systemsLayoutMode"}{":"}{" "}{"SystemsLayoutMode"}{" "}{"="}{" "}{"1"}{"beatTextAsLyrics"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}{"bool"}{" "}{"BeatTextAsLyrics"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}{"var"}{" "}{"beatTextAsLyrics"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}- `Windows-1252` -
{"encoding"}{":"}{" "}{"string"}{" "}{"="}{" "}{"utf-8"}{";"}{"string"}{" "}{"Encoding"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"utf-8"}{"var"}{" "}{"encoding"}{":"}{" "}{"String"}{" "}{"="}{" "}{"utf-8"}{"mergePartGroupsInMusicXml"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}{"bool"}{" "}{"MergePartGroupsInMusicXml"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}{"var"}{" "}{"mergePartGroupsInMusicXml"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}{"displayTranspositionPitches"}{":"}{" "}{"number"}{"[]"}{" "}{"="}{" "}{"[]"}{";"}{"IList"}{"<"}{"double"}{">"}{" "}{"DisplayTranspositionPitches"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"[]"}{"var"}{" "}{"displayTranspositionPitches"}{":"}{" "}{"alphaTab.collections.DoubleList"}{" "}{"="}{" "}{"[]"}| Element | -Description | -Default Visibility | -
|---|---|---|
| ScoreTitle | -The score title shown at the start of the music sheet. | -visible | -
| ScoreSubTitle | -The score subtitle shown at the start of the music sheet. | -visible | -
| ScoreArtist | -The score artist shown at the start of the music sheet. | -visible | -
| ScoreAlbum | -The score album shown at the start of the music sheet. | -visible | -
| ScoreWords | -The score words author shown at the start of the music sheet. | -visible | -
| ScoreMusic | -The score music author shown at the start of the music sheet. | -visible | -
| ScoreWordsAndMusic | -The score words&music author shown at the start of the music sheet. | -visible | -
| ScoreCopyright | -The score copyright owner shown at the start of the music sheet. | -visible | -
| GuitarTuning | -The tuning information of the guitar shown above the staves. | -visible | -
| TrackNames | -The track names which are shown in the accolade. | -visible | -
| ChordDiagrams | -The chord diagrams for guitars. Usually shown below the score info. | -visible | -
| ParenthesisOnTiedBends | -- Parenthesis that are shown for tied bends if they are preceeded by bends. - | -visible | -
| TabNotesOnTiedBends | -- The tab number for tied notes if the bend of a note is increased at that - point. - | -visible | -
| ZerosOnDiveWhammys | -Zero tab numbers on "dive whammys". | -not visible | -
| EffectAlternateEndings | -The alternate endings information on repeats shown above the staff. | -visible | -
| EffectCapo | -- The information about the fret on which the capo is placed shown above the - staff. - | -visible | -
| EffectChordNames | -The chord names shown above beats shown above the staff. | -visible | -
| EffectCrescendo | -The crescendo/decrescendo angle shown above the staff. | -visible | -
| EffectDynamics | -The beat dynamics shown above the staff. | -visible | -
| EffectFadeIn | -The curved angle for fade in/out effects shown above the staff. | -visible | -
| EffectFermata | -The fermata symbol shown above the staff. | -visible | -
| EffectFingering | -The fingering information. | -visible | -
| EffectHarmonics | -- The harmonics names shown above the staff. (does not represent the harmonic - note heads) - | -visible | -
| EffectLetRing | -The let ring name and line above the staff. | -visible | -
| EffectLyrics | -The lyrics of the track shown above the staff. | -visible | -
| EffectMarker | -The section markers shown above the staff. | -visible | -
| EffectOttavia | -The ottava symbol and lines shown above the staff. | -visible | -
| EffectPalmMute | -The palm mute name and line shown above the staff. | -visible | -
| EffectPickSlide | -- The pick slide information shown above the staff. (does not control the pick - slide lines) - | -visible | -
| EffectPickStroke | -The pick stroke symbols shown above the staff. | -visible | -
| EffectSlightBeatVibrato | -The slight beat vibrato waves shown above the staff. | -visible | -
| EffectSlightNoteVibrato | -The slight note vibrato waves shown above the staff. | -visible | -
| EffectTap | -The tap/slap/pop effect names shown above the staff. | -visible | -
| EffectTempo | -The tempo information shown above the staff. | -visible | -
| EffectText | -The additional beat text shown above the staff. | -visible | -
| EffectTrill | -The trill name and waves shown above the staff. | -visible | -
| EffectTripletFeel | -The triplet feel symbol shown above the staff. | -visible | -
| EffectWhammyBar | -- The whammy bar information shown above the staff. (does not control the - whammy lines shown within the staff) - | -visible | -
| EffectWideBeatVibrato | -The wide beat vibrato waves shown above the staff. | -visible | -
| EffectWideNoteVibrato | -The wide note vibrato waves shown above the staff. | -visible | -
{"elements"}{":"}{" "}{"Map"}{"<"}{"NotationElement"}{","}{" "}{"boolean"}{">"}{" "}{"="}{" "}{"[[NotationElement.ZerosOnDiveWhammys, false]]"}{";"}{"Map"}{"<"}{"NotationElement"}{","}{" "}{"bool"}{">"}{" "}{"Elements"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"[[NotationElement.ZerosOnDiveWhammys, false]]"}{"var"}{" "}{"elements"}{":"}{" "}{"alphaTab.collections.ObjectBooleanMap"}{"<"}{"NotationElement"}{","}{" "}{"Boolean"}{">"}{" "}{"="}{" "}{"[[NotationElement.ZerosOnDiveWhammys, false]]"}{"NotationElement"} enumeration value.
+For JSON input the usual enumeration serialization applies where also the names can be used. The names
+are case insensitive.
```js
const api = new alphaTab.AlphaTabApi(document.querySelector('#alphaTab'), {
@@ -283,24 +66,19 @@ const api = new alphaTab.AlphaTabApi(document.querySelector('#alphaTab'), {
});
api.settings.notation.elements.set(alphaTab.NotationElement.EffectWhammyBar, false);
```
-
{"extendBendArrowsOnTiedNotes"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}{"bool"}{" "}{"ExtendBendArrowsOnTiedNotes"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}{"var"}{" "}{"extendBendArrowsOnTiedNotes"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}{"extendLineEffectsToBeatEnd"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}{"bool"}{" "}{"ExtendLineEffectsToBeatEnd"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}{"var"}{" "}{"extendLineEffectsToBeatEnd"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}- `SingleNoteEffectBand` -
- `effectband` -
- `1` - SingleNoteEffectBand -
- `SingleNoteEffectBand` -
- `SingleNoteEffectBand` -
{"fingeringMode"}{":"}{" "}{"FingeringMode"}{" "}{"="}{" "}{"FingeringMode.ScoreDefault"}{";"}{"FingeringMode"}{" "}{"FingeringMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"FingeringMode.ScoreDefault"}{"var"}{" "}{"fingeringMode"}{":"}{" "}{"FingeringMode"}{" "}{"="}{" "}{"FingeringMode.ScoreDefault"}- `GuitarPro` -
- `GuitarPro` -
- `1` - GuitarPro -
- `GuitarPro` -
- `GuitarPro` -
{"notationMode"}{":"}{" "}{"NotationMode"}{" "}{"="}{" "}{"NotationMode.GuitarPro"}{";"}{"NotationMode"}{" "}{"NotationMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"NotationMode.GuitarPro"}{"var"}{" "}{"notationMode"}{":"}{" "}{"NotationMode"}{" "}{"="}{" "}{"NotationMode.GuitarPro"}{"rhythmMode"} setting to control how high the rhythm notation should be rendered below the tab staff.
-## Default Value
+{"rhythmHeight"}{":"}{" "}{"number"}{" "}{"="}{" "}{"15"}{";"}{"double"}{" "}{"RhythmHeight"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"15"}{"var"}{" "}{"rhythmHeight"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"15"}- `ShowWithBeams` - Rhythm notation is rendered with all beats having individual beams
- `ShowWithBars` - Rhythm notation is rendered with normal bars like on standard notation -
- `showwithbeams`
- `showwithbars` -
- `1` - ShowWithBeams
- `2` - ShowWithBars -
- `ShowWithBeams`
- `ShowWithBars` -
- `ShowWithBeams`
- `ShowWithBars` -
{"rhythmMode"}{":"}{" "}{"TabRhythmMode"}{" "}{"="}{" "}{"TabRhythmMode.Automatic"}{";"}{"TabRhythmMode"}{" "}{"RhythmMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"TabRhythmMode.Automatic"}{"var"}{" "}{"rhythmMode"}{":"}{" "}{"TabRhythmMode"}{" "}{"="}{" "}{"TabRhythmMode.Automatic"}- `14`
- `3.5` -
{"slurHeight"}{":"}{" "}{"number"}{" "}{"="}{" "}{"5"}{";"}{"double"}{" "}{"SlurHeight"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"5"}{"var"}{" "}{"slurHeight"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"5"}{"smallGraceTabNotes"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}{"bool"}{" "}{"SmallGraceTabNotes"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}{"var"}{" "}{"smallGraceTabNotes"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}{"transpositionPitches"}{":"}{" "}{"number"}{"[]"}{" "}{"="}{" "}{"[]"}{";"}{"IList"}{"<"}{"double"}{">"}{" "}{"TranspositionPitches"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"[]"}{"var"}{" "}{"transpositionPitches"}{":"}{" "}{"alphaTab.collections.DoubleList"}{" "}{"="}{" "}{"[]"}- `1000` -
{"bufferTimeInMilliseconds"}{":"}{" "}{"number"}{" "}{"="}{" "}{"500"}{";"}{"double"}{" "}{"BufferTimeInMilliseconds"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"500"}{"var"}{" "}{"bufferTimeInMilliseconds"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"500"}{"enableAnimatedBeatCursor"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}{"bool"}{" "}{"EnableAnimatedBeatCursor"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}{"var"}{" "}{"enableAnimatedBeatCursor"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}{"enableCursor"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}{"bool"}{" "}{"EnableCursor"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}{"var"}{" "}{"enableCursor"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}{"enableElementHighlighting"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}{"bool"}{" "}{"EnableElementHighlighting"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}{"var"}{" "}{"enableElementHighlighting"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}{"enablePlayer"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}{"bool"}{" "}{"EnablePlayer"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}{"var"}{" "}{"enablePlayer"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}{"enableUserInteraction"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}{"bool"}{" "}{"EnableUserInteraction"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}{"var"}{" "}{"enableUserInteraction"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}{"scrollSpeed"} will not have an effect anymore.
-## Default Value
+{"nativeBrowserSmoothScroll"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}- `WebAudioScriptProcessor` - Using the [ScriptProcessorNode](https://developer.mozilla.org/en-US/docs/Web/API/ScriptProcessorNode) for playback
-
- `webaudioscriptprocessor` -
- `1` - WebAudioScriptProcessor
-
{"outputMode"}{":"}{" "}{"PlayerOutputMode"}{" "}{"="}{" "}{"PlayerOutputMode.WebAudioAudioWorklets"}{";"}{"playTripletFeel"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}{"bool"}{" "}{"PlayTripletFeel"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}{"var"}{" "}{"playTripletFeel"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}{"scrollElement"}{":"}{" "}{"string"}{" "}{"|"}{" "}{"HTMLElement"}{" "}{"="}{" "}{"html,body"}{";"}- `Continuous` - Scrolling happens as soon the offsets of the cursors change
- `OffScreen` - Scrolling happens as soon the cursors exceed the displayed range -
- `continuous`
- `offscreen` -
- `1` - Continuous
- `2` - OffScreen -
- `Continuous`
- `OffScreen` -
- `Continuous`
- `OffScreen` -
{"scrollMode"}{":"}{" "}{"ScrollMode"}{" "}{"="}{" "}{"ScrollMode.Continuous"}{";"}{"ScrollMode"}{" "}{"ScrollMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"ScrollMode.Continuous"}{"var"}{" "}{"scrollMode"}{":"}{" "}{"ScrollMode"}{" "}{"="}{" "}{"ScrollMode.Continuous"}- `20` -
{"scrollOffsetX"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}{"double"}{" "}{"ScrollOffsetX"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}{"var"}{" "}{"scrollOffsetX"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}- `20` -
{"scrollOffsetY"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}{"double"}{" "}{"ScrollOffsetY"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}{"var"}{" "}{"scrollOffsetY"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}- `300`
- `100` -
{"nativeBrowserSmoothScroll"} must be set to `false` for this to have an effect.
+
+{"scrollSpeed"}{":"}{" "}{"number"}{" "}{"="}{" "}{"300"}{";"}{"double"}{" "}{"ScrollSpeed"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"300"}{"var"}{" "}{"scrollSpeed"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"300"}-
-
-
| Setting | -Type | -Default | -Summary | -
|---|
{"readonly"}{" "}{"slide"}{":"}{" "}{"SlidePlaybackSettings"}{";"}{"SlidePlaybackSettings"}{" "}{"Slide"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}{"val"}{" "}{"slide"}{":"}{" "}{"SlidePlaybackSettings"}- `120`
- `250` -
{"songBookBendDuration"}{":"}{" "}{"number"}{" "}{"="}{" "}{"75"}{";"}{"double"}{" "}{"SongBookBendDuration"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"75"}{"var"}{" "}{"songBookBendDuration"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"75"}- `120`
- `250` -
{"songBookDipDuration"}{":"}{" "}{"number"}{" "}{"="}{" "}{"150"}{";"}{"double"}{" "}{"SongBookDipDuration"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"150"}{"var"}{" "}{"songBookDipDuration"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"150"}{"soundFont"}{":"}{" "}{"string"}{" "}{"|"}{" "}{"null"}{" "}{"="}{" "}{"null"}{";"}-
-
-
-
| Setting | -Type | -Default | -Summary | -
|---|
{"readonly"}{" "}{"vibrato"}{":"}{" "}{"VibratoPlaybackSettings"}{";"}{"VibratoPlaybackSettings"}{" "}{"Vibrato"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}{"val"}{" "}{"vibrato"}{":"}{" "}{"VibratoPlaybackSettings"}`;
+ break;
+ case "block":
+ code += ``;
+ code += ``;
+ break;
+ }
+
+ const translated = this.translateChunks(this.chunks, language);
+
+ for (const chunk of translated) {
+ switch (chunk.kind) {
+ case "identifier":
+ case "token":
+ case "keyword":
+ case "whitespace":
+ code +=
+ `{` +
+ JSON.stringify(chunk.content as string) +
+ `}`;
+ break;
+
+ // case "type": // rewritten during translateChunks
+ // break;
+ case "link":
+ const link = chunk.content as TypeReferencedCodeLink;
+ code += `{${JSON.stringify(link.linkText)}}`;
+ break;
+ }
+ }
+
+ switch (style) {
+ case "inline":
+ code += "";
+ break;
+ case "block":
+ code += `
`;
+ break;
+ }
+
+ return code;
+ }
+
+ translateChunks(
+ chunks: TypeReferencedCodeToken[],
+ language: TypeReferencedCodeLanguage
+ ): TypeReferencedCodeToken[] {
+ const translated: TypeReferencedCodeToken[] = [];
+
+ for (const chunk of chunks) {
+ switch (chunk.kind) {
+ case "identifier":
+ case "token":
+ case "keyword":
+ case "whitespace":
+ case "link":
+ translated.push(chunk);
+ break;
+ case "type":
+ this.translateType(
+ translated,
+ language,
+ chunk.content as TypeWithNullableInfo
+ );
+ break;
+ }
+ }
+
+ return translated;
+ }
+
+ translateType(
+ tokens: TypeReferencedCodeToken[],
+ language: TypeReferencedCodeLanguage,
+ type: TypeWithNullableInfo
+ ) {
+ if (type.isPrimitiveType) {
+ this.translatePrimitiveType(tokens, language, type);
+ return;
+ }
+
+ if (type.isArray) {
+ this.translateArrayType(tokens, language, type);
+ return;
+ }
+
+ if (type.isUnionType) {
+ this.translateUnionType(tokens, language, type);
+ return;
+ }
+
+ this.translateTypeReference(tokens, language, type);
+ }
+ translateUnionType(
+ tokens: TypeReferencedCodeToken[],
+ language: TypeReferencedCodeLanguage,
+ type: TypeWithNullableInfo
+ ) {
+ switch (language) {
+ case "js":
+ for (let i = 0; i < type.unionTypes!.length; i++) {
+ if (i > 0) {
+ tokens.push({
+ kind: "whitespace",
+ content: " ",
+ });
+ tokens.push({
+ kind: "token",
+ content: "|",
+ });
+ tokens.push({
+ kind: "whitespace",
+ content: " ",
+ });
+ }
+
+ this.translateType(tokens, language, type.unionTypes![i]);
+ }
+ break;
+ case "c#":
+ case "kotlin":
+ cconsole.error(
+ "Requested generation of union type for unsupported language",
+ language,
+ type.fullString
+ );
+ break;
+ }
+ }
+
+ translateTypeReference(
+ tokens: TypeReferencedCodeToken[],
+ language: TypeReferencedCodeLanguage,
+ type: TypeWithNullableInfo
+ ) {
+ const referenceLink = getTypeReferenceUrl(
+ this.context,
+ type,
+ false
+ );
+
+ switch (language) {
+ case "js":
+ if (referenceLink) {
+ tokens.push({
+ kind: "link",
+ content: {
+ link: referenceLink,
+ linkText: type.ownTypeAsString,
+ },
+ });
+ } else {
+ tokens.push({
+ kind: "identifier",
+ content: type.ownTypeAsString,
+ });
+ }
+ break;
+ case "c#":
+ switch (type.ownTypeAsString) {
+ case "void":
+ tokens.push({
+ kind: "keyword",
+ content: "void",
+ });
+ return;
+ case "Error":
+ tokens.push({
+ kind: "link",
+ content: {
+ link: "https://learn.microsoft.com/en-us/dotnet/api/system.exception",
+ linkText: "System.Exception",
+ },
+ });
+ break;
+ case "Promise":
+ tokens.push({
+ kind: "link",
+ content: {
+ link: type.typeArguments
+ ? "https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1"
+ : "https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task",
+ linkText: "System.Threading.Task",
+ },
+ });
+ break;
+ default:
+ if (referenceLink) {
+ tokens.push({
+ kind: "link",
+ content: {
+ link: referenceLink,
+ linkText: toPascalCase(type.ownTypeAsString),
+ },
+ });
+ } else {
+ tokens.push({
+ kind: "identifier",
+ content: toPascalCase(type.ownTypeAsString),
+ });
+ }
+ break;
+ }
+
+ break;
+ case "kotlin":
+ switch (type.ownTypeAsString) {
+ case "void":
+ tokens.push({
+ kind: "identifier",
+ content: "Unit",
+ });
+ return;
+ case "Error":
+ tokens.push({
+ kind: "link",
+ content: {
+ link: "https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-throwable/",
+ linkText: "kotlin.Throwable",
+ },
+ });
+ break;
+ case "Promise":
+ if (!type.typeArguments) {
+ tokens.push({
+ kind: "identifier",
+ content: "Unit",
+ });
+ } else {
+ this.translateType(tokens, language, type.typeArguments[0]);
+ }
+ return;
+ case "Map":
+ if (
+ type.typeArguments![0].isPrimitiveType ||
+ type.typeArguments![1].isPrimitiveType
+ ) {
+ const keyPart = type.typeArguments![0].isPrimitiveType
+ ? this.kotlinPrimitiveType(type.typeArguments![0])
+ : "Object";
+
+ const valuePart = type.typeArguments![1].isPrimitiveType
+ ? this.kotlinPrimitiveType(type.typeArguments![1])
+ : "Object";
+
+ tokens.push({
+ kind: "identifier",
+ content: "alphaTab.collections." + keyPart + valuePart + "Map",
+ });
+ } else {
+ tokens.push({
+ kind: "identifier",
+ content: "alphaTab.collections.Map",
+ });
+ }
+ break;
+ default:
+ if (referenceLink) {
+ tokens.push({
+ kind: "link",
+ content: {
+ link: referenceLink,
+ linkText: type.ownTypeAsString,
+ },
+ });
+ } else {
+ tokens.push({
+ kind: "identifier",
+ content: type.ownTypeAsString,
+ });
+ }
+ break;
+ }
+
+ break;
+ }
+
+ this.translateTypeArguments(tokens, language, type);
+
+ this.translateNullableInfo(tokens, language, type);
+ }
+
+ translateTypeArguments(
+ tokens: TypeReferencedCodeToken[],
+ language: TypeReferencedCodeLanguage,
+ type: TypeWithNullableInfo
+ ) {
+ if (!type.typeArguments) {
+ return;
+ }
+
+ tokens.push({
+ kind: "token",
+ content: "<",
+ });
+
+ for (let i = 0; i < type.typeArguments.length; i++) {
+ if (i > 0) {
+ tokens.push({
+ kind: "token",
+ content: ",",
+ });
+ tokens.push({
+ kind: "whitespace",
+ content: " ",
+ });
+ }
+
+ this.translateType(tokens, language, type.typeArguments[i]);
+ }
+
+ tokens.push({
+ kind: "token",
+ content: ">",
+ });
+ }
+
+ translateArrayType(
+ tokens: TypeReferencedCodeToken[],
+ language: TypeReferencedCodeLanguage,
+ type: TypeWithNullableInfo
+ ) {
+ switch (language) {
+ case "js":
+ this.translateType(tokens, language, type.arrayItemType!);
+ tokens.push({
+ kind: "token",
+ content: "[]",
+ });
+ break;
+ case "c#":
+ tokens.push({
+ kind: "link",
+ content: {
+ linkText: "IList",
+ link:
+ "https://learn.microsoft.com/en-us/dotnet/api/system.collections.ilist",
+ },
+ });
+ tokens.push({
+ kind: "token",
+ content: "<",
+ });
+ this.translateType(tokens, language, type.arrayItemType!);
+ tokens.push({
+ kind: "token",
+ content: ">",
+ });
+
+ break;
+ case "kotlin":
+ if (type.arrayItemType!.isPrimitiveType) {
+ switch (type.arrayItemType!.ownTypeAsString) {
+ case "boolean":
+ tokens.push({
+ kind: "identifier",
+ content: "alphaTab.collections.BooleanList",
+ });
+ break;
+ case "number":
+ tokens.push({
+ kind: "identifier",
+ content: "alphaTab.collections.DoubleList",
+ });
+ break;
+ }
+ } else {
+ tokens.push({
+ kind: "identifier",
+ content: "alphaTab.collections.List",
+ });
+ tokens.push({
+ kind: "token",
+ content: "<",
+ });
+ this.translateType(tokens, language, type.arrayItemType!);
+ tokens.push({
+ kind: "token",
+ content: ">",
+ });
+ }
+ break;
+ }
+
+ this.translateNullableInfo(tokens, language, type);
+ }
+
+ kotlinPrimitiveType(type: TypeWithNullableInfo) {
+ switch (type.ownTypeAsString) {
+ case "number":
+ return "Double";
+ case "string":
+ return "String";
+ case "boolean":
+ return "Boolean";
+ case "BigInt":
+ return "Long";
+ case "unknown":
+ return "Any";
+ }
+ return type.ownTypeAsString;
+ }
+
+ translatePrimitiveType(
+ tokens: TypeReferencedCodeToken[],
+ language: "js" | "c#" | "kotlin",
+ type: TypeWithNullableInfo
+ ) {
+ const referenceLink = getTypeReferenceUrl(this.context, type, false);
+ let name: string = "";
+ switch (language) {
+ case "js":
+ name = type.ownTypeAsString;
+ break;
+ case "c#":
+ switch (type.ownTypeAsString) {
+ case "number":
+ name = "double";
+ break;
+ case "string":
+ name = "string";
+ break;
+ case "boolean":
+ name = "bool";
+ break;
+ case "BigInt":
+ name = "long";
+ break;
+ case "unknown":
+ name = "object";
+ break;
+ }
+ break;
+ case "kotlin":
+ name = this.kotlinPrimitiveType(type);
+ break;
+ }
+
+ if (referenceLink) {
+ tokens.push({
+ kind: "link",
+ content: {
+ link: referenceLink,
+ linkText: name,
+ },
+ });
+ } else {
+ tokens.push({
+ kind: "identifier",
+ content: name,
+ });
+ }
+
+ this.translateNullableInfo(tokens, language, type);
+ }
+
+ translateNullableInfo(
+ tokens: TypeReferencedCodeToken[],
+ language: TypeReferencedCodeLanguage,
+ type: TypeWithNullableInfo
+ ) {
+ switch (language) {
+ case "js":
+ if (type.isOptional) {
+ tokens.push({
+ kind: "whitespace",
+ content: " ",
+ });
+ tokens.push({
+ kind: "token",
+ content: "|",
+ });
+ tokens.push({
+ kind: "whitespace",
+ content: " ",
+ });
+ tokens.push({
+ kind: "keyword",
+ content: "undefined",
+ });
+ }
+ if (type.isNullable) {
+ tokens.push({
+ kind: "whitespace",
+ content: " ",
+ });
+ tokens.push({
+ kind: "token",
+ content: "|",
+ });
+ tokens.push({
+ kind: "whitespace",
+ content: " ",
+ });
+ tokens.push({
+ kind: "keyword",
+ content: "null",
+ });
+ }
+ break;
+ case "c#":
+ if (type.isOptional || type.isNullable) {
+ tokens.push({
+ kind: "token",
+ content: "?",
+ });
+ }
+ break;
+ case "kotlin":
+ if (type.isOptional || type.isNullable) {
+ tokens.push({
+ kind: "token",
+ content: "?",
+ });
+ }
+ break;
+ }
+ }
+}
diff --git a/scripts/generate-settings.mts b/scripts/generate-settings.mts
new file mode 100644
index 000000000..a32a247c9
--- /dev/null
+++ b/scripts/generate-settings.mts
@@ -0,0 +1,108 @@
+import path from "path";
+import fs from "fs";
+import ts from "typescript";
+import {
+ disableWarningsOnMissingDocs,
+ enableWarningsOnMissingDocs,
+ getCategory,
+ getJsDocTagText,
+ getSummary,
+ isDomWildcard,
+ isJsonOnParent,
+ isTargetWeb,
+ repositoryRoot,
+ writeCommonImports,
+ writePropertyDetails,
+} from "./generate-common.mjs";
+import { GenerateContext } from "./typeschema.mjs";
+import { openFileStream } from "./util.mjs";
+
+export async function generateSettings(context: GenerateContext) {
+ enableWarningsOnMissingDocs();
+ try {
+ const allProps = context.settings.members.filter((m) => {
+ const isStatic =
+ ts.canHaveModifiers(m) &&
+ m.modifiers?.some((mod) => mod.kind == ts.SyntaxKind.StaticKeyword);
+
+ return ts.isPropertyDeclaration(m) && !isStatic;
+ }) as ts.PropertyDeclaration[];
+
+ for (const m of allProps) {
+ const basePath = path.join(
+ repositoryRoot,
+ "docs",
+ "reference",
+ "settings",
+ m.name.getText().toLowerCase()
+ );
+
+ const subSettingType =
+ context.checker.getTypeAtLocation(m).symbol.valueDeclaration;
+ if (subSettingType && ts.isClassDeclaration(subSettingType)) {
+ for (const member of subSettingType.members) {
+ const isSubSettingPropStatic =
+ ts.canHaveModifiers(member) &&
+ member.modifiers?.some(
+ (mod) => mod.kind == ts.SyntaxKind.StaticKeyword
+ );
+
+ if (ts.isPropertyDeclaration(member) && !isSubSettingPropStatic) {
+ const settingFile = path.join(
+ basePath,
+ member.name.getText().toLowerCase() + ".mdx"
+ );
+
+ await fs.promises.mkdir(basePath, { recursive: true });
+
+ await using fileStream = await openFileStream(settingFile);
+ await fileStream.write("---\n");
+ await fileStream.write(
+ `title: ${m.name.getText()}.${member.name.getText()}\n`
+ );
+
+ await fileStream.write(
+ `description: ${JSON.stringify(
+ getSummary(context, member, false)
+ )}\n`
+ );
+ await fileStream.write(`sidebar_custom_props:\n`);
+
+ const isWebOnly = isTargetWeb(context, member);
+ if (isWebOnly) {
+ await fileStream.write(` javaScriptOnly: true\n`);
+ }
+
+ if (isDomWildcard(context, member)) {
+ await fileStream.write(` domWildcard: true\n`);
+ }
+
+ if (isJsonOnParent(context, m)) {
+ await fileStream.write(` jsOnParent: true\n`);
+ }
+
+ await fileStream.write(
+ ` category: ${getCategory(context, member, "")}\n`
+ );
+
+ const since = getJsDocTagText(context, member, "since");
+ await fileStream.write(` since: ${since}\n`);
+
+ await fileStream.write("---\n");
+
+ await writeCommonImports(fileStream);
+
+ await fileStream.write(
+ "import { SettingsHeader } from '@site/src/components/SettingsHeader';\n\n"
+ );
+ await fileStream.write(`Description \n\n`
+ );
+ await fileStream.write(`${getFullDescription(context, exportedType)}\n\n`);
+
+ if (
+ ts.isClassDeclaration(exportedType) ||
+ ts.isInterfaceDeclaration(exportedType) ||
+ ts.isTypeAliasDeclaration(exportedType)
+ ) {
+ let definition = new TypeReferencedCodeBuilder(context);
+ if (exportedType.modifiers) {
+ for (const m of exportedType.modifiers) {
+ switch (m.kind) {
+ case ts.SyntaxKind.AbstractKeyword:
+ definition.whitespace(" ");
+ definition.keyword("abstract");
+ break;
+ }
+ }
+ }
+
+ definition.whitespace(" ");
+ if (ts.isClassDeclaration(exportedType)) {
+ definition.keyword("class");
+ } else if (ts.isInterfaceDeclaration(exportedType)) {
+ definition.keyword("interface");
+ } else if (ts.isTypeAliasDeclaration(exportedType)) {
+ definition.keyword("type");
+ }
+ definition.whitespace(" ");
+ definition.identifier(exportedType.name!.getText());
+
+ if (
+ exportedType.typeParameters &&
+ exportedType.typeParameters.length > 0
+ ) {
+ definition.token("<");
+
+ for (let i = 0; i < exportedType.typeParameters.length; i++) {
+ if (i > 0) {
+ definition.token(",");
+ definition.whitespace(" ");
+ }
+
+ definition.identifier(exportedType.typeParameters[i].name.getText());
+ }
+
+ definition.token(">");
+ }
+
+ if (ts.isTypeAliasDeclaration(exportedType)) {
+ definition.whitespace(" ");
+ definition.token("=");
+ definition.whitespace(" ");
+ definition.type(
+ getTypeWithNullableInfo(context, exportedType.type, true, false)
+ );
+ } else if (exportedType.heritageClauses) {
+ for (const clause of exportedType.heritageClauses) {
+ switch (clause.token) {
+ case ts.SyntaxKind.ExtendsKeyword:
+ definition.whitespace(" ");
+ definition.keyword("extends");
+ break;
+ case ts.SyntaxKind.ImplementsKeyword:
+ definition.whitespace(" ");
+ definition.keyword("implements");
+ break;
+ }
+
+ definition.whitespace(" ");
+
+ for (const type of clause.types) {
+ definition.type(
+ getTypeWithNullableInfo(context, type, true, false)
+ );
+ }
+ }
+ }
+
+ await fileStream.writeLine(definition.toMdx("js", 'block'));
+
+ const properties: (
+ | ts.PropertyDeclaration
+ | ts.PropertySignature
+ | ts.GetAccessorDeclaration
+ )[] = [];
+
+ const events: (
+ | ts.PropertyDeclaration
+ | ts.PropertySignature
+ | ts.GetAccessorDeclaration
+ )[] = [];
+
+ const methods: (ts.MethodDeclaration | ts.MethodSignature)[] = [];
+
+ const members: Map = new Map();
+ if (!ts.isTypeAliasDeclaration(exportedType)) {
+ collectMembers(context, members, exportedType);
+
+ const sortedMembers = Array.from(members.values()).sort((a, b) => {
+ return a.name!.getText().localeCompare(b.name!.getText());
+ });
+
+ for (const m of sortedMembers) {
+ if (isEvent(context, m)) {
+ events.push(m as (typeof events)[0]);
+ } else if (
+ ts.isPropertyDeclaration(m) ||
+ ts.isPropertySignature(m) ||
+ ts.isGetAccessorDeclaration(m)
+ ) {
+ properties.push(m);
+ } else if (ts.isMethodDeclaration(m) || ts.isMethodSignature(m)) {
+ methods.push(m);
+ }
+ }
+
+ await writeProperties(
+ context,
+ fileStream,
+ basePath,
+ exportedType,
+ properties
+ );
+ await writeMethods(
+ context,
+ fileStream,
+ basePath,
+ exportedType,
+ methods
+ );
+ await writeEvents(context, fileStream, basePath, exportedType, events);
+ }
+ } else if (ts.isEnumDeclaration(exportedType)) {
+ await writeEnumMembers(context, fileStream, exportedType);
+ }
+ }
+}
+
+async function writeProperties(
+ context: GenerateContext,
+ fileStream: FileStream,
+ basePath: string,
+ parent: ts.ClassDeclaration | ts.InterfaceDeclaration,
+ properties: (
+ | ts.PropertyDeclaration
+ | ts.PropertySignature
+ | ts.GetAccessorDeclaration
+ )[]
+) {
+ if (properties.length === 0) {
+ return;
+ }
+
+ await fileStream.write(
+ `\nProperties \n\n`
+ );
+
+ await fileStream.write(
+ `\n`
+ );
+ await fileStream.write(` \n`);
+
+ for (const member of properties) {
+ await fileStream.write(` \n`);
+
+ const referenceBuilder = new TypeReferencedCodeBuilder(context);
+ referenceBuilder.declaration(member);
+ await fileStream.write(
+ ` ${referenceBuilder.toMdx("js", "inline")} \n`
+ );
+
+ referenceBuilder.reset();
+ referenceBuilder.type(
+ getTypeWithNullableInfo(
+ context,
+ member.type,
+ true,
+ !!member.questionToken
+ )
+ );
+
+ await fileStream.writeLine(
+ ` {props.detailed && (${referenceBuilder.toMdx("js", "inline")} )}`
+ );
+
+ let defaultValue = getJsDocTagText(context, member, "defaultValue");
+ if (!defaultValue) {
+ defaultValue = "(no default)";
+ }
+ await fileStream.writeLine(
+ ` {props.detailed && {${JSON.stringify(defaultValue)}}\n`);
+ await fileStream.write(
+ `${description
+ .split("\n")
+ .map((l) => ` ${l}`)
+ .join("\n")}\n`
+ );
+ await fileStream.write(` \n`);
+
+ await fileStream.write(` \n`);
+
+ await writePropertyPage(context, basePath, member);
+ }
+ await fileStream.write(` \n`);
+ await fileStream.write(`
\n`);
+}
+
+async function writeMethods(
+ context: GenerateContext,
+ fileStream: FileStream,
+ basePath: string,
+ parent: ts.ClassDeclaration | ts.InterfaceDeclaration,
+ methods: (ts.MethodDeclaration | ts.MethodSignature)[]
+) {
+ if (methods.length === 0) {
+ return;
+ }
+
+ await fileStream.write(
+ `\nMethods \n\n`
+ );
+
+ await fileStream.write(
+ `\n`
+ );
+ await fileStream.write(` \n`);
+
+ for (const member of methods) {
+ await fileStream.write(` \n`);
+
+ const parameters = member.parameters
+ .map((p) => p.type!.getText())
+ .join(", ");
+ await fileStream.write(
+ ` [\`${member.name.getText()}(${parameters})\`](./${member.name
+ .getText()
+ .toLowerCase()}.mdx) \n`
+ );
+
+ let description =
+ getSummary(context, member, true, true) +
+ getInheritenceInfo(context, parent, member);
+ await fileStream.write(` \n`);
+ await fileStream.write(
+ `${description
+ .split("\n")
+ .map((l) => ` ${l}`)
+ .join("\n")}\n`
+ );
+ await fileStream.write(` \n`);
+
+ await fileStream.write(` \n`);
+
+ await writeMethodPage(context, basePath, member);
+ }
+ await fileStream.write(` \n`);
+ await fileStream.write(`
\n`);
+}
+
+async function writeEvents(
+ context: GenerateContext,
+ fileStream: FileStream,
+ basePath: string,
+ parent: ts.ClassDeclaration | ts.InterfaceDeclaration,
+ events: (
+ | ts.PropertyDeclaration
+ | ts.PropertySignature
+ | ts.GetAccessorDeclaration
+ )[]
+) {
+ if (events.length === 0) {
+ return;
+ }
+
+ await fileStream.write(
+ `\nEvents \n\n`
+ );
+
+ await fileStream.write(
+ `\n`
+ );
+ await fileStream.write(` \n`);
+
+ for (const member of events) {
+ await fileStream.write(` \n`);
+
+ await fileStream.write(
+ ` [\`${member.name.getText()}\`](./${member.name
+ .getText()
+ .toLowerCase()}.mdx) \n`
+ );
+
+ let description =
+ getSummary(context, member, true, true) +
+ getInheritenceInfo(context, parent, member);
+ await fileStream.write(` \n`);
+ await fileStream.write(
+ `${description
+ .split("\n")
+ .map((l) => ` ${l}`)
+ .join("\n")}\n`
+ );
+ await fileStream.write(` \n`);
+
+ await fileStream.write(` \n`);
+
+ await writeEventPage(context, basePath, member);
+ }
+ await fileStream.write(` \n`);
+ await fileStream.write(`
\n`);
+}
+
+async function writeEnumMembers(
+ context: GenerateContext,
+ fileStream: FileStream,
+ exportedType: ts.EnumDeclaration
+) {
+ await fileStream.write(
+ `\nEnum Members \n\n`
+ );
+
+ await fileStream.write(
+ `\n`
+ );
+ await fileStream.write(
+ ` Name Numeric Value Description \n`);
+
+ await fileStream.write(
+ ` \`${member.name.getText()}\` \n`
+ );
+
+ const numericValue = context.checker.getConstantValue(member);
+ await fileStream.write(` \`${numericValue}\` \n`);
+
+ let description = getFullDescription(context, member);
+ const since = getJsDocTagText(context, member, "since");
+ if (since) {
+ description = `${description}\n \n`);
+ await fileStream.write(
+ `${description
+ .split("\n")
+ .map((l) => ` ${l}`)
+ .join("\n")}\n`
+ );
+ await fileStream.write(` \n`);
+
+ await fileStream.write(` \n`);
+ }
+ await fileStream.write(` \n`);
+ await fileStream.write(`
\n`);
+}
+
+async function writeFrontMatter(
+ context: GenerateContext,
+ fileStream: FileStream,
+ memberName: string,
+ member: ts.ClassElement | ts.TypeElement,
+ kind: string
+) {
+ await fileStream.write("---\n");
+ await fileStream.write(`title: ${memberName}\n`);
+ await fileStream.write(`sidebar_custom_props:\n`);
+ await fileStream.write(` kind: ${kind}\n`);
+
+ const since = getJsDocTagText(context, member, "since");
+ if (since) {
+ await fileStream.write(` since: ${since}\n`);
+ }
+
+ await fileStream.write("---\n");
+
+ await writeCommonImports(fileStream);
+
+ if (since) {
+ await fileStream.write(`;
+ flatExports: Map;
+};
+
+export type TypeWithNullableInfo = {
+ readonly symbol: ts.Symbol | undefined;
+ readonly isNullable: boolean;
+ readonly isOptional: boolean;
+ readonly isUnionType: boolean;
+ readonly isPrimitiveType: boolean;
+ readonly isEnumType: boolean;
+ readonly isOwnType: boolean;
+ readonly isTypedArray: boolean;
+ readonly ownTypeAsString: string;
+ readonly fullString: string;
+ readonly isArray: boolean;
+ readonly isTypeLiteral: boolean;
+ readonly isFunctionType: boolean;
+ readonly arrayItemType?: TypeWithNullableInfo;
+ readonly typeArguments?: readonly TypeWithNullableInfo[];
+ readonly unionTypes?: readonly TypeWithNullableInfo[];
+};
+
+type Writeable = { -readonly [P in keyof T]: T[P] };
+
+export function findModule(type: ts.Type) {
+ const symbol = type.getSymbol() ?? type.aliasSymbol;
+
+ if (symbol && symbol.declarations) {
+ for (const decl of symbol.declarations) {
+ const file = decl.getSourceFile();
+ if (file) {
+ const relative = path.relative(
+ repositoryRoot,
+ path.resolve(file.fileName)
+ );
+ return relative;
+ }
+ }
+
+ return "./" + symbol.name;
+ }
+
+ return "";
+}
+
+export function getTypeWithNullableInfo(
+ context: GenerateContext,
+ node: ts.TypeNode | ts.ExpressionWithTypeArguments | undefined,
+ allowUnion: boolean,
+ isOptionalFromDeclaration: boolean
+): TypeWithNullableInfo {
+ if (!node) {
+ return {
+ isNullable: false,
+ isOptional: isOptionalFromDeclaration,
+ isUnionType: false,
+ isPrimitiveType: false,
+ isEnumType: false,
+ isTypedArray: false,
+ isOwnType: false,
+ fullString: "unknown",
+ ownTypeAsString: "unknown",
+ isArray: false,
+ symbol: context.checker.getUnknownType().getSymbol(),
+ isTypeLiteral: false,
+ isFunctionType: false,
+ };
+ }
+
+ let typeInfo: Writeable = {
+ isNullable: false,
+ isOptional: isOptionalFromDeclaration,
+ isUnionType: false,
+ isPrimitiveType: false,
+ isEnumType: false,
+ isTypedArray: false,
+ isOwnType: false,
+ fullString: node.getText(),
+ ownTypeAsString: "",
+ isArray: false,
+ symbol: null!,
+ isTypeLiteral: false,
+ isFunctionType: false,
+ };
+ let mainTypeNode: ts.TypeNode | undefined;
+
+ const fillBaseInfoFrom = (typeNode: ts.TypeNode) => {
+ const type = context.checker.getTypeFromTypeNode(typeNode);
+ typeInfo.symbol = type.getSymbol() ?? type.aliasSymbol;
+ typeInfo.ownTypeAsString = typeNode.getText();
+
+ const modulePath = findModule(type);
+ typeInfo.isOwnType =
+ !!modulePath && path.basename(modulePath) === path.basename(context.dts);
+
+ typeInfo.isTypeLiteral = ts.isTypeLiteralNode(typeNode);
+ typeInfo.isFunctionType = ts.isFunctionTypeNode(typeNode);
+
+ if (ts.isTypeReferenceNode(typeNode) && typeNode.typeArguments) {
+ typeInfo.typeArguments = typeNode.typeArguments.map((p) =>
+ getTypeWithNullableInfo(context, p, allowUnion, false)
+ );
+
+ // cut off generics on name
+ const genericsStart = typeInfo.ownTypeAsString.indexOf("<");
+ if (genericsStart >= 0) {
+ typeInfo.ownTypeAsString = typeInfo.ownTypeAsString
+ .substring(0, genericsStart)
+ .trim();
+ }
+ }
+
+ if (isEnumType(type)) {
+ typeInfo.isEnumType = true;
+ } else if (isPrimitiveType(type)) {
+ typeInfo.isPrimitiveType = true;
+ } else if (context.checker.isArrayType(type)) {
+ typeInfo.isArray = true;
+
+ if (typeInfo.typeArguments) {
+ typeInfo.arrayItemType = typeInfo.typeArguments[0];
+ } else if (ts.isArrayTypeNode(typeNode)) {
+ typeInfo.arrayItemType = getTypeWithNullableInfo(
+ context,
+ typeNode.elementType,
+ allowUnion,
+ false
+ );
+ }
+ } else if (typeInfo.symbol) {
+ switch (typeInfo.symbol.name) {
+ case "Uint8Array":
+ case "Uint16Array":
+ case "Uint32Array":
+ case "Int8Array":
+ case "Int16Array":
+ case "Int32Array":
+ case "Float32Array":
+ case "Float64Array":
+ typeInfo.isTypedArray = true;
+ typeInfo.arrayItemType = {
+ fullString: "number",
+ isArray: false,
+ isEnumType: false,
+ isNullable: false,
+ isOptional: false,
+ isOwnType: false,
+ isPrimitiveType: false,
+ isTypedArray: true,
+ isUnionType: false,
+ ownTypeAsString: "number",
+ symbol: context.checker.getNumberType().getSymbol(),
+ isTypeLiteral: false,
+ isFunctionType: false,
+ };
+ break;
+ }
+ }
+ };
+
+ if (ts.isUnionTypeNode(node)) {
+ for (const t of node.types) {
+ if (t.kind === ts.SyntaxKind.NullKeyword) {
+ typeInfo.isNullable = true;
+ } else if (
+ ts.isLiteralTypeNode(t) &&
+ t.literal.kind === ts.SyntaxKind.NullKeyword
+ ) {
+ typeInfo.isNullable = true;
+ } else if (t.kind === ts.SyntaxKind.UndefinedKeyword) {
+ typeInfo.isOptional = true;
+ } else if (
+ ts.isLiteralTypeNode(t) &&
+ t.literal.kind === ts.SyntaxKind.UndefinedKeyword
+ ) {
+ typeInfo.isOptional = true;
+ } else if (!mainTypeNode) {
+ mainTypeNode = t;
+ } else if (allowUnion) {
+ if (!typeInfo.unionTypes) {
+ typeInfo.unionTypes = [
+ getTypeWithNullableInfo(context, mainTypeNode!, false, false),
+ ];
+ }
+
+ typeInfo.isUnionType = true;
+
+ (typeInfo.unionTypes as TypeWithNullableInfo[]).push(
+ getTypeWithNullableInfo(context, t, false, false)
+ );
+ } else {
+ throw new Error(
+ "Multi union types on not supported at this location: " +
+ node.getSourceFile().fileName +
+ ":" +
+ node.getText()
+ );
+ }
+ }
+
+ if (!typeInfo.unionTypes && mainTypeNode) {
+ fillBaseInfoFrom(mainTypeNode);
+ }
+ } else if (ts.isExpressionWithTypeArguments(node)) {
+ const type = context.checker.getTypeAtLocation(node);
+ typeInfo.symbol = type.getSymbol();
+ typeInfo.ownTypeAsString = node.expression.getText();
+ const modulePath = findModule(type);
+ typeInfo.isOwnType =
+ !!modulePath && path.basename(modulePath) === path.basename(context.dts);
+
+ if (node.typeArguments) {
+ typeInfo.typeArguments = node.typeArguments.map((p) =>
+ getTypeWithNullableInfo(context, p, allowUnion, false)
+ );
+
+ // cut off generics on name
+ const genericsStart = typeInfo.ownTypeAsString.indexOf("<");
+ if (genericsStart >= 0) {
+ typeInfo.ownTypeAsString = typeInfo.ownTypeAsString
+ .substring(0, genericsStart)
+ .trim();
+ }
+ }
+ } else {
+ fillBaseInfoFrom(node);
+ }
+
+ return typeInfo;
+}
+
+function isEnumType(type: ts.Type) {
+ // if for some reason this returns true...
+ if (hasFlag(type, ts.TypeFlags.Enum)) return true;
+ // it's not an enum type if it's an enum literal type
+ if (hasFlag(type, ts.TypeFlags.EnumLiteral)) return true;
+ // get the symbol and check if its value declaration is an enum declaration
+ const symbol = type.getSymbol();
+ if (!symbol) return false;
+ const { valueDeclaration } = symbol;
+
+ return (
+ valueDeclaration && valueDeclaration.kind === ts.SyntaxKind.EnumDeclaration
+ );
+}
+
+function hasFlag(type: ts.Type, flag: ts.TypeFlags): boolean {
+ return (type.flags & flag) === flag;
+}
+
+function isPrimitiveType(type: ts.Type | null) {
+ if (!type) {
+ return false;
+ }
+
+ if (hasFlag(type, ts.TypeFlags.Number)) {
+ return true;
+ }
+ if (hasFlag(type, ts.TypeFlags.String)) {
+ return true;
+ }
+ if (hasFlag(type, ts.TypeFlags.Boolean)) {
+ return true;
+ }
+ if (hasFlag(type, ts.TypeFlags.BigInt)) {
+ return true;
+ }
+ if (hasFlag(type, ts.TypeFlags.Unknown)) {
+ return true;
+ }
+
+ return false;
+}
+
+function isNumberType(type: ts.Type | null) {
+ if (!type) {
+ return false;
+ }
+
+ if (hasFlag(type, ts.TypeFlags.Number)) {
+ return true;
+ }
+
+ return false;
+}
+
+export function valueOrFirstDeclarationInDts(
+ context: GenerateContext,
+ s: ts.Symbol,
+ errorNode: ts.Node
+): ts.Declaration;
+export function valueOrFirstDeclarationInDts(
+ context: GenerateContext,
+ s: ts.Symbol
+): ts.Declaration | undefined;
+export function valueOrFirstDeclarationInDts(
+ context: GenerateContext,
+ s: ts.Symbol | undefined,
+ errorNode?: ts.Node
+) {
+ if (!s) {
+ return undefined;
+ }
+
+ if (s.valueDeclaration) {
+ return s.valueDeclaration;
+ }
+
+ const d = s.declarations?.find(
+ (d) =>
+ path.basename(d.getSourceFile().fileName) == path.basename(context.dts)
+ );
+ if (d) {
+ return d;
+ }
+
+ if (errorNode) {
+ throw new Error(
+ "Could not resolve declarataion of symbol " +
+ s.name +
+ " at " +
+ errorNode.getSourceFile().fileName +
+ ":" +
+ errorNode.getSourceFile().getLineAndCharacterOfPosition(errorNode.pos)
+ );
+ }
+
+ return undefined;
+}
diff --git a/scripts/util.mts b/scripts/util.mts
new file mode 100644
index 000000000..616ef6fc1
--- /dev/null
+++ b/scripts/util.mts
@@ -0,0 +1,43 @@
+import fs from "fs";
+
+export interface FileStream extends AsyncDisposable {
+ readonly path: string;
+ write(s: string): Promise;
+ writeLine(s?: string): Promise;
+}
+
+export async function openFileStream(path: string): Promise {
+ const fileStream = await fs.promises.open(path, "w");
+
+ const write = async (s: string) => {
+ await fileStream.write(s);
+ };
+ const writeLine = (s?: string) => {
+ if (s) {
+ return write(s + "\n");
+ } else {
+ return write("\n");
+ }
+ };
+ const asyncDispose = async () => {
+ await fileStream.close();
+ };
+
+ return {
+ path,
+ write,
+ writeLine,
+ [Symbol.asyncDispose]: asyncDispose,
+ };
+}
+
+export function toPascalCase(v: string | string[]) {
+ if (typeof v === "string") {
+ var parts = v.split(".");
+ for (let i = 0; i < parts.length; i++) {
+ parts[i] = parts[i].slice(0, 1).toUpperCase() + parts[i].slice(1);
+ }
+ return parts.join(".");
+ }
+ return v.map(toPascalCase);
+}
\ No newline at end of file
diff --git a/sidebars.ts b/sidebars.ts
index 4dda4fb5c..c212494a6 100644
--- a/sidebars.ts
+++ b/sidebars.ts
@@ -30,15 +30,16 @@ const sidebars: SidebarsConfig = {
"getting-started/configuration-android",
],
Guides: [
- "guides/lowlevel-apis",
- "guides/styling-player",
- "guides/multiple-soundfonts",
- "guides/song-details",
- "guides/exporter",
- "guides/handling-midi-events",
- "guides/nodejs",
- "guides/breaking-changes-095-096",
- "guides/breaking-changes-097-098",
+ {
+ type: "autogenerated",
+ dirName: 'guides',
+ customProps: {
+ sort: [
+ ['order', 'asc'],
+ ['title', 'asc']
+ ]
+ }
+ }
],
"API Reference": [
{
@@ -82,35 +83,16 @@ const sidebars: SidebarsConfig = {
},
{
type: "category",
- label: "ScoreRenderer",
- link: {
- type: "doc",
- id: "reference/scorerenderer",
- },
- className: "reference-item",
- collapsible: false,
- collapsed: true,
- items: [
- {
- type: "autogenerated",
- dirName: "reference/scorerenderer",
- },
- ],
- },
- {
- type: "category",
- label: "AlphaSynth",
+ label: "All Types",
+ className: "types-item",
link: {
type: "doc",
- id: "reference/alphasynth",
+ id: "reference/types",
},
- className: "reference-item",
- collapsible: false,
- collapsed: true,
items: [
{
type: "autogenerated",
- dirName: "reference/alphasynth",
+ dirName: "reference/types",
},
],
},
diff --git a/src/components/AlphaTexSample/index.tsx b/src/components/AlphaTexSample/index.tsx
index dc8cba505..d1aae88e6 100644
--- a/src/components/AlphaTexSample/index.tsx
+++ b/src/components/AlphaTexSample/index.tsx
@@ -17,8 +17,6 @@ export const AlphaTexSample: React.FC = ({
player,
settings,
}) => {
- const doc = useDoc();
- debugger;
return (
<>
diff --git a/src/components/CodeBadge/index.tsx b/src/components/CodeBadge/index.tsx
index 50cc05053..eaddbaacf 100644
--- a/src/components/CodeBadge/index.tsx
+++ b/src/components/CodeBadge/index.tsx
@@ -1,5 +1,6 @@
import React from "react";
import styles from "./styles.module.scss";
+import Link from "@docusaurus/Link";
export type Platform =
| "all"
@@ -19,14 +20,15 @@ export type Platform =
export type CodeBadgeProps = {
type?: Platform;
name?: string;
+ link?: string;
};
-export const CodeBadge: React.FC = ({ type, name }) => {
+export const CodeBadge: React.FC = ({ type, name, link }) => {
if (!name) {
return <>;
}
- type ??= 'all';
+ type ??= "all";
let title: string = type;
let typeStyle = styles[type];
@@ -79,10 +81,22 @@ export const CodeBadge: React.FC = ({ type, name }) => {
break;
}
const css = `${styles["code-badge"]} ${typeStyle}`;
- return (
-
- {name}
- {title}
-
- );
+
+ if (link) {
+ return (
+
+
+ {name}
+ {title}
+
+
+ );
+ } else {
+ return (
+
+ {name}
+ {title}
+
+ );
+ }
};
diff --git a/src/components/ColoringExample/index.tsx b/src/components/ColoringExample/index.tsx
new file mode 100644
index 000000000..2c5b530e0
--- /dev/null
+++ b/src/components/ColoringExample/index.tsx
@@ -0,0 +1,164 @@
+import { useAlphaTab, useAlphaTabEvent } from "@site/src/hooks";
+import react, { useEffect } from "react";
+import * as alphaTab from "@coderline/alphatab";
+import CodeBlock from "@theme/CodeBlock";
+
+export const ColoringExample: react.FC = () => {
+ const tex = `
+ \\title "Canon Rock"
+ \\artist "JerryC"
+ \\tempo 90
+ .
+ 12.2{v f} 14.2{v f}.4 :8 15.2 17.2 |
+ 14.1.2 :8 17.2 15.1 14.1{h} 17.2 |
+ 15.2{v d}.4 :16 17.2{h} 15.2 :8 14.2 14.1 17.1{b (0 4 4 0)}.4 |
+ 15.1.8 :16 14.1{tu 3} 15.1{tu 3} 14.1{tu 3} :8 17.2 15.1 14.1 :16 12.1{tu 3} 14.1{tu 3} 12.1{tu 3} :8 15.2 14.2
+ `;
+ const [api, element] = useAlphaTab((s) => {});
+
+ function applyColors(score: alphaTab.model.Score) {
+ // create custom style on score level
+ score.style = new alphaTab.model.ScoreStyle();
+ score.style.colors.set(
+ alphaTab.model.ScoreSubElement.Title,
+ alphaTab.model.Color.fromJson("#426d9d")
+ );
+ score.style.colors.set(
+ alphaTab.model.ScoreSubElement.Artist,
+ alphaTab.model.Color.fromJson("#4cb3d4")
+ );
+
+ const fretColors = {
+ 12: alphaTab.model.Color.fromJson("#bb4648"),
+ 13: alphaTab.model.Color.fromJson("#ab519f"),
+ 14: alphaTab.model.Color.fromJson("#3953a5"),
+ 15: alphaTab.model.Color.fromJson("#70ccd6"),
+ 16: alphaTab.model.Color.fromJson("#6abd45"),
+ 17: alphaTab.model.Color.fromJson("#e1a90e")
+ };
+
+ // traverse hierarchy and apply colors as desired
+ for (const track of score.tracks) {
+ for (const staff of track.staves) {
+ for (const bar of staff.bars) {
+ for (const voice of bar.voices) {
+ for (const beat of voice.beats) {
+ // on tuplets colors beam and tuplet bracket
+ if (beat.hasTuplet) {
+ beat.style = new alphaTab.model.BeatStyle();
+ const color = alphaTab.model.Color.fromJson("#00DD00");
+ beat.style.colors.set(
+ alphaTab.model.BeatSubElement.StandardNotationTuplet,
+ color
+ );
+ beat.style.colors.set(
+ alphaTab.model.BeatSubElement.StandardNotationBeams,
+ color
+ );
+ }
+
+ for (const note of beat.notes) {
+ // color notes based on the fret
+ note.style = new alphaTab.model.NoteStyle();
+ note.style.colors.set(alphaTab.model.NoteSubElement.StandardNotationNoteHead,
+ fretColors[note.fret]
+ );
+ note.style.colors.set(alphaTab.model.NoteSubElement.GuitarTabFretNumber,
+ fretColors[note.fret]
+ );
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+
+ const codeLines = `
+ const api = new alphaTab.AlphaTabApi(...);
+ api.scoreLoaded.on(score => applyColors(score));
+ function applyColors(score) {
+ // create custom style on score level
+ score.style = new alphaTab.model.ScoreStyle();
+ score.style.colors.set(
+ alphaTab.model.ScoreSubElement.Title,
+ alphaTab.model.Color.fromJson("#426d9d")
+ );
+ score.style.colors.set(
+ alphaTab.model.ScoreSubElement.Artist,
+ alphaTab.model.Color.fromJson("#4cb3d4")
+ );
+
+ const fretColors = {
+ 12: alphaTab.model.Color.fromJson("#bb4648"),
+ 13: alphaTab.model.Color.fromJson("#ab519f"),
+ 14: alphaTab.model.Color.fromJson("#3953a5"),
+ 15: alphaTab.model.Color.fromJson("#70ccd6"),
+ 16: alphaTab.model.Color.fromJson("#6abd45"),
+ 17: alphaTab.model.Color.fromJson("#e1a90e")
+ };
+
+ // traverse hierarchy and apply colors as desired
+ for (const track of score.tracks) {
+ for (const staff of track.staves) {
+ for (const bar of staff.bars) {
+ for (const voice of bar.voices) {
+ for (const beat of voice.beats) {
+ // on tuplets colors beam and tuplet bracket
+ if (beat.hasTuplet) {
+ beat.style = new alphaTab.model.BeatStyle();
+ const color = alphaTab.model.Color.fromJson("#00DD00");
+ beat.style.colors.set(
+ alphaTab.model.BeatSubElement.StandardNotationTuplet,
+ color
+ );
+ beat.style.colors.set(
+ alphaTab.model.BeatSubElement.StandardNotationBeams,
+ color
+ );
+ }
+
+ for (const note of beat.notes) {
+ // color notes based on the fret
+ note.style = new alphaTab.model.NoteStyle();
+ note.style.colors.set(alphaTab.model.NoteSubElement.StandardNotationNoteHead,
+ fretColors[note.fret]
+ );
+ note.style.colors.set(alphaTab.model.NoteSubElement.GuitarTabFretNumber,
+ fretColors[note.fret]
+ );
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+
+ `.split("\n");
+
+ const indent =
+ codeLines.find((l) => l.length > 0)?.match(/^([ ]+).*/)?.[1]?.length ?? 0;
+
+ const trimmed = codeLines
+ .map((l) => l.substring(indent))
+ .join("\n")
+ .trim();
+
+ useEffect(() => {
+ if (api) {
+ const score = alphaTab.importer.ScoreLoader.loadScoreFromBytes(
+ new TextEncoder().encode(tex)
+ );
+ applyColors(score);
+ api.renderScore(score, [0]);
+ }
+ }, [api]);
+
+ return (
+
+
+ {trimmed}
+
+ );
+};
diff --git a/src/components/DynHeading/index.tsx b/src/components/DynHeading/index.tsx
new file mode 100644
index 000000000..a17d2a16a
--- /dev/null
+++ b/src/components/DynHeading/index.tsx
@@ -0,0 +1,36 @@
+import React from "react";
+
+import Heading, { type Props } from "@theme/Heading";
+
+export type DynHeadingProps = Props & {
+ inlined?: boolean;
+};
+
+export const DynHeading: React.FC = (props) => {
+ const { inlined, ...headingProps } = props;
+
+ if (inlined) {
+ switch (headingProps.as) {
+ case "h1":
+ headingProps.as = "h2";
+ break;
+ case "h2":
+ headingProps.as = "h3";
+ break;
+ case "h3":
+ headingProps.as = "h4";
+ break;
+ case "h4":
+ headingProps.as = "h5";
+ break;
+ case "h5":
+ headingProps.as = "h6";
+ break;
+ }
+ }
+
+ return = ({
status.since || status.tooltip
? ReactDOMServer.renderToStaticMarkup(
<>
- = ({
title,
children,
+ tooltip,
}) => {
- const tooltip = ReactDOMServer.renderToStaticMarkup(
+ const renderedTooltip = ReactDOMServer.renderToStaticMarkup(
+ <>
+ {tooltip}
= ({
<>
-
+
{title}
diff --git a/src/components/FormattingTemplateSample/index.tsx b/src/components/FormattingTemplateSample/index.tsx
new file mode 100644
index 000000000..71f6c053b
--- /dev/null
+++ b/src/components/FormattingTemplateSample/index.tsx
@@ -0,0 +1,117 @@
+import { useAlphaTab, useAlphaTabEvent } from "@site/src/hooks";
+import react, { useEffect } from "react";
+import * as alphaTab from "@coderline/alphatab";
+import CodeBlock from "@theme/CodeBlock";
+
+export const FormattingTemplateSample: react.FC = () => {
+ const tex = `
+ \\title "Song Title"
+ \\subtitle Subtitle
+ \\artist Artist
+ .
+ `;
+ const [api, element] = useAlphaTab((s) => {});
+
+ function adjustStyle(score:alphaTab.model.Score) {
+ // ensure we have a score style
+ if(!score.style) {
+ score.style = new alphaTab.model.ScoreStyle();
+ }
+
+ // set a new style for the title
+ score.style.headerAndFooter.set(
+ alphaTab.model.ScoreSubElement.Title,
+ new alphaTab.model.HeaderFooterStyle(
+ "%TITLE% - %SUBTITLE%", // text template
+ true, // visible?
+ alphaTab.platform.TextAlign.Left
+ )
+ );
+ score.style.colors.set(
+ alphaTab.model.ScoreSubElement.Title,
+ alphaTab.model.Color.fromJson("#FF0000")
+ );
+
+ // hide the subtitle
+ score.style.headerAndFooter.set(
+ alphaTab.model.ScoreSubElement.SubTitle,
+ new alphaTab.model.HeaderFooterStyle(
+ "", // text template
+ false, // visible?
+ alphaTab.platform.TextAlign.Left
+ )
+ );
+ }
+
+ const codeLines = `
+ function adjustStyle(score: alphaTab.model.Score) {
+ // ensure we have a score style
+ if(!score.style) {
+ score.style = new alphaTab.model.ScoreStyle();
+ }
+
+ // set a new style for the title
+ score.style.headerAndFooter.set(
+ alphaTab.model.ScoreSubElement.Title,
+ new alphaTab.model.HeaderFooterStyle(
+ "%TITLE% - %SUBTITLE%", // text template
+ true, // visible?
+ alphaTab.platform.TextAlign.Left
+ )
+ );
+ score.style.colors.set(
+ alphaTab.model.ScoreSubElement.Title,
+ alphaTab.model.Color.fromJson("#FF0000")
+ );
+
+ // hide the subtitle
+ score.style.headerAndFooter.set(
+ alphaTab.model.ScoreSubElement.SubTitle,
+ new alphaTab.model.HeaderFooterStyle(
+ "", // text template
+ false, // visible?
+ alphaTab.platform.TextAlign.Left
+ )
+ );
+ }
+
+ // Variant A: Adjust when the song is loaded manually
+ const score = alphaTab.importer.ScoreLoader.loadScoreFromBytes(loadFileFromSomewhere());
+ adjustStyle(score);
+ alphaTabApi.renderScore(score, [0]);
+
+ // Variant B: Adjust the style later at any point
+ adjustStyle(api.score);
+ alphaTabApi.renderScore(score, [0]);
+
+ // Variant C: Listen for any new score loaded and adjust it
+ alphaTabApi.scoreLoaded.on(score => {
+ adjustStyle(score);
+ });
+ `.split("\n");
+
+ const indent =
+ codeLines.find((l) => l.length > 0)?.match(/^([ ]+).*/)?.[1]?.length ?? 0;
+
+ const trimmed = codeLines
+ .map((l) => l.substring(indent))
+ .join("\n")
+ .trim();
+
+ useEffect(() => {
+ if (api) {
+ const score = alphaTab.importer.ScoreLoader.loadScoreFromBytes(
+ new TextEncoder().encode(tex)
+ );
+ adjustStyle(score);
+ api.renderScore(score, [0]);
+ }
+ }, [api]);
+
+ return (
+
+
+ {trimmed}
+
+ );
+};
diff --git a/src/components/MarkdownString/index.tsx b/src/components/MarkdownString/index.tsx
new file mode 100644
index 000000000..69818eb05
--- /dev/null
+++ b/src/components/MarkdownString/index.tsx
@@ -0,0 +1,23 @@
+// MdxPreview
+import React, { useEffect, useState } from "react";
+import { evaluate } from "@mdx-js/mdx";
+import * as runtime from "react/jsx-runtime";
+
+export type MarkdownStringProps = { content: string };
+export const MarkdownString: React.FC = ({ content }: MarkdownStringProps) => {
+ const exports = useMDX(content);
+ const Content = exports.default;
+ return = ({
children,
platform,
- type,
name,
since,
}) => {
@@ -31,9 +29,6 @@ export const ParameterRow: React.FC = ({
-
- {type}
-
{Array.isArray(children)
? React.Children.map(children, renderChild)
@@ -53,8 +48,7 @@ export const ParameterTable: React.FC = ({ children }) => {
- Parameters
- Type
+ Parameter
Summary
diff --git a/src/components/PropertyDescription/index.tsx b/src/components/PropertyDescription/index.tsx
index 7ac05a13f..c1fcf73bb 100644
--- a/src/components/PropertyDescription/index.tsx
+++ b/src/components/PropertyDescription/index.tsx
@@ -2,13 +2,11 @@ import { buildNames } from "@site/src/names";
import { Page } from "@site/src/page";
import React from "react";
import { CodeBadge } from "../CodeBadge";
-import { PropVersionDoc } from "@docusaurus/plugin-content-docs";
import { useDoc } from "@docusaurus/plugin-content-docs/lib/client/doc.js";
+import styles from "./styles.module.scss";
export interface PropertyDescriptionProps {
- metadata: any;
showJson: boolean;
- doc: PropVersionDoc;
}
export const PropertyDescription: React.FC = ({
@@ -16,55 +14,22 @@ export const PropertyDescription: React.FC = ({
}) => {
const doc = useDoc();
const page = new Page(doc.metadata, doc.metadata);
- const { jsNames, csNames, jQueryNames, domNames, androidNames } =
- buildNames(page);
+ const { jsNames, csNames, androidNames } = buildNames(page);
const jsonNames = showJson ? jsNames : [];
return (
-
-
- {jsNames.map((n) => (
-
-
-
-
- ))}
- {jsonNames.map((n) => (
-
-
-
-
- ))}
- {jQueryNames.map((n) => (
-
-
-
-
- ))}
- {domNames.map((n) => (
-
-
-
-
- ))}
- {csNames.map((n) => (
-
-
-
-
- ))}
- {androidNames.map((n) => (
-
-
-
-
- ))}
-
-
+
+ {jsNames.map((n) => (
+ = ({ property, showJson }) => {
- const { jsNames, csNames, jQueryNames, domNames, androidNames } =
+ const { mainName, javaScriptOnly } =
buildNames(property);
- const jsonNames = showJson ? jsNames : [];
+
return (
- {jsNames.map((n) => (
-
}
- {jsonNames.map((n) => (
-
}
- {jQueryNames.map((n) => (
-
}
- {domNames.map((n) => (
-
}
- {csNames.map((n) => (
-
}
- {androidNames.map((n) => (
-
- {property.prop("description", "")}
+
);
};
@@ -130,6 +103,10 @@ export const ReferenceTable: React.FC = ({
const existingKeys = new Map();
const pages: { key: string; items: Page[] }[] = [];
for (const page of allPages) {
+ if(page.type === "link" && page.docId?.startsWith('_') === true) {
+ continue;
+ }
+
const category = (page.customProps?.category as string) ?? "";
let items = existingKeys.get(category);
if (!items) {
diff --git a/src/components/SettingsHeader/index.tsx b/src/components/SettingsHeader/index.tsx
new file mode 100644
index 000000000..eda818fac
--- /dev/null
+++ b/src/components/SettingsHeader/index.tsx
@@ -0,0 +1,15 @@
+import React from "react";
+import { useDoc } from "@docusaurus/plugin-content-docs/client";
+import { SinceBadge } from "../SinceBadge";
+import { PropertyDescription } from "../PropertyDescription";
+
+export const SettingsHeader: React.FC = () => {
+ const doc = useDoc();
+ const since = doc.frontMatter.sidebar_custom_props?.since;
+ return (
+ <>
+ {since && = ({ since, inline }) => {
+ const doc = useDoc();
+ if (
+ inline &&
+ doc.frontMatter.sidebar_custom_props?.since &&
+ doc.frontMatter.sidebar_custom_props?.since == since
+ ) {
+ return <>;
+ }
+
+ if (since) {
+ return (
+
+ since {since}
+
+ );
+ } else {
+ return <>;
+ }
+};
+
+// compatible with ReactDOMServer.renderToStaticMarkup needed in tooltip scenarios
+// it doesn't auto-hide if the since badge has the same version as the page
+export const TooltipSinceBadge: React.FC = ({ since, inline }) => {
if (since) {
return (
;
+ return = ({ children, type, name }) => {
+export const TypeRow: React.FC = ({
+ children,
+ type,
+ name,
+ link,
+}) => {
if (children && type && name) {
return (
-
{Array.isArray(children)
diff --git a/src/css/custom.scss b/src/css/custom.scss
index 0a5575efd..8ca81122a 100644
--- a/src/css/custom.scss
+++ b/src/css/custom.scss
@@ -35,7 +35,7 @@
--ifm-color-primary-lightest: #648ebe;
--ifm-code-font-size: 95%;
--ifm-z-index-fixed: 2000;
- --docusaurus-highlighted-code-line-bg: rgba(0,0,0, 0.20);
+ --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.2);
--ifm-font-family-base: "Noto Sans";
}
@@ -86,6 +86,20 @@ li.reference-item ul {
display: none !important;
}
+li.types-item .menu__list-item-collapsible {
+ flex-wrap: no-wrap;
+}
+
+li.types-item .menu__list {
+ font-size: 0.8rem;
+}
+
+li.types-item .menu__link {
+ overflow: hidden;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+}
+
.navbar__item.header-github-link {
display: flex;
align-items: center;
@@ -124,5 +138,41 @@ li.reference-item ul {
stroke: #0078ff;
}
-@import 'react-tooltip/dist/react-tooltip.css'
+@import "react-tooltip/dist/react-tooltip.css";
+.codeBlockContainer {
+ border-radius: var(--ifm-code-border-radius);
+ box-shadow: var(--ifm-global-shadow-lw);
+ margin-bottom: var(--ifm-leading);
+ background: var(--prism-background-color);
+ color: var(--prism-color);
+
+ & .codeBlockContent {
+ border-radius: inherit;
+ direction: ltr;
+ position: relative;
+ }
+
+ & .codeBlock {
+ --ifm-pre-background: var(--prism-background-color);
+ margin: 0;
+ padding: 0;
+ scrollbar-width: thin;
+ }
+
+ & .codeBlockLines {
+ float: left;
+ font: inherit;
+ min-width: 100%;
+ padding: var(--ifm-pre-padding);
+
+ & a {
+ text-decoration: underline dotted;
+ }
+
+
+ & a:hover {
+ text-decoration: underline;
+ }
+ }
+}
diff --git a/src/names.ts b/src/names.ts
index 675f18f41..a23c3247e 100644
--- a/src/names.ts
+++ b/src/names.ts
@@ -64,11 +64,12 @@ export function tojQueryPropertyNames(jsNames: string[]) {
export function buildNames(property: Page) {
const javaScriptOnly = property.prop("javaScriptOnly", false);
- const jQueryOnly = property.prop("jQueryOnly", false);
const domWildcard = property.prop("domWildcard", false);
const category = property.prop("category", "");
- let jsNames = jQueryOnly ? [] : property.props("title");
+ let jsNames = property.props("title");
+
+ let mainName = jsNames[0];
let csNames = property.props("csName");
if (!javaScriptOnly && csNames.length === 0) {
@@ -117,6 +118,8 @@ export function buildNames(property: Page) {
}
return {
+ mainName,
+ javaScriptOnly,
jsNames,
csNames,
jQueryNames,
diff --git a/src/theme/CodeBlock/Content/String.tsx b/src/theme/CodeBlock/Content/String.tsx
new file mode 100644
index 000000000..c66116713
--- /dev/null
+++ b/src/theme/CodeBlock/Content/String.tsx
@@ -0,0 +1,122 @@
+import React, { type ReactNode } from "react";
+import clsx from "clsx";
+import { useThemeConfig, usePrismTheme } from "@docusaurus/theme-common";
+import {
+ parseCodeBlockTitle,
+ parseLanguage,
+ parseLines,
+ containsLineNumbers,
+ useCodeWordWrap,
+} from "@docusaurus/theme-common/internal";
+import { Highlight, type Language } from "prism-react-renderer";
+import Line from "../Line";
+import CopyButton from "@theme/CodeBlock/CopyButton";
+import WordWrapButton from "@theme/CodeBlock/WordWrapButton";
+import Container from "@theme/CodeBlock/Container";
+import type { Props } from "@theme/CodeBlock/Content/String";
+
+import styles from "./styles.module.css";
+import { parseCodeBlockMeta, ParseLineOptions } from "../utils";
+
+// Prism languages are always lowercase
+// We want to fail-safe and allow both "php" and "PHP"
+// See https://github.com/facebook/docusaurus/issues/9012
+function normalizeLanguage(language: string | undefined): string | undefined {
+ return language?.toLowerCase();
+}
+
+export default function CodeBlockString({
+ children,
+ className: blockClassName = "",
+ metastring,
+ title: titleProp,
+ showLineNumbers: showLineNumbersProp,
+ language: languageProp,
+}: Props): ReactNode {
+ const {
+ prism: { defaultLanguage, magicComments },
+ } = useThemeConfig();
+ const language = normalizeLanguage(
+ languageProp ?? parseLanguage(blockClassName) ?? defaultLanguage
+ );
+
+ const prismTheme = usePrismTheme();
+ const wordWrap = useCodeWordWrap();
+
+ // We still parse the metastring in case we want to support more syntax in the
+ // future. Note that MDX doesn't strip quotes when parsing metastring:
+ // "title=\"xyz\"" => title: "\"xyz\""
+ const title = parseCodeBlockTitle(metastring) || titleProp;
+
+ const options:ParseLineOptions = {
+ metastring,
+ language,
+ magicComments,
+ };
+
+ const { lineClassNames, code } = parseLines(children, options);
+ const showLineNumbers =
+ showLineNumbersProp ?? containsLineNumbers(metastring);
+
+ const meta = parseCodeBlockMeta(options);
+
+ return (
+
+ {title && {title}}
+
+
+ {({ className, style, tokens, getLineProps, getTokenProps }) => (
+
+
+ {tokens.map((line, i) => (
+
+
+ )}
+
+
+ {(wordWrap.isEnabled || wordWrap.isCodeScrollable) && (
+ wordWrap.toggle()}
+ isEnabled={wordWrap.isEnabled}
+ />
+ )}
+
+
+
+ );
+}
diff --git a/src/theme/CodeBlock/Content/styles.module.css b/src/theme/CodeBlock/Content/styles.module.css
new file mode 100644
index 000000000..3760c530c
--- /dev/null
+++ b/src/theme/CodeBlock/Content/styles.module.css
@@ -0,0 +1,87 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+.codeBlockContent {
+ position: relative;
+ /* rtl:ignore */
+ direction: ltr;
+ border-radius: inherit;
+}
+
+.codeBlockTitle {
+ border-bottom: 1px solid var(--ifm-color-emphasis-300);
+ font-size: var(--ifm-code-font-size);
+ font-weight: 500;
+ padding: 0.75rem var(--ifm-pre-padding);
+ border-top-left-radius: inherit;
+ border-top-right-radius: inherit;
+}
+
+.codeBlock {
+ --ifm-pre-background: var(--prism-background-color);
+ margin: 0;
+ padding: 0;
+}
+
+.codeBlockTitle + .codeBlockContent .codeBlock {
+ border-top-left-radius: 0;
+ border-top-right-radius: 0;
+}
+
+.codeBlockStandalone {
+ padding: 0;
+}
+
+.codeBlockLines {
+ font: inherit;
+ /* rtl:ignore */
+ float: left;
+ min-width: 100%;
+ padding: var(--ifm-pre-padding);
+}
+
+.codeBlockLinesWithNumbering {
+ display: table;
+ padding: var(--ifm-pre-padding) 0;
+}
+
+@media print {
+ .codeBlockLines {
+ white-space: pre-wrap;
+ }
+}
+
+.buttonGroup {
+ display: flex;
+ column-gap: 0.2rem;
+ position: absolute;
+ /* rtl:ignore */
+ right: calc(var(--ifm-pre-padding) / 2);
+ top: calc(var(--ifm-pre-padding) / 2);
+}
+
+.buttonGroup button {
+ display: flex;
+ align-items: center;
+ background: var(--prism-background-color);
+ color: var(--prism-color);
+ border: 1px solid var(--ifm-color-emphasis-300);
+ border-radius: var(--ifm-global-radius);
+ padding: 0.4rem;
+ line-height: 0;
+ transition: opacity var(--ifm-transition-fast) ease-in-out;
+ opacity: 0;
+}
+
+.buttonGroup button:focus-visible,
+.buttonGroup button:hover {
+ opacity: 1 !important;
+}
+
+:global(.theme-code-block:hover) .buttonGroup button {
+ opacity: 0.4;
+}
diff --git a/src/theme/CodeBlock/Line/index.tsx b/src/theme/CodeBlock/Line/index.tsx
new file mode 100644
index 000000000..a175c074e
--- /dev/null
+++ b/src/theme/CodeBlock/Line/index.tsx
@@ -0,0 +1,78 @@
+import React, { type ReactNode } from "react";
+import clsx from "clsx";
+import type { Props } from "@theme/CodeBlock/Line";
+
+import styles from "./styles.module.css";
+import { CodeBlockMeta } from "../utils";
+import Link from "@docusaurus/Link";
+
+export type ExtendedCodeLineProps = Props & {
+ meta: CodeBlockMeta;
+};
+
+
+export default function CodeBlockLine({
+ line,
+ classNames,
+ showLineNumbers,
+ getLineProps,
+ getTokenProps,
+ meta,
+}: ExtendedCodeLineProps): ReactNode {
+ if (line.length === 1 && line[0]!.content === "\n") {
+ line[0]!.content = "";
+ }
+
+ const lineProps = getLineProps({
+ line,
+ className: clsx(classNames, showLineNumbers && styles.codeLine),
+ });
+
+ const lineTokens = line.map((token, key) => {
+ const trimmed = token.content.trim();
+ const makeLink = token.types.some((t) => t === "plain" || t === "function");
+ if (makeLink) {
+ const link = meta.options[`link${trimmed}`.toLowerCase()];
+ if (typeof link === "string") {
+ const index = token.content.indexOf(trimmed);
+ let before = token.content.substring(0, index);
+ let after = token.content.substring(index + trimmed.length);
+ return (
+ <>
+ {before && (
+
+ )}
+
+ {after && (
+
+ )}
+
+ );
+ }
+ }
+
+ return ;
+ });
+
+ return (
+
+ {showLineNumbers ? (
+ <>
+
+ {lineTokens}
+
+ ) : (
+ lineTokens
+ )}
+
+
+ );
+}
diff --git a/src/theme/CodeBlock/Line/styles.module.css b/src/theme/CodeBlock/Line/styles.module.css
new file mode 100644
index 000000000..7c28ed9aa
--- /dev/null
+++ b/src/theme/CodeBlock/Line/styles.module.css
@@ -0,0 +1,45 @@
+/* Intentionally has zero specificity, so that to be able to override
+the background in custom CSS file due bug https://github.com/facebook/docusaurus/issues/3678 */
+:where(:root) {
+ --docusaurus-highlighted-code-line-bg: rgb(72 77 91);
+}
+
+:where([data-theme='dark']) {
+ --docusaurus-highlighted-code-line-bg: rgb(100 100 100);
+}
+
+:global(.theme-code-block-highlighted-line) {
+ background-color: var(--docusaurus-highlighted-code-line-bg);
+ display: block;
+ margin: 0 calc(-1 * var(--ifm-pre-padding));
+ padding: 0 var(--ifm-pre-padding);
+}
+
+.codeLine {
+ display: table-row;
+ counter-increment: line-count;
+}
+
+.codeLineNumber {
+ display: table-cell;
+ text-align: right;
+ width: 1%;
+ position: sticky;
+ left: 0;
+ padding: 0 var(--ifm-pre-padding);
+ background: var(--ifm-pre-background);
+ overflow-wrap: normal;
+}
+
+.codeLineNumber::before {
+ content: counter(line-count);
+ opacity: 0.4;
+}
+
+:global(.theme-code-block-highlighted-line) .codeLineNumber::before {
+ opacity: 0.8;
+}
+
+.codeLineContent {
+ padding-right: var(--ifm-pre-padding);
+}
diff --git a/src/theme/CodeBlock/utils.ts b/src/theme/CodeBlock/utils.ts
new file mode 100644
index 000000000..505426084
--- /dev/null
+++ b/src/theme/CodeBlock/utils.ts
@@ -0,0 +1,151 @@
+import rangeParser from "parse-numeric-range";
+import { useThemeConfig } from "@docusaurus/theme-common";
+
+type MagicCommentConfig = ReturnType<
+ typeof useThemeConfig
+>["prism"]["magicComments"][0];
+
+/**
+ * The supported types for {@link CodeBlockMeta.options} values.
+ */
+export type CodeMetaOptionValue = string | boolean | number;
+
+/**
+ * Any options as specified by the user in the "metastring" of codeblocks.
+ */
+export interface CodeBlockMeta {
+ /**
+ * The highlighted lines, 0-indexed. e.g. `{ 0: ["highlight", "sample"] }`
+ * means the 1st line should have `highlight` and `sample` as class names.
+ */
+ readonly lineClassNames: { [lineIndex: number]: string[] };
+
+ /**
+ * The parsed options, key converted to lowercase.
+ * e.g. `"title" => "file.js", "showlinenumbers" => true`
+ */
+ readonly options: { [key: string]: CodeMetaOptionValue };
+}
+
+// note: regexp/no-useless-non-capturing-group is a false positive
+// the group is required or it breaks the correct alternation of
+// |
+const optionRegex =
+ // eslint-disable-next-line regexp/no-useless-non-capturing-group
+ /(?\w+)(?:=(?:(?:(?["'])(?.*?)\k)|(?\S*)))?/g;
+const metastringLinesRangeRegex = /\{(?[\d,-]+)\}/g;
+const highlightOptionKey = "highlight";
+
+function parseCodeBlockOptions(
+ meta: CodeBlockMeta,
+ originalMetastring: string,
+ metastring: string,
+ magicComments: MagicCommentConfig[]
+) {
+ if (metastring) {
+ optionRegex.lastIndex = 0;
+
+ let match = optionRegex.exec(metastring);
+
+ while (match) {
+ const { stringValue, rawValue } = match.groups!;
+
+ const key = match.groups!.key!.toLowerCase();
+
+ // special highlight option
+ if (key === highlightOptionKey) {
+ if (magicComments.length === 0) {
+ throw new Error(
+ `A highlight range has been given in code block's metastring (\`\`\` ${originalMetastring}), but no magic comment config is available. Docusaurus applies the first magic comment entry's className for metastring ranges.`
+ );
+ }
+ const metastringRangeClassName = magicComments[0]!.className;
+ rangeParser(stringValue ?? rawValue!)
+ .filter((n) => n > 0)
+ .forEach((n) => {
+ meta.lineClassNames[n - 1] = [metastringRangeClassName];
+ });
+ } else if (stringValue === undefined && rawValue === undefined) {
+ // flag options
+ meta.options[key] = true;
+ } else if (stringValue !== undefined) {
+ // string option
+ meta.options[key] = stringValue;
+ } else if (rawValue === "true") {
+ // boolean option
+ meta.options[key] = true;
+ } else if (rawValue === "false") {
+ meta.options[key] = false;
+ } else {
+ const number = parseFloat(rawValue!);
+ if (!Number.isNaN(number)) {
+ // number value
+ meta.options[key] = number;
+ } else {
+ // non quoted string
+ meta.options[key] = rawValue!;
+ }
+ }
+
+ match = optionRegex.exec(metastring);
+ }
+ }
+}
+
+export type ParseLineOptions = {
+ /**
+ * The full metastring, as received from MDX. Line ranges declared here
+ * start at 1. Or alternatively the parsed {@link CodeBlockMeta}.
+ */
+ metastring: string | undefined;
+ /**
+ * Language of the code block, used to determine which kinds of magic
+ * comment styles to enable.
+ */
+ language: string | undefined;
+ /**
+ * Magic comment types that we should try to parse. Each entry would
+ * correspond to one class name to apply to each line.
+ */
+ magicComments: MagicCommentConfig[];
+};
+
+/**
+ * Rewrites the range syntax to special options. e.g.
+ * `{1,2,3-4,5} => highlight=1 highlight=2 highlight=3-4 highlight=5`
+ * @param metastring The input metastring with the range syntax
+ * @returns The string where the range syntax has been rewritten
+ */
+function rewriteLinesRange(metastring: string): string {
+ metastringLinesRangeRegex.lastIndex = 0;
+
+ return metastring.replaceAll(metastringLinesRangeRegex, (_, range) => {
+ return (range as string)
+ .split(",")
+ .map((r) => `${highlightOptionKey}=${r}`)
+ .join(" ");
+ });
+}
+
+export function parseCodeBlockMeta(options: ParseLineOptions): CodeBlockMeta {
+ if (typeof options.metastring === "object") {
+ return options.metastring;
+ }
+
+ const meta: CodeBlockMeta = {
+ lineClassNames: {},
+ options: {},
+ };
+
+ const { metastring, magicComments } = options;
+
+ // exit early if nothing to do.
+ if (!metastring) {
+ return meta;
+ }
+
+ const rewritten = rewriteLinesRange(metastring);
+ parseCodeBlockOptions(meta, metastring, rewritten, magicComments);
+
+ return meta;
+}
diff --git a/src/types/RenderFinishedEventArgs/index.tsx b/src/types/RenderFinishedEventArgs/index.tsx
deleted file mode 100644
index 2ff40a959..000000000
--- a/src/types/RenderFinishedEventArgs/index.tsx
+++ /dev/null
@@ -1,47 +0,0 @@
-import React from "react";
-import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable';
-
-export function RenderFinishedEventArgs() {
- return (
-
-
- The unique id of the chunk to request rendering through [`renderResult`](/docs/reference/scorerenderer/renderresult)
- Since 1.2.3
-
-
- The absolute x-position of the chunk within the overall music sheet.
- Since 1.2.3
-
-
- The absolute y-position of the chunk within the overall music sheet.
- Since 1.2.3
-
-
- The width of the current rendering result.
-
-
- The height of the current rendering result.
-
-
- The currently known total width of the final music sheet.
-
-
- The currently known total height of the final music sheet.
-
-
- The index of the first masterbar that was rendered in this result.
-
-
- The last masterbar that was rendered in this result.
-
-
- The render engine specific result object which contains the rendered
- music sheet:
- - For `svg` it will contain the raw SVG string,
- - For `html5` it will contain a HTML5 canvas DOM element
- - For `skia` it will contain a `SkImage`
- - For `gdi` it will contain a `Bitmap`
-
-
- );
-}
diff --git a/static/img/release/v15/emojis.png b/static/img/release/v15/emojis.png
new file mode 100644
index 000000000..f74f5eeef
Binary files /dev/null and b/static/img/release/v15/emojis.png differ