GNU LilyPond

Welcome to the home of the GNU Music Typesetter

Node:LilyPond context properties, Next:LilyPond backend, Previous:LilyPond engravers, Up:Top

LilyPond context properties

ExtraVerticalExtent (pair of numbers):

extra vertical extent, same format as MinimumVerticalExtent

Generic_property_list (list):

description of the conversion.

Defines names and types for generic properties. These are properties than can be plugged into the backend directly. See the init file generic-property.scm for details. For internal use only, deprecated.

MinimumVerticalExtent (pair of numbers):

minimum vertical extent, same format as VerticalExtent

VerticalExtent (pair of numbers):

hard coded vertical extent. The format is a pair of dimensions, for example, this sets the sizes of a staff to 10 (5+5) staffspaces high.

property Staff.VerticalExtent = #(-5.0 . 5.0)

VerticalExtent, MinimumVerticalExtent and ExtraVerticalExtent are predefined in all relevant contexts to #f, so they will not inherit values.

Note that these VerticalExtents can only operate on vertical groups, and therefore only work in contexts which contain an Axis_group_engraver.

aDueText (string):

text for begin of a due

associatedVoice (string):

Name of the Voice that has the melody for this LyricsVoice.

autoBeamSettings (list):

Specifies when automatically generated beams should begin and end. The elements have the format:

   function shortest-duration-in-beam time-signature

where

    function = begin or end
    shortest-duration-in-beam = numerator denominator; eg: 1 16
    time-signature = numerator denominator, eg: 4 4

unspecified or wildcard entries for duration or time-signature
are given by * *

The user can override beam begin or end time by pushing a wildcard entries
'(begin * * * *) or '(end * * * *) resp., eg:

    property Voice.autoBeamSettings push #'(end * * * *) = #(make-moment 1 4)

The head of the list:
    '(
((end * * 3 2) . ,(make-moment 1 2))
((end 1 16 3 2) . ,(make-moment 1 4))
((end 1 32 3 2) . ,(make-moment 1 8))
     ...
    )

automaticMelismata (boolean):

If set, ddlyrics will assume that beams, slurs and ties signal melismata, and align lyrics accordingly.

automaticPhrasing (boolean):

If set, the Lyric_phrasing_engraver will match note heads of context called Voice X to syllables from LyricsVoice called X-<something>. This feature is turned on by default. See the example file lyrics-multi-stanza.ly.

barAlways (boolean):

If set to true a bar line is drawn after each note.

barCheckNoSynchronize (boolean):

If set, don't reset measurePosition when finding a bbarcheck. This makes bar-checks for polyphonic music easier.

barNonAuto (boolean):

If set to true then bar lines will not be printed automatically; they must be explicitly created with bar keywords. Unlike with the cadenza keyword, measures are still counted. Bar generation will resume according to that count if this property is set to zero.

beamMelismaBusy (boolean):

Signal if a beam is set when automaticMelismata is set

beatLength (moment):

The length of one beat in this time signature.

breakAlignOrder (list):

Defines the order in which prefatory matter (clefs, key signatures) appears, eg. this puts the key signatures after the bar lines:

	\property Score.breakAlignOrder = #'(
	  Span_bar
	  Breathing_sign
	  Clef_item
	  Staff_bar
	  Key_item
	  Time_signature
	)

centralCPosition (number):

Place of the central C. Usually determined by looking at clefPosition and clefGlyph.

changeMoment (unknown):

duration that voices are examined for differences, when part-combining. Usually unset or zero when combining threads into one voice, and 1 (or the duration of one measure) when combining voices into one staff.

chordChanges (boolean):

Only show changes in chords scheme?

clefGlyph (string):

Name of the symbol within the music font

clefOctavation (integer):

Add this much extra octavation. Values of 7 and -7 are common.

clefPosition (number):

Where should the center of the symbol go?

combineParts (boolean):

try to combine parts?

connectArpeggios (boolean):

If set, connect all arpeggios that are found. In this way, you can make arpeggios that cross staffs.

createKeyOnClefChange (boolean):

Print a key signature whenever the clef is changed.

crescendoSpanner (symbol):

Type of spanner to be used for crescendi. One of: hairpin, line, dashed-line, dotted-line. If unset, hairpin type is used.

crescendoText (markup (list or string)):

Text to print at start of non-hairpin crecscendo, ie: cresc.

currentBarNumber (integer):

Contains the current barnumber. This property is incremented at every barline.

currentCommandColumn (grob (GRaphical OBject)):

