customScrollHandler

since 1.8.0

customScrollHandlerJavaScriptCustomScrollHandler.netcustomScrollHandlerAndroid

Description

A custom scroll handler which will be used to handle scrolling operations during playback.

JavaScript

customScrollHandler?: IScrollHandler;

C#

IScrollHandler CustomScrollHandler { get; set; }

Kotlin

var customScrollHandler: IScrollHandler

Examples

JavaScript

const api = new alphaTab.AlphaTabApi(document.querySelector('#alphaTab'));
api.customScrollHandler = {
  forceScrollTo(currentBeatBounds) {
    const scroll = api.uiFacade.getScrollElement();
    api.uiFacade.scrollToY(scroll, currentBeatBounds.barBounds.masterBarBounds.realBounds.y, 0);
  },
  onBeatCursorUpdating(startBeat, endBeat, cursorMode, relativePosition, actualBeatCursorStartX, actualBeatCursorEndX, actualBeatCursorTransitionDuration) {
    const scroll = api.uiFacade.getScrollElement();
    api.uiFacade.scrollToY(scroll, startBeat.barBounds.masterBarBounds.realBounds.y, 0);
  }
}

C#

var api = new AlphaTabApi<MyControl>(...);
api.CustomScrollHandler = new CustomScrollHandler();

Android

val api = AlphaTabApi<MyControl>(...)
api.customScrollHandler = CustomScrollHandler();