alphaTab.model.Note

A note is a single played sound on a fretted instrument. It consists of a fret offset and a string on which the note is played on. It also can be modified by a lot of different effects.

 class Note

Properties

accentuated

Gets or sets the accentuation of this note.

JavaScript

accentuated: AccentuationType;

C#

AccentuationType Accentuated { get; set; }

Kotlin

var accentuated: AccentuationType

accidentalMode

Gets or sets how accidetnals for this note should be handled.

JavaScript

accidentalMode: NoteAccidentalMode;

C#

NoteAccidentalMode AccidentalMode { get; set; }

Kotlin

var accidentalMode: NoteAccidentalMode

beat

Gets or sets the reference to the parent beat to which this note belongs to.

JavaScript

beat: Beat;

C#

Beat Beat { get; set; }

Kotlin

var beat: Beat

bendOrigin

Gets or sets the note from which this note continues the bend.

JavaScript

bendOrigin: Note | null;

C#

Note? BendOrigin { get; set; }

Kotlin

var bendOrigin: Note?

bendPoints

Gets or sets a list of the points defining the bend behavior.

JavaScript

bendPoints: BendPoint[] | null;

C#

IList<BendPoint>? BendPoints { get; set; }

Kotlin

var bendPoints: alphaTab.collections.List<BendPoint>?

bendStyle

Gets or sets the bend style for this note.

JavaScript

bendStyle: BendStyle;

C#

BendStyle BendStyle { get; set; }

Kotlin

var bendStyle: BendStyle

bendType

Gets or sets the bend type for this note.

JavaScript

bendType: BendType;

C#

BendType BendType { get; set; }

Kotlin

var bendType: BendType

displayValue

(no description)

JavaScript

readonly displayValue: number;

C#

double DisplayValue { get; }

Kotlin

val displayValue: Double

displayValueWithoutBend

(no description)

JavaScript

readonly displayValueWithoutBend: number;

C#

double DisplayValueWithoutBend { get; }

Kotlin

val displayValueWithoutBend: Double

durationPercent

Gets or sets the percentual duration of the note relative to the overall beat duration.

JavaScript

durationPercent: number;

C#

double DurationPercent { get; set; }

Kotlin

var durationPercent: Double

dynamics

Gets or sets the dynamics for this note.

JavaScript

dynamics: DynamicValue;

C#

DynamicValue Dynamics { get; set; }

Kotlin

var dynamics: DynamicValue

effectSlurDestination

(no description)

JavaScript

effectSlurDestination: Note | null;

C#

Note? EffectSlurDestination { get; set; }

Kotlin

var effectSlurDestination: Note?

effectSlurOrigin

(no description)

JavaScript

effectSlurOrigin: Note | null;

C#

Note? EffectSlurOrigin { get; set; }

Kotlin

var effectSlurOrigin: Note?

element

Deprecated

This member is deprecated.

Gets or sets the percusson element.

JavaScript

readonly element: number;

C#

double Element { get; }

Kotlin

val element: Double

fret

Gets or sets the fret on which this note is played on the instrument. 0 is the nut.

JavaScript

fret: number;

C#

double Fret { get; set; }

Kotlin

var fret: Double

hammerPullDestination

Gets the destination for the hammeron/pullof started by this note.

JavaScript

hammerPullDestination: Note | null;

C#

Note? HammerPullDestination { get; set; }

Kotlin

var hammerPullDestination: Note?

hammerPullOrigin

Gets the origin of the hammeron/pulloff of this note.

JavaScript

hammerPullOrigin: Note | null;

C#

Note? HammerPullOrigin { get; set; }

Kotlin

var hammerPullOrigin: Note?

harmonicPitch

The interval in semitones the harmonic sounds above the played pitch. Natural harmonics are relative to the open string and therefore need a string, the other types are an interval above the played note on any pitched note.

JavaScript

readonly harmonicPitch: number;

C#

double HarmonicPitch { get; }

Kotlin

val harmonicPitch: Double

harmonicType

Gets or sets the harmonic type applied to this note.

JavaScript

harmonicType: HarmonicType;

C#

HarmonicType HarmonicType { get; set; }

Kotlin

var harmonicType: HarmonicType

harmonicValue

Gets or sets the value defining the harmonic pitch.

JavaScript

harmonicValue: number;

C#

double HarmonicValue { get; set; }

Kotlin

