alphaTab.rendering.BoundsLookup

(no description)

 class BoundsLookup

Properties

isFinished

Gets or sets a value indicating whether this lookup was finished already.

JavaScript

isFinished: boolean;

C#

bool IsFinished { get; set; }

Kotlin

var isFinished: Boolean

staffSystems

Gets a list of all individual staff systems contained in the rendered music notation.

JavaScript

staffSystems: StaffSystemBounds[];

C#

IList<StaffSystemBounds> StaffSystems { get; set; }

Kotlin

var staffSystems: alphaTab.collections.List<StaffSystemBounds>

Methods

addBeat

Adds a new beat to the lookup.

JavaScript

addBeat(bounds: BeatBounds): void

C#

void AddBeat(BeatBounds bounds)

Kotlin

fun addBeat(bounds: BeatBounds): Unit

Parameter	Summary
boundsAll	The beat bounds to add.

addMasterBar

Adds a new master bar to the lookup.

JavaScript

addMasterBar(bounds: MasterBarBounds): void

C#

void AddMasterBar(MasterBarBounds bounds)

Kotlin

fun addMasterBar(bounds: MasterBarBounds): Unit

Parameter	Summary
boundsAll	The master bar bounds to add.

addStaffSystem

Adds a new staff sytem to the lookup.

JavaScript

addStaffSystem(bounds: StaffSystemBounds): void

C#

void AddStaffSystem(StaffSystemBounds bounds)

Kotlin

fun addStaffSystem(bounds: StaffSystemBounds): Unit

Parameter	Summary
boundsAll	The staff system bounds to add.

findBeat

Tries to find the bounds of a given beat.

JavaScript

findBeat(beat: Beat): BeatBounds | null

C#

BeatBounds? FindBeat(Beat beat)

Kotlin

fun findBeat(beat: Beat): BeatBounds?

Parameter	Summary
beatAll	The beat to find.

Returns

The beat bounds if it was rendered, or null if no boundary information is available.

findBeats

Tries to find the bounds of a given beat.

JavaScript

findBeats(beat: Beat): BeatBounds[] | null

C#

IList<BeatBounds>? FindBeats(Beat beat)

Kotlin

fun findBeats(beat: Beat): alphaTab.collections.List<BeatBounds>?

Parameter	Summary
beatAll	The beat to find.

Returns

The beat bounds if it was rendered, or null if no boundary information is available.

findMasterBar

Tries to find the master bar bounds by a given master bar.

JavaScript

findMasterBar(bar: MasterBar): MasterBarBounds | null

C#

MasterBarBounds? FindMasterBar(MasterBar bar)

Kotlin

fun findMasterBar(bar: MasterBar): MasterBarBounds?

Parameter	Summary
barAll	The master bar to find.

Returns

The master bar bounds if it was rendered, or null if no boundary information is available.

findMasterBarByIndex

Tries to find the master bar bounds by a given index.

JavaScript

findMasterBarByIndex(index: number): MasterBarBounds | null

C#

MasterBarBounds? FindMasterBarByIndex(double index)

Kotlin

fun findMasterBarByIndex(index: Double): MasterBarBounds?

Parameter	Summary
indexAll	The index of the master bar to find.

Returns

The master bar bounds if it was rendered, or null if no boundary information is available.

finish

Finishes the lookup for optimized access.

JavaScript

finish(scale?: number): void

C#

void Finish(double? scale)

Kotlin

fun finish(scale: Double?): Unit

Parameter	Summary
scaleAll	(no description)

fromJson

(no description)

JavaScript

static fromJson(json: Map<string, unknown> | null, score: Score): BoundsLookup | null

C#

static BoundsLookup? FromJson(Map<string, object>? json, Score score)

Kotlin

fun fromJson(json: alphaTab.collections.StringAnyMap<String, Any>?, score: Score): BoundsLookup?

Parameter	Summary
jsonAll	(no description)
scoreAll	(no description)

getBeatAtPos

Tries to find a beat at the given absolute position.

JavaScript

getBeatAtPos(x: number, y: number): Beat | null

C#

Beat? GetBeatAtPos(double x, double y)

Kotlin

fun getBeatAtPos(x: Double, y: Double): Beat?

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

Returns

The beat found at the given position or null if no beat could be found.

getNoteAtPos

Tries to find the note at the given position using the given beat for fast access. Use findBeat to find a beat for a given position first.

JavaScript

getNoteAtPos(beat: Beat, x: number, y: number): Note | null

C#

Note? GetNoteAtPos(Beat beat, double x, double y)

Kotlin

fun getNoteAtPos(beat: Beat, x: Double, y: Double): Note?

Parameter	Summary
beatAll	The beat containing the note.
xAll	The X-position of the note.
yAll	The Y-position of the note.

Returns

The note at the given position within the beat.

toJson

(no description)

JavaScript

toJson(): Map<string, unknown>

C#

Map<string, object> ToJson()

Kotlin

fun toJson(): alphaTab.collections.StringAnyMap<String, Any>