Grob that is X-parent to all current breakable (clef, key signature, etc.) items.

currentMusicalColumn (grob (GRaphical OBject)):

Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).

decrescendoSpanner (symbol):

Type of spanner to be used for decrescendi. One of: hairpin, line, dashed-line, dotted-line. If unset, hairpin type is used.

decrescendoText (markup (list or string)):

Text to print at start of non-hairpin decrecscendo, ie: dim.

defaultBarType (string):

Sets the default type of bar line. Available bar types: [FIXME];

This variable is typically read at Score level, so overriding Staff.defaultBarType will have no effect.

devNullThread (symbol):

User control of Thread_devnull_engraver: one of

(), or unset

Behave in normal way: remove one set of grobs when in unisolo.

allways:

Remove any grob that comes along.

never:

Do nothing.

devNullVoice (symbol):

User control of Voice_devnull_engraver: one of

(), or unset

Behave in normal way: remove spanners when in unisolo.

allways:

Remove any spanners that come along.

never:

Do nothing.

easyPlay (boolean):

Copy note names into note head grob property

explicitClefVisibility (procedure):

visibility-lambda function for clef changes.

explicitKeySignatureVisibility (procedure):

visibility-lambda function for explicit Key changes; override of #'visibility-lambda will set the visibility for normal (ie. at the start of the line) key signatures.

followVoice (boolean):

if set, note heads are tracked across staff switches by a thin line

forceClef (boolean):

Show clef symbol, even if it hasn't changed. Only active for the first clef after the property is set, not for the full staff.

forgetAccidentals (boolean):

do not set localKeySignature when a note alterated differently from localKeySignature is found.

Causes accidentals to be printed at every note instead of remembered for the duration of a measure.

graceAccidentalSpace (number):

amount space to alot for an accidental

graceAlignPosition (direction):

put the grace note before or after the main note?

instr (markup (list or string)):

see instrument

instrument (markup (list or string)):

If Instrument_name_engraver is added to the Staff translator, then the instrument property is used to label the first line of the staff and the instr property is used to label subsequent lines. If the midiInstrument property is not set, then instrument is used to determine the instrument for MIDI output.

instrumentEqualizer (procedure):

[DOCUMENT-ME]

keyAccidentalOrder (list):

Alist that defines in what order alterations should be printed. The format is (NAME . ALTER), where NAME is from 0 .. 6 and ALTER from -1, 1.

keySignature (list):

The current key signature. This is an alist containing (NAME . ALTER) or ((OCTAVE . NAME) . ALTER) pairs, where NAME is from 0.. 6 and ALTER from -2,-1,0,1,2

localKeySignature (list):

the key signature at this point in the measure. The format is the same as for keySignature.

measureLength (moment):

Length of one measure in the current time signature last?

measurePosition (moment):

How much of the current measure (measured in whole notes) have we had. This can be set manually to create incomplete measures (anacrusis, upbeat), the start of the music.

melismaBusy (boolean):

Signifies whether a melisma is active. This can be used to signal melismas on top of those automatically detected.

melismaEngraverBusy (boolean):

See (lilypond)melismaBusy. This is set automatically.

midiInstrument (string):

Name of the MIDI instrument to use

noAutoBeaming (boolean):

If set to true then beams are not generated automatically.

noDirection (boolean):

Don't set directions by a2-engraver when part-combining.

noResetKey (boolean):

Do not reset local key to the value of keySignature at the start of a measure, as determined by measurePosition.

Do not reset the key at the start of a measure. Accidentals will be printed only once and are in effect until overridden, possibly many measures later.

oneBeat (moment):

How long does one beat in the current time signature last?

pedalSostenutoStrings (string):

see pedalSustainStrings.

pedalSustainStrings (list):

List of string to print for sustain-pedal. Format is (UP UPDOWN DOWN), where each of the three is the string to print when this is done with the pedal.

pedalUnaCordaStrings (string):

see pedalSustainStrings.

phrasingPunctuation (string):

rehearsalMark (number or string):

repeatCommands (list):

This property is read to find any command of the form (volta . X), where X is a string or #f

scriptDefinitions (list):

Description of scripts. This is used by Script_engraver for typesetting note-super/subscripts. See scm/script.scm for more information

scriptHorizontal (boolean):

Put scripts left or right of note heads. Support for this is limited. Accidentals will collide with scripts.

skipBars (boolean):