var harmonicValue: Double

hasBend

(no description)

JavaScript

readonly hasBend: boolean;

C#

bool HasBend { get; }

Kotlin

val hasBend: Boolean

hasEffectSlur

(no description)

JavaScript

hasEffectSlur: boolean;

C#

bool HasEffectSlur { get; set; }

Kotlin

var hasEffectSlur: Boolean

hasQuarterToneOffset

(no description)

JavaScript

readonly hasQuarterToneOffset: boolean;

C#

bool HasQuarterToneOffset { get; }

Kotlin

val hasQuarterToneOffset: Boolean

id

Gets or sets the unique id of this note.

JavaScript

id: number;

C#

double Id { get; set; }

Kotlin

var id: Double

index

Gets or sets the zero-based index of this note within the beat.

JavaScript

index: number;

C#

double Index { get; set; }

Kotlin

var index: Double

initialBendValue

(no description)

JavaScript

readonly initialBendValue: number;

C#

double InitialBendValue { get; }

Kotlin

val initialBendValue: Double

isContinuedBend

Gets or sets whether this note continues a bend from a previous note.

JavaScript

isContinuedBend: boolean;

C#

bool IsContinuedBend { get; set; }

Kotlin

var isContinuedBend: Boolean

isDead

Gets or sets whether the note is shown and played as dead note.

JavaScript

isDead: boolean;

C#

bool IsDead { get; set; }

Kotlin

var isDead: Boolean

isEffectSlurDestination

(no description)

JavaScript

readonly isEffectSlurDestination: boolean;

C#

bool IsEffectSlurDestination { get; }

Kotlin

val isEffectSlurDestination: Boolean

isEffectSlurOrigin

(no description)

JavaScript

isEffectSlurOrigin: boolean;

C#

bool IsEffectSlurOrigin { get; set; }

Kotlin

var isEffectSlurOrigin: Boolean

isFingering

Gets or sets whether this note has fingering defined.

JavaScript

readonly isFingering: boolean;

C#

bool IsFingering { get; }

Kotlin

val isFingering: Boolean

isGhost

Gets or sets whether the note is a ghost note and shown in parenthesis. Also this will make the note a bit more silent.

JavaScript

isGhost: boolean;

C#

bool IsGhost { get; set; }

Kotlin

var isGhost: Boolean

isHammerPullDestination

(no description)

JavaScript

readonly isHammerPullDestination: boolean;

C#

bool IsHammerPullDestination { get; }

Kotlin

val isHammerPullDestination: Boolean

isHammerPullOrigin

Gets or sets whether this note starts a hammeron or pulloff.

JavaScript

isHammerPullOrigin: boolean;

C#

bool IsHammerPullOrigin { get; set; }

Kotlin

var isHammerPullOrigin: Boolean

isHarmonic

(no description)

JavaScript

readonly isHarmonic: boolean;

C#

bool IsHarmonic { get; }

Kotlin

val isHarmonic: Boolean

isLeftHandTapped

Gets a value indicating whether the note is left hand tapped.

JavaScript

isLeftHandTapped: boolean;

C#

bool IsLeftHandTapped { get; set; }

Kotlin

var isLeftHandTapped: Boolean

isLetRing

Gets or sets whether this note has a let-ring effect.

JavaScript

isLetRing: boolean;

C#

bool IsLetRing { get; set; }

Kotlin

var isLetRing: Boolean

isPalmMute

Gets or sets whether this note has a palm-mute effect.

JavaScript

isPalmMute: boolean;

C#

bool IsPalmMute { get; set; }

Kotlin

var isPalmMute: Boolean

isPercussion

(no description)

JavaScript

readonly isPercussion: boolean;

C#

bool IsPercussion { get; }

Kotlin

val isPercussion: Boolean

isPiano

(no description)

JavaScript

readonly isPiano: boolean;

C#

bool IsPiano { get; }

Kotlin

val isPiano: Boolean

isSlurDestination

Gets or sets whether this note finishes a slur.

JavaScript

isSlurDestination: boolean;

C#

bool IsSlurDestination { get; set; }

Kotlin

var isSlurDestination: Boolean

isSlurOrigin

(no description)

JavaScript

readonly isSlurOrigin: boolean;

C#

bool IsSlurOrigin { get; }

Kotlin

val isSlurOrigin: Boolean

isStaccato

Gets or sets whether the note is played as staccato.

