Staff Metadata

This page documents the staff metadata scope — the metadata tags that configure a single staff, such as its instrument, tuning, and articulation table.

Set these tags on the first bar of the staff to avoid unexpected side effects further in.

Some entries here remain metadata tags for historical reasons. They may move to staff properties in a future release.

\tuning

Scope: Staff metadata

Syntax

// [1]: 
\tuning mode
// [2]: 
\tuning (strings)

Description: Defines the number of strings and their tuning for stringed (and fretted) instruments.

Parameters:

Overload	Name	Description	Type	Required
[1]	mode	A built-in standard mode for tunings	piano|none|voice	yes
[2]	strings	The tuning values as pitched notes	Ident[]	no

Parameter Values:

Following parameters have value limitations

Overload	Name	Values
[1]	mode	Value Description piano Indicates that this staff is NOT stringed, but a piano with pitched notes. none Indicates that this staff is NOT stringed and has no tuning and uses pitched notes. voice Indicates that this staff is NOT stringed, but a vocal voice with pitched notes.

Example:

00:00

00:00

\track "Track 1"
\staff {tabs}
\tuning (A1 D2 A2 D3 G3 B3 E4) { hide label "Special Guitar Tuning" }
4.1 3.1 2.1 1.1
\track "Track 2"
\tuning piano
C4 D4 E4 F4

Properties:

hide

Scope: Staff metadata

Syntax

hide ()

Description: Hides the tuning from being displayed above the first staff.

Example:

00:00

00:00

\track
\staff {tabs}
\tuning (E4 B3 G3 D3 A2 D2)
4.1 3.1 2.1 1.1   
\track
\staff {tabs}
\tuning (F2 C2 G1 D1) { hide}
4.1 3.1 2.1 1.1

label

Scope: Staff metadata

Syntax

label text

Description: Defines the textual label for the tuning.

Parameters:

Name	Description	Type	Required
text	The label to set.	String	yes

Example:

00:00

00:00

\track
\staff {tabs}
\tuning (E4 B3 G3 D3 A2 D2) { label "Dropped D Tuning" }
4.1 3.1 2.1 1.1

\chord

Scope: Staff metadata

Syntax

\chord (name strings)

Description: Defines a new chord for a chord diagram display defining how to play it.

To avoid inconsistencies with tunings, chords should be defined after the tuning is set.

To use the defined chord the ch chordName beat property has to be applied. The notes for the chord still have to be specified separately, the definition in this metadata is purely for the chord diagram.

Parameters:

Name	Description	Type	Required
name	The name of the chord	String	yes
strings	For every string of the staff tuning, the fret to be played or x for strings not played.	Ident|String|Number[]	no

Example:

00:00

00:00

\chord ("C" 0 1 0 2 3 x)
\ts 2 4
(0.1 1.2 0.3 2.4 3.5){ch "C"} (0.1 1.2 0.3 2.4 3.5)

Properties:

firstFret

Scope: Staff metadata

Syntax

firstFret fret

Description: Shifts the first fret shown in the diagram higher

Parameters:

Name	Description	Type	Required
fret	The index of the first fret	Number	yes

Example:

00:00

00:00

\chord ("D#" 6 8 8 8 6 x) {firstfret 6}
(6.1 8.2 8.3 8.4 6.5){ch "D#"}

barre

Scope: Staff metadata

Syntax

barre (fret)

Description: Defines on which frets a barré should be played (visually joins the dots to a bar).

Parameters:

Name	Description	Type	Required
fret	The frets on which a barré should be played	Number[]	no

Example:

00:00

00:00

\chord ("D#" 6 8 8 8 6 x) {firstfret 6 barre 6}
\chord ("Special" 3 3 3 1 1 1) {showname false barre (1 3)}
(6.1 8.2 8.3 8.4 6.5){ch "D#"} 
(3.1 3.2 3.3 1.4 1.5 1.6){ch "Special"}

showDiagram

Scope: Staff metadata

Syntax

// [1]: 
showDiagram ()
// [2]: 
showDiagram visibility
// [3]: 
showDiagram visibility
// [4]: 
showDiagram visibility

Description: Set the chord diagram visibility.

Parameters:

Overload	Name	Description	Type	Required
[2]	visibility	The visibility of the diagram	"true"|"false"	yes
[3]	visibility	The visibility of the diagram	true|false	yes
[4]	visibility	The visibility of the diagram	1|0	yes

