alphaTab.platform.IUiFacade

This interface represents the UI abstraction between alphaTab and the corresponding UI framework being used.

 interface IUiFacade<TSettings>

Properties

areWorkersSupported

Gets a value indicating whether the UI framework supports worker based rendering.

JavaScript

readonly areWorkersSupported: boolean;

C#

bool AreWorkersSupported { get; }

Kotlin

val areWorkersSupported: Boolean

canRender

Gets or sets whether the UI is ready to render the music notation. On some platforms where pre-loading of assets is done asynchronously, rendering might need to be deferred.

JavaScript

readonly canRender: boolean;

C#

bool CanRender { get; }

Kotlin

val canRender: Boolean

canRenderChanged

This events is fired when the canRender property changes.

JavaScript

readonly canRenderChanged: IEventEmitter;

C#

IEventEmitter CanRenderChanged { get; }

Kotlin

val canRenderChanged: IEventEmitter

resizeThrottle

Gets the resize throttling in milliseconds. Then the music sheet is resized, the re-rendering is deferred until this timeout is reached.

JavaScript

readonly resizeThrottle: number;

C#

double ResizeThrottle { get; }

Kotlin

val resizeThrottle: Double

rootContainer

Gets the root UI element that holds the whole alphaTab control.

JavaScript

readonly rootContainer: IContainer;

C#

IContainer RootContainer { get; }

Kotlin

val rootContainer: IContainer

rootContainerBecameVisible

This event is fired when rootContainer became visible when it was invisible at the time rendering was initiated.

JavaScript

readonly rootContainerBecameVisible: IEventEmitter;

C#

IEventEmitter RootContainerBecameVisible { get; }

Kotlin

val rootContainerBecameVisible: IEventEmitter

Methods

beginAppendRenderResults

Tells the UI layer to append the given render results to the UI. At this point the partial result is not actually rendered yet, only the layouting process completed.

JavaScript

beginAppendRenderResults(renderResults: RenderFinishedEventArgs | null): void

C#

void BeginAppendRenderResults(RenderFinishedEventArgs? renderResults)

Kotlin

fun beginAppendRenderResults(renderResults: RenderFinishedEventArgs?): Unit

Parameter	Summary
renderResultsAll	The rendered partial that should be added to the UI. null indicates the rendering finished.

beginInvoke

Tells the UI layer to invoke the given action.

JavaScript

beginInvoke(action: () => void): void

C#

void BeginInvoke(() => void action)

Kotlin

fun beginInvoke(action: () => void): Unit

Parameter	Summary
actionAll	(no description)

beginUpdateRenderResults

Tells the UI layer to update the given render results within the UI.

JavaScript

beginUpdateRenderResults(renderResults: RenderFinishedEventArgs): void

C#

void BeginUpdateRenderResults(RenderFinishedEventArgs renderResults)

Kotlin

fun beginUpdateRenderResults(renderResults: RenderFinishedEventArgs): Unit

Parameter	Summary
renderResultsAll	The rendered partial that should be updated within the UI.

createBackingTrackPlayer

Tells the UI layer to create a player which can play backing tracks.

JavaScript

createBackingTrackPlayer(): IAlphaSynth | null

C#

IAlphaSynth? CreateBackingTrackPlayer()

Kotlin

fun createBackingTrackPlayer(): IAlphaSynth?

createCanvasElement

Creates the canvas element that wraps all individually rendered partials.

JavaScript

createCanvasElement(): IContainer

C#

IContainer CreateCanvasElement()

Kotlin

fun createCanvasElement(): IContainer

Returns

The canvas element that wraps all individually rendered partials.

createCursors

Creates the cursor objects that are used to highlight the currently played beats and bars.

JavaScript

createCursors(): Cursors | null

C#

Cursors? CreateCursors()

Kotlin

fun createCursors(): Cursors?

createSelectionElement

Creates a new UI element that is used to display the selection rectangle.

JavaScript

createSelectionElement(): IContainer | null

C#

IContainer? CreateSelectionElement()

Kotlin

fun createSelectionElement(): IContainer?

createWorkerAudioExporter

Tells the UI layer to create a new audio exporter.

JavaScript

createWorkerAudioExporter(synth: IAlphaSynth | null): IAudioExporterWorker

C#

IAudioExporterWorker CreateWorkerAudioExporter(IAlphaSynth? synth)

Kotlin

fun createWorkerAudioExporter(synth: IAlphaSynth?): IAudioExporterWorker

Parameter	Summary
synthAll	The currently active alphaSynth that might be used for synthesizing. If the provided synthesizer is already an active player worker (created via createWorkerPlayer ), it can reuse the already initialized state.

createWorkerPlayer

Tells the UI layer to create a player worker for the synthesizer.

JavaScript

createWorkerPlayer(): IAlphaSynth | null

C#

IAlphaSynth? CreateWorkerPlayer()

Kotlin

fun createWorkerPlayer(): IAlphaSynth?

createWorkerRenderer

Tells the UI layer to create the worker renderer. This method is the UI layer supports worker rendering and worker rendering is not disabled via setting.

JavaScript

createWorkerRenderer(): IScoreRenderer

C#

IScoreRenderer CreateWorkerRenderer()

Kotlin

fun createWorkerRenderer(): IScoreRenderer

destroy

Tells the UI layer to destroy the alphaTab controls and restore the initial state.

JavaScript

destroy(): void

C#

void Destroy()

Kotlin

fun destroy(): Unit

destroyCursors

Destroys the cursor objects that are used to highlight the currently played beats and bars.

JavaScript

destroyCursors(): void

C#

void DestroyCursors()

Kotlin

fun destroyCursors(): Unit

getOffset

Calculates the relative offset of a container to the scroll element.