JavaScript

isStaccato: boolean;

C#

bool IsStaccato { get; set; }

Kotlin

var isStaccato: Boolean

isStringed

(no description)

JavaScript

readonly isStringed: boolean;

C#

bool IsStringed { get; }

Kotlin

val isStringed: Boolean

isTieDestination

Gets or sets whether this note is ends a tied note.

JavaScript

isTieDestination: boolean;

C#

bool IsTieDestination { get; set; }

Kotlin

var isTieDestination: Boolean

isTieOrigin

(no description)

JavaScript

readonly isTieOrigin: boolean;

C#

bool IsTieOrigin { get; }

Kotlin

val isTieOrigin: Boolean

isTrill

(no description)

JavaScript

readonly isTrill: boolean;

C#

bool IsTrill { get; }

Kotlin

val isTrill: Boolean

isTrillStart

Gets or sets whether a separate trill starts on this note. If set, the trill does not continue a trill on the previous beat.

JavaScript

isTrillStart: boolean;

C#

bool IsTrillStart { get; set; }

Kotlin

var isTrillStart: Boolean

isVisible

Gets or sets whether this note is visible on the music sheet.

JavaScript

isVisible: boolean;

C#

bool IsVisible { get; set; }

Kotlin

var isVisible: Boolean

leftHandFinger

Gets or sets the fingers used for this note on the left hand.

JavaScript

leftHandFinger: Fingers;

C#

Fingers LeftHandFinger { get; set; }

Kotlin

var leftHandFinger: Fingers

letRingDestination

Gets or sets the destination note for the let-ring effect.

JavaScript

letRingDestination: Note | null;

C#

Note? LetRingDestination { get; set; }

Kotlin

var letRingDestination: Note?

maxBendPoint

Gets or sets the bend point with the highest bend value.

JavaScript

maxBendPoint: BendPoint | null;

C#

BendPoint? MaxBendPoint { get; set; }

Kotlin

var maxBendPoint: BendPoint?

octave

Gets or sets the octave on which this note is played.

JavaScript

octave: number;

C#

double Octave { get; set; }

Kotlin

var octave: Double

ornament

The ornament applied on the note.

JavaScript

ornament: NoteOrnament;

C#

NoteOrnament Ornament { get; set; }

Kotlin

var ornament: NoteOrnament

palmMuteDestination

Gets or sets the destination note for the palm-mute effect.

JavaScript

palmMuteDestination: Note | null;

C#

Note? PalmMuteDestination { get; set; }

Kotlin

var palmMuteDestination: Note?

percussionArticulation

Gets or sets the index of percussion articulation in the related track.percussionArticulations. If the articulation is not listed in track.percussionArticulations the following list based on GP7 applies:

• 029 Ride (choke)
• 030 Cymbal (hit)
• 031 Snare (side stick)
• 033 Snare (side stick)
• 034 Snare (hit)
• 035 Kick (hit)
• 036 Kick (hit)
• 037 Snare (side stick)
• 038 Snare (hit)
• 039 Hand Clap (hit)
• 040 Snare (hit)
• 041 Low Floor Tom (hit)
• 042 Hi-Hat (closed)
• 043 Very Low Tom (hit)
• 044 Pedal Hi-Hat (hit)
• 045 Low Tom (hit)
• 046 Hi-Hat (open)
• 047 Mid Tom (hit)
• 048 High Tom (hit)
• 049 Crash high (hit)
• 050 High Floor Tom (hit)
• 051 Ride (middle)
• 052 China (hit)
• 053 Ride (bell)
• 054 Tambourine (hit)
• 055 Splash (hit)
• 056 Cowbell medium (hit)
• 057 Crash medium (hit)
• 058 Vibraslap (hit)
• 059 Ride (edge)
• 060 Hand (hit)
• 061 Hand (hit)
• 062 Conga high (mute)
• 063 Conga high (hit)
• 064 Conga low (hit)
• 065 Timbale high (hit)
• 066 Timbale low (hit)
• 067 Agogo high (hit)
• 068 Agogo tow (hit)
• 069 Cabasa (hit)
• 070 Left Maraca (hit)
• 071 Whistle high (hit)
• 072 Whistle low (hit)
• 073 Guiro (hit)
• 074 Guiro (scrap-return)
• 075 Claves (hit)
• 076 Woodblock high (hit)
• 077 Woodblock low (hit)
• 078 Cuica (mute)
• 079 Cuica (open)
• 080 Triangle (rnute)
• 081 Triangle (hit)
• 082 Shaker (hit)
• 083 Tinkle Bell (hat)
• 083 Jingle Bell (hit)
• 084 Bell Tree (hit)
• 085 Castanets (hit)
• 086 Surdo (hit)
• 087 Surdo (mute)
• 091 Snare (rim shot)
• 092 Hi-Hat (half)
• 093 Ride (edge)
• 094 Ride (choke)
• 095 Splash (choke)
• 096 China (choke)
• 097 Crash high (choke)
• 098 Crash medium (choke)
• 099 Cowbell low (hit)
• 100 Cowbell low (tip)
• 101 Cowbell medium (tip)
• 102 Cowbell high (hit)
• 103 Cowbell high (tip)
• 104 Hand (mute)
• 105 Hand (slap)
• 106 Hand (mute)
• 107 Hand (slap)
• 108 Conga low (slap)
• 109 Conga low (mute)
• 110 Conga high (slap)
• 111 Tambourine (return)
• 112 Tambourine (roll)
• 113 Tambourine (hand)
• 114 Grancassa (hit)
• 115 Piatti (hat)
• 116 Piatti (hand)
• 117 Cabasa (return)
• 118 Left Maraca (return)
• 119 Right Maraca (hit)
• 120 Right Maraca (return)
• 122 Shaker (return)
• 123 Bell Tee (return)
• 124 Golpe (thumb)
• 125 Golpe (finger)
• 126 Ride (middle)
• 127 Ride (bell)

