Note Properties

This page documents the note property scope — the properties attached to a single note that render as effects or annotations in the music sheet.

Historically these property names are heavily abbreviated to keep source short. A more verbose alternative will land in a future alphaTab release.

nh

Scope: Note property

Syntax

nh ()

Description: Applies a natural harmonic effect to the note (for fretted instruments).

Example:

00:00

00:00

:8 3.3{nh} 3.3{ah} 3.3{ph} 3.3{th} 3.3{sh}

ah

Scope: Note property

Syntax

ah value

Description: Applies an artificial harmonic effect to the note (for fretted instruments).

Parameters:

Name	Description	Type	Required
value	The harmonic value determines a relative fret-offset changing the note pitch when played. For natural harmonics the played fret determines the harmonic value. The rules are a bit special but mostly are aligned with the frequency adjustments happening when harmonics are played at respective frets: * 2.4 adds 36 frets * 2.7 adds 34 frets * < 3 adds 0 frets * <= 3.5 adds 31 frets * <= 4 adds 28 frets * <= 5 adds 34 frets * <= 7 adds 19 frets * <= 8.5 adds 36 frets * <= 9 adds 28 frets * <= 10 adds 34 frets * <= 11 adds 0 frets * <= 12 adds 12 frets * < 14 adds 0 frets * <= 15 adds 34 frets * <= 16 adds 28 frets * <= 17 adds 36 frets * <= 18 adds 0 frets * <= 19 adds 19 frets * <= 21 adds 0 frets * <= 22 adds 36 frets * <= 24 adds 24 frets * `other: adds 0 frets	Number	no

Example:

00:00

00:00

C4 {volume 8} D4 E4 {tempo 16} F4

th

Scope: Note property

Syntax

th value

Description: Applies a tapped harmonic effect to the note (for fretted instruments).

Parameters:

Name	Description	Type	Required
value	The harmonic value determines a relative fret-offset changing the note pitch when played. For natural harmonics the played fret determines the harmonic value. The rules are a bit special but mostly are aligned with the frequency adjustments happening when harmonics are played at respective frets: * 2.4 adds 36 frets * 2.7 adds 34 frets * < 3 adds 0 frets * <= 3.5 adds 31 frets * <= 4 adds 28 frets * <= 5 adds 34 frets * <= 7 adds 19 frets * <= 8.5 adds 36 frets * <= 9 adds 28 frets * <= 10 adds 34 frets * <= 11 adds 0 frets * <= 12 adds 12 frets * < 14 adds 0 frets * <= 15 adds 34 frets * <= 16 adds 28 frets * <= 17 adds 36 frets * <= 18 adds 0 frets * <= 19 adds 19 frets * <= 21 adds 0 frets * <= 22 adds 36 frets * <= 24 adds 24 frets * `other: adds 0 frets	Number	no

Example:

00:00

00:00

:8 3.3{nh} 3.3{ah} 3.3{ph} 3.3{th} 3.3{sh}

ph

Scope: Note property

Syntax

ph value

Description: Applies a pinch harmonic effect to the note (for fretted instruments).

Parameters:

Name	Description	Type	Required
value	The harmonic value determines a relative fret-offset changing the note pitch when played. For natural harmonics the played fret determines the harmonic value. The rules are a bit special but mostly are aligned with the frequency adjustments happening when harmonics are played at respective frets: * 2.4 adds 36 frets * 2.7 adds 34 frets * < 3 adds 0 frets * <= 3.5 adds 31 frets * <= 4 adds 28 frets * <= 5 adds 34 frets * <= 7 adds 19 frets * <= 8.5 adds 36 frets * <= 9 adds 28 frets * <= 10 adds 34 frets * <= 11 adds 0 frets * <= 12 adds 12 frets * < 14 adds 0 frets * <= 15 adds 34 frets * <= 16 adds 28 frets * <= 17 adds 36 frets * <= 18 adds 0 frets * <= 19 adds 19 frets * <= 21 adds 0 frets * <= 22 adds 36 frets * <= 24 adds 24 frets * `other: adds 0 frets	Number	no

Example:

00:00

00:00

:8 3.3{nh} 3.3{ah} 3.3{ph} 3.3{th} 3.3{sh}

sh

Scope: Note property

Syntax

sh value

Description: Applies a semi harmonic effect to the note (for fretted instruments).

Parameters:

Name	Description	Type	Required
value	The harmonic value determines a relative fret-offset changing the note pitch when played. For natural harmonics the played fret determines the harmonic value. The rules are a bit special but mostly are aligned with the frequency adjustments happening when harmonics are played at respective frets: * 2.4 adds 36 frets * 2.7 adds 34 frets * < 3 adds 0 frets * <= 3.5 adds 31 frets * <= 4 adds 28 frets * <= 5 adds 34 frets * <= 7 adds 19 frets * <= 8.5 adds 36 frets * <= 9 adds 28 frets * <= 10 adds 34 frets * <= 11 adds 0 frets * <= 12 adds 12 frets * < 14 adds 0 frets * <= 15 adds 34 frets * <= 16 adds 28 frets * <= 17 adds 36 frets * <= 18 adds 0 frets * <= 19 adds 19 frets * <= 21 adds 0 frets * <= 22 adds 36 frets * <= 24 adds 24 frets * `other: adds 0 frets	Number	no

Example:

00:00

00:00

:8 3.3{nh} 3.3{ah} 3.3{ph} 3.3{th} 3.3{sh}

fh

Scope: Note property

Syntax

fh value

Description: Applies a feedback harmonic effect to the note (for fretted instruments).

Parameters:

Name	Description	Type	Required
value	The harmonic value determines a relative fret-offset changing the note pitch when played. For natural harmonics the played fret determines the harmonic value. The rules are a bit special but mostly are aligned with the frequency adjustments happening when harmonics are played at respective frets: * 2.4 adds 36 frets * 2.7 adds 34 frets * < 3 adds 0 frets * <= 3.5 adds 31 frets * <= 4 adds 28 frets * <= 5 adds 34 frets * <= 7 adds 19 frets * <= 8.5 adds 36 frets * <= 9 adds 28 frets * <= 10 adds 34 frets * <= 11 adds 0 frets * <= 12 adds 12 frets * < 14 adds 0 frets * <= 15 adds 34 frets * <= 16 adds 28 frets * <= 17 adds 36 frets * <= 18 adds 0 frets * <= 19 adds 19 frets * <= 21 adds 0 frets * <= 22 adds 36 frets * <= 24 adds 24 frets * `other: adds 0 frets	Number	no

Example:

00:00

00:00

:8 3.3{fh} 3.3{ah} 3.3{ph} 3.3{th} 3.3{sh}

v

Scope: Note property

Syntax

v ()

Description: Adds a slight vibrato effect to the note.

Example:

00:00

00:00

3.3{v}

vw

Scope: Note property

Syntax

vw ()

Description: Adds a wide vibrato effect to the note.

Example:

00:00

00:00

3.3{vw}

sl

Scope: Note property

Syntax

sl ()

Description: Adds a legato slide effect to the note.

Example:

00:00

00:00

3.3{sl} 4.3 3.3{ss} 4.3 |
3.3{sib} 3.3{sia} 3.3{sou} 3.3{sod} |
3.3{sib sou} 3.3{sib sod} 3.3{sia sod} 3.3{sia sou} |
x.3{psd} 3.3 |
x.3{psu} 3.3 |

ss

Scope: Note property

Syntax

ss ()

Description: Adds a shift slide effect to the note.

Example:

00:00

00:00

3.3{sl} 4.3 3.3{ss} 4.3 |
3.3{sib} 3.3{sia} 3.3{sou} 3.3{sod} |
3.3{sib sou} 3.3{sib sod} 3.3{sia sod} 3.3{sia sou} |
x.3{psd} 3.3 |
x.3{psu} 3.3 |

sib

Scope: Note property

Syntax

sib ()

Description: Adds a slide effect into the note from below.

Example:

00:00

00:00

3.3{sl} 4.3 3.3{ss} 4.3 |
3.3{sib} 3.3{sia} 3.3{sou} 3.3{sod} |
3.3{sib sou} 3.3{sib sod} 3.3{sia sod} 3.3{sia sou} |
x.3{psd} 3.3 |
x.3{psu} 3.3 |

sia

Scope: Note property

Syntax

sia ()

Description: Adds a slide effect into the note from above.

Example:

00:00

00:00

3.3{sl} 4.3 3.3{ss} 4.3 |
3.3{sib} 3.3{sia} 3.3{sou} 3.3{sod} |
3.3{sib sou} 3.3{sib sod} 3.3{sia sod} 3.3{sia sou} |
x.3{psd} 3.3 |
x.3{psu} 3.3 |

sou

Scope: Note property

Syntax

sou ()

Description: Adds a slide effect out from note upwards.

Example:

00:00

00:00

3.3{sl} 4.3 3.3{ss} 4.3 |
3.3{sib} 3.3{sou} 3.3{sou} 3.3{sod} |
3.3{sib sou} 3.3{sib sod} 3.3{sou sod} 3.3{sou sou} |
x.3{psd} 3.3 |
x.3{psu} 3.3 |

sod

Scope: Note property

Syntax

sod ()

Description: Adds a slide effect out from note downwards.

Example:

00:00

00:00

3.3{sl} 4.3 3.3{ss} 4.3 |
3.3{sib} 3.3{sod} 3.3{sod} 3.3{sod} |
3.3{sib sod} 3.3{sib sod} 3.3{sod sod} 3.3{sod sod} |
x.3{psd} 3.3 |
x.3{psu} 3.3 |

psu

Scope: Note property

Syntax

psu ()

Description: Adds a pick slide effect out from note upwards.

Example:

00:00

00:00

3.3{sl} 4.3 3.3{ss} 4.3 |
3.3{sib} 3.3{psu} 3.3{psu} 3.3{psu} |
3.3{sib psu} 3.3{sib psu} 3.3{psu psu} 3.3{psu psu} |
x.3{psd} 3.3 |
x.3{psu} 3.3 |

psd

Scope: Note property

Syntax

psd ()

Description: Adds a pick slide effect out from note downwards.

Example:

00:00

00:00

3.3{sl} 4.3 3.3{ss} 4.3 |
3.3{sib} 3.3{psd} 3.3{psd} 3.3{psd} |
3.3{sib psd} 3.3{sib psd} 3.3{psd psd} 3.3{psd psd} |
x.3{psd} 3.3 |
x.3{psd} 3.3 |

h

Scope: Note property

Syntax

h ()

Description: Applies a hammer on / pull-off effect to the note.

The fret of the following note on the same string defines whether it is a hammer-on or pull-of.

Example:

00:00

00:00

3.3{h} 4.3 4.3{h} 3.3 | 3.3{h} 4.3{h} 3.3{h} 4.3

lht

Scope: Note property

Syntax

lht ()

Description: Applies a left-hand-tapped annotation to the note.

Example:

00:00

00:00

:16 15.1{h} 13.1{h} 12.1{h} 15.2{lht}

g

Scope: Note property

Syntax

g ()

Description: Marks the note as a ghost note.

Example:

00:00

00:00

3.3{g}

ac

Scope: Note property

Syntax

ac ()

Description: Applies a simple accentuation to the note.

Example:

00:00

00:00

3.3{ac} 3.3{hac} 3.3{ten}

hac

Scope: Note property

Syntax

hac ()

Description: Applies a heavy accentuation to the note.

Example:

00:00

00:00

3.3{ac} 3.3{hac} 3.3{ten}

ten

Scope: Note property

Syntax

ten ()

Description: Applies a tenuto accentuation to the note.

Example:

00:00

00:00

3.3{ac} 3.3{ten} 3.3{ten}

tr

Scope: Note property

Syntax

tr (fret duration)

Description: Applies a trill effect to the note.

Parameters:

Name	Description	Type	Required
fret	The fret on which to trill	Number	yes
duration	The duration/speed of the trills	16|32|64	no 16

Parameter Values:

Following parameters have value limitations

Name	Values
duration	Value Description 16 16th Note 32 32nd Note 64 64th Note

Example:

00:00

00:00

:4 3.3{tr 4} 3.3{tr 4 16} 3.3{tr 5 32} 3.3{tr 6 64}

pm

Scope: Note property

Syntax

pm ()

Description: Applies a palm mute effect to the note.

Example:

00:00

00:00

3.3{pm} 3.3{pm} 3.3{pm} 3.3{pm}

st

Scope: Note property

Syntax

st ()

Description: Applies a staccato effect to the note.

Example:

00:00

00:00

3.3{st}

lr

Scope: Note property

Syntax

lr ()

Description: Applies a LetRing effect to the note.

Example:

00:00

00:00

3.4{lr} 3.3{lr} 3.2{lr} 3.1{lr}

x

Scope: Note property

Syntax

x ()

Description: Marks the note as a dead note.

Example:

00:00

00:00

x.3 3.3{x}

t

Scope: Note property

Syntax

t ()

Description: Marks the note as a tied note.

This is an alternative syntax to directly specifying the fret as -.

For non stringed instrument it can be a bit more tricky as we cannot use the string to identify which note to tie. There are multiple ways to work around this problem. AlphaTab will try to find the start note for the tie via several rules, if this does not match the desired behavior, you can specify the note value as alternative and indicate the tie via a note effect.

Example:

00:00

00:00

3.3 -.3 | (1.1 3.2 2.3 0.4) (-.1 -.4)

00:00

00:00

\tuning piano
.
// If there is a single note on the previous beat, we tie to this one
// Then a simple - is enough for a tie
:2 a4 - |
// Alternatively you can specify a '-' or 't' as note effect to indicate a tie
:2 a4 a4{-} |
:2 a4 a4{t} |
// This also works for chords using correct note ordering
:2 (a4 a3) (- a3) |
:2 (a4 a3) (a4 -) |
// If nothing helps, always the explicit note value and tie effect should allow
// specifying the correct behavior
:2 (a4 a3) (a4{t} a3) |
:4 (a4 a3) (b2 b3) a4{t} a3{-} |

turn

Scope: Note property

Syntax

turn ()

Description: Applies a turn ornament to the note.

Example:

00:00

00:00

:1 C4{turn} |

iturn

Scope: Note property

Syntax

iturn ()

Description: Applies an inverted turn ornament to the note.

Example:

00:00

00:00

:1 C4{iturn} |

umordent

Scope: Note property

Syntax

umordent ()

Description: Applies an upper mordent ornament to the note.

Example:

00:00

00:00

:1 C4{umordent} |

lmordent

Scope: Note property

Syntax

lmordent ()

Description: Applies an lower mordent ornament to the note.

Example:

00:00

00:00

:1 C4{lmordent} |

string

Scope: Note property

Syntax

// [1]: Show the string number of a fretted note
string ()
// [2]: Show the given string number on a pitched note
string string

Description: Adds an annotation showing the string number of the note above the staff.

For fretted notes the string is taken from the note value (fret.string). For pitched notes the string number can be specified explicitly (e.g. string indications in classical guitar music). It is only shown as annotation and has no effect on the playback.

Parameters:

Overload	Name	Description	Type	Required
[2]	string	The string number to show. Like for fretted notes 1 is the highest string. On staves without tuning a standard 6 string instrument is assumed. Only allowed on pitched notes.	Number	yes

Example:

00:00

00:00

3.3{string} 3.4{string} 3.5{string}

00:00

00:00

\tuning piano
.
a4{string 1} c4{string 2} g3{string 3} e3{string 4}

hide

Scope: Note property

Syntax

hide ()

Description: Hides the note from being displayed in the music sheet.

Example:

00:00

00:00

:8 3.3 (4.4{hide} 5.5)

b

Scope: Note property

Syntax

// [1]: 
b (values)
// [2]: 
b (type values)
// [3]: 
b (style values)
// [4]: 
b (type style values)

Description: Adds a bend effect to the note.

• The b variant automatically spreads the values across the duration of the beat.
• The be (exact) variant allows specifying exactly at which offset a value is placed.

It is recommended to rely on the auto-detection of the type and only specify the type explicitly if something is wrong.

Parameters:

Overload	Name	Description	Type	Required
[1]	values	The values of the bend in quarter-tones relative to the original note, decimals supported	Number[]	no
[2]	type	The type of bend (affects the display).	Ident	yes
[2]	values	The values of the bend in quarter-tones relative to the original note, decimals supported	Number[]	no
[3]	style	The style of the bend.	default|gradual|fast	yes
[3]	values	The values of the bend in quarter-tones relative to the original note, decimals supported	Number[]	no
[4]	type	The type of bend (affects the display).	Ident	yes
[4]	style	The style of the bend.	default|gradual|fast	yes
[4]	values	The values of the bend in quarter-tones relative to the original note, decimals supported	Number[]	no

Parameter Values:

Following parameters have value limitations

Overload	Name	Values
[2]	type	Value Description custom A non-standard custom bends with multiple points bend A simple bend up to a higher note release A release of bends down to a lower note bendRelease A bend directly followed by a release hold A bend which is held from the previous note prebend A bend applied before the note is played prebendBend A pre-bend followed by a bend prebendRelease A pre-bend followed by a release
[3]	style	Value Description default gradual fast
[4]	type	Value Description custom A non-standard custom bends with multiple points bend A simple bend up to a higher note release A release of bends down to a lower note bendRelease A bend directly followed by a release hold A bend which is held from the previous note prebend A bend applied before the note is played prebendBend A pre-bend followed by a bend prebendRelease A pre-bend followed by a release
[4]	style	Value Description default gradual fast

Example:

00:00

00:00

3.3{b (0 4)} |
3.3{b (0 4 0 8)} |

be

Scope: Note property

Syntax

// [1]: 
be (valueAndOffset)
// [2]: 
be (type valueAndOffset)
// [3]: 
be (style valueAndOffset)
// [4]: 
be (type style valueAndOffset)

Description: Adds an exact bend effect to the note.

• The b variant automatically spreads the values across the duration of the beat.
• The be (exact) variant allows specifying exactly at which offset a value is placed.

It is recommended to rely on the auto-detection of the type and only specify the type explicitly if something is wrong.

Parameters:

Overload	Name	Description	Type	Required
[1]	valueAndOffset	The offset at which the value becomes valid in range of 0-60 and The value of the bend in quarter-tones relative to the original note. The offset and value are actually two parameters: 3.3 {be (0 0 5 2 30 4)}	Number[]	no
[2]	type	The type of bend (affects the display).	Ident	yes
[2]	valueAndOffset	The offset at which the value becomes valid in range of 0-60 and The value of the bend in quarter-tones relative to the original note. The offset and value are actually two parameters: 3.3 {be (0 0 5 2 30 4)}	Number[]	no
[3]	style	The style of the whammy play style.	default|gradual|fast	yes
[3]	valueAndOffset	The offset at which the value becomes valid in range of 0-60 and The value of the bend in quarter-tones relative to the original note. The offset and value are actually two parameters: 3.3 {be (0 0 5 2 30 4)}	Number[]	no
[4]	type	The type of bend (affects the display).	Ident	yes
[4]	style	The style of the whammy play style.	default|gradual|fast	yes
[4]	valueAndOffset	The offset at which the value becomes valid in range of 0-60 and The value of the bend in quarter-tones relative to the original note. The offset and value are actually two parameters: 3.3 {be (0 0 5 2 30 4)}	Number[]	no

Parameter Values:

Following parameters have value limitations

Overload	Name	Values
[2]	type	Value Description custom A non-standard custom bends with multiple points bend A simple bend up to a higher note release A release of bends down to a lower note bendRelease A bend directly followed by a release hold A bend which is held from the previous note prebend A bend applied before the note is played prebendBend A pre-bend followed by a bend prebendRelease A pre-bend followed by a release
[3]	style	Value Description default gradual fast
[4]	type	Value Description custom A non-standard custom bends with multiple points bend A simple bend up to a higher note release A release of bends down to a lower note bendRelease A bend directly followed by a release hold A bend which is held from the previous note prebend A bend applied before the note is played prebendBend A pre-bend followed by a bend prebendRelease A pre-bend followed by a release
[4]	style	Value Description default gradual fast

Example:

00:00

00:00

:1 3.3 {be (0 0 5 2 30 4)}

lf

Scope: Note property

Syntax

lf finger

Description: Adds a left-hand fingering annotation to the note.

Parameters:

Name	Description	Type	Required
finger	The finger	Number	yes

Parameter Values:

Following parameters have value limitations

Name	Values
finger	Value Description 1 Thumb 2 Index-Finger 3 Middle-Finger 4 Annual-Finger 5 Little-Finger

Example:

00:00

00:00

:8 3.3{lf 1} 3.3{lf 2} 3.3{lf 3} 3.3{lf 4} 3.3{lf 5} (2.2{lf 4} 2.3{lf 3} 2.4{lf 2}) |
:8 3.3{rf 1} 3.3{rf 2} 3.3{rf 3} 3.3{rf 4} 3.3{lf 5}

rf

Scope: Note property

Syntax

rf finger

Description: Adds a right-hand fingering annotation to the note.

Parameters:

Name	Description	Type	Required
finger	The finger	Number	yes

Parameter Values:

Following parameters have value limitations

Name	Values
finger	Value Description 1 Thumb 2 Index-Finger 3 Middle-Finger 4 Annual-Finger 5 Little-Finger

Example:

00:00

00:00

:8 3.3{lf 1} 3.3{lf 2} 3.3{lf 3} 3.3{lf 4} 3.3{lf 5} (2.2{lf 4} 2.3{lf 3} 2.4{lf 2}) |
:8 3.3{rf 1} 3.3{rf 2} 3.3{rf 3} 3.3{rf 4} 3.3{lf 5}

acc

Scope: Note property

Syntax

acc mode

Description: Changes the mode to determine the accidentals for this note.

Parameters:

Name	Description	Type	Required
mode	The accidental mode	Ident	yes

Parameter Values:

Following parameters have value limitations

Name

Values

mode

Value Description default Auto-detect the accidentals forceNone Force no accidentals forceNatural Force a naturalize accidental forceSharp Force a sharp accidental forceDoubleSharp Force a double-sharp accidental forceFlat Force a flat accidental forceDoubleFlat Force a double flat accidental d Auto-detect the accidentals - Force no accidentals n Force a naturalize accidental # Force a sharp accidental ## Force a double-sharp accidental x Force a double-sharp accidental b Force a flat accidental bb Force a double flat accidental

Example:

00:00

00:00

:8 3.3{lf 1} 3.3{lf 2} 3.3{lf 3} 3.3{lf 4} 3.3{lf 5} (2.2{lf 4} 2.3{lf 3} 2.4{lf 2}) |
:8 3.3{rf 1} 3.3{rf 2} 3.3{rf 3} 3.3{rf 4} 3.3{lf 5}

slur

Scope: Note property

Syntax

// [1]: 
slur id
// [2]: 
slur id

Description: Marks the start or end of a slur for the note.

Parameters:

Overload	Name	Description	Type	Required
[1]	id	A unique ID to mark the start and end of the slur.	String	yes
[2]	id	A unique ID to mark the start and end of the slur.	Ident	yes

Example:

00:00

00:00

(3.3 {slur s1} 4.4).4 7.3.8 8.3.8 10.3 {slur s1} .8

-

Scope: Note property

Syntax

- ()

Description: Marks the note as a tied note.

This is an alternative syntax to directly specifying the fret as -.

For non stringed instrument it can be a bit more tricky as we cannot use the string to identify which note to tie. There are multiple ways to work around this problem. AlphaTab will try to find the start note for the tie via several rules, if this does not match the desired behavior, you can specify the note value as alternative and indicate the tie via a note effect.

Example:

00:00

00:00

3.3 -.3 | (1.1 3.2 2.3 0.4) (-.1 -.4)

00:00

00:00

\tuning piano
.
// If there is a single note on the previous beat, we tie to this one
// Then a simple - is enough for a tie
:2 a4 - |
// Alternatively you can specify a '-' or 't' as note effect to indicate a tie
:2 a4 a4{-} |
:2 a4 a4{t} |
// This also works for chords using correct note ordering
:2 (a4 a3) (- a3) |
:2 (a4 a3) (a4 -) |
// If nothing helps, always the explicit note value and tie effect should allow
// specifying the correct behavior
:2 (a4 a3) (a4{t} a3) |
:4 (a4 a3) (b2 b3) a4{t} a3{-} |