Toggling notation elements off

alphaTab draws every notation category by default. The notation.elements map lets you flip individual categories off — score title, tuning, bar numbers, palm-mute brackets, whammy annotations, lyrics, or any of the other entries in the NotationElement enumeration. Reach for it when a chart needs a compact printout, when your renderer already provides its own title bar, or when an editor UI needs to preview one element at a time.

Score titleGuitar tuningBar numbersWhammy bandDynamicsPalm-mute brackets

Flip a checkbox to remove that category from the score. Each toggle maps to one NotationElement key on the notation.elements map.

What you can toggle

Every enum entry maps to one rendered piece of the score. The categories fall into four groups:

• Score info — ScoreTitle, ScoreSubTitle, ScoreArtist, ScoreAlbum, ScoreWords, ScoreMusic, ScoreWordsAndMusic, ScoreCopyright.
• Track chrome — TrackNames, GuitarTuning, BarNumber, ChordDiagrams, ChordDiagramFretboardNumbers, RepeatCount.
• Effect bands — EffectAlternateEndings, EffectChordNames, EffectDynamics, EffectFermata, EffectFingering, EffectHarmonics, EffectLetRing, EffectLyrics, EffectMarker, EffectOttavia, EffectPalmMute, EffectPickSlide, EffectPickStroke, EffectSlightBeatVibrato, EffectSlightNoteVibrato, EffectTap, EffectTempo, EffectText, EffectTrill, EffectTripletFeel, EffectWhammyBar, EffectWideBeatVibrato, EffectWideNoteVibrato, EffectLeftHandTap, EffectFreeTime, EffectSustainPedal, EffectGolpe, EffectWahPedal, EffectBeatBarre, EffectNoteOrnament, EffectRasgueado, EffectDirections, EffectBeatTimer, EffectCapo, EffectCrescendo, EffectFadeIn.
• Notation glyphs — ScoreBendSlur, EffectWhammyBarLine, EffectNumberedNotationKeySignature, EffectHammerOnPullOffText, EffectSlideText, ParenthesisOnTiedBends, TabNotesOnTiedBends, ZerosOnDiveWhammys.

ZerosOnDiveWhammys is off by default; every other entry is on by default.

Show it in code

Pass a Map (JavaScript / TypeScript) or a dictionary (JSON, .NET, Kotlin) keyed by the enum. Values are booleans:

import * as alphaTab from '@coderline/alphatab';

const container = getAlphaTabContainer();
const api = new alphaTab.AlphaTabApi(container, {
  core: { file: '/scores/song.gp' },
  notation: {
    elements: new Map([
      [alphaTab.NotationElement.EffectWhammyBar, false],
      [alphaTab.NotationElement.BarNumber, false],
      [alphaTab.NotationElement.TrackNames, false],
    ]),
  },
});

getAlphaTabContainer() is a placeholder for the platform-specific render target — a <div> on Web, an AlphaTab control on .NET, or an AlphaTabView on Android.

For JSON input, use the camelCase enum name as the key:

{
  "notation": {
    "elements": {
      "effectWhammyBar": false,
      "barNumber": false
    }
  }
}

To flip an entry at runtime, mutate the map on api.settings.notation.elements and call api.render():

api.settings.notation.elements.set(alphaTab.NotationElement.EffectLyrics, false);
api.render();

Where to look next

• Staff element display — control clefs, key and time signatures, bar numbers and tab rests per staff type, staff or bar instead of score-wide.
• NotationElement — the full enumeration with every value.
• notation.elements — the setting reference.
• Effects and articulations — the effect bands you can flip individually.
• Dynamics, hairpins, and accents — hide dynamics with the granular EffectDynamics toggle, or use the stylesheet-wide hideDynamics shortcut.
• Hiding dynamics — the score-wide stylesheet shortcut for the dynamics category.
• updateSettings and render — the API surface used when flipping toggles after load.