JavaScript

percussionArticulation: number;

C#

double PercussionArticulation { get; set; }

Kotlin

var percussionArticulation: Double

realValue

(no description)

JavaScript

readonly realValue: number;

C#

double RealValue { get; }

Kotlin

val realValue: Double

realValueWithoutHarmonic

(no description)

JavaScript

readonly realValueWithoutHarmonic: number;

C#

double RealValueWithoutHarmonic { get; }

Kotlin

val realValueWithoutHarmonic: Double

rightHandFinger

Gets or sets the fingers used for this note on the right hand.

JavaScript

rightHandFinger: Fingers;

C#

Fingers RightHandFinger { get; set; }

Kotlin

var rightHandFinger: Fingers

showStringNumber

Gets or sets whether the string number for this note should be shown. For pitched notes this requires string to be set.

JavaScript

showStringNumber: boolean;

C#

bool ShowStringNumber { get; set; }

Kotlin

var showStringNumber: Boolean

slideInType

Gets or sets the slide-in type this note is played with.

JavaScript

slideInType: SlideInType;

C#

SlideInType SlideInType { get; set; }

Kotlin

var slideInType: SlideInType

slideOrigin

Gets or sets the source note for several slide types.

JavaScript

slideOrigin: Note | null;

C#

Note? SlideOrigin { get; set; }

Kotlin

var slideOrigin: Note?

slideOutType

Gets or sets the slide-out type this note is played with.

JavaScript

slideOutType: SlideOutType;

C#

SlideOutType SlideOutType { get; set; }

Kotlin

var slideOutType: SlideOutType

slideTarget

Gets or sets the target note for several slide types.

JavaScript

slideTarget: Note | null;

C#

Note? SlideTarget { get; set; }

Kotlin

var slideTarget: Note?

slurDestination

Gets or sets the note where the slur of this note ends.

JavaScript

slurDestination: Note | null;

C#

Note? SlurDestination { get; set; }

Kotlin

var slurDestination: Note?

slurOrigin

Gets or sets the note where the slur of this note starts.

JavaScript

slurOrigin: Note | null;

C#

Note? SlurOrigin { get; set; }

Kotlin

var slurOrigin: Note?

string

Gets or sets the string number where the note is placed. 1 is the lowest string on the guitar and the bottom line on the tablature. It then increases the the number of strings on available on the track. On pitched notes (no fret) the string is only an annotation shown via showStringNumber and has no effect on playback. Staves without tuning assume a standard 6 string instrument for this case.

JavaScript

string: number;

C#

double String { get; set; }

Kotlin

var string: Double

stringTuning

(no description)

JavaScript

readonly stringTuning: number;

C#

double StringTuning { get; }

Kotlin

val stringTuning: Double

style

The style customizations for this item.

JavaScript

