1 @node Properties, , , Reference Manual
3 Properties are Scheme values, so they have a type. The type of a
4 property is listed in parentheses after the property name.
11 @item @code{Generic_property_list} Defines names and types for
12 generic properties. These are properties than can be plugged into the
13 backend directly. See the init file @file{generic-property.scm} for
14 details. For internal use only.
16 @cindex properties!Lyrics
19 @item @code{textStyle}@indexcode{textStyle} @propertytype{string}
20 Set the font for lyrics. The available font choices are
21 @code{roman}, @code{italic}, @code{bold}, @code{large}, @code{Large},
22 @code{typewriter}, and @code{finger}. The @code{finger} font can
23 only display numbers. Note also that you must be careful when
24 using @code{\property} in Lyrics mode, because of the way strings
25 are parsed. Either put quotes around the arguments to
26 @code{\property} or be sure to leave a space on both sides of the
31 @cindex properties!Thread
34 @item @code{noteheadStyle}@indexcode{noteheadStyle} @propertytype{string}
35 Selects type of note head. Choices are @code{cross},
36 @code{diamond}, @code{harmonic}, @code{transparent}, and @code{""}.
37 They are shown in that order below.
39 @mudela[center,verbatim]
42 \property Staff.barNonAuto = 1
43 \property Voice.noteHeadStyle = cross
45 \property Voice.noteHeadStyle = diamond
47 \property Voice.noteHeadStyle = harmonic
49 \property Voice.noteHeadStyle = transparent
51 \property Voice.noteHeadStyle = ""
62 @subsubheading Grace properties
64 @cindex properties!Grace
68 @item @code{stemStyle}@indexcode{flagStyle} @propertytype{string}
69 By default set to @code{"grace"} meaning that all unbeamed
70 notes with flags are typeset with a slash through the flag.
71 Setting to @code{""} gives standard flags.
74 c'8 \property Voice.flagStyle = "grace" c'8
79 @subsubheading Voice properties
81 @cindex properties!Voice
84 @item @code{abbrev}@indexcode{abbrev} @propertytype{integer}
85 Set length for tremolo to be used if no length is explicitly
88 @item @code{articulationScriptPadding}@indexcode{articulationScriptPadding}
89 Determines the extra space added between articulation marks, such
90 as staccato, tenuto, trill, up/down bow or fermata, and the
91 closest staff line or note.
93 @item @code{articulationScriptVerticalDirection} @propertytype{direction}
94 @indexcode{articulationScriptVerticalDirection}
95 Determines the location of articulation marks. Set to @code{\up}
96 to print marks above the staff; set to @code{\down} to print marks
97 below the staff. This property does not override explicit
98 directions marked with `@code{^}' or `@code{_}' in the mudela file.
100 @item @code{noAutoBeaming}@indexcode{beamAuto} @propertytype{boolean}
101 If set to 1 then beams are not generated automatically.
103 @item @code{beamAutoEnd}@indexcode{beamAutoEnd} @propertytype{?}
104 Specifies when automatically generated beams can end. See
105 section XREF-autobeam [FIXME].
107 @item @code{beamAutoBegin}@indexcode{beamAutoBegin} @propertytype{?}
108 Specifies when automatically generated beams can start. See
109 section XREF-autobeam [FIXME].
113 @item @code{beamQuantisation}@indexcode{beamQuantisation} @propertytype{symbol}
114 Set to @code{\none} for no quantization. Set to @code{\normal} to
115 quantize position and slope. Set to @code{\traditional} to avoid
116 wedges. These three settings are available via
117 @code{\beamposfree}@keyindex{beamposfree},
118 @code{\beamposnormal}@keyindex{beamposnormal}, and
119 @code{\beampostraditional}@keyindex{beampostraditional}.
121 @item @code{beamSlopeDamping}@indexcode{beamSlopeDamping} @propertytype{number}
122 Set to @code{\none} for undamped beams. Set to @code{\normal} for
123 damped beams. Set to @code{\infinity} for beams with zero slope.
125 @code{\beamslopeproportional}@keyindex{beamslopeproportional},
126 @code{\beamslopedamped}@keyindex{beamslopedamped}, and
127 @code{\beamslopezero}@keyindex{beamslopezero} each set the
130 @item @code{dynamicDirection}@indexcode{dynamicDirection} @propertytype{direction}
131 Determines location of dynamic marks. Set to @code{\up} to print
132 marks above the staff; set to @code{\down} to print marks below
135 @item @code{dynamicStyle}@indexcode{dynamicStyle} @propertytype{string}
136 Set the text style for dynamics.
138 @item @code{fontSize}@indexcode{fontSize} @propertytype{number}
139 Can be used to select smaller font sizes for music. The normal
140 font size is 0, and the two smaller sizes are -1
144 c''16 \property Staff.fontSize = -2 c''16
147 @item @code{forceHorizontalShift}@indexcode{forceHorizontalShift}
148 Force horizontal shift for collision resolution. It overrides
149 automatic collision resolution. The value is the shift amount
150 expressed in @code{note_width}, as set in the paper section.
152 @item @code{collisionMergeDotted}@indexcode{collisionMergeDotted} @propertytype{boolean}
154 Merge noteheads in collisions, even if they have a different number of
155 dots. This normal notation for polyphonic guitar music.
157 @mudelafile[verbatim]{force-hshift.sly}
160 [FIXME: this should be moved]
162 Lilypond always arranges note heads on alternate sides of a stem (that
163 is, within a single voice) as necessary to prevent collisions (note head
164 overlaps). For up stems, the upper note of a colliding pair is placed
165 on the right side of the stem, the lower on the left. For down stems,
166 the algorithm works in reverse.
168 Lily also attempts to prevent collisions of note heads in different
169 voices. A situation where chords of two or more voices are played
170 simultaneously within one staff.
172 By default, if only two voices (and both have opposite stem directions)
173 are in this 'collision group', the notes both are shifted by @code{0.5
174 \quartwidth} if there are unisons or seconds between the voices.
176 If there are more than two voices in a collision group, shifting is
177 inactive by default, since in this case, there are multiple chords with
178 the same stem direction. By distinguish between those chords, LilyPond
179 can do collision resolution in these cases as well.
181 Distinguishing between voices with the same stem direction, is done by
182 setting the property @code{Voice.horizontalNoteShift}. It must be set
183 to a different integer for each voice. Then, all note heads in collision
184 groups (not just unisons and seconds) will be offset, one voice relative
185 another. The following fragment of sheet music shows how shifting is
186 done, with values of @code{horizontalNoteShift} printed over and under
187 the notes. In this case the chords are just simple notes.
189 @c URG : mudela book bug.
190 @mudela[singleline,verbatim]
192 \notes \context Staff <
193 \context Voice = VA { \stemup f''4^"0" }
194 \context Voice = VB {\stemup
195 \property Voice.horizontalNoteShift = 1 d''4^" 1" }
196 \context Voice = VC { \stemup \property
197 Voice.horizontalNoteShift = 2 b'4^" 2" }
198 \context Voice = VD { \stemdown \property
199 Voice.horizontalNoteShift = 1 g'4_"1 " }
200 \context Voice = VE { \stemdown e'4_"0" }
205 If you are not satisfied with the collision resolution of LilyPond, you
206 can override the horizontal shift value of the chord of one Voice, by
207 setting @code{forceHorizontalShift}. This sets the amount shift,
208 measured in black note head widths.
210 To take complete control of note position shifts in complex passages,
211 you have set things up for normal collisions and override all shifts by
212 setting @code{forceHorizontalShift} to zero everywhere
214 \property Voice.horizontalNoteShift = <n>
215 \property Voice.forceHorizontalShift = "0.0"
218 Then you can set the force property to a suitable value before each note
219 that really needs it (unisons and seconds), and reset it to 0.0 after
222 @item @code{horizontalNoteShift}@indexcode{horizontalNoteShift} @propertytype{integer}
223 Enable LilyPond to shift notes horizontally if they collide with
224 other notes. This is useful when typesetting many voices on one
225 staff. The identifier @code{\shift}@keyindex{shift} is defined to
226 enable this. Traditionally, the outer chords (the upmost and
227 downmost voices), should have no @code{horizontalNoteShift}.
229 @item @code{markScriptPadding}@indexcode{markScriptPadding} @propertytype{number}
230 Determines the extra space added between the mark and the closest
233 @item @code{markDirection}@indexcode{markDirection} @propertytype{direction}
234 Determines if marks should be printed above or below the staff.
235 Set to @code{\up} to print marks above the staff; set to
236 @code{\down} to print marks below the staff.
238 @item @code{midiInstrument}@indexcode{midiInstrument} @propertytype{string}
239 Sets the instrument for MIDI output. If this property is not set
240 then LilyPond will use the @code{instrument} property. This must
241 be set to one of the strings on the list of MIDI instruments that
242 appears in section XREF-midilist [FIXME]. If you use a string which
243 is not listed, LilyPond will silently substitute piano.
245 @item @code{restStyle}@indexcode{restStyle} @propertytype{string}
246 Change the layout of rests shorter than quarter notes.
247 Currently, the standard layout @code{""} and mensural notation
248 @code{"mensural"} are available. Mensural rests of duration
249 32 or shorter are not available.
251 r\longa r\breve r1 r2 r4 r8 r16 r32 r64 r128 r128
252 \property Staff.restStyle = "mensural"
253 r\longa r\breve r1 r2 r4 r8 r16 r32 r64 r128 r128
256 @item @code{scriptHorizontal}@indexcode{scriptHorizontal} @propertytype{boolean}
257 Put scripts left or right of note heads. Support for this is
258 limited. Accidentals will collide with scripts.
260 @item @code{slurVerticalDirection}@indexcode{slurVerticalDirection} @propertytype{direction}
261 Set to @code{\free} for free choice of slur direction, set to
262 @code{\up} to force slurs up, set to @code{\down} to force slurs
263 down. The shorthands @code{\slurup}@keyindex{slurup},
264 @code{\slurdown}@keyindex{slurdown}, and
265 @code{\slurboth}@keyindex{slurboth} are available.
267 @item @code{slurDash}@indexcode{slurDash} @propertytype{number}
268 Set to NIL for normal slurs, 1 for dotted slurs, and a
269 larger value for dashed slurs. Identifiers
270 @code{\slurnormal}@keyindex{slurnormal} and
271 @code{\slurdotted}@keyindex{slurdotted} are predefined to set the
276 \property Voice.slurDash = 3
280 @item @code{stemLength}@indexcode{stemLength}
281 Set length of stems. Unit is `@code{interline}/2', so
282 @code{stemLength} defaults to 7.
284 g''4 \property Voice.stemLength = #14 g4 \property Voice.stemLength = #3 g4 g,,4
287 @item @code{stemLeftBeamCount}@indexcode{stemLeftBeamCount} @propertytype{integer}
288 Specify the number of beams to draw on the left side of the next
289 note. Overrides automatic beaming. The value is only used once,
290 and then it is erased.
292 @item @code{stemRightBeamCount}@indexcode{stemRightBeamCount} @propertytype{integer}
293 Specify the number of beams to draw on the right side of the next
294 note. Overrides automatic beaming. The value is only used once,
295 and then it is erased.
297 @item @code{tieVerticalDirection}@indexcode{tieVerticalDirection} @propertytype{direction}
298 Set to @code{\free} for free choice of tie direction, set to
299 @code{\up} to force ties up, set to @code{\down} to force ties
302 @item @code{transposing}@indexcode{transposing} @propertytype{integer}
303 Transpose the MIDI output. Set this property to the number of
304 half-steps to transpose by.
306 @item @code{textEmptyDimension}@indexcode{textEmptyDimension} @propertytype{boolean}
307 If set to true then text placed above or below the staff is
308 assumed to have zero width. @code{fatText} and @code{emptyText}
309 are predefined settings.
312 c4^"foo" \emptyText c4^"foo" c4
315 @item @code{textStyle}@indexcode{textStyle} @propertytype{string}
316 Set the text style for superscripts and subscripts. See above
317 for list of text styles.
319 @item @code{textScriptPadding}@indexcode{textScriptPadding} @propertytype{number}
320 Determines the extra space added between superscripted resp.
321 subscripted text and the closest staff line or note.
323 @item @code{verticalDirection}@indexcode{verticalDirection} @propertytype{direction}
324 Determines the direction of stems, subscripts, beams, slurs, and
325 ties. Set to @code{\down} to force them down, @code{\up} to force
326 them up, or @code{\free} to let LilyPond decide. This can be used
327 to distinguish between voices on the same staff. The
328 @code{\stemdown}@keyindex{stemdown}, @code{\stemup}@keyindex{stemup},
329 and @code{\stemboth}@keyindex{stemboth} identifiers set this
333 @item @code{tupletDirection}@indexcode{tupletDirection} @propertytype{direction}
334 Determines the direction of triplets and other tuplets. Set to
335 @code{\down} to force them below the staff, @code{\up} to force
336 them above, or @code{\free} to let LilyPond decide.
338 @item @code{tupletBracketVisibility}@indexcode{tupletBracketVisibility} @propertytype{boolean} or @propertytype{symbol}
339 @item @code{tupletNumberVisibility}@indexcode{tupletNumberVisibility} @propertytype{boolean} or @propertytype{symbol}
341 These properties the visibility of the tuplet bracket and its
342 number respectively. Setting it to false will prevent printing of the
343 associated element. Setting the property to 'if-no-beam will make it
344 print only if there is no beam associated with this tuplet bracket.
348 @item @code{tupletInvisible}@indexcode{tupletInvisible} @propertytype{boolean}
350 If set to true, tuplet bracket creation is switched off
351 entirely. This has the same effect as setting both
352 @code{tupletNumberVisibility} and @code{tupletBracketVisibility} to
353 @code{#f}, but as this does not even create elements, this setting
354 uses less memory and time.
357 @item @code{tupletSpannerDuration} @indexcode{tupletSpannerDuration}
358 @propertytype{moment}
360 Normally a tuplet bracket is as wide as the
361 @code{\times} expression that gave rise to it. By setting this
362 property, you can make brackets last shorter. Example
364 @mudela[verbatim,fragment]
365 \context Voice \times 2/3 { \property Voice.tupletSpannerDuration = #(make-moment 1 4) [c8 c c] [c c c] }
370 @subsubheading Staff properties
372 @cindex properties!Staff
376 @item @code{barNonAuto}@indexcode{barNonAuto} @propertytype{boolean}
377 If set to true then bar lines will not be printed
378 automatically; they must be explicitly created with @code{\bar}
379 keywords. Unlike with the @code{\cadenza} keyword, measures are
380 still counted. Bar generation will resume according to that
381 count if this property is set to zero.
383 @item @code{barNumberDirection}@indexcode{barNumberDirection} @propertytype{direction}
384 Set to @code{\up} or @code{\down} to put bar numbers above or below
387 @item @code{barNumberScriptPadding}@indexcode{barNumberScriptPadding}
388 Sets extra space between the bar number and the bar it labels.
390 @item @code{barSize}@indexcode{barSize}
391 Specify the height of the bar lines if it should be different
392 than the staff height.
394 c1 c1 \property Staff.barSize = 20 c1 c1
397 @item @code{barAtLineStart}@indexcode{barAtLineStart} @propertytype{boolean}
398 Set to true to produce a bar line after the clef at the start
399 of each line (but not at the beginning of the music).
403 @item @code{clefStyle}@indexcode{clefStyle} @propertytype{string}
404 Determines how clefs are typeset. If set to @code{transparent},
405 the clefs are not printed at all, if set to
406 @code{fullSizeChanges}, clef changes in the middle of a line are
407 typeset with a full size clef. By default, clef changes are
408 typeset in smaller size.
410 @item @code{supportedClefTypes}@indexcode{supportedClefTypes} @propertytype{alist}
412 Clef settings supported. The value is an association list clef
413 descriptions indexed by clef name (alto, baritone, etc.). A clef
414 description is a list with the glyph name, and the staff position
415 where it should go. For internal use.
417 @item @code{clefPitches}@indexcode{clefPitches} @propertytype{alist}
418 Settings for the position of the central C, relative to this clef
419 symbol. For internal use.
421 @item @code{defaultClef}@indexcode{defaultClef} @propertytype{string}
422 Clef setting to use when this context is created. If unset,
423 no clef is printed upon creation.
425 @item @code{marginDirection}@indexcode{marginDirection} @propertytype{direction}
426 Set to @code{\left} or @code{\right} to specify location of
429 @item @code{marginScriptPadding}@indexcode{marginScriptPadding}
430 Specify extra space for marginal scripts.
432 @item @code{forgetAccidentals}@indexcode{forgetAccidentals} @propertytype{boolean}
433 Causes accidentals to be printed at every note instead of
434 remembered for the duration of a measure.
436 @item @code{noResetKey}@indexcode{noResetKey} @propertytype{boolean}
437 Do not reset the key at the start of a measure. Accidentals will
438 be printed only once and are in effect until overridden, possibly
441 @item @code{staffSpace}@indexcode{staffLineLeading} @propertytype{number}
442 Specifies the distance (in points) between lines of the staff.
444 @item @code{numberOfStaffLines}@indexcode{numberOfStaffLines} @propertytype{integer}
445 Specifies the number of staff lines. The default is 5.
447 @item @code{postBreakPadding}@indexcode{postBreakPadding} @propertytype{number}
448 Extra space in points to be added after the clef, time signature
449 and key signature on the staff. Deprecated, do not use.
451 @item @code{noVoltaBraces}@indexcode{noVoltaBraces} @propertytype{boolean}
452 Set to true to suppress the printing of brackets over alternate
453 endings specified by the command @code{\alternative}.
456 @item @code{barAlways}@indexcode{barAlways} @propertytype{boolean}
457 If set to true a bar line is drawn after each note.
459 @item @code{defaultBarType}@indexcode{defaultBarType} @propertytype{string}
460 Sets the default type of bar line. See Section XREF-barlines [FIXME]
461 for a list of available bar types.
463 @item @code{instrument}, @code{instr} @propertytype{string}
464 @indexcode{instrument}@indexcode{instr}
465 If @code{Staff_margin_engraver}
466 @cindex Staff_margin_engraver
468 added to the Staff translator, then the @code{instrument} property
469 is used to label the first line of the staff and the @code{instr}
470 property is used to label subsequent lines. If the
471 @code{midiInstrument} property is not set, then @code{instrument}
472 is used to determine the instrument for MIDI output.
474 @item @code{keyOctaviation}@indexcode{keyOctaviation} @propertytype{boolean}
475 If set to false, then keys are the same in all octaves. If set
476 to true then the key signature for different octaves can be
477 different and is specified independently:
480 \keysignature bes fis'
483 The default value is @code{#f}. Can be set to @code{#t} with
484 @code{\specialkey} or reset with @code{\normalkey}.
486 @item @code{timeSignatureStyle}@indexcode{timeSignatureStyle} @propertytype{string}
487 Changes the default two-digit layout for time signatures. The
488 following values are recognized:
491 @item @code{C}@indexcode{C}
492 4/4 and 2/2 are typeset as C and struck C, respectively. All
493 other time signatures are written with two digits.
495 @item @code{old}@indexcode{old}
496 2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8 and 9/8 are
497 typeset with old-style mensuration marks. All other time
498 signatures are written with two digits.
500 @item @code{1}@indexcode{1}
501 All time signatures are typeset with a single
502 digit, e.g. 3/2 is written as 3.
504 @item @indexcode{CM/N}@code{C}@var{M}@code{/}@var{N},
505 @indexcode{oldM/N}@code{old}@var{M}@code{/}@var{N} or
506 @code{old6/8alt}@indexcode{old6/8alt}
507 Tells LilyPond to use a specific symbol as time signature.
510 The different time signature characters are shown below with its
513 @mudela[center,verbatim]
516 \notes\relative c'' {
517 \property Voice.textStyle = typewriter
518 \property Staff.timeSignatureStyle = "C2/2"
519 \time 2/2; a2^"C2/2" a2
520 \property Staff.timeSignatureStyle = "C4/4"
521 \time 2/2; a2^"C4/4" a2
522 \property Staff.timeSignatureStyle = "old2/2"
523 \time 2/2; a2^"old2/2" a2
524 \property Staff.timeSignatureStyle = "old3/2"
525 \time 2/2; a2^"old3/2" a2
526 \property Staff.timeSignatureStyle = "old2/4"
527 \time 2/2; a2^"old2/4" a2
528 \property Staff.timeSignatureStyle = "old4/4"
529 \time 2/2; a2^"old4/4" a2
530 \property Staff.timeSignatureStyle = "old6/4"
531 \time 2/2; a2^"old6/4" a2
532 \property Staff.timeSignatureStyle = "old9/4"
533 \time 2/2; a2^"old9/4" a2
534 \property Staff.timeSignatureStyle = "old4/8"
535 \time 2/2; a2^"old4/8" a2
536 \property Staff.timeSignatureStyle = "old6/8"
537 \time 2/2; a2^"old6/8" a2
538 \property Staff.timeSignatureStyle = "old6/8alt"
539 \time 2/2; a2^"old6/8alt" a2
540 \property Staff.timeSignatureStyle = "old9/8"
541 \time 2/2; a2^"old9/8" a2
550 @item @code{voltaSpannerDuration}@indexcode{voltaSpannerDuration} @propertytype{moment}
551 Set to an integer to control the size of the brackets printed by
552 @code{\alternative}. The integer specifies the number of whole
553 notes duration to use for the brackets. It is rounded to the
554 nearest measure. This can be used to shrink the length of
555 brackets in the situation where one alternative is very large.
556 It may have odd effects if the specified duration is longer than
557 the music given in an @code{\alternative}.
561 @cindex properties!GrandStaff
564 @item @code{maxVerticalAlign}@indexcode{maxVerticalAlign} @propertytype{number}
565 Set the maximum vertical distance between staffs.
567 @item @code{minVerticalAlign}@indexcode{minVerticalAlign} @propertytype{number}
568 Set the minimum vertical distance between staffs.
572 @cindex properties!Score
575 @item @code{skipBars}@indexcode{skipBars} @propertytype{boolean}
576 Set to 1 to skip the empty bars that are produced by
577 multimeasure notes and rests. These bars will not appear on the
578 printed output. Set to zero (the default) to expand multimeasure
579 notes and rests into their full length, printing the appropriate
580 number of empty bars so that synchronization with other voices is
585 @mudela[fragment,verbatim,center]
586 r1 r1*3 R1*3\property Score.skipBars=1 r1*3 R1*3
591 @item @code{breakAlignOrder}@indexcode{breakAlignOrder} @propertytype{list of string}
593 Defines the order in which prefatory matter (clefs, key signatures) appears, eg. this puts the key signatures after the bar lines:
595 \property Score.breakAlignOrder = #'(
607 @cindex properties!ChordNamesVoice
610 @item @code{chordInversion}@indexcode{chordInversion} @propertytype{boolean}
611 Determines whether LilyPond should look for chord inversions when
612 translating from notes to chord names. Set to 1 to find
613 inversions. The default is 0 which does not look for