ScoreRenderer
The ScoreRenderer
is one of the low level APIs that can be used if no full alphaTab API object with UI interaction
can be used or is needed. It is used to render a given score into a visual music sheet.
This page describes all methods, properties and events exposed by this class.
Name | Summary | ||
---|---|---|---|
Events | |||
errorJavaScript Error.net | This event is fired when an error within alphatab occurred. | ||
partialLayoutFinishedJavaScript PartialLayoutFinished.net | Occurs whenever a part of the whole music sheet is layed out. | ||
partialRenderFinishedJavaScript PartialRenderFinished.net | Occurs whenever a part of the whole music sheet is rendered and can be displayed. | ||
postRenderFinishedJavaScript PostRenderFinished.net | This event is fired when the rendering of the whole music sheet is finished, and all handlers of RenderFinished ran. | ||
preRenderJavaScript PreRender.net | Occurs before the rendering of the tracks starts | ||
renderFinishedJavaScript RenderFinished.net | This event is fired when the rendering of the whole music sheet is finished. | ||
Methods | |||
destroy()JavaScript Destroy().net | Destroys the renderer and all related components. | ||
render()JavaScript Render().net | Initiates a re-rendering of the current setup. | ||
renderResult()JavaScript RenderResult().net | Requests the rendering of a chunk which was layed out before. | ||
renderScore()JavaScript RenderScore().net | Initiates the rendering of the specified tracks of the given score. | ||
resizeRender()JavaScript ResizeRender().net | Initiates a resize-optimized re-rendering of the score using the current settings. | ||
updateSettings()JavaScript UpdateSettings().net | Updates the settings to the given object. | ||
Properties | |||
boundsLookupJavaScript BoundsLookup.net | The lookup which allows fast access to beats at a given position | ||
widthJavaScript Width.net | The width of the rendered score |