Tunable context properties

aDueText (string)

Text to print at a unisono passage.

alignBassFigureAccidentals (boolean)

If true, then the accidentals are aligned in bass figure context.

allowBeamBreak (boolean)

If true allow line breaks for beams over bar lines.

associatedVoice (string)

Name of the Voice that has the melody for this Lyrics line.

autoAccidentals (list)

List of different ways to typeset an accidental.

For determining when to print an accidental, several different rules are tried. The rule that gives the highest number of accidentals is used. Each rule consists of

context:

In which context is the rule applied. For example, if context is Score then all staves share accidentals, and if context is Staff then all voices in the same staff share accidentals, but staves do not.

octavation:

Whether the accidental changes all octaves or only the current octave. Valid choices are

same-octave:

This is the default algorithm. Accidentals are typeset if the note changes the accidental of that note in that octave. Accidentals lasts to the end of the measure and then as many measures as specified in the value. I.e. 1 means to the end of next measure, -1 means to the end of previous measure (that is: no duration at all), etc. #t means forever.

any-octave:

Accidentals are typeset if the note is different from the previous note on the same pitch in any octave. The value has same meaning as in same-octave.

laziness

Over how many bar lines the accidental lasts. If laziness is -1 then the accidental is forget immediately, and if laziness is #t then the accidental lasts forever.

autoBeamSettings (list)

Specifies when automatically generated beams should begin and end. See Setting automatic beam behavior for more information.

autoBeaming (boolean)

If set to true then beams are generated automatically.

autoCautionaries (list)

List similar to autoAccidentals, but it controls cautionary accidentals rather than normal ones. Both lists are tried, and the one giving the most accidentals wins. In case of draw, a normal accidental is typeset.

automaticBars (boolean)

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

barAlways (boolean)

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

barCheckSynchronize (boolean)

If true then reset measurePosition when finding a barcheck.

barNumberVisibility (procedure)

Procedure that takes an int and returns whether the corresponding bar number should be printed

bassFigureFormatFunction (procedure)

Procedure that is called to produce the formatting for a BassFigure grob. It takes a list of BassFigureEvents, a context, and the grob to format.

beatGrouping (list)

List of beatgroups, e.g., in 5/8 time '(2 3).

beatLength (moment)

The length of one beat in this time signature.

chordChanges (boolean)

Only show changes in chords scheme?

chordNameExceptions (list)

Alist of chord exceptions. Contains (chord . markup) entries.

chordNameExceptionsFull (list)

Alist of chord exceptions. Contains (chord . markup) entries.

chordNameExceptionsPartial (list)

Alist of partial chord exceptions. Contains (chord . (prefix-markup suffix-markup)) entries.

chordNameFunction (procedure)

The function that converts lists of pitches to chord names.

chordNameSeparator (markup)

The markup object used to separate parts of a chord name.

chordNoteNamer (procedure)

Function that converts from a pitch object to a text markup. Used for single pitches.

chordRootNamer (procedure)

Function that converts from a pitch object to a text markup. Used for chords.

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 clef symbol go, measured in half staff spaces from the center of the staff.

connectArpeggios (boolean)

If set, connect arpeggios across piano staff.

createKeyOnClefChange (boolean)

Print a key signature whenever the clef is changed.

createSpacing (boolean)

Create StaffSpacing objects? Should be set for staves.

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)

Text to print at start of non-hairpin crescendo, i.e.: cresc.

currentBarNumber (integer)

Contains the current barnumber. This property is incremented at every bar line.

decrescendoSpanner (symbol)

See crescendoSpanner.

decrescendoText (markup)

Text to print at start of non-hairpin decrescendo, i.e.: dim.

defaultBarType (string)

Sets the default type of bar line. See whichBar for information on available bar types.

This variable is read by Timing_engraver at Score level.

drumPitchTable (hash table)

A table mapping percussion instruments (symbols) to pitches.

drumStyleTable (hash table)

A hash table containing mapping drums to layout settings. Predefined values: drums-style, timbales-style, congas-style, bongos-style and percussion-style.

The layout style is a hash table, containing the drum-pitches (e.g. the symbol hihat) as key, and a list (notehead-style script vertical-position) as values.

explicitClefVisibility (procedure)

break-visibility function for clef changes.

explicitKeySignatureVisibility (procedure)

break-visibility function for explicit key changes. \override of #'break-visibility will set the visibility for normal (i.e. at the start of the line) key signatures.

extraNatural (boolean)

Whether to typeset an extra natural sign before accidentals changing from a non-natural to another non-natural.

extraVerticalExtent (pair of numbers)

extra vertical extent, same format as minimumVerticalExtent

fingeringOrientations (list)

List of symbols, containing left, right, up and/or down. This list determines where fingerings are put relative to the chord being fingered.

followVoice (boolean)

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

fontSize (number)

The relative size of all grobs in a context.

forceClef (boolean)

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

harmonicAccidentals (boolean)

If set, harmonic notes in chords get accidentals.

highStringOne (boolean)

Whether the 1st string is the string with highest pitch on the instrument. This used by the automatic string selector for tab notation.

ignoreMelismata (boolean)

