alphaTab.model.Staff

This class describes a single staff within a track. There are instruments like pianos where a single track can contain multiple staves.

 class Staff

Properties

bars

Gets or sets a list of all bars contained in this staff.

JavaScript

bars: Bar[];

C#

IList<Bar> Bars { get; set; }

Kotlin

var bars: alphaTab.collections.List<Bar>

capo

Gets or sets the fret on which a capo is set.

JavaScript

capo: number;

C#

double Capo { get; set; }

Kotlin

var capo: Double

chords

Gets or sets a list of all chords defined for this staff. chordId refers to entries in this lookup.

JavaScript

chords: Map<string, Chord> | null;

C#

Map<string, Chord>? Chords { get; set; }

Kotlin

var chords: alphaTab.collections.StringObjectMap<String, Chord>?

DefaultStandardNotationLineCount

(no description)

JavaScript

static readonly DefaultStandardNotationLineCount: unknown;

C#

static Unknown DefaultStandardNotationLineCount { get; }

Kotlin

companion object { val DefaultStandardNotationLineCount: unknown }

displayTranspositionPitch

Gets or sets the number of semitones this track should be transposed. This applies only to rendering.

JavaScript

displayTranspositionPitch: number;

C#

double DisplayTranspositionPitch { get; set; }

Kotlin

var displayTranspositionPitch: Double

filledVoices

The indexes of the non-empty voices in this staff..

JavaScript

readonly filledVoices: Set<number>;

C#

Set<double> FilledVoices { get; }

Kotlin

val filledVoices: Set<Double>

index

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

JavaScript

index: number;

C#

double Index { get; set; }

Kotlin

var index: Double

isPercussion

Gets or sets whether the staff contains percussion notation

JavaScript

isPercussion: boolean;

C#

bool IsPercussion { get; set; }

Kotlin

var isPercussion: Boolean

isStringed

(no description)

JavaScript

readonly isStringed: boolean;

C#

bool IsStringed { get; }

Kotlin

val isStringed: Boolean

numberedConfig

Per-Staff override for the numbered (jianpu) staff's display.

JavaScript

numberedConfig?: NumberedStaffConfig;

C#

NumberedStaffConfig NumberedConfig { get; set; }

Kotlin

var numberedConfig: NumberedStaffConfig

scoreConfig

Per-Staff override for the standard-notation staff's display.

JavaScript

scoreConfig?: ScoreStaffConfig;

C#

ScoreStaffConfig ScoreConfig { get; set; }

Kotlin

var scoreConfig: ScoreStaffConfig

showNumbered

Gets or sets whether the numbered notation is shown.

JavaScript

showNumbered: boolean;

C#

bool ShowNumbered { get; set; }

Kotlin

var showNumbered: Boolean

showSlash

Gets or sets whether the slash notation is shown.

JavaScript

showSlash: boolean;

C#

bool ShowSlash { get; set; }

Kotlin

var showSlash: Boolean

showStandardNotation

Gets or sets whether the standard notation is shown.

JavaScript

showStandardNotation: boolean;

C#

bool ShowStandardNotation { get; set; }

Kotlin

var showStandardNotation: Boolean

showTablature

Gets or sets whether the tabs are shown.

JavaScript

showTablature: boolean;

C#

bool ShowTablature { get; set; }

Kotlin

var showTablature: Boolean

slashConfig

Per-Staff override for the slash staff's display.

JavaScript

slashConfig?: SlashStaffConfig;

C#

SlashStaffConfig SlashConfig { get; set; }

Kotlin

var slashConfig: SlashStaffConfig

standardNotationLineCount

The number of lines shown for the standard notation. For some percussion instruments this number might vary.

JavaScript

standardNotationLineCount: number;

C#

double StandardNotationLineCount { get; set; }

Kotlin

var standardNotationLineCount: Double

stringTuning

Get or set the guitar tuning of the guitar. This tuning also indicates the number of strings shown in the guitar tablature. Unlike the string property this array directly represents the order of the tracks shown in the tablature. The first item is the most top tablature line.

JavaScript

stringTuning: Tuning;

C#

Tuning StringTuning { get; set; }

Kotlin

var stringTuning: Tuning

tabConfig

Per-Staff override for the tablature staff's display.

JavaScript

tabConfig?: TabStaffConfig;

C#

TabStaffConfig TabConfig { get; set; }

Kotlin

var tabConfig: TabStaffConfig

track

Gets or sets the reference to the track this staff belongs to.

JavaScript

track: Track;

C#

Track Track { get; set; }

Kotlin

var track: Track

transpositionPitch

Gets or sets the number of semitones this track should be transposed. This applies to rendering and playback.

JavaScript

transpositionPitch: number;

C#

double TranspositionPitch { get; set; }

Kotlin

var transpositionPitch: Double

tuning

Get or set the values of the related guitar tuning.

JavaScript

readonly tuning: number[];

C#

IList<double> Tuning { get; }

Kotlin

val tuning: alphaTab.collections.DoubleList

tuningName

Gets or sets the name of the tuning.

JavaScript

readonly tuningName: string;

C#

string TuningName { get; }

Kotlin

val tuningName: String

Methods

addBar

(no description)

JavaScript

addBar(bar: Bar): void

C#

void AddBar(Bar bar)

Kotlin

fun addBar(bar: Bar): Unit

Parameter	Summary
barAll	(no description)

addChord

(no description)

JavaScript

addChord(chordId: string, chord: Chord): void

C#

void AddChord(string chordId, Chord chord)

Kotlin

fun addChord(chordId: String, chord: Chord): Unit

Parameter	Summary
chordIdAll	(no description)
chordAll	(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)

getChord

(no description)

JavaScript

getChord(chordId: string): Chord | null

C#

Chord? GetChord(string chordId)

Kotlin

fun getChord(chordId: String): Chord?

Parameter	Summary
chordIdAll	(no description)

hasChord

(no description)

JavaScript

hasChord(chordId: string): boolean

C#

bool HasChord(string chordId)

Kotlin

fun hasChord(chordId: String): Boolean

Parameter	Summary
chordIdAll	(no description)