alphaTab.model.Bar

A bar is a single block within a track, also known as Measure.

 class Bar

Properties

barLineLeft

The bar line to draw on the left side of the bar. Note that the combination with barLineRight of the previous bar matters. If this bar has a Regular/Automatic style but the previous bar is customized, no additional line is drawn by this bar. If both bars have a custom style, both bar styles are drawn.

JavaScript

barLineLeft: BarLineStyle;

C#

BarLineStyle BarLineLeft { get; set; }

Kotlin

var barLineLeft: BarLineStyle

barLineRight

The bar line to draw on the right side of the bar. Note that the combination with barLineLeft of the next bar matters. If this bar has a Regular/Automatic style but the next bar is customized, no additional line is drawn by this bar. If both bars have a custom style, both bar styles are drawn.

JavaScript

barLineRight: BarLineStyle;

C#

BarLineStyle BarLineRight { get; set; }

Kotlin

var barLineRight: BarLineStyle

barNumberDisplay

How bar numbers should be displayed. If specified, overrides the value from the stylesheet on score level.

JavaScript

barNumberDisplay?: BarNumberDisplay;

C#

BarNumberDisplay BarNumberDisplay { get; set; }

Kotlin

var barNumberDisplay: BarNumberDisplay

clef

Gets or sets the clef on this bar.

JavaScript

clef: Clef;

C#

Clef Clef { get; set; }

Kotlin

var clef: Clef

clefOttava

Gets or sets the ottava applied to the clef.

JavaScript

clefOttava: Ottavia;

C#

Ottavia ClefOttava { get; set; }

Kotlin

var clefOttava: Ottavia

displayScale

A relative scale for the size of the bar when displayed. The scale is relative within a single line (system). The sum of all scales in one line make the total width, and then this individual scale gives the relative size.

JavaScript

displayScale: number;

C#

double DisplayScale { get; set; }

Kotlin

var displayScale: Double

displayWidth

An absolute width of the bar to use when displaying in single track display scenarios.

JavaScript

displayWidth: number;

C#

double DisplayWidth { get; set; }

Kotlin

var displayWidth: Double

filledVoices

Gets the number of voices which have content within this stuff.

JavaScript

readonly filledVoices: Set<number>;

C#

Set<double> FilledVoices { get; }

Kotlin

val filledVoices: Set<Double>

hasChanges

Whether this bar has any changes applied which are not related to the voices in it. (e.g. new key signatures)

JavaScript

readonly hasChanges: boolean;

C#

bool HasChanges { get; }

Kotlin

val hasChanges: Boolean

id

Gets or sets the unique id of this bar.

JavaScript

id: number;

C#

double Id { get; set; }

Kotlin

var id: Double

index

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

JavaScript

index: number;

C#

double Index { get; set; }

Kotlin

var index: Double

isEmpty

Whether this bar is fully empty (not even having rests).

JavaScript

readonly isEmpty: boolean;

C#

bool IsEmpty { get; }

Kotlin

val isEmpty: Boolean

isMultiVoice

Gets a value indicating whether this bar contains multiple voices with notes.

JavaScript

readonly isMultiVoice: boolean;

C#

bool IsMultiVoice { get; }

Kotlin

val isMultiVoice: Boolean

isRestOnly

Whether this bar is empty or has only rests.

JavaScript

readonly isRestOnly: boolean;

C#

bool IsRestOnly { get; }

Kotlin

val isRestOnly: Boolean

keySignature

Gets or sets the key signature used on all bars.

JavaScript

keySignature: KeySignature;

C#

KeySignature KeySignature { get; set; }

Kotlin

var keySignature: KeySignature

keySignatureType

Gets or sets the type of key signature (major/minor)

JavaScript

keySignatureType: KeySignatureType;

C#

KeySignatureType KeySignatureType { get; set; }

Kotlin

var keySignatureType: KeySignatureType

masterBar

(no description)

JavaScript

readonly masterBar: MasterBar;

C#

MasterBar MasterBar { get; }

Kotlin

val masterBar: MasterBar

nextBar

Gets or sets the next bar that comes after this bar.

JavaScript

nextBar: Bar | null;

C#

Bar? NextBar { get; set; }

Kotlin

var nextBar: Bar?

previousBar

Gets or sets the previous bar that comes before this bar.

JavaScript

previousBar: Bar | null;

C#

Bar? PreviousBar { get; set; }

Kotlin

var previousBar: Bar?

simileMark

Gets or sets the simile mark on this bar.

JavaScript

simileMark: SimileMark;

C#

SimileMark SimileMark { get; set; }

Kotlin

var simileMark: SimileMark

staff

Gets or sets the reference to the parent staff.

JavaScript

staff: Staff;

C#

Staff Staff { get; set; }

Kotlin

var staff: Staff

style

The style customizations for this item.

JavaScript

style?: BarStyle;

C#

BarStyle Style { get; set; }

Kotlin

var style: BarStyle

sustainPedals

The sustain pedal markers within this bar.

JavaScript

sustainPedals: SustainPedalMarker[];

C#

IList<SustainPedalMarker> SustainPedals { get; set; }

Kotlin

var sustainPedals: alphaTab.collections.List<SustainPedalMarker>

voices

Gets or sets the list of voices contained in this bar.

JavaScript

voices: Voice[];

C#

IList<Voice> Voices { get; set; }

Kotlin

var voices: alphaTab.collections.List<Voice>

Methods

addVoice

(no description)

JavaScript

addVoice(voice: Voice): void

C#

void AddVoice(Voice voice)

Kotlin

fun addVoice(voice: Voice): Unit

Parameter	Summary
voiceAll	(no description)

calculateDuration

(no description)

JavaScript

calculateDuration(): number

C#

double CalculateDuration()

Kotlin

fun calculateDuration(): Double

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)

getActualBarLineLeft

The bar line to draw on the left side of the bar with an "automatic" type resolved to the actual one.

JavaScript

getActualBarLineLeft(isFirstOfSystem: boolean): BarLineStyle

C#

BarLineStyle GetActualBarLineLeft(bool isFirstOfSystem)

Kotlin

fun getActualBarLineLeft(isFirstOfSystem: Boolean): BarLineStyle

Parameter	Summary
isFirstOfSystemAll	Whether the bar is the first one in the system.

getActualBarLineRight

The bar line to draw on the right side of the bar with an "automatic" type resolved to the actual one.

JavaScript

getActualBarLineRight(): BarLineStyle

C#

BarLineStyle GetActualBarLineRight()

Kotlin

fun getActualBarLineRight(): BarLineStyle