Breaking changes on settings between 0.9.5 and 0.9.6

In 0.9.6 there was a bigger settings rework introduced that very likely broke every setup beside the default one. Please find all changes that were introduced below.

API changes

BeforeAfterDescription
AlphaTab.Settings.Defaults.net
alphaTab.Settings.get_defaults()JavaScript
new AlphaTab.Settings().net
new alphaTab.Settings()JavaScript
The default values for all settings were moved to the constructor. Simply create a new object and all default settings will be configured.
AlphaTabApi.updateLayout(settings,json,dataAttributes)JavaScript
This API was removed. Simply change the settings and call `updateSettings` and `render` to achive the same behavior.

Settings changes

Many settings have now a new place within the settings object, hence many settings might need adjustment in your code. The new mechanism of specifying settings is way more tolerant than the old one: settings are now case insensitive (useWorkers is equal to uSeWoRkerS) and dashes on html attributes are also ignored (data-use-workers is equal to data-useworkers).

  • .net is how the property is named on .net object level
  • JavaScript is how the property is named on the JavaScript object level (alphaTab.Settings instance)
  • JSON is how the property is named when specifying the property as input to alphaTab (usually short hand names)
  • HTML is how the property is named on HTML data attributes
BeforeAfterNotes
UseWorkers.net
useWorkerJavaScript
useWorkerJSON
data-use-workerHTML
Core.UseWorkers.net
core.useWorkersJavaScript
core.useWorkersJSON
useWorkersJSON
data-core-use-workersHTML
data-use-workersHTML
LogLevel.net
logLevelJavaScript
loggingJSON
data-loggingHTML
Core.LogLevel.net
core.logLevelJavaScript
core.logLevelJSON
logLevelJSON
data-core-loglevelHTML
data-loglevelHTML
DisplayMode.net
displayModeJavaScript
displayModeJSON
data-display-modeHTML
Notation.NotationMode.net
notation.notationModeJavaScript
notation.notationModeJSON
data-notation-notationmodeHTML
Scale.net
scaleJavaScript
scaleJSON
data-scaleHTML
Display.Scale.net
display.scaleJavaScript
display.scaleJSON
scaleJSON
data-display-scaleHTML
data-scaleHTML
SlurHeight.net
slurHeightJavaScript
slurHeightJSON
data-slur-heightHTML
Notation.SlurHeight.net
notation.slurHeightJavaScript
notation.slurHeightJSON
data-notation-slur-heightHTML
Engine.net
engineJavaScript
engineJSON
data-engineHTML
Core.Engine.net
core.engineJavaScript
core.engineJSON
engineJSON
data-core-engineHTML
data-engineHTML
StretchForce.net
stretchForceJavaScript
stretchForceJSON
data-stretch-forceHTML
Display.StretchForce.net
display.stretchForceJavaScript
display.stretchForceJSON
stretchForceJSON
data-display-stretchforceHTML
data-stretchforceHTML
ForcePianoFingering.net
forcePianoFingeringJavaScript
forcePianoFingeringJSON
data-force-piano-fingeringHTML
Notation.FingeringMode.net
forcePianoFingeringJavaScript
forcePianoFingeringJSON
data-force-piano-fingeringHTML
Set it to `ScoreForcePiano` or `SingleNoteEffectBandForcePiano` to get the forced piano fingering depending on the preferred display of fingering.
EnableLazyLoading.net
enableLazyLoadingJavaScript
lazyJSON
data-lazyHTML
Core.EnableLazyLoading.net
Core.enableLazyLoadingJavaScript
core.enableLazyLoadingJSON
enableLazyLoadingJSON
data-core-enablelazyloadingHTML
data-enablelazyloadingHTML
TranspositionPitches.net
transpositionPitchesJavaScript
transpositionPitchesJSON
data-transposition-pitchesHTML
Notation.TranspositionPitches.net
Notation.transpositionPitchesJavaScript
Notation.transpositionPitchesJSON
data-notation-transpositionpitchesHTML
DisplayTranspositionPitches.net
displayTranspositionPitchesJavaScript
displayTranspositionPitchesJSON
data-display-transposition-pitchesHTML
Notation.DisplayTranspositionPitches.net
notation.displayTranspositionPitchesJavaScript
notation.displayTranspositionPitchesJSON
data-notation-displaytranspositionpitchesHTML
ScriptFile.net
scriptFileJavaScript
scriptFileJSON
data-script-fileHTML
Core.ScriptFile.net
core.scriptFileJavaScript
core.scriptFileJSON
scriptFileJSON
data-core-script-fileHTML
data-script-fileHTML
FontDirectory.net
fontDirectoryJavaScript
fontDirectoryJSON
data-font-directoryHTML
Core.FontDirectory.net
core.fontDirectoryJavaScript
core.fontDirectoryJSON
fontDirectoryJSON
data-core-font-directoryHTML
data-font-directoryHTML
SmallGraceTabNotes.net
smallGraceTabNotesJavaScript
smallGraceTabNotesJSON
data-small-grace-tab-notesHTML
Notation.SmallGraceTabNotes.net
notation.smallGraceTabNotesJavaScript
notation.smallGraceTabNotesJSON
data-notation-smallgracetabnotesHTML
FingeringMode.net
fingeringModeJavaScript
fingeringModeJSON
data-fingering-modeHTML
Notation.FingeringMode.net
notation.fingeringModeJavaScript
notation.fingeringModeJSON
data-notation-fingering-modeHTML
ExtendBendArrowsOnTiedNotes.net
extendBendArrowsOnTiedNotesJavaScript
extendBendArrowsOnTiedNotesJSON
data-extend-bend-arrows-on-tied-notesHTML
Notation.ExtendBendArrowsOnTiedNotes.net
notation.extendBendArrowsOnTiedNotesJavaScript
notation.extendBendArrowsOnTiedNotesJSON
data-notation-extendbendarrowsontiednotesHTML
ShowParenthesisForTiedBends.net
showParenthesisForTiedBendsJavaScript
showParenthesisForTiedBendsJSON
data-show-parenthesis-for-tied-bendsHTML
Notation.ShowParenthesisForTiedBends.net
notation.showParenthesisForTiedBendsJavaScript
notation.showParenthesisForTiedBendsJSON
data-notation-showparenthesisfortiedbendsHTML
ShowTabNoteOnTiedBend.net
showTabNoteOnTiedBendJavaScript
showTabNoteOnTiedBendJSON
data-show-tab-note-on-tied-bendHTML
Notation.ShowTabNoteOnTiedBend.net
notation.showTabNoteOnTiedBendJavaScript
notation.showTabNoteOnTiedBendJSON
data-notation-showtabnoteontiedbendHTML
ShowZeroOnDiveWhammy.net
showZeroOnDiveWhammyJavaScript
showZeroOnDiveWhammyJSON
data-show-zero-on-dive-whammyHTML
Notation.ShowZeroOnDiveWhammy.net
notation.showZeroOnDiveWhammyJavaScript
notation.showZeroOnDiveWhammyJSON
data-notation-showzeroondivewhammyHTML
ExtendLineEffectsToBeatEnd.net
extendLineEffectsToBeatEndJavaScript
extendLineEffectsToBeatEndJSON
data-extend-line-effects-to-beat-endHTML
Notation.ExtendLineEffectsToBeatEnd.net
notation.extendLineEffectsToBeatEndJavaScript
notation.extendLineEffectsToBeatEndJSON
data-notation-extendlineeffectstobeatendHTML
SongBookBendDuration.net
songBookBendDurationJavaScript
songBookBendDurationJSON
data-song-book-bend-durationHTML
Player.SongBookBendDuration.net
player.songBookBendDurationJavaScript
player.songBookBendDurationJSON
data-player-songbookbenddurationHTML
SongBookDipDuration.net
songBookDipDurationJavaScript
songBookDipDurationJSON
data-song-book-dip-durationHTML
Player.SongBookDipDuration.net
player.songBookDipDurationJavaScript
player.songBookDipDurationJSON
data-player-songbookdipdurationHTML
Layout.Mode.net
layout.modeJavaScript
layout.modeJSON
layoutJSON
data-layoutHTML
Display.LayoutMode.net
display.layoutModeJavaScript
display.layoutModeJSON
layoutModeJSON
data-display-layout-modeHTML
data-layout-modeHTML
The display mode is now a strong typed enumeration.
Layout.AdditionalSettings["barsPerRow"].net
layout.additionalSettings.barsPerRowJavaScript
layout.additionalSettings.barsPerRowJSON
data-layout-bars-per-rowHTML
Display.BarsPerRow.net
display.barsPerRowJavaScript
display.barsPerRowJSON
barsPerRowJSON
data-display-barsperrowHTML
data-barsperrowHTML
Layout.AdditionalSettings["start"].net
layout.additionalSettings.startJavaScript
layout.additionalSettings.startJSON
data-layout-startHTML
Display.StartBar.net
display.startBarJavaScript
display.startBarJSON
startBarJSON
data-display-startbarHTML
data-startbarHTML
Layout.AdditionalSettings["count"].net
layout.additionalSettings.countJavaScript
layout.additionalSettings.countJSON
data-layout-countHTML
Display.BarCount.net
display.barCountJavaScript
display.barCountJSON
barCountJSON
data-display-barcountHTML
data-barcountHTML
Layout.AdditionalSettings["hideInfo"].net
layout.additionalSettings.hideInfoJavaScript
layout.additionalSettings.hideInfoJSON
data-layout-hide-infoHTML
Display.HideInfo.net
display.hideInfoJavaScript
display.hideInfoJSON
hideInfoJSON
data-display-hideinfoHTML
data-hideinfoHTML
Layout.AdditionalSettings["hideTuning"].net
layout.additionalSettings.hideTuningJavaScript
layout.additionalSettings.hideTuningJSON
data-layout-hide-tuningHTML
Display.HideTuning.net
display.hideTuningJavaScript
display.hideTuningJSON
hideTuningJSON
data-display-hidetuningHTML
data-hidetuningHTML
Layout.AdditionalSettings["hideChordDiagram"].net
layout.additionalSettings.hideChordDiagramJavaScript
layout.additionalSettings.hideChordDiagramJSON
data-layout-hide-chord-diagramHTML
Display.HideChordDiagrams.net
display.hideChordDiagramsJavaScript
display.hideChordDiagramsJSON
hideChordDiagramsJSON
data-display-hidechorddiagramsHTML
data-hidechorddiagramsHTML
Layout.AdditionalSettings["hideTrackNames"].net
layout.additionalSettings.hideTrackNamesJavaScript
layout.additionalSettings.hideTrackNamesJSON
data-layout-hide-track-namesHTML
Display.HideTrackNames.net
display.hideTrackNamesJavaScript
display.hideTrackNamesJSON
hideTrackNamesJSON
data-display-hidetracknamesHTML
data-hidetracknamesHTML
IncludeNoteBounds.net
includeNoteBoundsJavaScript
includeNoteBoundsJSON
data-include-note-boundsHTML
Core.IncludeNoteBounds.net
core.includeNoteBoundsJavaScript
core.includeNoteBoundsJSON
includeNoteBoundsJSON
data-core-includenoteboundsHTML
data-includenoteboundsHTML
PlayTripletFeel.net
playTripletFeelJavaScript
playTripletFeelJSON
data-play-triplet-feelHTML
player.PlayTripletFeel.net
player.playTripletFeelJavaScript
player.playTripletFeelJSON
data-player-playtripletfeelHTML
Vibrato.NoteSlightAmplitude.net
vibrato.noteSlightAmplitudeJavaScript
vibrato.noteSlightAmplitudeJSON
data-vibrato-note-slight-amplitudeHTML
Player.Vibrato.NoteSlightAmplitude.net
player.vibrato.noteSlightAmplitudeJavaScript
player.vibrato.noteSlightAmplitudeJSON
data-player-vibrato-noteslightamplitudeHTML
Vibrato.NoteWideAmplitude.net
vibrato.noteWideAmplitudeJavaScript
vibrato.noteWideAmplitudeJSON
data-vibrato-note-wide-amplitudeHTML
Player.Vibrato.NoteWideAmplitude.net
player.vibrato.noteWideAmplitudeJavaScript
player.vibrato.noteWideAmplitudeJSON
data-player-vibrato-notewideamplitudeHTML
Vibrato.NoteSlightLength.net
vibrato.noteSlightLengthJavaScript
vibrato.noteSlightLengthJSON
data-vibrato-note-slight-lengthHTML
Player.Vibrato.NoteSlightLength.net
player.vibrato.noteSlightLengthJavaScript
player.vibrato.noteSlightLengthJSON
data-player-vibrato-noteslightlengthHTML
Vibrato.NoteWideLength.net
vibrato.noteWideLengthJavaScript
vibrato.noteWideLengthJSON
data-vibrato-note-wide-lengthHTML
Player.Vibrato.NoteWideLength.net
player.vibrato.noteWideLengthJavaScript
player.vibrato.noteWideLengthJSON
data-player-vibrato-notewidelengthHTML
Vibrato.BeatSlightAmplitude.net
vibrato.beatSlightAmplitudeJavaScript
vibrato.beatSlightAmplitudeJSON
data-vibrato-beat-slight-amplitudeHTML
Player.Vibrato.BeatSlightAmplitude.net
player.vibrato.beatSlightAmplitudeJavaScript
player.vibrato.beatSlightAmplitudeJSON
data-player-vibrato-beatslightamplitudeHTML
Vibrato.BeatWideAmplitude.net
vibrato.beatWideAmplitudeJavaScript
vibrato.beatWideAmplitudeJSON
data-vibrato-beat-wide-amplitudeHTML
Player.Vibrato.BeatWideAmplitude.net
player.vibrato.beatWideAmplitudeJavaScript
player.vibrato.beatWideAmplitudeJSON
data-player-vibrato-beatwideamplitudeHTML
Vibrato.BeatSlightLength.net
vibrato.beatSlightLengthJavaScript
vibrato.beatSlightLengthJSON
data-vibrato-beat-slight-lengthHTML
Player.Vibrato.BeatSlightLength.net
player.vibrato.beatSlightLengthJavaScript
player.vibrato.beatSlightLengthJSON
data-player-vibrato-beatslightlengthHTML
Vibrato.BeatWideLength.net
vibrato.beatWideLengthJavaScript
vibrato.beatWideLengthJSON
data-vibrato-beat-wide-lengthHTML
Player.Vibrato.BeatWideLength.net
player.vibrato.beatWideLengthJavaScript
player.vibrato.beatWideLengthJSON
data-player-vibrato-beatwidelengthHTML
Staves.Id.net
staves.idJavaScript
staves.idJSON
stavesJSON
data-stavesHTML
Display.StaveProfile.net
display.staveProfileJavaScript
display.staveProfileJSON
staveProfileJSON
data-display-staveprofileHTML
data-staveprofileHTML
Staves.AdditionalSettings["rhythm"].net
staves.additionalSettings.rhythmJavaScript
staves.additionalSettings.rhythmJSON
data-staves-rhythmHTML
Notation.RhythmMode.net
notation.rhythmModeJavaScript
notation.rhythmModeJSON
data-notation-rhythmmodeHTML
Staves.AdditionalSettings["rhythmBeams"].net
staves.additionalSettings.rhythmBeamsJavaScript
staves.additionalSettings.rhythmBeamsJSON
data-staves-rhythm-beamsHTML
Notation.RhythmMode.net
notation.rhythmModeJavaScript
notation.rhythmModeJSON
data-notation-rhythmmodeHTML
Staves.AdditionalSettings["rhythmHeight"].net
staves.additionalSettings.rhythmHeightJavaScript
staves.additionalSettings.rhythmHeightJSON
data-staves-rhythm-heightHTML
Notation.RhythmHeight.net
notation.rhythmHeightJavaScript
notation.rhythmHeightJSON
data-notation-rhythmheightHTML
EnablePlayer.net
enablePlayerJavaScript
enablePlayerJSON
data-playerHTML
Player.EnablePlayer.net
player.enablePlayerJavaScript
player.enablePlayerJSON
data-player-enableplayerHTML
On JavaScript earlier the setting controlled both enabling the player and which soundfont should be loaded. Now it really only controls whether the player should be enabled. The soundfont is specified via `SoundFont` or loaded manually via API.
SoundFontFile.net
soundFontFileJavaScript
soundFontFileJSON
data-playerHTML
Player.SoundFont.net
player.soundFontJavaScript
player.soundFontJSON
data-player-soundfontHTML
EnableCursor.net
enableCursorJavaScript
cursorJSON
data-cursorHTML
Player.EnableCursor.net
player.enableCursorJavaScript
player.enableCursorJSON
data-player-enablecursorHTML
ImporterSettings["encoding"].net
importer.encodingJavaScript
importer.encodingJSON
data-importer-encodingHTML
Importer.Encoding.net
importer.encodingJavaScript
importer.encodingJSON
data-importer-encodingHTML
Staves.ImporterSettings["musicXMLMergePartGroups"].net
staves.importer.musicXMLMergePartGroupsJavaScript
staves.importer.musicXMLMergePartGroupsJSON
data-importer-musicxml-merge-part-groupsHTML
Importer.MergePartGroupsInMusicXml.net
importer.mergePartGroupsInMusicXmlJavaScript
importer.mergePartGroupsInMusicXmlJSON
data-importer-mergepartgroupsinmusicxmlHTML
RenderingResources.CopyrightFont.net
resources.copyrightFontJavaScript
resources.copyrightFontJSON
data-resources-copyright-fontHTML
Display.Resources.CopyrightFont.net
display.resources.copyrightFontJavaScript
display.resources.copyrightFontJSON
resources.copyrightFontJSON
data-display-resources-copyrightfontHTML
data-resources-copyrightfontHTML
RenderingResources.TitleFont.net
resources.titleFontJavaScript
resources.titleFontJSON
data-resources-title-fontHTML
Display.Resources.TitleFont.net
display.resources.titleFontJavaScript
display.resources.titleFontJSON
resources.titleFontJSON
data-display-resources-titlefontHTML
data-resources-titlefontHTML
RenderingResources.SubTitleFont.net
resources.subTitleFontJavaScript
resources.subTitleFontJSON
data-resources-subtitle-fontHTML
Display.Resources.SubTitleFont.net
display.resources.subTitleFontJavaScript
display.resources.subTitleFontJSON
resources.subTitleFontJSON
data-display-resources-subtitlefontHTML
data-resources-subtitlefontHTML
RenderingResources.WordsFont.net
resources.wordsFontJavaScript
resources.wordsFontJSON
data-resources-words-fontHTML
Display.Resources.WordsFont.net
display.resources.wordsFontJavaScript
display.resources.wordsFontJSON
resources.wordsFontJSON
data-display-resources-wordsfontHTML
data-resources-wordsfontHTML
RenderingResources.EffectFont.net
resources.effectFontJavaScript
resources.effectFontJSON
data-resources-effect-fontHTML
Display.Resources.EffectFont.net
display.resources.effectFontJavaScript
display.resources.effectFontJSON
resources.effectFontJSON
data-display-resources-effectfontHTML
data-resources-effectfontHTML
RenderingResources.FretboardNumberFont.net
resources.fretboardNumberFontJavaScript
resources.fretboardNumberFontJSON
data-resources-fretboard-number-fontHTML
Display.Resources.FretboardNumberFont.net
display.resources.fretboardNumberFontJavaScript
display.resources.fretboardNumberFontJSON
resources.fretboardNumberFontJSON
data-display-resources-fretboardnumberfontHTML
data-resources-fretboardnumberfontHTML
RenderingResources.TablatureFont.net
resources.tablatureFontJavaScript
resources.tablatureFontJSON
data-resources-tablature-fontHTML
Display.Resources.TablatureFont.net
display.resources.tablatureFontJavaScript
display.resources.tablatureFontJSON
resources.tablatureFontJSON
data-display-resources-tablaturefontHTML
data-resources-tablaturefontHTML
RenderingResources.GraceFont.net
resources.graceFontJavaScript
resources.graceFontJSON
data-resources-grace-fontHTML
Display.Resources.GraceFont.net
display.resources.graceFontJavaScript
display.resources.graceFontJSON
resources.graceFontJSON
data-display-resources-gracefontHTML
data-resources-gracefontHTML
RenderingResources.BarNumberFont.net
resources.barNumberFontJavaScript
resources.barNumberFontJSON
data-resources-bar-number-fontHTML
Display.Resources.BarNumberFont.net
display.resources.barNumberFontJavaScript
display.resources.barNumberFontJSON
resources.barNumberFontJSON
data-display-resources-barnumberfontHTML
data-resources-barnumberfontHTML
RenderingResources.FingeringFont.net
resources.fingeringFontJavaScript
resources.fingeringFontJSON
data-resources-fingering-fontHTML
Display.Resources.FingeringFont.net
display.resources.fingeringFontJavaScript
display.resources.fingeringFontJSON
resources.fingeringFontJSON
data-display-resources-fingeringfontHTML
data-resources-fingeringfontHTML
RenderingResources.MarkerFont.net
resources.markerFontJavaScript
resources.markerFontJSON
data-resources-marker-fontHTML
Display.Resources.MarkerFont.net
display.resources.markerFontJavaScript
display.resources.markerFontJSON
resources.markerFontJSON
data-display-resources-markerfontHTML
data-resources-markerfontHTML
RenderingResources.StaffLineColor.net
resources.staffLineColorJavaScript
resources.staffLineColorJSON
data-resources-staff-line-colorHTML
Display.Resources.StaffLineColor.net
display.resources.staffLineColorJavaScript
display.resources.staffLineColorJSON
resources.staffLineColorJSON
data-display-resources-stafflinecolorHTML
data-resources-stafflinecolorHTML
RenderingResources.BarNumberColor.net
resources.barNumberColorJavaScript
resources.barNumberColorJSON
data-resources-bar-number-colorHTML
Display.Resources.BarNumberColor.net
display.resources.barNumberColorJavaScript
display.resources.barNumberColorJSON
resources.barNumberColorJSON
data-display-resources-barnumbercolorHTML
data-resources-barnumbercolorHTML
RenderingResources.BarSeparatorColor.net
resources.barSeparatorColorJavaScript
resources.barSeparatorColorJSON
data-resources-bar-separator-colorHTML
Display.Resources.BarSeparatorColor.net
display.resources.barSeparatorColorJavaScript
display.resources.barSeparatorColorJSON
resources.barSeparatorColorJSON
data-display-resources-barseparatorcolorHTML
data-resources-barseparatorcolorHTML
RenderingResources.MainGlyphColor.net
resources.mainGlyphColorJavaScript
resources.mainGlyphColorJSON
data-resources-main-glyph-colorHTML
Display.Resources.MainGlyphColor.net
display.resources.mainGlyphColorJavaScript
display.resources.mainGlyphColorJSON
resources.mainGlyphColorJSON
data-display-resources-mainglyphcolorHTML
data-resources-mainglyphcolorHTML
RenderingResources.SecondaryGlyphColor.net
resources.secondaryGlyphColorJavaScript
resources.secondaryGlyphColorJSON
data-resources-secondary-glyph-colorHTML
Display.Resources.SecondaryGlyphColor.net
display.resources.secondaryGlyphColorJavaScript
display.resources.secondaryGlyphColorJSON
resources.secondaryGlyphColorJSON
data-display-resources-secondaryglyphcolorHTML
data-resources-secondaryglyphcolorHTML
RenderingResources.ScoreInfoColor.net
resources.scoreInfoColorJavaScript
resources.scoreInfoColorJSON
data-resources-score-info-colorHTML
Display.Resources.ScoreInfoColor.net
display.resources.scoreInfoColorJavaScript
display.resources.scoreInfoColorJSON
resources.scoreInfoColorJSON
data-display-resources-scoreinfocolorHTML
data-resources-scoreinfocolorHTML
ScrollOffsetX.net
scrollOffsetXJavaScript
playerOffsetJSON
playerOffset[0]JSON
data-player-offsetHTML
player.ScrollOffsetX.net
player.scrollOffsetXJavaScript
player.scrollOffsetXJSON
data-player-scrolloffsetxHTML
ScrollOffsetY.net
scrollOffsetYJavaScript
playerOffsetJSON
playerOffset[1]JSON
data-player-offsetHTML
player.ScrollOffsetY.net
player.scrollOffsetYJavaScript
player.scrollOffsetYJSON
data-player-scrolloffsetyHTML
ScrollMode.net
scrollModeJavaScript
autoScrollJSON
data-auto-scrollHTML
player.ScrollMode.net
player.scrollModeJavaScript
player.scrollModeJSON
data-player-scrollmodeHTML
ScrollSpeed.net
scrollSpeedJavaScript
scrollSpeedJSON
player.ScrollSpeed.net
player.scrollSpeedJavaScript
player.scrollSpeedJSON
data-player-scrollspeedHTML
ScrollElement.net
scrollElementJavaScript
scrollElementJSON
data-scroll-elementHTML
Player.ScrollElement.net
player.scrollElementJavaScript
player.scrollElementJSON
data-player-scroll-elementHTML
BeatCursorWidth.net
beatCursorWidthJavaScript
beatCursorWidthJSON
data-beat-cursor-widthHTML
Setting was removed4 use CSS like for the other stylings to set the width of the beat cursor.