Parameter Values:

Following parameters have value limitations

Overload	Name	Values
[2]	visibility	Value Description "true" Show the diagram "false" Hide the diagram
[3]	visibility	Value Description true Show the diagram false Hide the diagram
[4]	visibility	Value Description 1 Show the diagram 0 Hide the diagram

Example:

00:00

00:00

\chord ("E" 0 0 1 2 2 0) {showdiagram false}
(0.1 0.2 1.3 2.4 2.5 0.6){ch "E"}

showFingering

Scope: Staff metadata

Syntax

// [1]: 
showFingering ()
// [2]: 
showFingering visibility
// [3]: 
showFingering visibility
// [4]: 
showFingering visibility

Description: Set the finger position visibility.

Parameters:

Overload	Name	Description	Type	Required
[2]	visibility	The visibility of the finger position	"true"|"false"	yes
[3]	visibility	The visibility of the finger position	true|false	yes
[4]	visibility	The visibility of the finger position	1|0	yes

Parameter Values:

Following parameters have value limitations

Overload	Name	Values
[2]	visibility	Value Description "true" Show the fingering "false" Hide the fingering
[3]	visibility	Value Description true Show the fingering false Hide the fingering
[4]	visibility	Value Description 1 Show the fingering 0 Hide the fingering

Example:

00:00

00:00

\chord ("E" 0 0 1 2 2 0) {showfingers false}
(0.1 0.2 1.3 2.4 2.5 0.6){ch "E"}

showName

Scope: Staff metadata

Syntax

// [1]: 
showName ()
// [2]: 
showName visibility
// [3]: 
showName visibility
// [4]: 
showName visibility

Description: Set the chord name visibility.

Parameters:

Overload	Name	Description	Type	Required
[2]	visibility	The visibility of the chord name in the diagram	"true"|"false"	yes
[3]	visibility	The visibility of the chord name in the diagram	true|false	yes
[4]	visibility	The visibility of the chord name in the diagram	1|0	yes

Parameter Values:

Following parameters have value limitations

Overload	Name	Values
[2]	visibility	Value Description "true" Show the chord name "false" Hide the chord name
[3]	visibility	Value Description true Show the chord name false Hide the chord name
[4]	visibility	Value Description 1 Show the chord name 0 Hide the chord name

Example:

00:00

00:00

// Hide name
\chord ("Special" 3 3 3 1 1 1) {showname false}
.
(3.1 3.2 3.3 1.4 1.5 1.6){ch "Special"}

\capo

Scope: Staff metadata

Syntax

\capo fret

Description: Defines the fret on which a capo should be placed.

Parameters:

Name	Description	Type	Required
fret	The fret on which a capo is placed	Number	yes

Example:

00:00

00:00

\track "Guitar"
\staff{tabs} 
\capo 5
1.2 3.2 0.1 1.1

\lyrics

Scope: Staff metadata

Syntax

// [1]: 
\lyrics lyrics
// [2]: 
\lyrics (startBar lyrics)

Description: Define the lyrics shown on the beats of the staff.

The lyrics system of alphaTab is borrowed from Guitar Pro. For every track multiple "lines" of lyrics can be defined which can either start at the beginning or at a later bar. The syllables of the provided lyrics are spread automatically across the beats of the track. Syllables are separated with spaces. If multiple words/syllables should stay on the same beat the space can be replaced with a +. Comments which should not be displayed can be put [into brackets].

Parameters:

Overload	Name	Description	Type	Required
[1]	lyrics	The lyrics text to apply to the beats	String	yes
[2]	startBar	The first bar on which the notes should be applied	Number	yes
[2]	lyrics	The lyrics text to apply to the beats	String	yes

Example:

00:00

00:00

\title "With Lyrics"
\instrument piano
\lyrics "Do Re Mi Fa So La Ti"
C4 D4 E4 F4 | G4 A4 B4 r

00:00

00:00

\title "Combine Syllables (and empty beats)"
\instrument piano
\lyrics "Do+Do  Mi+Mi"
C4 C4 E4 E4

00:00

00:00

\title "Start Later"
\instrument piano
\lyrics 2 "Do Re Mi Fa So La Ti"
r r r r | r r r r |
C4 D4 E4 F4 | G4 A4 B4 r

00:00

00:00