Set to true to skip the empty bars that are produced by multimeasure notes and rests. These bars will not appear on the printed output. If not set (the default) multimeasure notes and rests expand into their full length, printing the appropriate number of empty bars so that synchronization with other voices is preserved.

@lilypond[fragment,verbatim,center]
r1 r1*3 R1*3  \\property Score.skipBars= ##t r1*3 R1*3

@end lilypond

skipTypesetting (boolean):

When true, all no typesetting is done at this moment, causing the interpretation phase to go a lot faster. This can help with debugging large scores.

slurBeginAttachment (symbol):

translates to the car of grob-property 'attachment of NoteColumn. See Slur.

slurEndAttachment (symbol):

translates to the cdr of grob-property 'attachment of NoteColumn. See Slur.

slurMelismaBusy (boolean):

Signal a slur if automaticMelismata is set.

solo (boolean):

set if solo is detected by the part combiner.

soloADue (boolean):

set Solo/A due texts in the part combiner?.

soloIIText (string):

text for begin of solo for voice "two" when part-combining.

soloText (string):

text for begin of solo when part-combining.

sparseTies (boolean):

only create one tie per chord.

split-interval (boolean):

set if part-combiner separated voices based on splitInterval.

splitInterval (pair of numbers):

part-combiner will separate its two voices (or threads) when interval between the two voices is contained in this range.

squashedPosition (integer):

Vertical position of squashing for Pitch_squash_engraver.

staffsFound (list):

list of all staff-symbols found.

stanza (markup (list or string)):

Stanza `number' to print at start of a verse. Use in LyricsVoice context.

stemLeftBeamCount (integer):

Specify the number of beams to draw on the left side of the next note. Overrides automatic beaming. The value is only used once, and then it is erased. .

stemRightBeamCount (integer):

idem, for the right side.

stz (markup (list or string)):

Abbreviated form for a stanza, see also Stanza property.

textNonEmpty (boolean):

If set to true then text placed above or below the staff is not assumed to have zero width. atText and emptyText are predefined settings. .

tieMelismaBusy (boolean):

Signal ties when automaticMelismata is set.

timeSignatureFraction (pair of numbers):

pair of numbers, signifying the time signature. For example #'(4 . 4) is a 4/4time signature.

timing (boolean):

Keep administration of measure length, position, bar number, etc? Switch off for cadenzas.

transposing (integer):

Transpose the MIDI output. Set this property to the number of half-steps to transpose by.

tremoloFlags (integer):

Number of tremolo flags to add if none is specified.

tupletInvisible (boolean):

If set to true, tuplet bracket creation is switched off entirely. This has the same effect as setting both tupletNumberVisibility and tupletBracketVisibility to #f, but as this does not even create any grobs, this setting uses less memory and time.

tupletNumberFormatFunction (procedure):

Function taking a music as input, producing a string. This function is called to determine the text to print on a tuplet bracket.

tupletSpannerDuration (moment):

Normally a tuplet bracket is as wide as the imes expression that gave rise to it. By setting this property, you can make brackets last shorter. Example

@lilypond[verbatim,fragment]
context Voice 	imes 2/3 {
  property Voice.tupletSpannerDuration = #(make-moment 1 4)
  [c8 c c] [c c c]
}
@end lilypond

.

unirhythm (boolean):

set if unirhythm is detected by the part combiner.

unisilence (boolean):

set if unisilence is detected by the part combiner.

unison (boolean):

set if unisono is detected by the part combiner. .

verticalAlignmentChildCallback (procedure):

what callback to add to children of a vertical alignment. It determines what alignment procedure is used on the alignment itself. .

voltaSpannerDuration (moment):

maximum duration of the volta bracket.

Set to a duration to control the size of the brackets printed by \alternative. It specifies the number of whole notes duration to use for the brackets. This can be used to shrink the length of brackets in the situation where one alternative is very large. It may have odd effects if the specified duration is longer than the music given in an \alternative. .

weAreGraceContext (boolean):

.

whichBar (string):

This property is read to determine what type of barline to create.

Example:

\property Staff.whichBar = "|:"

This will create a start-repeat bar in this staff only.

If not set explicitly (by property or bar), this is set according to values of defaultBarType, barAlways, barNonAuto and measurePosition.

Valid values are described in (lilypond-internals)bar-line-interface.

.

Please send GNU LilyPond questions and comments to lilypond-user@gnu.org.

Please send comments on these web pages to lilypond@packages.debian.org

Copyright (c) 1997--2001 Han-Wen Nienhuys and Jan Nieuwenhuizen.

Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.