Side-by-side Comparison

Right below you can find a side-by-side comparison between a settings object before and after the rework.

BeforeAfter
{
scriptFile: null,
fontDirectory: null,
enableLazyLoading: true,
soundFontFile: null,
scrollElement: "html,body",
scale: 1,
engine: "default",
layout: {
mode: "page",
additionalSettings: {}
},
importerSettings: {},
stretchForce: 1,
forcePianoFingering: false,
staves: {
id: "default",
additionalSettings: {}
},
transpositionPitches: [],
displayTranspositionPitches: [],
logLevel: "info"
smallGraceTabNotes: true,
extendBendArrowsOnTiedNotes: true,
showParenthesisForTiedBends: true,
showTabNoteOnTiedBend: true,
displayMode: 0,
fingeringMode: 0,
showZeroOnDiveWhammy: false,
extendLineEffectsToBeatEnd: false,
vibrato: {
noteWideLength: 480,
noteWideAmplitude: 2,
noteSlightLength: 480,
noteSlightAmplitude: 2,
beatWideLength: 240,
beatWideAmplitude: 3,
beatSlightLength: 240,
beatSlightAmplitude: 3
}
playTripletFeel: true,
slurHeight: 7,
songBookBendDuration: 75,
songBookDipDuration: 150,
includeNoteBounds: false,
useWorkers: true,
enablePlayer: false,
enableCursor: false,
beatCursorWidth: 3,
scrollOffsetX: 0,
scrollOffsetY: 0,
scrollMode: "continuous",
scrollSpeed: 300,
renderingResources: {
copyrightFont: "bold 12px 'Arial'",
titleFont: "32px 'Georgia'",
subTitleFont: "20px 'Georgia'",
wordsFont: "15px 'Georgia'",
effectFont: "italic 12px 'Georgia'",
fretboardNumberFont: "11px 'Arial'",
tablatureFont: "13px 'Arial'",
graceFont: "11px 'Arial'",
staffLineColor: "#A5A5A5",
barSeparatorColor:"#222211",
barNumberFont: "11px 'Arial'",
barNumberColor: "#C80000"},
fingeringFont: "14px 'Georgia'",
markerFont: "bold 14px 'Georgia'",
mainGlyphColor: "#000000",
secondaryGlyphColor: "rgba(0,0,0,0.40)",
scoreInfoColor: "#000000"
}
}
{
core: {
includeNoteBounds: false,
useWorkers: true,
logLevel: "info",
engine: "default",
enableLazyLoading: true,
scriptFile: "https://docs.alphatab.net/develop/js/alphaTab/alphaTab.js",
fontDirectory: "https://docs.alphatab.net/develop/js/alphaTab/Font/"
},
display: {
barCountPerPartial: 10
barCount: -1
startBar: 1
barsPerRow: -1
staveProfile: 'default'
layoutMode: 'page',
stretchForce: 1
scale: 1
padding: null,
resources: {
copyrightFont: "bold 12px 'Arial'",
titleFont: "32px 'Georgia'",
subTitleFont: "20px 'Georgia'",
wordsFont: "15px 'Georgia'",
effectFont: "italic 12px 'Georgia'",
fretboardNumberFont: "11px 'Arial'",
tablatureFont: "13px 'Arial'",
graceFont: "11px 'Arial'",
staffLineColor: "#A5A5A5",
barSeparatorColor:"#222211",
barNumberFont: "11px 'Arial'",
barNumberColor: "#C80000",
fingeringFont: "14px 'Georgia'",
markerFont: "bold 14px 'Georgia'",
mainGlyphColor: "#000000",
secondaryGlyphColor: "rgba(0,0,0,0.40)",
scoreInfoColor: "#000000"
}
},
importer: {
mergePartGroupsInMusicXml: false,
encoding: "utf-8"
},
notation: {
slurHeight: 7,
extendLineEffectsToBeatEnd: false,
showZeroOnDiveWhammy: false,
showTabNoteOnTiedBend: true,
showParenthesisForTiedBends: true,
extendBendArrowsOnTiedNotes: true,
smallGraceTabNotes: true,
displayTranspositionPitches: []
transpositionPitches: [],
rhythmHeight: 15,
rhythmMode: "hidden",
hideChordDiagrams: false,
hideTrackNames: false,
hideTuning: false,
hideInfo: false,
fingeringMode: "ScoreDefault",
notationMode: "GuitarPro"
}
player: {
playTripletFeel: true,
vibrato: {
beatSlightAmplitude: 3,
beatSlightLength: 240,
beatWideAmplitude: 3,
beatWideLength: 240,
noteSlightAmplitude: 2,
noteSlightLength: 480,
noteWideAmplitude: 2,
noteWideLength: 480,
}
songBookDipDuration: 150,
songBookBendDuration: 75,
scrollSpeed: 300,
scrollMode: "Continuous",
scrollOffsetY: 0,
scrollOffsetX: 0,
enableCursor: true,
enablePlayer: false,
scrollElement: "html,body",
soundFont: null
}
}