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

notation.elementsAndroid

Element	Description	Default Visibility
ScoreTitle	The score title shown at the start of the music sheet.	visible
ScoreSubTitle	The score subtitle shown at the start of the music sheet.	visible
ScoreArtist	The score artist shown at the start of the music sheet.	visible
ScoreAlbum	The score album shown at the start of the music sheet.	visible
ScoreWords	The score words author shown at the start of the music sheet.	visible
ScoreMusic	The score music author shown at the start of the music sheet.	visible
ScoreWordsAndMusic	The score words&music author shown at the start of the music sheet.	visible
ScoreCopyright	The score copyright owner shown at the start of the music sheet.	visible
GuitarTuning	The tuning information of the guitar shown above the staves.	visible
TrackNames	The track names which are shown in the accolade.	visible
ChordDiagrams	The chord diagrams for guitars. Usually shown below the score info.	visible
ParenthesisOnTiedBends	Parenthesis that are shown for tied bends if they are preceeded by bends.	visible
TabNotesOnTiedBends	The tab number for tied notes if the bend of a note is increased at that point.	visible
ZerosOnDiveWhammys	Zero tab numbers on "dive whammys".	not visible
EffectAlternateEndings	The alternate endings information on repeats shown above the staff.	visible
EffectCapo	The information about the fret on which the capo is placed shown above the staff.	visible
EffectChordNames	The chord names shown above beats shown above the staff.	visible
EffectCrescendo	The crescendo/decrescendo angle shown above the staff.	visible
EffectDynamics	The beat dynamics shown above the staff.	visible
EffectFadeIn	The curved angle for fade in/out effects shown above the staff.	visible
EffectFermata	The fermata symbol shown above the staff.	visible
EffectFingering	The fingering information.	visible
EffectHarmonics	The harmonics names shown above the staff. (does not represent the harmonic note heads)	visible
EffectLetRing	The let ring name and line above the staff.	visible
EffectLyrics	The lyrics of the track shown above the staff.	visible
EffectMarker	The section markers shown above the staff.	visible
EffectOttavia	The ottava symbol and lines shown above the staff.	visible
EffectPalmMute	The palm mute name and line shown above the staff.	visible
EffectPickSlide	The pick slide information shown above the staff. (does not control the pick slide lines)	visible
EffectPickStroke	The pick stroke symbols shown above the staff.	visible
EffectSlightBeatVibrato	The slight beat vibrato waves shown above the staff.	visible
EffectSlightNoteVibrato	The slight note vibrato waves shown above the staff.	visible
EffectTap	The tap/slap/pop effect names shown above the staff.	visible
EffectTempo	The tempo information shown above the staff.	visible
EffectText	The additional beat text shown above the staff.	visible
EffectTrill	The trill name and waves shown above the staff.	visible
EffectTripletFeel	The triplet feel symbol shown above the staff.	visible
EffectWhammyBar	The whammy bar information shown above the staff. (does not control the whammy lines shown within the staff)	visible
EffectWideBeatVibrato	The wide beat vibrato waves shown above the staff.	visible
EffectWideNoteVibrato	The wide note vibrato waves shown above the staff.	visible

Examples

JavaScript

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);

HTML

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>

C#

var settings = new AlphaTab.Settings();
settings.Notation.Elements[AlphaTab.NotationElement.ScoreTitle] = false;
settings.Notation.Elements[AlphaTab.NotationElement.TrackNames] = false;