\title "Comment"
\subtitle "Useful when loading lyrics from a different source"
\instrument piano
\lyrics "[This is a comment]Do Re Mi Fa"
C4 D4 E4 F4

\articulation

Scope: Staff metadata

Syntax

// [1]: Registers all standard articulation names
\articulation defaults
// [2]: 
\articulation (name value)

Description: Defines the articulations available to write percussion and drum tabs.

Currently alphaTex does not defining completely custom articulations (note heads, staff line, technical symbols etc.).

Number	Name Long	Name Short
29	Ride (choke)	Ridechoke
30	Cymbal (hit)	Cymbalhit
31	Snare (side stick)	Snaresidestick
33	Snare (side stick) 2	Snaresidestick2
34	Snare (hit)	Snarehit
35	Kick (hit)	Kickhit
36	Kick (hit) 2	Kickhit2
37	Snare (side stick) 3	Snaresidestick3
38	Snare (hit) 2	Snarehit2
39	Hand Clap (hit)	HandClaphit
40	Snare (hit) 3	Snarehit3
41	Low Floor Tom (hit)	LowFloorTomhit
42	Hi-Hat (closed)	HiHatclosed
43	Very Low Tom (hit)	VeryLowTomhit
44	Pedal Hi-Hat (hit)	PedalHiHathit
45	Low Tom (hit)	LowTomhit
46	Hi-Hat (open)	HiHatopen
47	Mid Tom (hit)	MidTomhit
48	High Tom (hit)	HighTomhit
49	Crash high (hit)	Crashhighhit
50	High Floor Tom (hit)	HighFloorTomhit
51	Ride (middle)	Ridemiddle
52	China (hit)	Chinahit
53	Ride (bell)	Ridebell
54	Tambourine (hit)	Tambourinehit
55	Splash (hit)	Splashhit
56	Cowbell medium (hit)	Cowbellmediumhit
57	Crash medium (hit)	Crashmediumhit
58	Vibraslap (hit)	Vibraslaphit
59	Ride (edge)	Rideedge
60	Hand (hit)	Handhit
61	Hand (hit)	Handhit
62	Conga high (mute)	Congahighmute
63	Conga high (hit)	Congahighhit
64	Conga low (hit)	Congalowhit
65	Timbale high (hit)	Timbalehighhit
66	Timbale low (hit)	Timbalelowhit
67	Agogo high (hit)	Agogohighhit
68	Agogo tow (hit)	Agogotowhit
69	Cabasa (hit)	Cabasahit
70	Left Maraca (hit)	LeftMaracahit
71	Whistle high (hit)	Whistlehighhit
72	Whistle low (hit)	Whistlelowhit
73	Guiro (hit)	Guirohit
74	Guiro (scrap-return)	Guiroscrapreturn
75	Claves (hit)	Claveshit
76	Woodblock high (hit)	Woodblockhighhit
77	Woodblock low (hit)	Woodblocklowhit
78	Cuica (mute)	Cuicamute
79	Cuica (open)	Cuicaopen
80	Triangle (rnute)	Trianglernute
81	Triangle (hit)	Trianglehit
82	Shaker (hit)	Shakerhit
83	Tinkle Bell (hat)	TinkleBellhat
83	Jingle Bell (hit)	JingleBellhit
84	Bell Tree (hit)	BellTreehit
85	Castanets (hit)	Castanetshit
86	Surdo (hit)	Surdohit
87	Surdo (mute)	Surdomute
91	Snare (rim shot)	Snarerimshot
92	Hi-Hat (half)	HiHathalf
93	Ride (edge) 2	Rideedge2
94	Ride (choke) 2	Ridechoke2
95	Splash (choke)	Splashchoke
96	China (choke)	Chinachoke
97	Crash high (choke)	Crashhighchoke
98	Crash medium (choke)	Crashmediumchoke
99	Cowbell low (hit)	Cowbelllowhit
100	Cowbell low (tip)	Cowbelllowtip
101	Cowbell medium (tip)	Cowbellmediumtip
102	Cowbell high (hit)	Cowbellhighhit
103	Cowbell high (tip)	Cowbellhightip
104	Hand (mute)	Handmute
105	Hand (slap)	Handslap
106	Hand (mute) 2	Handmute2
107	Hand (slap) 2	Handslap2
108	Conga low (slap)	Congalowslap
109	Conga low (mute)	Congalowmute
110	Conga high (slap)	Congahighslap
111	Tambourine (return)	Tambourinereturn
112	Tambourine (roll)	Tambourineroll
113	Tambourine (hand)	Tambourinehand
114	Grancassa (hit)	Grancassahit
115	Piatti (hat)	Piattihat
116	Piatti (hand)	Piattihand
117	Cabasa (return)	Cabasareturn
118	Left Maraca (return)	LeftMaracareturn
119	Right Maraca (hit)	RightMaracahit
120	Right Maraca (return)	RightMaracareturn
122	Shaker (return)	Shakerreturn
123	Bell Tee (return)	BellTeereturn
124	Golpe (thumb)	Golpethumb
125	Golpe (finger)	Golpefinger
126	Ride (middle) 2	Ridemiddle2
127	Ride (bell) 2	Ridebell2

