alphaTab.rendering.BeatBounds

Represents the bounds of a single beat.

 class BeatBounds

Properties

barBounds

Gets or sets the reference to the parent BarBounds .

JavaScript

barBounds: BarBounds;

C#

BarBounds BarBounds { get; set; }

Kotlin

var barBounds: BarBounds

beat

Gets or sets the beat related to this bounds.

JavaScript

beat: Beat;

C#

Beat Beat { get; set; }

Kotlin

var beat: Beat

notes

Gets or sets the individual note positions of this beat (if CoreSettings.includeNoteBounds was set to true).

JavaScript

notes: NoteBounds[] | null;

C#

IList<NoteBounds>? Notes { get; set; }

Kotlin

var notes: alphaTab.collections.List<NoteBounds>?

onNotesX

Gets or sets x-position where the timely center of the notes for this beat is. This is where the cursor should be at the time when this beat is played.

JavaScript

onNotesX: number;

C#

double OnNotesX { get; set; }

Kotlin

var onNotesX: Double

realBounds

Gets or sets the actual bounds of the elements in this beat including whitespace areas.

JavaScript

realBounds: Bounds;

C#

Bounds RealBounds { get; set; }

Kotlin

var realBounds: Bounds

visualBounds

Gets or sets the bounds covering all visually visible elements spanning this beat.

JavaScript

visualBounds: Bounds;

C#

Bounds VisualBounds { get; set; }

Kotlin

var visualBounds: Bounds

Methods

addNote

Adds a new note to this bounds.

JavaScript

addNote(bounds: NoteBounds): void

C#

void AddNote(NoteBounds bounds)

Kotlin

fun addNote(bounds: NoteBounds): Unit

Parameter	Summary
boundsAll	The note bounds to add.

findNoteAtPos

Tries to find a note at the given position.

JavaScript

findNoteAtPos(x: number, y: number): Note | null

C#

Note? FindNoteAtPos(double x, double y)

Kotlin

fun findNoteAtPos(x: Double, y: Double): Note?

Parameter	Summary
xAll	The X-position of the note to find.
yAll	The Y-position of the note to find.

Returns

The note at the given position or null if no note was found, or the note lookup was not enabled before rendering.

finish

Finishes the lookup object and optimizes itself for fast access.

JavaScript

finish(scale?: number): void

C#

void Finish(double? scale)

Kotlin

fun finish(scale: Double?): Unit

Parameter	Summary
scaleAll	(no description)