Ignore melismata for this Lyrics line.

instr (markup)

See instrument

instrument (markup)

The name to print left of a staff. The instrument property labels the staff in the first system, and the instr property labels following lines.

instrumentEqualizer (procedure)

Function taking a string (instrument name), and returning a (min . max) pair of numbers for the loudness range of the instrument.

instrumentTransposition (pitch)

Define the transposition of the instrument. This is used to transpose the MIDI output, and \quotes.

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). where name is from 0.. 6 and alter from -4 (double flat) to 4 (double sharp).

majorSevenSymbol (markup)

How should the major 7th be formatted in a chord name?

markFormatter (procedure)

Procedure taking as arguments context and rehearsal mark. It should return the formatted mark as a markup object.

measureLength (moment)

Length of one measure in the current time signature.

measurePosition (moment)

How much of the current measure have we had. This can be set manually to create incomplete measures.

melismaBusyProperties (list)

List of properties (symbols) to determine whether a melisma is playing. Setting this property will influence how lyrics are aligned to notes. For example, if set to #'(melismaBusy beamMelismaBusy), only manual melismata and manual beams are considered. Possible values include melismaBusy, slurMelismaBusy, tieMelismaBusy, and beamMelismaBusy

metronomeMarkFormatter (procedure)

How to produce a metronome markup. Called with 2 arguments, event and context.

middleCPosition (number)

Place of the middle C, measured in half staffspaces. Usually determined by looking at clefPosition and clefGlyph.

midiInstrument (string)

Name of the MIDI instrument to use

midiMaximumVolume (number)

Analogous to midiMinimumVolume.

midiMinimumVolume (number)

Sets the minimum loudness for MIDI. Ranges from 0 to 1.

minimumFret (number)

The tablature auto string-selecting mechanism selects the highest string with a fret at least minimumFret

minimumVerticalExtent (pair of numbers)

minimum vertical extent, same format as verticalExtent

ottavation (string)

If set, the text for an ottava spanner. Changing this creates a new text spanner.

pedalSostenutoStrings (list)

See pedalSustainStrings.

pedalSostenutoStyle (symbol)

see pedalSustainStyle.

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.

pedalSustainStyle (symbol)

A symbol that indicates how to print sustain pedals: text, bracket or mixed (both).

pedalUnaCordaStrings (list)

See pedalSustainStrings.

pedalUnaCordaStyle (symbol)

see pedalSustainStyle.

printKeyCancellation (boolean)

Print restoration alterations before a key signature change.

printOctaveNames (boolean)

Print octave marks for the NoteNames context.

recordEventSequence (procedure)

When Recording_group_engraver is in this context, then upon termination of the context, this function is called with current context and a list of music objects. The list of contains entries with start times, music objects and whether they are processed in this context.

rehearsalMark (integer)

The last rehearsal mark printed.

repeatCommands (list)

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

restNumberThreshold (number)

If a multimeasure rest takes less than this number of measures, no number is printed.

skipBars (boolean)

If set to true, then 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, speeding up the interpretation phase. This speeds up debugging large scores.

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.

squashedPosition (integer)

Vertical position of squashing for Pitch_squash_engraver.

stanza (markup)

Stanza `number' to print before the start of a verse. Use in Lyrics 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)

See stemLeftBeamCount.

stringOneTopmost (boolean)

Whether the 1st string is printed on the top line of the tablature.

stringTunings (list)

The tablature strings tuning. It is a list of the pitch (in semitones) of each string (starting with the lower one).

subdivideBeams (boolean)

If set, multiple beams will be subdivided at beat positions by only drawing one beam over the beat.

systemStartDelimiter (symbol)

Which grob to make for the start of the system/staff? Set to SystemStartBrace, SystemStartBracket or SystemStartBar.

tablatureFormat (procedure)

Function formatting a tab note head; it takes a string number, a list of string tunings and Pitch object. It returns the text as a string.

timeSignatureFraction (pair of numbers)

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

timing (boolean)

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

tonic (pitch)

The tonic of the current scale

tremoloFlags (integer)

Number of tremolo flags to add if no number is specified.

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 \times expression that gave rise to it. By setting this property, you can make brackets last shorter. Example

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

.

verticalAlignmentChildCallback (procedure)

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

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.

          \set Staff.verticalExtent = #'(-5.0 . 5.0)
          

This does not work for Voice or any other context that doesn't form a vertical group.

vocNam (markup)

Name of a vocal line, short version.

vocalName (markup)

Name of a vocal line.

voltaOnThisStaff (boolean)

Normally, volta brackets are put only on the topmost staff. Setting this variable will create a bracket on this staff as well.

voltaSpannerDuration (moment)

This specifies the maximum duration to use for the brackets printed for \alternative. This can be used to shrink the length of brackets in the situation where one alternative is very large.

whichBar (string)

This property is read to determine what type of bar line to create.

Example:

          \set Staff.whichBar = "|:"
          

This will create a start-repeat bar in this staff only. Valid values are described in bar-line-interface.

Read comments on this page, or add one. This page is for LilyPond-2.2.0 (stable-branch). Report errors to <bug-lilypond@gnu.org>.