Skip to main content

notation.elements

since 0.9.8
notation.elementsJavaScriptnotation.elementsJSONNotation.Elements.netnotation.elementsAndroid

Description​

Whether music notation elements are visible or not. AlphaTab has quite a set of notation elements that are usually shown by default or only shown when using the SongBook notation mode. This setting allows showing/hiding individual notation elements like the song information or the track names.

For each element you can configure whether it is visible or not. The setting is a Map/Dictionary where the key is the element to configure and the value is a boolean value whether it should be visible or not.

elements: Map<NotationElement, boolean> = [[NotationElement.ZerosOnDiveWhammys, false]];

Examples​

Internally the setting is a Map where the key must be a NotationElement enumeration value. For JSON input the usual enumeration serialization applies where also the names can be used. The names are case insensitive.

const api = new alphaTab.AlphaTabApi(document.querySelector('#alphaTab'), {
notation: {
elements: {
scoreTitle: false,
trackNames: false
}
}
});
api.settings.notation.elements.set(alphaTab.NotationElement.EffectWhammyBar, false);