Parameters:

Overload	Name	Description	Type	Required
[1]	defaults	Registers all standard articulation names	defaults	yes
[2]	name	The string used in the note values	String	yes
[2]	value	The numeric value of the built-in articulation	Number	yes

Parameter Values:

Following parameters have value limitations

Overload	Name	Values
[1]	defaults	Value Description defaults

Example:

00:00

00:00

\track "Drums" { instrument percussion }
\tempo 120
\clef neutral
\articulation defaults
(KickHit RideBell).16 r KickHit KickHit (KickHit RideBell).16 r KickHit KickHit (KickHit RideBell).16 r KickHit KickHit (KickHit RideBell).16 r KickHit KickHit |
(KickHit HiHatOpen) KickHit KickHit KickHit (KickHit HiHatOpen) KickHit KickHit KickHit (KickHit SnareHit HiHatOpen) KickHit KickHit.32 KickHit KickHit.16 (KickHit HiHatOpen) KickHit KickHit KickHit |
(KickHit HiHatOpen).8{tu 3} KickHit{tu 3} KickHit{tu 3} (KickHit SnareHit HiHatOpen){tu 3} KickHit.16{tu 3} KickHit{tu 3} KickHit.8{tu 3} (KickHit HiHatOpen).8{tu 3} KickHit{tu 3} KickHit{tu 3} (KickHit SnareHit HiHatOpen).8{tu 3} KickHit{tu 3} KickHit{tu 3}

\displayTranspose

Scope: Staff metadata

Syntax

\displayTranspose semitones

Description: Defines the number of semitones by which the standard notation should be transposed.

This only affects the display of the notes, not their audio.

It is typically used in situations like for guitars where the standard notation is displayed 1 octave lower to fit better into the standard staff.

It is a common practice to show a standard clef on guitar notes even though they are transposed by 1 octave to better fit into the standard staff lines.

Parameters:

Name	Description	Type	Required
semitones	The number of semitones by which the notes should be transposed	Number	yes

Example:

00:00

00:00

\track \staff \instrument piano
\displayTranspose -12
  C4.4 D4 E4 F4 | r.1

\transpose

Scope: Staff metadata

Syntax

\transpose semitones

Description: Defines the number of semitones by which the standard notation should be transposed.

This affects the display and audio.

Parameters:

Name	Description	Type	Required
semitones	The number of semitones by which the notes should be transposed	Number	yes

Example:

00:00

00:00

\track \staff \instrument piano
\transpose -12
  C4.4 D4 E4 F4 | r.1

\staffDisplay

Scope: Staff metadata

Syntax

\staffDisplay (staffTypes)

Description: Defines the display of elements like clefs, key signatures, time signatures, rests and bar numbers for the current staff.

The arguments select the staff types to which the properties apply. If no staff types are specified, every property applies to all staff types supporting the related element.

All properties are optional. Properties which are not specified are inherited from \defaultStaffDisplay. The values can be overridden per bar with \barDisplay.

Parameters:

Name	Description	Type	Required
staffTypes	The staff types to which the properties apply. If omitted, every property applies to all staff types supporting it.	score|tabs|slash|numbered[]	no

Parameter Values:

Following parameters have value limitations

Name	Values
staffTypes	Value Description score Standard notation tabs Guitar tablature slash Slash notation numbered Numbered notation (Jianpu)

Example:

00:00

00:00

\track
  \staff {score tabs}
  \staffDisplay tabs { tsPlacement allStaves rhythm showWithBeams }
  3.3.4 3.3 3.3 3.3 | 3.3 3.3 3.3 3.3

