Skip to main content

notation.elements

since 0.9.8

Description

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.

notation.elementsJavaScript
notation.elementsJSON
data-notation-elementsHTML
Notation.Elements.net
ElementDescriptionDefault Visibility
ScoreTitleThe score title shown at the start of the music sheet.visible
ScoreSubTitleThe score subtitle shown at the start of the music sheet.visible
ScoreArtistThe score artist shown at the start of the music sheet.visible
ScoreAlbumThe score album shown at the start of the music sheet.visible
ScoreWordsThe score words author shown at the start of the music sheet.visible
ScoreMusicThe score music author shown at the start of the music sheet.visible
ScoreWordsAndMusicThe score words&music author shown at the start of the music sheet.visible
ScoreCopyrightThe score copyright owner shown at the start of the music sheet.visible
GuitarTuningThe tuning information of the guitar shown above the staves.visible
TrackNamesThe track names which are shown in the accolade.visible
ChordDiagramsThe chord diagrams for guitars. Usually shown below the score info.visible
ParenthesisOnTiedBendsParenthesis that are shown for tied bends if they are preceeded by bends.visible
TabNotesOnTiedBendsThe tab number for tied notes if the bend of a note is increased at that point.visible
ZerosOnDiveWhammysZero tab numbers on "dive whammys".not visible
EffectAlternateEndingsThe alternate endings information on repeats shown above the staff.visible
EffectCapoThe information about the fret on which the capo is placed shown above the staff.visible
EffectChordNamesThe chord names shown above beats shown above the staff.visible
EffectCrescendoThe crescendo/decrescendo angle shown above the staff.visible
EffectDynamicsThe beat dynamics shown above the staff.visible
EffectFadeInThe curved angle for fade in/out effects shown above the staff.visible
EffectFermataThe fermata symbol shown above the staff.visible
EffectFingeringThe fingering information.visible
EffectHarmonicsThe harmonics names shown above the staff. (does not represent the harmonic note heads)visible
EffectLetRingThe let ring name and line above the staff.visible
EffectLyricsThe lyrics of the track shown above the staff.visible
EffectMarkerThe section markers shown above the staff.visible
EffectOttaviaThe ottava symbol and lines shown above the staff.visible
EffectPalmMuteThe palm mute name and line shown above the staff.visible
EffectPickSlideThe pick slide information shown above the staff. (does not control the pick slide lines)visible
EffectPickStrokeThe pick stroke symbols shown above the staff.visible
EffectSlightBeatVibratoThe slight beat vibrato waves shown above the staff.visible
EffectSlightNoteVibratoThe slight note vibrato waves shown above the staff.visible
EffectTapThe tap/slap/pop effect names shown above the staff.visible
EffectTempoThe tempo information shown above the staff.visible
EffectTextThe additional beat text shown above the staff.visible
EffectTrillThe trill name and waves shown above the staff.visible
EffectTripletFeelThe triplet feel symbol shown above the staff.visible
EffectWhammyBarThe whammy bar information shown above the staff. (does not control the whammy lines shown within the staff)visible
EffectWideBeatVibratoThe wide beat vibrato waves shown above the staff.visible
EffectWideNoteVibratoThe wide note vibrato waves shown above the staff.visible

Examples

Internally the setting is a Map where the key must be a alphaTab.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);

For data attributes currently a full object must be embedded in the attribute value.

<div id="alphaTab" data-notation-elements='{"ScoreTitle": false, "TrackNames": false}'></div>
var settings = new AlphaTab.Settings();
settings.Notation.Elements[AlphaTab.NotationElement.ScoreTitle] = false;
settings.Notation.Elements[AlphaTab.NotationElement.TrackNames] = false;