alphaTab.rendering.RenderFinishedEventArgs

This eventargs define the details about the rendering and layouting process and are provided whenever a part of of the music sheet is rendered.

 class RenderFinishedEventArgs

Properties

firstMasterBarIndex

Gets or sets the index of the first masterbar that was rendered in this result.

JavaScript

firstMasterBarIndex: number;

C#

double FirstMasterBarIndex { get; set; }

Kotlin

var firstMasterBarIndex: Double

height

Gets or sets the height of the current rendering result.

JavaScript

height: number;

C#

double Height { get; set; }

Kotlin

var height: Double

id

Gets or sets the unique id of this event args.

JavaScript

id: string;

C#

string Id { get; set; }

Kotlin

var id: String

lastMasterBarIndex

Gets or sets the index of the last masterbar that was rendered in this result.

JavaScript

lastMasterBarIndex: number;

C#

double LastMasterBarIndex { get; set; }

Kotlin

var lastMasterBarIndex: Double

renderResult

Gets or sets the render engine specific result object which contains the rendered music sheet.

JavaScript

renderResult: unknown;

C#

object RenderResult { get; set; }

Kotlin

var renderResult: Any

reuseViewport

A value indicating whether the currently rendered viewport can be reused. If set to true, the viewport does NOT need to be cleared as a similar content will be rendered. If set to false, the viewport and any visual partials should be cleared as it could lead to UI disturbances otherwise.

The viewport can be typically used on resize renders or if the user supplied a rendering hint that the new score is "similar" to the old one (e.g. in case of live-editing).

JavaScript

reuseViewport: boolean;

C#

bool ReuseViewport { get; set; }

Kotlin

var reuseViewport: Boolean

totalHeight

Gets or sets the currently known total height of the final music sheet.

JavaScript

totalHeight: number;

C#

double TotalHeight { get; set; }

Kotlin

var totalHeight: Double

totalWidth

Gets or sets the currently known total width of the final music sheet.

JavaScript

totalWidth: number;

C#

double TotalWidth { get; set; }

Kotlin

var totalWidth: Double

width

Gets or sets the width of the current rendering result.

JavaScript

width: number;

C#

double Width { get; set; }

Kotlin

var width: Double

x

Gets or sets the x position of the current rendering result.

JavaScript

x: number;

C#

double X { get; set; }

Kotlin

var x: Double

y

Gets or sets the y position of the current rendering result.

JavaScript

y: number;

C#

double Y { get; set; }

Kotlin

var y: Double