Properties:

clefVisibility

Scope: Staff metadata

Syntax

// [1]: 
clefVisibility ()
// [2]: 
clefVisibility visibility
// [3]: 
clefVisibility visibility
// [4]: 
clefVisibility visibility

Description: Show or hide the clef. Supported staff types: score, tabs.

Parameters:

Overload	Name	Description	Type	Required
[2]	visibility	Whether the clef is shown	"true"|"false"	yes
[3]	visibility	Whether the clef is shown	true|false	yes
[4]	visibility	Whether the clef is shown	1|0	yes

Parameter Values:

Following parameters have value limitations

Overload	Name	Values
[2]	visibility	Value Description "true" Show the clef "false" Hide the clef
[3]	visibility	Value Description true Show the clef false Hide the clef
[4]	visibility	Value Description 1 Show the clef 0 Hide the clef

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { clefVisibility false }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3

clefPlacement

Scope: Staff metadata

Syntax

clefPlacement placement

Description: Show the clef on all staves or only on the primary (topmost) staff. Supported staff types: score, tabs.

Parameters:

Name	Description	Type	Required
placement	On which staves the clef is shown	allStaves|primary	yes

Parameter Values:

Following parameters have value limitations

Name	Values
placement	Value Description allStaves All staves primary Only the primary (topmost) staff

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { clefPlacement primary }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3

clefSystems

Scope: Staff metadata

Syntax

clefSystems systems

Description: Show the clef on all systems or only on the first system. Supported staff types: score, tabs.

Parameters:

Name	Description	Type	Required
systems	On which systems the clef is shown	allSystems|firstSystemOnly	yes

Parameter Values:

Following parameters have value limitations

Name	Values
systems	Value Description allSystems All systems firstSystemOnly Only the first system

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { clefSystems firstSystemOnly }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3

ksVisibility

Scope: Staff metadata

Syntax

// [1]: 
ksVisibility ()
// [2]: 
ksVisibility visibility
// [3]: 
ksVisibility visibility
// [4]: 
ksVisibility visibility

Description: Show or hide the key signature. Supported staff types: score, slash.

Parameters:

Overload	Name	Description	Type	Required
[2]	visibility	Whether the key signature is shown	"true"|"false"	yes
[3]	visibility	Whether the key signature is shown	true|false	yes
[4]	visibility	Whether the key signature is shown	1|0	yes

Parameter Values:

Following parameters have value limitations

Overload	Name	Values
[2]	visibility	Value Description "true" Show the key signature "false" Hide the key signature
[3]	visibility	Value Description true Show the key signature false Hide the key signature
[4]	visibility	Value Description 1 Show the key signature 0 Hide the key signature

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { ksVisibility false }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3

ksPlacement

Scope: Staff metadata

Syntax

ksPlacement placement

Description: Show the key signature on all staves or only on the primary (topmost) staff. Supported staff types: score, slash.

Parameters:

Name	Description	Type	Required
placement	On which staves the key signature is shown	allStaves|primary	yes

Parameter Values:

Following parameters have value limitations

Name	Values
placement	Value Description allStaves All staves primary Only the primary (topmost) staff

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { ksPlacement primary }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3

ksSystems

Scope: Staff metadata

Syntax

ksSystems systems

Description: Show the key signature on all systems or only on the first system. Supported staff types: score, slash.

Parameters:

Name	Description	Type	Required
systems	On which systems the key signature is shown	allSystems|firstSystemOnly	yes

Parameter Values:

Following parameters have value limitations

Name	Values
systems	Value Description allSystems All systems firstSystemOnly Only the first system

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { ksSystems firstSystemOnly }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3

tsVisibility

Scope: Staff metadata

Syntax

// [1]: 
tsVisibility ()
// [2]: 
tsVisibility visibility
// [3]: 
tsVisibility visibility
// [4]: 
tsVisibility visibility

Description: Show or hide the time signature. Supported staff types: score, tabs, slash, numbered.

Parameters:

Overload	Name	Description	Type	Required
[2]	visibility	Whether the time signature is shown	"true"|"false"	yes
[3]	visibility	Whether the time signature is shown	true|false	yes
[4]	visibility	Whether the time signature is shown	1|0	yes

Parameter Values:

Following parameters have value limitations

Overload	Name	Values
[2]	visibility	Value Description "true" Show the time signature "false" Hide the time signature
[3]	visibility	Value Description true Show the time signature false Hide the time signature
[4]	visibility	Value Description 1 Show the time signature 0 Hide the time signature

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { tsVisibility false }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3

tsPlacement

Scope: Staff metadata

Syntax

tsPlacement placement

Description: Show the time signature on all staves or only on the primary (topmost) staff. Supported staff types: score, tabs, slash, numbered.

Parameters:

Name	Description	Type	Required
placement	On which staves the time signature is shown	allStaves|primary	yes

Parameter Values:

Following parameters have value limitations

Name	Values
placement	Value Description allStaves All staves primary Only the primary (topmost) staff

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { tsPlacement primary }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3

tsSystems

Scope: Staff metadata

Syntax

tsSystems systems

Description: Show the time signature on all systems or only on the first system. Supported staff types: score, tabs, slash, numbered.

Parameters:

Name	Description	Type	Required
systems	On which systems the time signature is shown	allSystems|firstSystemOnly	yes

Parameter Values:

Following parameters have value limitations

Name	Values
systems	Value Description allSystems All systems firstSystemOnly Only the first system

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { tsSystems firstSystemOnly }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3

restsVisibility

Scope: Staff metadata

Syntax

// [1]: 
restsVisibility ()
// [2]: 
restsVisibility visibility
// [3]: 
restsVisibility visibility
// [4]: 
restsVisibility visibility

Description: Show or hide the rests. Supported staff types: tabs.

Parameters:

Overload	Name	Description	Type	Required
[2]	visibility	Whether the rests is shown	"true"|"false"	yes
[3]	visibility	Whether the rests is shown	true|false	yes
[4]	visibility	Whether the rests is shown	1|0	yes

Parameter Values:

Following parameters have value limitations

Overload	Name	Values
[2]	visibility	Value Description "true" Show the rests "false" Hide the rests
[3]	visibility	Value Description true Show the rests false Hide the rests
[4]	visibility	Value Description 1 Show the rests 0 Hide the rests

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { restsVisibility false }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3

restsPlacement

Scope: Staff metadata

Syntax

restsPlacement placement

Description: Show the rests on all staves or only on the primary (topmost) staff. Supported staff types: tabs.

Parameters:

Name	Description	Type	Required
placement	On which staves the rests is shown	allStaves|primary	yes

Parameter Values:

Following parameters have value limitations

Name	Values
placement	Value Description allStaves All staves primary Only the primary (topmost) staff

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { restsPlacement primary }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3

restsSystems

Scope: Staff metadata

Syntax

restsSystems systems

Description: Show the rests on all systems or only on the first system. Supported staff types: tabs.

Parameters:

Name	Description	Type	Required
systems	On which systems the rests is shown	allSystems|firstSystemOnly	yes

Parameter Values:

Following parameters have value limitations

Name	Values
systems	Value Description allSystems All systems firstSystemOnly Only the first system

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { restsSystems firstSystemOnly }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3

barNumber

Scope: Staff metadata

Syntax

barNumber mode

Description: Set how bar numbers are shown. Supported staff types: all.

Parameters:

Name	Description	Type	Required
mode	The mode to use	allBars|firstOfSystem|hide	yes

Parameter Values:

Following parameters have value limitations

Name	Values
mode	Value Description allBars All bars firstOfSystem First bar of every system hide Hide

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { barNumber allBars }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3

rhythm

Scope: Staff metadata

Syntax

rhythm mode

Description: Set how the rhythm notation is shown. Supported staff types: tabs.

Parameters:

Name	Description	Type	Required
mode	The mode to use	hidden|showWithBeams|showWithBars|automatic	yes

Parameter Values:

Following parameters have value limitations

Name	Values
mode	Value Description hidden Hidden showWithBeams Individual beams per beat showWithBars Connected bars like standard notation automatic Shown if no standard notation is shown

Example:

00:00

00:00

\track { defaultSystemsLayout 2 }
  \staff {score tabs}
  \staffDisplay { rhythm showWithBeams }
  \ks D 3.3.4 r 3.3 3.3 | 3.3.4 3.3 r 3.3 | \ts (3 4) \ks A 3.3.4 3.3 r | 3.3.4 r 3.3