alphaTab.model.Track

This public class describes a single track or instrument of score. It is primarily a list of staves containing individual music notation kinds.

 class Track

Properties

color

Gets or sets the display color defined for this track.

JavaScript

color: Color;

C#

Color Color { get; set; }

Kotlin

var color: Color

defaultSystemsLayout

Defines how many bars are placed into the systems (rows) when displaying the track unless a value is set in the systemsLayout.

JavaScript

defaultSystemsLayout: number;

C#

double DefaultSystemsLayout { get; set; }

Kotlin

var defaultSystemsLayout: Double

index

Gets or sets the zero-based index of this track.

JavaScript

index: number;

C#

double Index { get; set; }

Kotlin

var index: Double

isPercussion

Gets whether this track is a percussion track.

JavaScript

readonly isPercussion: boolean;

C#

bool IsPercussion { get; }

Kotlin

val isPercussion: Boolean

isVisibleOnMultiTrack

Gets or sets whether this track should be visible in the UI. This information is purely informational and might not be provided by all input formats. In formats like Guitar Pro this flag indicates whether on the default "multi-track" layout tracks should be visible or not.

JavaScript

isVisibleOnMultiTrack: boolean;

C#

bool IsVisibleOnMultiTrack { get; set; }

Kotlin

var isVisibleOnMultiTrack: Boolean

lineBreaks

Defines on which bars specifically a line break is forced.

JavaScript

lineBreaks?: Set<number>;

C#

Set<double> LineBreaks { get; set; }

Kotlin

var lineBreaks: Set<Double>

name

Gets or sets the long name of this track.

JavaScript

name: string;

C#

string Name { get; set; }

Kotlin

var name: String

percussionArticulations

Gets or sets a mapping on which staff lines particular percussion instruments should be shown.

JavaScript

percussionArticulations: InstrumentArticulation[];

C#

IList<InstrumentArticulation> PercussionArticulations { get; set; }

Kotlin

var percussionArticulations: alphaTab.collections.List<InstrumentArticulation>

playbackInfo

Gets or sets the playback information for this track.

JavaScript

playbackInfo: PlaybackInformation;

C#

PlaybackInformation PlaybackInfo { get; set; }

Kotlin

var playbackInfo: PlaybackInformation

score

Gets or sets the reference this track belongs to.

JavaScript

score: Score;

C#

Score Score { get; set; }

Kotlin

var score: Score

shortName

Gets or sets the short name of this track.

JavaScript

shortName: string;

C#

string ShortName { get; set; }

Kotlin

var shortName: String

staves

Gets or sets the list of staves that are defined for this track.

JavaScript

staves: Staff[];

C#

IList<Staff> Staves { get; set; }

Kotlin

var staves: alphaTab.collections.List<Staff>

style

The style customizations for this item.

JavaScript

style?: TrackStyle;

C#

TrackStyle Style { get; set; }

Kotlin

var style: TrackStyle

systemsLayout

Defines how many bars are placed into the systems (rows) when displaying the track.

JavaScript

systemsLayout: number[];

C#

IList<double> SystemsLayout { get; set; }

Kotlin

var systemsLayout: alphaTab.collections.DoubleList

Methods

addLineBreaks

Adds a new line break.

JavaScript

addLineBreaks(index: number): void

C#

void AddLineBreaks(double index)

Kotlin

fun addLineBreaks(index: Double): Unit

Parameter	Summary
indexAll	The index of the bar before which a line break should happen.

addStaff

(no description)

JavaScript

addStaff(staff: Staff): void

C#

void AddStaff(Staff staff)

Kotlin

fun addStaff(staff: Staff): Unit

Parameter	Summary
staffAll	(no description)

applyLyrics

(no description)

JavaScript

applyLyrics(lyrics: Lyrics[]): void

C#

void ApplyLyrics(IList<Lyrics> lyrics)

Kotlin

fun applyLyrics(lyrics: alphaTab.collections.List<Lyrics>): Unit

Parameter	Summary
lyricsAll	(no description)

ensureStaveCount

(no description)

JavaScript

ensureStaveCount(staveCount: number): void

C#

void EnsureStaveCount(double staveCount)

Kotlin

fun ensureStaveCount(staveCount: Double): Unit

Parameter	Summary
staveCountAll	(no description)

finish

(no description)

JavaScript

finish(settings: Settings, sharedDataBag?: Map<string, unknown> | null): void

C#

void Finish(Settings settings, Map<string, object>? sharedDataBag)

Kotlin

fun finish(settings: Settings, sharedDataBag: alphaTab.collections.StringAnyMap<String, Any>?): Unit

Parameter	Summary
settingsAll	(no description)
sharedDataBagAll	(no description)

getOrRegisterPercussionArticulation

Returns the index of articulation in percussionArticulations , appending it (deduplicated by uniqueId) when not yet present. Callers store the returned index in percussionArticulation .

JavaScript

getOrRegisterPercussionArticulation(articulation: InstrumentArticulation): number

C#

double GetOrRegisterPercussionArticulation(InstrumentArticulation articulation)

Kotlin

fun getOrRegisterPercussionArticulation(articulation: InstrumentArticulation): Double

Parameter	Summary
articulationAll	(no description)