JavaScript

getOffset(scrollElement: IContainer | null, container: IContainer): Bounds

C#

Bounds GetOffset(IContainer? scrollElement, IContainer container)

Kotlin

fun getOffset(scrollElement: IContainer?, container: IContainer): Bounds

Parameter	Summary
scrollElementAll	The parent scroll element to which the relative position is computed.
containerAll	The container element for which the relative position is calculated.

getScrollContainer

Gets the UI element that is used for scrolling during playback.

JavaScript

getScrollContainer(): IContainer

C#

IContainer GetScrollContainer()

Kotlin

fun getScrollContainer(): IContainer

highlightElements

Tells the UI layer to highlight the music notation elements with the given ID.

JavaScript

highlightElements(groupId: string, masterBarIndex: number): void

C#

void HighlightElements(string groupId, double masterBarIndex)

Kotlin

fun highlightElements(groupId: String, masterBarIndex: Double): Unit

Parameter	Summary
groupIdAll	The group id that identifies the elements to be highlighted.
masterBarIndexAll	The index of the related masterbar of the highlighted group.

initialize

Initializes the UI using the given alphaTab API and settings object.

JavaScript

initialize(api: AlphaTabApiBase<TSettings>, settings: TSettings): void

C#

void Initialize(AlphaTabApiBase<TSettings> api, TSettings settings)

Kotlin

fun initialize(api: AlphaTabApiBase<TSettings>, settings: TSettings): Unit

Parameter	Summary
apiAll	The alphaTab API wrapper responsible for UI interaction.
settingsAll	The settings object holding the settings from the UI layer.

initialRender

Tells the UI layer to do the initial rendering.

JavaScript

initialRender(): void

C#

void InitialRender()

Kotlin

fun initialRender(): Unit

load

Attempts a load of the score represented by the given data object.

JavaScript

load(data: unknown, success: (score: Score) => void, error: (error: Error) => void): boolean

C#

bool Load(object data, (score: Score) => void success, (error: Error) => void error)

Kotlin

fun load(data: Any, success: (score: Score) => void, error: (error: Error) => void): Boolean

Parameter	Summary
dataAll	The data object to decode
successAll	The action to call if the score was loaded
errorAll	The action to call if any error during loading ocurred.

Returns

true if the data object is supported and a load was initiated, otherwise false

loadSoundFont

Attempts a load of the score represented by the given data object.

JavaScript

loadSoundFont(data: unknown, append: boolean): boolean

C#

bool LoadSoundFont(object data, bool append)

Kotlin

fun loadSoundFont(data: Any, append: Boolean): Boolean

Parameter	Summary
dataAll	The data object to decode
appendAll	Whether to fully replace or append the data from the given soundfont.

Returns

true if the data object is supported and a load was initiated, otherwise false

removeHighlights

Tells the UI layer to remove all highlights from highlighted music notation elements.

JavaScript

removeHighlights(): void

C#

void RemoveHighlights()

Kotlin

fun removeHighlights(): Unit

scrollToX

Initiates a horizontal scroll on the given element.

JavaScript

scrollToX(scrollElement: IContainer, offset: number, speed: number): void

C#

void ScrollToX(IContainer scrollElement, double offset, double speed)

Kotlin

fun scrollToX(scrollElement: IContainer, offset: Double, speed: Double): Unit

Parameter	Summary
scrollElementAll	The element on which the scrolling should happen.
offsetAll	The absolute scroll offset to which scrolling should happen.
speedAll	How fast the scrolling from the current offset to the given one should happen in milliseconds.

scrollToY

Initiates a vertical scroll on the given element.

JavaScript

scrollToY(scrollElement: IContainer, offset: number, speed: number): void

C#

void ScrollToY(IContainer scrollElement, double offset, double speed)

Kotlin

fun scrollToY(scrollElement: IContainer, offset: Double, speed: Double): Unit

Parameter	Summary
scrollElementAll	The element on which the scrolling should happen.
offsetAll	The absolute scroll offset to which scrolling should happen.
speedAll	How fast the scrolling from the current offset to the given one should happen in milliseconds.

setCanvasOverflow

Updates the overflows needed to ensure the smooth scrolling can reach the "end" at the desired position. Without these overflows we might not have enough scroll space and we cannot reach a "sticky cursor" behavior.

JavaScript

setCanvasOverflow(canvasElement: IContainer, overflow: number, isVertical: boolean): void

C#

void SetCanvasOverflow(IContainer canvasElement, double overflow, bool isVertical)

Kotlin

fun setCanvasOverflow(canvasElement: IContainer, overflow: Double, isVertical: Boolean): Unit

Parameter	Summary
canvasElementAll	The canvas element.
overflowAll	(no description)
isVerticalAll	Whether we have a vertical or horizontal overflow

stopScrolling

Stops any ongoing scrolling of the given element.

JavaScript

stopScrolling(scrollElement: IContainer): void

C#

void StopScrolling(IContainer scrollElement)

Kotlin

fun stopScrolling(scrollElement: IContainer): Unit

Parameter	Summary
scrollElementAll	The element which might be scrolling dynamically.

triggerEvent

Tells the UI layer to trigger an event with the given name and details.

JavaScript

triggerEvent(container: IContainer, eventName: string, details: unknown, originalEvent?: IMouseEventArgs): void

C#

void TriggerEvent(IContainer container, string eventName, object details, IMouseEventArgs? originalEvent)

Kotlin

fun triggerEvent(container: IContainer, eventName: String, details: Any, originalEvent: IMouseEventArgs?): Unit

Parameter	Summary
containerAll	The element on which the event should be triggered.
eventNameAll	The event that should be triggered.
detailsAll	The object holding the details about the event.
originalEventAll	The original event related to this custom event.