alphaTab.rendering.StaffSystemBounds

Represents the bounds of a staff system.

 class StaffSystemBounds

Properties

bars

Gets or sets the list of master bar bounds related to this staff system.

JavaScript

bars: MasterBarBounds[];

C#

IList<MasterBarBounds> Bars { get; set; }

Kotlin

var bars: alphaTab.collections.List<MasterBarBounds>

boundsLookup

Gets or sets a reference to the parent bounds lookup.

JavaScript

boundsLookup: BoundsLookup;

C#

BoundsLookup BoundsLookup { get; set; }

Kotlin

var boundsLookup: BoundsLookup

index

Gets or sets the index of the bounds within the parent lookup. This allows fast access of the next/previous system.

JavaScript

index: number;

C#

double Index { get; set; }

Kotlin

var index: Double

isFinished

Whether this system's bounds are already scaled and sorted, either via finish or because the renderer built them that way. Prevents double-scaling when the parent BoundsLookup is preserved across partial renders and finish is invoked again on a mix of systems.

JavaScript

isFinished: boolean;

C#

bool IsFinished { get; set; }

Kotlin

var isFinished: Boolean

realBounds

Gets or sets the actual bounds of the elements in this staff system 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 of this staff system.

JavaScript

visualBounds: Bounds;

C#

Bounds VisualBounds { get; set; }

Kotlin

var visualBounds: Bounds

Methods

addBar

Adds a new master bar to this lookup.

JavaScript

addBar(bounds: MasterBarBounds): void

C#

void AddBar(MasterBarBounds bounds)

Kotlin

fun addBar(bounds: MasterBarBounds): Unit

Parameter	Summary
boundsAll	The master bar bounds to add.

findBarAtPos

Tries to find the master bar bounds that are located at the given X-position.

JavaScript

findBarAtPos(x: number): MasterBarBounds | null

C#

MasterBarBounds? FindBarAtPos(double x)

Kotlin

fun findBarAtPos(x: Double): MasterBarBounds?

Parameter	Summary
xAll	The X-position to find a master bar.

Returns

The master bounds at the given X-position.

finish

Finished the lookup for optimized access. Idempotent: once finished, further calls are no-ops so preserved systems survive partial renders without being re-scaled.

JavaScript

finish(scale?: number): void

C#

void Finish(double? scale)

Kotlin

fun finish(scale: Double?): Unit

Parameter	Summary
scaleAll	(no description)