jQuery

warning

Listening to alphaTab via DOM events has been deprecated in 1.5 and will be removed in 2.x.

jQuery used to be, and is still, a big player in the Web Development world. For alphaTab we decided that it is not worth to have a dedicated alphaTab jQuery plugin anymore as the AlphaTabApi object already provides an easy-to-use interface making jQuery an unnecessary overhead to maintain.

We recommend migrating all codebases to standard modern JavaScript and our API object.

For historical reference this page describes some aspects on how to use the alphaTab jQuery plugin but avoid using it for new developments.

To initialize alphaTab on any element use jQuery('.selector').alphaTab(). With alphaTab initialized you can either access the API object via jQuery('.selector').alphaTab('api') or use a subset of the API surface. Parameters and return values can be passed accordingly. For properties, if no value is provided, the current value is loaded, if one is provided it is set.

• jq.alphaTab('print') - Delegates to api.print()
• jq.alphaTab('load') - Delegates to api.load()
• jq.alphaTab('render') - Delegates to api.render()
• jq.alphaTab('renderScore') - Delegates to api.renderScore()
• jq.alphaTab('renderTracks') - Delegates to api.renderTracks()
• jq.alphaTab('invalidate') - Delegates to api.render()
• jq.alphaTab('tex') - Delegates to api.tex()
• jq.alphaTab('muteTrack') - Delegates to api.changeTrackMute()
• jq.alphaTab('soloTrack') - Delegates to api.changeTrackSolo()
• jq.alphaTab('trackVolume') - Delegates to api.changeTrackVolume()
• jq.alphaTab('loadSoundFont') - Delegates to api.loadSoundFont()
• jq.alphaTab('resetSoundFonts') - Delegates to api.resetSoundFonts()
• jq.alphaTab('pause') - Delegates to api.pause()
• jq.alphaTab('play') - Delegates to api.play()
• jq.alphaTab('playPause') - Delegates to api.playPause()
• jq.alphaTab('stop') - Delegates to api.stop()
• jq.alphaTab('player') - Delegates to api.player
• jq.alphaTab('isReadyForPlayback') - Delegates to api.isReadyForPlayback
• jq.alphaTab('playerState') - Delegates to api.playerState
• jq.alphaTab('masterVolume') - Delegates to api.masterVolume
• jq.alphaTab('metronomeVolume') - Delegates to api.metronomeVolume
• jq.alphaTab('countInVolume') - Delegates to api.countInVolume
• jq.alphaTab('midiEventsPlayedFilter') - Delegates to api.midiEventsPlayedFilter
• jq.alphaTab('playbackSpeed') - Delegates to api.playbackSpeed
• jq.alphaTab('tickPosition') - Delegates to api.tickPosition
• jq.alphaTab('timePosition') - Delegates to api.timePosition
• jq.alphaTab('loop') - Delegates to api.isLooping
• jq.alphaTab('renderer') - Delegates to api.renderer
• jq.alphaTab('score') - Delegates to api.score
• jq.alphaTab('settings') - Delegates to api.settings
• jq.alphaTab('tracks') - Delegates to api.tracks
• jq.alphaTab('destroy') - Delegates to api.destroy

Additionally you can subscribe to alphaTab events via the jQuery event listener mechanisms:

• jq.on('soundFontLoad') - Subscribes to api.destroy
• jq.on('playedBeatChanged') - Subscribes to api.playedBeatChanged
• jq.on('activeBeatsChanged') - Subscribes to api.activeBeatsChanged
• jq.on('beatMouseDown') - Subscribes to api.beatMouseDown
• jq.on('noteMouseDown') - Subscribes to api.noteMouseDown
• jq.on('beatMouseMove') - Subscribes to api.beatMouseMove
• jq.on('noteMouseMove') - Subscribes to api.noteMouseMove
• jq.on('beatMouseUp') - Subscribes to api.beatMouseUp
• jq.on('noteMouseUp') - Subscribes to api.noteMouseUp
• jq.on('scoreLoaded') - Subscribes to api.scoreLoaded
• jq.on('resize') - Subscribes to api.resize
• jq.on('renderStarted') - Subscribes to api.renderStarted
• jq.on('renderFinished') - Subscribes to api.renderFinished
• jq.on('postRenderFinished') - Subscribes to api.postRenderFinished
• jq.on('error') - Subscribes to api.error
• jq.on('playerReady') - Subscribes to api.playerReady
• jq.on('playerFinished') - Subscribes to api.playerFinished
• jq.on('soundFontLoaded') - Subscribes to api.soundFontLoaded
• jq.on('midiLoad') - Subscribes to api.midiLoad
• jq.on('midiFileLoaded') - Subscribes to api.midiLoaded
• jq.on('playerStateChanged') - Subscribes to api.playerStateChanged
• jq.on('playerPositionChanged') - Subscribes to api.playerPositionChanged
• jq.on('midiEventsPlayed') - Subscribes to api.midiEventsPlayed
• jq.on('playbackRangeChanged') - Subscribes to api.playbackRangeChanged
• jq.on('settingsUpdated') - Subscribes to api.settingsUpdated