style?: NoteStyle;

C#

NoteStyle Style { get; set; }

Kotlin

var style: NoteStyle

tieDestination

Gets the desination of the tie.

JavaScript

tieDestination: Note | null;

C#

Note? TieDestination { get; set; }

Kotlin

var tieDestination: Note?

tieOrigin

Gets the origin of the tied if this note is tied.

JavaScript

tieOrigin: Note | null;

C#

Note? TieOrigin { get; set; }

Kotlin

var tieOrigin: Note?

tone

Gets or sets the tone of this note within the octave.

JavaScript

tone: number;

C#

double Tone { get; set; }

Kotlin

var tone: Double

trillFret

(no description)

JavaScript

readonly trillFret: number;

C#

double TrillFret { get; }

Kotlin

val trillFret: Double

trillSpeed

Gets or sets the speed of the trill effect.

JavaScript

trillSpeed: Duration;

C#

Duration TrillSpeed { get; set; }

Kotlin

var trillSpeed: Duration

trillValue

Gets or sets the target note value for the trill effect.

JavaScript

trillValue: number;

C#

double TrillValue { get; set; }

Kotlin

var trillValue: Double

variation

Deprecated

This member is deprecated.

Gets or sets the variation of this note.

JavaScript

readonly variation: number;

C#

double Variation { get; }

Kotlin

val variation: Double

vibrato

Gets or sets whether a vibrato is played on the note.

JavaScript

vibrato: VibratoType;

C#

VibratoType Vibrato { get; set; }

Kotlin

var vibrato: VibratoType

Methods

addBendPoint

(no description)

JavaScript

addBendPoint(point: BendPoint): void

C#

void AddBendPoint(BendPoint point)

Kotlin

fun addBendPoint(point: BendPoint): Unit

Parameter	Summary
pointAll	(no description)

calculateRealValue

Calculates the real note value of this note as midi key respecting the given options.

JavaScript

calculateRealValue(applyTranspositionPitch: boolean, applyHarmonic: boolean): number

C#

double CalculateRealValue(bool applyTranspositionPitch, bool applyHarmonic)

Kotlin

fun calculateRealValue(applyTranspositionPitch: Boolean, applyHarmonic: Boolean): Double

Parameter	Summary
applyTranspositionPitchAll	Whether or not to apply the transposition pitch of the current staff.
applyHarmonicAll	Whether or not to apply harmonic pitches to the note.

Returns

The calculated note value as midi key.

chain

(no description)

JavaScript

chain(sharedDataBag?: Map<string, unknown> | null): void

C#

void Chain(Map<string, object>? sharedDataBag)

Kotlin

fun chain(sharedDataBag: alphaTab.collections.StringAnyMap<String, Any>?): Unit

Parameter	Summary
sharedDataBagAll	(no description)

findHammerPullDestination

(no description)

JavaScript

static findHammerPullDestination(note: Note): Note | null

C#

static Note? FindHammerPullDestination(Note note)

Kotlin

fun findHammerPullDestination(note: Note): Note?

Parameter	Summary
noteAll	(no description)

findTieOrigin

(no description)

JavaScript

static findTieOrigin(note: Note): Note | null

C#

static Note? FindTieOrigin(Note note)

Kotlin

fun findTieOrigin(note: Note): Note?

Parameter	Summary
noteAll	(no description)

finish

(no description)

JavaScript

finish(settings: Settings, sharedDataBag?: Map<string, unknown> | null): void

C#

void Finish(Settings settings, Map<string, object>? sharedDataBag)

Kotlin

fun finish(settings: Settings, sharedDataBag: alphaTab.collections.StringAnyMap<String, Any>?): Unit

Parameter	Summary
settingsAll	(no description)
sharedDataBagAll	(no description)

getStringTuning

(no description)

JavaScript

static getStringTuning(staff: Staff, noteString: number): number

C#

static double GetStringTuning(Staff staff, double noteString)

Kotlin

fun getStringTuning(staff: Staff, noteString: Double): Double

Parameter	Summary
staffAll	(no description)
noteStringAll	(no description)

nextNoteOnSameLine

(no description)

JavaScript

static nextNoteOnSameLine(note: Note): Note | null

C#

static Note? NextNoteOnSameLine(Note note)

Kotlin

fun nextNoteOnSameLine(note: Note): Note?

Parameter	Summary
noteAll	(no description)