Creates a dynamic mark.
Syntax: note\x
,
where x is one of \ppp, \pp, \p, \mp, \mf, \f, \ff, \fff.
Music types: general-music, event, dynamic-event and absolute-dynamic-event
Accepted by: Dynamic_engraver, Dynamic_performer, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'AbsoluteDynamicEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event dynamic-event absolute-dynamic-event)
The types of this music object; determines by what engraver this music expression is processed.
Call the argument with the current context during interpreting phase
Music types: general-music and apply-context
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'ApplyContext
Name of this music object
internal-class-name
(string):Music
C++ class to use for this Music object
types
(list):'(general-music apply-context)
The types of this music
object; determines by what engraver this music expression is
processed.
iterator-ctor
(procedure):Apply_context_iterator::constructor
Function to construct music-event-iterator object for this Music
Call the argument with all current grobs during interpreting phase.
Syntax
\applyoutput FUNC
arguments to func are 1. the grob, 2. the originating context, 3. context where FUNC is called.
Music types: general-music and layout-instruction
Accepted by: Output_property_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'ApplyOutputEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
iterator-ctor
(procedure):Output_property_music_iterator::constructor
Function to construct music-event-iterator object for this Music
types
(list):'(general-music layout-instruction)
The types of this music object; determines by what engraver this music expression is processed.
Make an arpeggio on this note.
Syntax:
note-\arpeggio
Music types: general-music, arpeggio-event and event
Accepted by: Arpeggio_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'ArpeggioEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music arpeggio-event event)
The types of this music object; determines by what engraver this music expression is processed.
Adds an articulation marking to a note.
Syntax:
noteX
Y
, where X is a direction (up ^
, down
_
, or LilyPond's choice (no direction specified)), and where Y
is an articulation (such as -.
, ->
, \tenuto
,
\downbow
). See the user manual for details.
Music types: general-music, event, articulation-event and script-event
Accepted by: Script_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'ArticulationEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event articulation-event script-event)
The types of this music object; determines by what engraver this music expression is processed.
Used for making voices that switch between piano staves automatically.
Music types: general-music, music-wrapper-music and auto-change-instruction
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'AutoChangeMusic
Name of this music object
internal-class-name
(string):Music_wrapper
C++ class to use for this Music object
iterator-ctor
(procedure):Auto_change_iterator::constructor
Function to construct music-event-iterator object for this Music
types
(list):'(general-music music-wrapper-music auto-change-instruction)
The types of this music object; determines by what engraver this music expression is processed.
Check whether this music coincides with the start of the measure.
Music types: general-music and bar-check
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'BarCheck
Name of this music object
internal-class-name
(string):Music
C++ class to use for this Music object
types
(list):'(general-music bar-check)
The types of this music
object; determines by what engraver this music expression is
processed.
iterator-ctor
(procedure):Bar_check_iterator::constructor
Function to construct music-event-iterator object for this Music
Print a bass-figure text
Music types: general-music, event, rhythmic-event and bass-figure-event
Accepted by: Figured_bass_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'BassFigureEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event rhythmic-event bass-figure-event)
The types of this music object; determines by what engraver this music expression is processed.
Starts or stops a beam.
Syntax for manual control: c8-[ c c-] c8
Music types: general-music, event, beam-event and span-event
Accepted by: Beam_engraver, Beam_performer, Grace_beam_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'BeamEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event beam-event span-event)
The types of this music object; determines by what engraver this music expression is processed.
Specify that a note may not auto-beamed
Music types: general-music, event and beam-forbid-event
Accepted by: Auto_beam_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'BeamForbidEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event beam-forbid-event)
The types of this music object; determines by what engraver this music expression is processed.
Creates a line break.
Syntax: \break.
Music types: general-music, break-event and event
Accepted by: Score_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'BreakEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music break-event event)
The types of this music object; determines by what engraver this music expression is processed.
Creates a `breath mark' or `comma'.
Syntax: note\breathe.
Music types: general-music, event and breathing-event
Accepted by: Breathing_sign_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'BreathingSignEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event breathing-event)
The types of this music object; determines by what engraver this music expression is processed.
Used internally to signal beginning and ending of notes.
Music types: general-music, event and busy-playing-event
Accepted by: Completion_heads_engraver, Drum_note_performer, Drum_notes_engraver, Note_heads_engraver, Note_performer, Swallow_engraver, Swallow_performer and Tab_note_heads_engraver
Properties:
name
(symbol):'BusyPlayingEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event busy-playing-event)
The types of this music object; determines by what engraver this music expression is processed.
A note that is part of a cluster.
Music types: general-music, cluster-note-event, melodic-event, rhythmic-event and event
Accepted by: Cluster_spanner_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'ClusterNoteEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music cluster-note-event melodic-event rhythmic-event event)
The types of this music object; determines by what engraver this music expression is processed.
Change staffs in Piano staff.
Syntax \translator Staff =
new-id.
Music types: general-music and translator-change-instruction
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'ContextChange
Name of this music object
internal-class-name
(string):Music
C++ class to use for this Music object
iterator-ctor
(procedure):Change_iterator::constructor
Function to construct music-event-iterator object for this Music
types
(list):'(general-music translator-change-instruction)
The types of this music object; determines by what engraver this music expression is processed.
Interpret the argument music within a specific context.
Music types: context-specification, general-music and music-wrapper-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'ContextSpeccedMusic
Name of this music object
iterator-ctor
(procedure):Context_specced_music_iterator::constructor
Function to construct music-event-iterator object for this Music
internal-class-name
(string):Music_wrapper
C++ class to use for this Music object
types
(list):'(context-specification general-music music-wrapper-music)
The types of this music object; determines by what engraver this music expression is processed.
Begins or ends a crescendo.
Syntax: note\cr ... note\rc (you can also use \<, \!, \cresc, and \endcresc. See the user manual for details.).
Music types: general-music, dynamic-event, crescendo-event and event
Accepted by: Dynamic_engraver, Span_dynamic_performer, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'CrescendoEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music dynamic-event crescendo-event event)
The types of this music object; determines by what engraver this music expression is processed.
See CrescendoEvent.
Music types: general-music, dynamic-event, decrescendo-event and event
Accepted by: Dynamic_engraver, Span_dynamic_performer, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'DecrescendoEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music dynamic-event decrescendo-event event)
The types of this music object; determines by what engraver this music expression is processed.
Atomic music event.
Music types: general-music and event
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'Event
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event)
The types of this music object; determines by what engraver this music expression is processed.
Internally used to group a set of events.
Music types: general-music, event-chord and simultaneous-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'EventChord
Name of this music object
internal-class-name
(string):Event_chord
C++ class to use for this Music object
iterator-ctor
(procedure):Event_chord_iterator::constructor
Function to construct music-event-iterator object for this Music
types
(list):'(general-music event-chord simultaneous-music)
The types of this music object; determines by what engraver this music expression is processed.
Extend lyrics.
Music types: general-music, extender-event and event
Accepted by: Extender_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'ExtenderEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music extender-event event)
The types of this music object; determines by what engraver this music expression is processed.
Specify what finger to use for this note.
Music types: general-music, fingering-event and event
Accepted by: Fingering_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'FingerEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music fingering-event event)
The types of this music object; determines by what engraver this music expression is processed.
Repeats with alternatives placed in parallel.
Music types: general-music, repeated-music and folded-repeated-music
Accepted by: Chord_tremolo_engraver, Percent_repeat_engraver, Slash_repeat_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'FoldedRepeatedMusic
Name of this music object
internal-class-name
(string):Repeated_music
C++ class to use for this Music object
iterator-ctor
(procedure):Folded_repeat_iterator::constructor
Function to construct music-event-iterator object for this Music
start-moment-function
(procedure):Repeated_music::minimum_start
Function to compute the negative length of
starting grace notes.
length
(procedure):Repeated_music::folded_music_length
How to compute the duration of this music
types
(list):'(general-music repeated-music folded-repeated-music)
The types of this music object; determines by what engraver this music expression is processed.
Start a glissando on this note.
Music types: general-music, glissando-event and event
Accepted by: Glissando_engraver, Note_head_line_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'GlissandoEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music glissando-event event)
The types of this music object; determines by what engraver this music expression is processed.
Interpret the argument as grace notes.
Music types: grace-music, music-wrapper-music and general-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'GraceMusic
Name of this music object
internal-class-name
(string):Grace_music
C++ class to use for this Music object
iterator-ctor
(procedure):Grace_iterator::constructor
Function to construct music-event-iterator object for this Music
types
(list):'(grace-music music-wrapper-music general-music)
The types of this music object; determines by what engraver this music expression is processed.
Mark a note as harmonic
Music types: general-music, event and harmonic-event
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'HarmonicEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event harmonic-event)
The types of this music object; determines by what engraver this music expression is processed.
A hyphen between lyric syllables.
Music types: general-music, hyphen-event and event
Accepted by: Hyphen_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'HyphenEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music hyphen-event event)
The types of this music object; determines by what engraver this music expression is processed.
Change the key signature.
Syntax: \key
name scale.
Music types: general-music, key-change-event and event
Accepted by: Key_engraver, Key_performer, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'KeyChangeEvent
Name of this music object
internal-class-name
(string):Key_change_ev
C++ class to use for this Music object
types
(list):'(general-music key-change-event event)
The types of this music object; determines by what engraver this music expression is processed.
(docme).
Music types: general-music, span-event, ligature-event and event
Accepted by: Coherent_ligature_engraver, Gregorian_ligature_engraver, Ligature_bracket_engraver, Ligature_engraver, Mensural_ligature_engraver, Swallow_engraver, Swallow_performer and Vaticana_ligature_engraver
Properties:
name
(symbol):'LigatureEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
span-type
(string):'ligature
What kind of spanner should be created?
TODO: consider making type into symbol
types
(list):'(general-music span-event ligature-event event)
The types of this music object; determines by what engraver this music expression is processed.
Align lyrics to the start of notes.
Syntax \addlyrics music lyrics.
Music types: general-music and lyric-combine-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'LyricCombineMusic
Name of this music object
internal-class-name
(string):Lyric_combine_music
C++ class to use for this Music object
types
(list):'(general-music lyric-combine-music)
The types of this music
object; determines by what engraver this music expression is
processed.
iterator-ctor
(procedure):Lyric_combine_music_iterator::constructor
Function to construct music-event-iterator object for this Music
A lyric syllable. Must be entered in lyrics mode, i.e.
\lyrics { twinkle4 twinkle4 }
.
Music types: general-music, rhythmic-event, lyric-event and event
Accepted by: Lyric_engraver, Lyric_performer, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'LyricEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music rhythmic-event lyric-event event)
The types of this music object; determines by what engraver this music expression is processed.
Start or stop a melisma.
Syntax:c4\melisma d\melismaEnd
.
Music types: general-music, melisma-span-event and event
Accepted by: Melisma_translator, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'ManualMelismaEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music melisma-span-event event)
The types of this music object; determines by what engraver this music expression is processed.
Insert a rehearsal mark.
Syntax: \mark
marker,
e.g. \mark "A"
.
Music types: general-music, mark-event and event
Accepted by: Mark_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'MarkEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music mark-event event)
The types of this music object; determines by what engraver this music expression is processed.
Used internally to signal melismas.
Music types: general-music, melisma-playing-event and event
Accepted by: Melisma_translator, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'MelismaPlayingEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music melisma-playing-event event)
The types of this music object; determines by what engraver this music expression is processed.
Change tempo setting (in beats per minute).
Music types: general-music, metronome-change-event, tempo-event and event
Accepted by: Metronome_mark_engraver, Swallow_engraver, Swallow_performer and Tempo_performer
Properties:
name
(symbol):'MetronomeChangeEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music metronome-change-event tempo-event event)
The types of this music object; determines by what engraver this music expression is processed.
Rests that may be compressed into Multi rests.
Syntax
R2.*4
for 4 measures in 3/4 time. Note the capital R.
Music types: general-music, event, rhythmic-event and multi-measure-rest-event
Accepted by: Multi_measure_rest_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'MultiMeasureRestEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event rhythmic-event multi-measure-rest-event)
The types of this music object; determines by what engraver this music expression is processed.
Like sequential-music, but specifically intended to group start-mmrest, skip, stop-mmrest sequence.
Syntax R2.*5
for 5 measures in 3/4 time.
Music types: general-music and sequential-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'MultiMeasureRestMusicGroup
Name of this music object
internal-class-name
(string):Sequential_music
C++ class to use for this Music object
iterator-ctor
(procedure):Sequential_music_iterator::constructor
Function to construct music-event-iterator object for this Music
types
(list):'(general-music sequential-music)
The types of this music object; determines by what engraver this music expression is processed.
Texts on mm rests.
Syntax
R-\markup { \roman "bla" }
. Note the explicit font switch.
Music types: general-music, event and multi-measure-text-event
Accepted by: Multi_measure_rest_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'MultiMeasureTextEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event multi-measure-text-event)
The types of this music object; determines by what engraver this music expression is processed.
Generic type for music expressions.
Music types: general-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'Music
Name of this music object
internal-class-name
(string):Music
C++ class to use for this Music object
types
(list):'(general-music)
The types of this music object; determines by what engraver this music expression is processed.
Align lyrics to the start of notes.
Syntax \addlyrics music lyrics.
Music types: general-music and lyric-combine-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'NewLyricCombineMusic
Name of this music object
internal-class-name
(string):Music
C++ class to use for this Music object
length
(procedure):'#<Mom 0>
How to compute the duration of this music
types
(list):'(general-music lyric-combine-music)
The types of this music
object; determines by what engraver this music expression is
processed.
iterator-ctor
(procedure):New_lyric_combine_music_iterator::constructor
Function to construct music-event-iterator object for this Music
A note.
Music types: general-music, event, note-event, rhythmic-event and melodic-event
Accepted by: Chord_name_engraver, Completion_heads_engraver, Drum_note_performer, Drum_notes_engraver, Note_heads_engraver, Note_name_engraver, Note_performer, Note_swallow_translator, Swallow_engraver, Swallow_performer and Tab_note_heads_engraver
Properties:
name
(symbol):'NoteEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event note-event rhythmic-event melodic-event)
The types of this music object; determines by what engraver this music expression is processed.
Start or stop grouping brackets.
Music types: general-music, event and note-grouping-event
Accepted by: Horizontal_bracket_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'NoteGroupingEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event note-grouping-event)
The types of this music object; determines by what engraver this music expression is processed.
Set grob properties in objects individually.
Syntax \outputproperty
predicate prop
=
val.
Music types: general-music and layout-instruction
Accepted by: Output_property_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'OutputPropertySetMusic
Name of this music object
internal-class-name
(string):Music
C++ class to use for this Music object
iterator-ctor
(procedure):Output_property_music_iterator::constructor
Function to construct music-event-iterator object for this Music
types
(list):'(general-music layout-instruction)
The types of this music object; determines by what engraver this music expression is processed.
Extend the definition of a graphical object.
SYNTAX
\propery Foo.Bar \override
SYMBOL = VALUE
Music types: general-music and layout-instruction
Accepted by: Output_property_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'OverrideProperty
Name of this music object
internal-class-name
(string):Music
C++ class to use for this Music object
types
(list):'(general-music layout-instruction)
The types of this music
object; determines by what engraver this music expression is
processed.
iterator-ctor
(procedure):Push_property_iterator::constructor
Function to construct music-event-iterator object for this Music
Combine two parts on a staff, either merged or as separate voices.
Music types: general-music and part-combine-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'PartCombineMusic
Name of this music object
internal-class-name
(string):Simultaneous_music
C++ class to use for this Music object
types
(list):'(general-music part-combine-music)
The types of this music
object; determines by what engraver this music expression is
processed.
iterator-ctor
(procedure):Part_combine_iterator::constructor
Function to construct music-event-iterator object for this Music
Repeats encoded by percents.
Music types: general-music, repeated-music and percent-repeated-music
Accepted by: Chord_tremolo_engraver, Percent_repeat_engraver, Slash_repeat_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'PercentRepeatedMusic
Name of this music object
internal-class-name
(string):Repeated_music
C++ class to use for this Music object
iterator-ctor
(procedure):Percent_repeat_iterator::constructor
Function to construct music-event-iterator object for this Music
start-moment-function
(procedure):Repeated_music::first_start
Function to compute the negative length of
starting grace notes.
length
(procedure):Repeated_music::unfolded_music_length
How to compute the duration of this music
types
(list):'(general-music repeated-music percent-repeated-music)
The types of this music object; determines by what engraver this music expression is processed.
Within a ligature, mark the previous and the following note to form a pes (if melody goes up) or a flexa (if melody goes down).
Music types: general-music, pes-or-flexa-event and event
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'PesOrFlexaEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music pes-or-flexa-event event)
The types of this music object; determines by what engraver this music expression is processed.
Start or end phrasing slur.
Syntax NOTE \( and \) NOTE
Music types: general-music, span-event and phrasing-slur-event
Accepted by: Phrasing_slur_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'PhrasingSlurEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music span-event phrasing-slur-event)
The types of this music object; determines by what engraver this music expression is processed.
Set a context property.
Syntax: \property
context.
prop =
scheme-val.
Music types: layout-instruction and general-music
Accepted by: Output_property_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'PropertySet
Name of this music object
internal-class-name
(string):Music
C++ class to use for this Music object
types
(list):'(layout-instruction general-music)
The types of this music
object; determines by what engraver this music expression is
processed.
iterator-ctor
(procedure):Property_iterator::constructor
Function to construct music-event-iterator object for this Music
Remove the definition of a context \property
.
Music types: layout-instruction and general-music
Accepted by: Output_property_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'PropertyUnset
Name of this music object
internal-class-name
(string):Music
C++ class to use for this Music object
types
(list):'(layout-instruction general-music)
The types of this music
object; determines by what engraver this music expression is
processed.
iterator-ctor
(procedure):Property_unset_iterator::constructor
Function to construct music-event-iterator object for this Music
Quote preprocessed snippets of music.
Music types: general-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'QuoteMusic
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
iterator-ctor
(procedure):Quote_iterator::constructor
Function to construct music-event-iterator object for this Music
types
(list):'(general-music)
The types of this music object; determines by what engraver this music expression is processed.
Check if a pitch is in the correct octave.
Music types: general-music and relative-octave-check
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'RelativeOctaveCheck
Name of this music object
internal-class-name
(string):Relative_octave_check
C++ class to use for this Music object
types
(list):'(general-music relative-octave-check)
The types of this music object; determines by what engraver this music expression is processed.
Music that was entered in relative octave notation.
Music types: music-wrapper-music, general-music and relative-octave-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'RelativeOctaveMusic
Name of this music object
internal-class-name
(string):Relative_octave_music
C++ class to use for this Music object
types
(list):'(music-wrapper-music general-music relative-octave-music)
The types of this music object; determines by what engraver this music expression is processed.
Repeat music in different ways
Music types: general-music and repeated-music
Accepted by: Chord_tremolo_engraver, Percent_repeat_engraver, Slash_repeat_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'RepeatedMusic
Name of this music object
type
(symbol):'repeated-music
The type of this music object. Determines iteration in some cases.
types
(list):'(general-music repeated-music)
The types of this music object; determines by what engraver this music expression is processed.
A Rest.
Syntax r4
for a quarter rest.
Music types: general-music, event, rhythmic-event and rest-event
Accepted by: Figured_bass_engraver, Rest_engraver, Rest_swallow_translator, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'RestEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event rhythmic-event rest-event)
The types of this music object; determines by what engraver this music expression is processed.
The opposite of OverrideProperty: remove a previously added property from a graphical object definition
Music types: general-music and layout-instruction
Accepted by: Output_property_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'RevertProperty
Name of this music object
internal-class-name
(string):Music
C++ class to use for this Music object
types
(list):'(general-music layout-instruction)
The types of this music
object; determines by what engraver this music expression is
processed.
iterator-ctor
(procedure):Pop_property_iterator::constructor
Function to construct music-event-iterator object for this Music
Add an articulation mark to a note.
Music types: general-music and event
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'ScriptEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event)
The types of this music object; determines by what engraver this music expression is processed.
Music expressions concatenated.
Syntax \sequential {..} or simply {..} .
Music types: general-music and sequential-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'SequentialMusic
Name of this music object
internal-class-name
(string):Sequential_music
C++ class to use for this Music object
iterator-ctor
(procedure):Sequential_music_iterator::constructor
Function to construct music-event-iterator object for this Music
types
(list):'(general-music sequential-music)
The types of this music object; determines by what engraver this music expression is processed.
Music playing together.
SYNTAX
\simultaneous { .. }
or < .. >.
Music types: general-music and simultaneous-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'SimultaneousMusic
Name of this music object
internal-class-name
(string):Simultaneous_music
C++ class to use for this Music object
iterator-ctor
(procedure):Simultaneous_music_iterator::constructor
Function to construct music-event-iterator object for this Music
types
(list):'(general-music simultaneous-music)
The types of this music object; determines by what engraver this music expression is processed.
Filler that takes up duration, but does not print anything.
Syntax: s
duration
Music types: general-music, event, rhythmic-event and skip-event
Accepted by: Skip_event_swallow_translator, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'SkipEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event rhythmic-event skip-event)
The types of this music object; determines by what engraver this music expression is processed.
Filler that takes up duration, does not print anything, and also does not create staffs or voices implicitly.
Syntax: \skip
duration.
Music types: general-music, event, rhythmic-event and skip-event
Accepted by: Skip_event_swallow_translator, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'SkipMusic
Name of this music object
internal-class-name
(string):Music
C++ class to use for this Music object
length
(procedure):ly:music-duration-length
How to compute the duration of this music
iterator-ctor
(procedure):Simple_music_iterator::constructor
Function to construct music-event-iterator object for this Music
types
(list):'(general-music event rhythmic-event skip-event)
The types of this music object; determines by what engraver this music expression is processed.
Start or end slur.
Syntax NOTE( and )NOTE
Music types: general-music, span-event and slur-event
Accepted by: Slur_engraver, Slur_performer, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'SlurEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music span-event slur-event)
The types of this music object; determines by what engraver this music expression is processed.
Print Solo.1
Music types: general-music, event and part-combine-event
Accepted by: Part_combine_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'SoloOneEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
part-combine-status
(symbol):'solo1
Change to what kind of state? Options are
solo1, solo2 and unisono
types
(list):'(general-music event part-combine-event)
The types of this music object; determines by what engraver this music expression is processed.
Print Solo.2
Music types: general-music, event and part-combine-event
Accepted by: Part_combine_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'SoloTwoEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
part-combine-status
(symbol):'solo2
Change to what kind of state? Options are
solo1, solo2 and unisono
types
(list):'(general-music event part-combine-event)
The types of this music object; determines by what engraver this music expression is processed.
Depress or release sostenuto pedal.
Music types: general-music, pedal-event and sostenuto-pedal-event
Accepted by: Piano_pedal_engraver, Piano_pedal_performer, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'SostenutoEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music pedal-event sostenuto-pedal-event)
The types of this music object; determines by what engraver this music expression is processed.
Event for anything that is started at a different time than stopped.
Music types: general-music and event
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'SpanEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event)
The types of this music object; determines by what engraver this music expression is processed.
Used internally to signal beginning of notes.
Music types: general-music, event and start-playing-event
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'StartPlayingEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event start-playing-event)
The types of this music object; determines by what engraver this music expression is processed.
Specify on which string to play this note.
Syntax: \
number.
Music types: general-music, string-number-event and event
Accepted by: String_number_engraver, Swallow_engraver, Swallow_performer and Tab_note_heads_engraver
Properties:
name
(symbol):'StringNumberEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music string-number-event event)
The types of this music object; determines by what engraver this music expression is processed.
Depress or release sustain pedal.
Music types: general-music, pedal-event and sustain-pedal-event
Accepted by: Piano_pedal_engraver, Piano_pedal_performer, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'SustainEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music pedal-event sustain-pedal-event)
The types of this music object; determines by what engraver this music expression is processed.
Music types: general-music, script-event, text-script-event and event
Accepted by: Script_engraver, Swallow_engraver, Swallow_performer and Text_engraver
Properties:
name
(symbol):'TextScriptEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music script-event text-script-event event)
The types of this music object; determines by what engraver this music expression is processed.
Start a text spanner like 8va.....|
Music types: general-music, span-event and text-span-event
Accepted by: Swallow_engraver, Swallow_performer and Text_spanner_engraver
Properties:
name
(symbol):'TextSpanEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music span-event text-span-event)
The types of this music object; determines by what engraver this music expression is processed.
A tie. Entered as note-~.
Music types: general-music, tie-event and event
Accepted by: Swallow_engraver, Swallow_performer, Tie_engraver and Tie_performer
Properties:
name
(symbol):'TieEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music tie-event event)
The types of this music object; determines by what engraver this music expression is processed.
Multiply durations, as in tuplets.
Syntax \times
fraction music, e.g.
\times 2/3 { ... }
for triplets.
Music types: time-scaled-music, music-wrapper-music and general-music
Accepted by: Swallow_engraver, Swallow_performer and Tuplet_engraver
Properties:
name
(symbol):'TimeScaledMusic
Name of this music object
internal-class-name
(string):Time_scaled_music
C++ class to use for this Music object
iterator-ctor
(procedure):Time_scaled_music_iterator::constructor
Function to construct music-event-iterator object for this Music
types
(list):'(time-scaled-music music-wrapper-music general-music)
The types of this music object; determines by what engraver this music expression is processed.
Music that has been transposed.
Music types: music-wrapper-music, general-music and transposed-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'TransposedMusic
Name of this music object
internal-class-name
(string):Transposed_music
C++ class to use for this Music object
types
(list):'(music-wrapper-music general-music transposed-music)
The types of this music object; determines by what engraver this music expression is processed.
Un measured tremolo.
Music types: general-music, event and tremolo-event
Accepted by: Stem_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'TremoloEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music event tremolo-event)
The types of this music object; determines by what engraver this music expression is processed.
Repeated notes denoted by tremolo beams.
Music types: general-music, repeated-music and tremolo-repeated-music
Accepted by: Chord_tremolo_engraver, Percent_repeat_engraver, Slash_repeat_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'TremoloRepeatedMusic
Name of this music object
iterator-ctor
(procedure):Chord_tremolo_iterator::constructor
Function to construct music-event-iterator object for this Music
internal-class-name
(string):Repeated_music
C++ class to use for this Music object
start-moment-function
(procedure):Repeated_music::first_start
Function to compute the negative length of
starting grace notes.
length
(procedure):Repeated_music::folded_music_length
How to compute the duration of this music
types
(list):'(general-music repeated-music tremolo-repeated-music)
The types of this music object; determines by what engraver this music expression is processed.
Depress or release una-corda pedal.
Music types: general-music, pedal-event and una-corda-pedal-event
Accepted by: Piano_pedal_engraver, Piano_pedal_performer, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'UnaCordaEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
types
(list):'(general-music pedal-event una-corda-pedal-event)
The types of this music object; determines by what engraver this music expression is processed.
Music types: general-music, repeated-music and unfolded-repeated-music
Accepted by: Chord_tremolo_engraver, Percent_repeat_engraver, Slash_repeat_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'UnfoldedRepeatedMusic
Name of this music object
iterator-ctor
(procedure):Unfolded_repeat_iterator::constructor
Function to construct music-event-iterator object for this Music
start-moment-function
(procedure):Repeated_music::first_start
Function to compute the negative length of
starting grace notes.
internal-class-name
(string):Repeated_music
C++ class to use for this Music object
types
(list):'(general-music repeated-music unfolded-repeated-music)
The types of this music
object; determines by what engraver this music expression is
processed.
length
(procedure):Repeated_music::unfolded_music_length
How to compute the duration of this music
Print a2
Music types: general-music, event and part-combine-event
Accepted by: Part_combine_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'UnisonoEvent
Name of this music object
internal-class-name
(string):Event
C++ class to use for this Music object
part-combine-status
(symbol):'unisono
Change to what kind of state? Options are
solo1, solo2 and unisono
types
(list):'(general-music event part-combine-event)
The types of this music object; determines by what engraver this music expression is processed.
Music that can not be converted from relative to absolute notation. For example, transposed music.
Music types: music-wrapper-music, general-music and unrelativable-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'UnrelativableMusic
Name of this music object
internal-class-name
(string):Un_relativable_music
C++ class to use for this Music object
types
(list):'(music-wrapper-music general-music unrelativable-music)
The types of this music object; determines by what engraver this music expression is processed.
Music that can not be transposed.
Music types: music-wrapper-music, general-music and untransposable-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'UntransposableMusic
Name of this music object
internal-class-name
(string):Untransposable_music
C++ class to use for this Music object
types
(list):'(music-wrapper-music general-music untransposable-music)
The types of this music object; determines by what engraver this music expression is processed.
Separate polyphonic voices in simultaneous music.
Syntax: \\
Music types: separator and general-music
Accepted by: Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'VoiceSeparator
Name of this music object
internal-class-name
(string):Music
C++ class to use for this Music object
types
(list):'(separator general-music)
The types of this music object; determines by what engraver this music expression is processed.
Music types: general-music, repeated-music and volta-repeated-music
Accepted by: Chord_tremolo_engraver, Percent_repeat_engraver, Slash_repeat_engraver, Swallow_engraver and Swallow_performer
Properties:
name
(symbol):'VoltaRepeatedMusic
Name of this music object
iterator-ctor
(procedure):Volta_repeat_iterator::constructor
Function to construct music-event-iterator object for this Music
internal-class-name
(string):Repeated_music
C++ class to use for this Music object
start-moment-function
(procedure):Repeated_music::first_start
Function to compute the negative length of
starting grace notes.
length
(procedure):Repeated_music::volta_music_length
How to compute the duration of this music
types
(list):'(general-music repeated-music volta-repeated-music)
The types of this music object; determines by what engraver this music expression is processed.
Music event type absolute-dynamic-event
is in Music objects of type AbsoluteDynamicEvent
Accepted by: Dynamic_engraver and Dynamic_performer
Music event type apply-context
is in Music objects of type ApplyContext
Accepted by: none
Music event type arpeggio-event
is in Music objects of type ArpeggioEvent
Accepted by: Arpeggio_engraver
Music event type articulation-event
is in Music objects of type ArticulationEvent
Accepted by: Script_engraver
Music event type auto-change-instruction
is in Music objects of type AutoChangeMusic
Accepted by: none
Music event type bar-check
is in Music objects of type BarCheck
Accepted by: none
Music event type bass-figure-event
is in Music objects of type BassFigureEvent
Accepted by: Figured_bass_engraver
Music event type beam-event
is in Music objects of type BeamEvent
Accepted by: Beam_engraver, Beam_performer and Grace_beam_engraver
Music event type beam-forbid-event
is in Music objects of type BeamForbidEvent
Accepted by: Auto_beam_engraver
Music event type break-event
is in Music objects of type BreakEvent
Accepted by: Score_engraver
Music event type breathing-event
is in Music objects of type BreathingSignEvent
Accepted by: Breathing_sign_engraver
Music event type busy-playing-event
is in Music objects of type BusyPlayingEvent
Accepted by: Completion_heads_engraver, Drum_note_performer, Drum_notes_engraver, Note_heads_engraver, Note_performer and Tab_note_heads_engraver
Music event type cluster-note-event
is in Music objects of type ClusterNoteEvent
Accepted by: Cluster_spanner_engraver
Music event type context-specification
is in Music objects of type ContextSpeccedMusic
Accepted by: none
Music event type crescendo-event
is in Music objects of type CrescendoEvent
Accepted by: Dynamic_engraver and Span_dynamic_performer
Music event type decrescendo-event
is in Music objects of type DecrescendoEvent
Accepted by: Dynamic_engraver and Span_dynamic_performer
Music event type dynamic-event
is in Music objects of type AbsoluteDynamicEvent, CrescendoEvent and DecrescendoEvent
Accepted by: none
Music event type event
is in Music objects of type AbsoluteDynamicEvent, ArpeggioEvent, ArticulationEvent, BassFigureEvent, BeamEvent, BeamForbidEvent, BreakEvent, BreathingSignEvent, BusyPlayingEvent, ClusterNoteEvent, CrescendoEvent, DecrescendoEvent, Event, ExtenderEvent, FingerEvent, GlissandoEvent, HarmonicEvent, HyphenEvent, KeyChangeEvent, LigatureEvent, LyricEvent, ManualMelismaEvent, MarkEvent, MelismaPlayingEvent, MetronomeChangeEvent, MultiMeasureRestEvent, MultiMeasureTextEvent, NoteEvent, NoteGroupingEvent, PesOrFlexaEvent, RestEvent, ScriptEvent, SkipEvent, SkipMusic, SoloOneEvent, SoloTwoEvent, SpanEvent, StartPlayingEvent, StringNumberEvent, TextScriptEvent, TieEvent, TremoloEvent and UnisonoEvent
Accepted by: none
Music event type event-chord
is in Music objects of type EventChord
Accepted by: none
Music event type extender-event
is in Music objects of type ExtenderEvent
Accepted by: Extender_engraver
Music event type fingering-event
is in Music objects of type FingerEvent
Accepted by: Fingering_engraver
Music event type folded-repeated-music
is in Music objects of type FoldedRepeatedMusic
Accepted by: none
Music event type general-music
is in Music objects of type AbsoluteDynamicEvent, ApplyContext, ApplyOutputEvent, ArpeggioEvent, ArticulationEvent, AutoChangeMusic, BarCheck, BassFigureEvent, BeamEvent, BeamForbidEvent, BreakEvent, BreathingSignEvent, BusyPlayingEvent, ClusterNoteEvent, ContextChange, ContextSpeccedMusic, CrescendoEvent, DecrescendoEvent, EventChord, Event, ExtenderEvent, FingerEvent, FoldedRepeatedMusic, GlissandoEvent, GraceMusic, HarmonicEvent, HyphenEvent, KeyChangeEvent, LigatureEvent, LyricCombineMusic, LyricEvent, ManualMelismaEvent, MarkEvent, MelismaPlayingEvent, MetronomeChangeEvent, MultiMeasureRestEvent, MultiMeasureRestMusicGroup, MultiMeasureTextEvent, Music, NewLyricCombineMusic, NoteEvent, NoteGroupingEvent, OutputPropertySetMusic, OverrideProperty, PartCombineMusic, PercentRepeatedMusic, PesOrFlexaEvent, PhrasingSlurEvent, PropertySet, PropertyUnset, QuoteMusic, RelativeOctaveCheck, RelativeOctaveMusic, RepeatedMusic, RestEvent, RevertProperty, ScriptEvent, SequentialMusic, SimultaneousMusic, SkipEvent, SkipMusic, SlurEvent, SoloOneEvent, SoloTwoEvent, SostenutoEvent, SpanEvent, StartPlayingEvent, StringNumberEvent, SustainEvent, TextScriptEvent, TextSpanEvent, TieEvent, TimeScaledMusic, TransposedMusic, TremoloEvent, TremoloRepeatedMusic, UnaCordaEvent, UnfoldedRepeatedMusic, UnisonoEvent, UnrelativableMusic, UntransposableMusic, VoiceSeparator and VoltaRepeatedMusic
Accepted by: Swallow_engraver and Swallow_performer
Music event type glissando-event
is in Music objects of type GlissandoEvent
Accepted by: Glissando_engraver and Note_head_line_engraver
Music event type grace-music
is in Music objects of type GraceMusic
Accepted by: none
Music event type harmonic-event
is in Music objects of type HarmonicEvent
Accepted by: none
Music event type hyphen-event
is in Music objects of type HyphenEvent
Accepted by: Hyphen_engraver
Music event type key-change-event
is in Music objects of type KeyChangeEvent
Accepted by: Key_engraver and Key_performer
Music event type layout-instruction
is in Music objects of type ApplyOutputEvent, OutputPropertySetMusic, OverrideProperty, PropertySet, PropertyUnset and RevertProperty
Accepted by: Output_property_engraver
Music event type ligature-event
is in Music objects of type LigatureEvent
Accepted by: Coherent_ligature_engraver, Gregorian_ligature_engraver, Ligature_bracket_engraver, Ligature_engraver, Mensural_ligature_engraver and Vaticana_ligature_engraver
Music event type lyric-combine-music
is in Music objects of type LyricCombineMusic and NewLyricCombineMusic
Accepted by: none
Music event type lyric-event
is in Music objects of type LyricEvent
Accepted by: Lyric_engraver and Lyric_performer
Music event type mark-event
is in Music objects of type MarkEvent
Accepted by: Mark_engraver
Music event type melisma-playing-event
is in Music objects of type MelismaPlayingEvent
Accepted by: Melisma_translator
Music event type melisma-span-event
is in Music objects of type ManualMelismaEvent
Accepted by: Melisma_translator
Music event type melodic-event
is in Music objects of type ClusterNoteEvent and NoteEvent
Accepted by: none
Music event type metronome-change-event
is in Music objects of type MetronomeChangeEvent
Accepted by: Metronome_mark_engraver and Tempo_performer
Music event type multi-measure-rest-event
is in Music objects of type MultiMeasureRestEvent
Accepted by: Multi_measure_rest_engraver
Music event type multi-measure-text-event
is in Music objects of type MultiMeasureTextEvent
Accepted by: Multi_measure_rest_engraver
Music event type music-wrapper-music
is in Music objects of type AutoChangeMusic, ContextSpeccedMusic, GraceMusic, RelativeOctaveMusic, TimeScaledMusic, TransposedMusic, UnrelativableMusic and UntransposableMusic
Accepted by: none
Music event type note-event
is in Music objects of type NoteEvent
Accepted by: Chord_name_engraver, Completion_heads_engraver, Drum_note_performer, Drum_notes_engraver, Note_heads_engraver, Note_name_engraver, Note_performer, Note_swallow_translator and Tab_note_heads_engraver
Music event type note-grouping-event
is in Music objects of type NoteGroupingEvent
Accepted by: Horizontal_bracket_engraver
Music event type part-combine-event
is in Music objects of type SoloOneEvent, SoloTwoEvent and UnisonoEvent
Accepted by: Part_combine_engraver
Music event type part-combine-music
is in Music objects of type PartCombineMusic
Accepted by: none
Music event type pedal-event
is in Music objects of type SostenutoEvent, SustainEvent and UnaCordaEvent
Accepted by: Piano_pedal_engraver and Piano_pedal_performer
Music event type percent-repeated-music
is in Music objects of type PercentRepeatedMusic
Accepted by: none
Music event type pes-or-flexa-event
is in Music objects of type PesOrFlexaEvent
Accepted by: none
Music event type phrasing-slur-event
is in Music objects of type PhrasingSlurEvent
Accepted by: Phrasing_slur_engraver
Music event type relative-octave-check
is in Music objects of type RelativeOctaveCheck
Accepted by: none
Music event type relative-octave-music
is in Music objects of type RelativeOctaveMusic
Accepted by: none
Music event type repeated-music
is in Music objects of type FoldedRepeatedMusic, PercentRepeatedMusic, RepeatedMusic, TremoloRepeatedMusic, UnfoldedRepeatedMusic and VoltaRepeatedMusic
Accepted by: Chord_tremolo_engraver, Percent_repeat_engraver and Slash_repeat_engraver
Music event type rest-event
is in Music objects of type RestEvent
Accepted by: Figured_bass_engraver, Rest_engraver and Rest_swallow_translator
Music event type rhythmic-event
is in Music objects of type BassFigureEvent, ClusterNoteEvent, LyricEvent, MultiMeasureRestEvent, NoteEvent, RestEvent, SkipEvent and SkipMusic
Accepted by: none
Music event type script-event
is in Music objects of type ArticulationEvent and TextScriptEvent
Accepted by: Script_engraver
Music event type separator
is in Music objects of type VoiceSeparator
Accepted by: none
Music event type sequential-music
is in Music objects of type MultiMeasureRestMusicGroup and SequentialMusic
Accepted by: none
Music event type simultaneous-music
is in Music objects of type EventChord and SimultaneousMusic
Accepted by: none
Music event type skip-event
is in Music objects of type SkipEvent and SkipMusic
Accepted by: Skip_event_swallow_translator
Music event type slur-event
is in Music objects of type SlurEvent
Accepted by: Slur_engraver and Slur_performer
Music event type sostenuto-pedal-event
is in Music objects of type SostenutoEvent
Accepted by: none
Music event type span-event
is in Music objects of type BeamEvent, LigatureEvent, PhrasingSlurEvent, SlurEvent and TextSpanEvent
Accepted by: none
Music event type start-playing-event
is in Music objects of type StartPlayingEvent
Accepted by: none
Music event type string-number-event
is in Music objects of type StringNumberEvent
Accepted by: String_number_engraver and Tab_note_heads_engraver
Music event type sustain-pedal-event
is in Music objects of type SustainEvent
Accepted by: none
Music event type tempo-event
is in Music objects of type MetronomeChangeEvent
Accepted by: none
Music event type text-script-event
is in Music objects of type TextScriptEvent
Accepted by: Text_engraver
Music event type text-span-event
is in Music objects of type TextSpanEvent
Accepted by: Text_spanner_engraver
Music event type tie-event
is in Music objects of type TieEvent
Accepted by: Tie_engraver and Tie_performer
Music event type time-scaled-music
is in Music objects of type TimeScaledMusic
Accepted by: Tuplet_engraver
Music event type translator-change-instruction
is in Music objects of type ContextChange
Accepted by: none
Music event type transposed-music
is in Music objects of type TransposedMusic
Accepted by: none
Music event type tremolo-event
is in Music objects of type TremoloEvent
Accepted by: Stem_engraver
Music event type tremolo-repeated-music
is in Music objects of type TremoloRepeatedMusic
Accepted by: none
Music event type una-corda-pedal-event
is in Music objects of type UnaCordaEvent
Accepted by: none
Music event type unfolded-repeated-music
is in Music objects of type UnfoldedRepeatedMusic
Accepted by: none
Music event type unrelativable-music
is in Music objects of type UnrelativableMusic
Accepted by: none
Music event type untransposable-music
is in Music objects of type UntransposableMusic
Accepted by: none
Music event type volta-repeated-music
is in Music objects of type VoltaRepeatedMusic
Accepted by: none
absolute-octave
(integer)alteration
(number)articulation-type
(string)TODO: consider making type into symbol
articulations
(list of music)associated-context
(string)bass
(boolean)bracket-start
(boolean)bracket-stop
(boolean)cautionary
(boolean)change-to-id
(string)change-to-type
(symbol)compress-procedure
(procedure)context-id
(string)context-type
(symbol)denominator
(integer)descend-only
(boolean)\context
will only
descend in the context tree.
digit
(integer)direction
(direction)drum-type
(symbol)duration
(duration)element
(music)elements
(list of music)figure
(string)force-accidental
(boolean)grob-property
(symbol)grob-value
(any type)internal-class-name
(string)inversion
(boolean)iterator-ctor
(procedure)label
(markup)last-pitch
(pitch)length
(procedure)metronome-count
(number)name
(symbol)numerator
(integer)octavation
(integer)once
(boolean)origin
(input location)part-combine-status
(symbol)penalty
(number)pitch
(pitch)pitch-alist
(list)pop-first
(boolean)predicate
(procedure)procedure
(procedure)property-operations
(list)quoted-events
(hash table)repeat-count
(integer)
epeat
how ofen?
span-direction
(direction)span-type
(string)TODO: consider making type into symbol
split-list
(list)start-moment-function
(procedure)string-number
(integer)symbol
(symbol)tags
(list)\tag #'part ...
could tag a piece of music as only being active in a part.
tempo-unit
(duration)text
(markup)text-type
(symbol)tonic
(pitch)tremolo-type
(integer)
type
(symbol)types
(list)value
(any type)what
(symbol)Identical to StaffGroup
except that the
contained staves are not connected vertically.
This context creates the following layout objects:
SystemStartBar, SystemStartBrace and SystemStartBracket.
This context sets the following properties:
localKeySignature
to '()
systemStartDelimiter
to 'SystemStartBracket
Context ChoirStaff can contain InnerStaffGroup, InnerChoirStaff, ChordNames, Lyrics, PianoStaff, GrandStaff, RhythmicStaff, DrumStaff and Staff
This context is built from the following engravers:
Engraver_group_engraver
System_start_delimiter_engraver
Properties (read)
systemStartDelimiter
(symbol)SystemStartBrace
,
SystemStartBracket
or SystemStartBar
.
Typesets chord names.
This context creates the following layout objects:
ChordName, RemoveEmptyVerticalGroup, SeparatingGroupSpanner, SeparationItem, StaffSpacing and VoltaBracket.
This context sets the following properties:
verticalExtent
to #f
padding
in SeparatingGroupSpanner to 0.8
extraVerticalExtent
to #f
minimumVerticalExtent
to '(0 . 2.5)
voltaOnThisStaff
to #f
This context is a `bottom' context; it can not contain other contexts.
This context is built from the following engravers:
Engraver_group_engraver
Skip_event_swallow_translator
Music types accepted:
Chord_name_engraver
Music types accepted:
Properties (read)
majorSevenSymbol
(markup)chordNameExceptions
(list)chordRootNamer
(procedure)chordNoteNamer
(procedure)chordNameFunction
(procedure)chordNameExceptions
(list)chordChanges
(boolean)Separating_line_group_engraver
Properties (read)
createSpacing
(boolean)breakableSeparationItem
(layout object)Output_property_engraver
Music types accepted:
Rest_swallow_translator
Music types accepted:
Volta_engraver
Properties (read)
stavesFound
(list of grobs)voltaSpannerDuration
(moment)\alternative
. This can be
used to shrink the length of brackets in the situation where one
alternative is very large.
repeatCommands
(list)(volta .
x)
, where x is a string or #f
Hara_kiri_engraver
This engraver creates the following layout objects: RemoveEmptyVerticalGroup.
Silently discards all musical information given to this context.
This context is also known as:
Voice and Staff
This context creates the following layout objects:
none.
This context is a `bottom' context; it can not contain other contexts.
This context is built from the following engravers:
Engraver_group_engraver
Swallow_engraver
Music types accepted:
Handles typesetting for percussion.
This context is also known as:
Staff
This context creates the following layout objects:
BarLine, Clef, DotColumn, InstrumentName, NoteCollision, OctavateEight, RestCollision, SeparatingGroupSpanner, SeparationItem, StaffSpacing, StaffSymbol, TimeSignature, VerticalAxisGroup and VoltaBracket.
This context sets the following properties:
staff-padding
in Script to 0.75
clefPosition
to 0
clefGlyph
to clefs-percussion
instr
to '()
instrument
to '()
createSpacing
to #t
localKeySignature
to '()
verticalExtent
to #f
extraVerticalExtent
to #f
minimumVerticalExtent
to '(-6 . 6)
Context DrumStaff can contain DrumVoice
This context is built from the following engravers:
Engraver_group_engraver
Instrument_name_engraver
Staff.instrument
and Staff.instr
) at the left of the staff.
Properties (read)
instr
(markup)instrument
instrument
(markup)instrument
property labels the staff in the first system, and
the instr
property labels following lines.
Rest_collision_engraver
This engraver creates the following layout objects:
RestCollision.
Collision_engraver
This engraver creates the following layout objects:
NoteCollision.
Staff_symbol_engraver
This engraver creates the following layout objects:
StaffSymbol.
Time_signature_engraver
timeSignatureFraction
changes
This engraver creates the following layout objects:
TimeSignature.
Clef_engraver
Properties (read)
forceClef
(boolean)explicitClefVisibility
(procedure)clefOctavation
(integer)middleCPosition
(number)clefPosition
and
clefGlyph
.
clefGlyph
(string)clefPosition
(number)Dot_column_engraver
This engraver creates the following layout objects:
DotColumn.
Separating_line_group_engraver
Properties (read)
createSpacing
(boolean)breakableSeparationItem
(layout object)Volta_engraver
Properties (read)
stavesFound
(list of grobs)voltaSpannerDuration
(moment)\alternative
. This can be
used to shrink the length of brackets in the situation where one
alternative is very large.
repeatCommands
(list)(volta .
x)
, where x is a string or #f
Font_size_engraver
Properties (read)
fontSize
(number)Bar_engraver
whichBar
property. If it has no bar line to create, it will forbid a linebreak at this point
Properties (read)
whichBar
(string)Example:
\set Staff.whichBar = "|:"
This will create a start-repeat bar in this staff only. Valid values are described in bar-line-interface.
Output_property_engraver
Music types accepted:
Axis_group_engraver
Properties (read)
extraVerticalExtent
(pair of numbers)minimumVerticalExtent
(pair of numbers)verticalExtent
(pair of numbers)\set Staff.verticalExtent = #'(-5.0 . 5.0)
This does not work for Voice or any other context that doesn't form a vertical group.
A voice on a percussion staff.
This context is also known as:
Voice
This context creates the following layout objects:
Beam, BreathingSign, CombineTextScript, Dots, DoublePercentRepeat, DynamicLineSpanner, DynamicText, Hairpin, MultiMeasureRestNumber, MultiMeasureRestText, MultiMeasureRest, NoteColumn, NoteHead, NoteSpacing, PercentRepeat, PhrasingSlur, RepeatSlash, Rest, ScriptColumn, Script, Slur, StemTremolo, Stem, TextScript, TextSpanner, TieColumn, Tie and TupletBracket.
This context sets the following properties:
localKeySignature
to '()
This context is a `bottom' context; it can not contain other contexts.
This context is built from the following engravers:
Engraver_group_engraver
Skip_event_swallow_translator
Music types accepted:
Tuplet_engraver
Music types accepted:
Properties (read)
tupletSpannerDuration
(moment)\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
.
tupletNumberFormatFunction
(procedure)Drum_notes_engraver
Music types accepted:
busy-playing-event and note-event
Properties (read)
drumStyleTable
(hash table)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.
Rest_engraver
Music types accepted:
Properties (read)
middleCPosition
(number)clefPosition
and
clefGlyph
.
Grob_pq_engraver
Properties (read)
busyGrobs
(list)busyGrobs
(list)Text_spanner_engraver
Music types accepted:
This engraver creates the following layout objects:
TextSpanner.
Multi_measure_rest_engraver
R
. Reads measurePosition and currentBarNumber to determine what number to print over the MultiMeasureRest. Reads measureLength to determine if it should use a whole rest or a breve rest to represent 1 measure
Music types accepted:
multi-measure-text-event and multi-measure-rest-event
Properties (read)
measureLength
(moment)measurePosition
(moment)currentCommandColumn
(layout object)breakableSeparationItem
(layout object)restNumberThreshold
(number)currentBarNumber
(integer)Skip_event_swallow_translator
Music types accepted:
Tuplet_engraver
Music types accepted:
Properties (read)
tupletSpannerDuration
(moment)\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
.
tupletNumberFormatFunction
(procedure)Tie_engraver
Music types accepted:
Properties (read)
tieMelismaBusy
(boolean)Slur_engraver
Music types accepted:
Properties (read)
slurMelismaBusy
(boolean)Phrasing_slur_engraver
Music types accepted:
This engraver creates the following layout objects:
PhrasingSlur.
Rhythmic_column_engraver
This engraver creates the following layout objects:
NoteColumn and NoteSpacing.
Script_column_engraver
This engraver creates the following layout objects:
ScriptColumn.
Script_engraver
Music types accepted:
articulation-event and script-event
Properties (read)
scriptDefinitions
(list)Dynamic_engraver
Music types accepted:
decrescendo-event, crescendo-event and absolute-dynamic-event
This engraver creates the following layout objects:
DynamicLineSpanner, DynamicText, Hairpin and TextSpanner.
Text_engraver
Music types accepted:
This engraver creates the following layout objects:
TextScript.
Part_combine_engraver
Music types accepted:
Properties (read)
soloADue
(boolean)Melisma_translator
melismaBusy
, and signals it to the ddlyrics
code.
Music types accepted:
melisma-span-event and melisma-playing-event
Properties (read)
beamMelismaBusy
(boolean)tieMelismaBusy
(boolean)slurMelismaBusy
(boolean)melismaBusyProperties
(list)#'(melismaBusy beamMelismaBusy)
, only manual melismata and
manual beams are considered. Possible values include
melismaBusy
, slurMelismaBusy
, tieMelismaBusy
, and
beamMelismaBusy
melismaBusy
(boolean)Slash_repeat_engraver
Music types accepted:
Properties (read)
measureLength
(moment)Percent_repeat_engraver
Music types accepted:
Properties (read)
currentCommandColumn
(layout object)measureLength
(moment)Chord_tremolo_engraver
Music types accepted:
This engraver creates the following layout objects:
Beam.
Auto_beam_engraver
stemLeftBeamCount
and stemRightBeamCount
.
Music types accepted:
Properties (read)
subdivideBeams
(boolean)beatLength
(moment)autoBeamSettings
(list)autoBeaming
(boolean)Grace_beam_engraver
Music types accepted:
Properties (read)
subdivideBeams
(boolean)allowBeamBreak
(boolean)beatLength
(moment)beamMelismaBusy
(boolean)Beam_engraver
Music types accepted:
Properties (read)
subdivideBeams
(boolean)beatLength
(moment)beamMelismaBusy
(boolean)Stem_engraver
Music types accepted:
Properties (read)
stemRightBeamCount
(integer)stemLeftBeamCount
.
stemLeftBeamCount
(integer)tremoloFlags
(integer)Rest_engraver
Music types accepted:
Properties (read)
middleCPosition
(number)clefPosition
and
clefGlyph
.
Breathing_sign_engraver
Music types accepted:
This engraver creates the following layout objects:
BreathingSign.
Forbid_line_break_engraver
Properties (read)
busyGrobs
(list)Grob_pq_engraver
Properties (read)
busyGrobs
(list)busyGrobs
(list)Text_spanner_engraver
Music types accepted:
This engraver creates the following layout objects:
TextSpanner.
Multi_measure_rest_engraver
R
. Reads measurePosition and currentBarNumber to determine what number to print over the MultiMeasureRest. Reads measureLength to determine if it should use a whole rest or a breve rest to represent 1 measure
Music types accepted:
multi-measure-text-event and multi-measure-rest-event
Properties (read)
measureLength
(moment)measurePosition
(moment)currentCommandColumn
(layout object)breakableSeparationItem
(layout object)restNumberThreshold
(number)currentBarNumber
(integer)Output_property_engraver
Music types accepted:
Font_size_engraver
Properties (read)
fontSize
(number)(not documented)
This context creates the following layout objects:
BassFigure, RemoveEmptyVerticalGroup, SeparatingGroupSpanner, SeparationItem and StaffSpacing.
This context is a `bottom' context; it can not contain other contexts.
This context is built from the following engravers:
Engraver_group_engraver
Separating_line_group_engraver
Properties (read)
createSpacing
(boolean)breakableSeparationItem
(layout object)Skip_event_swallow_translator
Music types accepted:
Note_swallow_translator
Music types accepted:
Rest_swallow_translator
Music types accepted:
Figured_bass_engraver
Music types accepted:
bass-figure-event and rest-event
Properties (read)
bassFigureFormatFunction
(procedure)BassFigure
grob. It takes a
list of BassFigureEvent
s, a context, and the grob to format.
Hara_kiri_engraver
This engraver creates the following layout objects: RemoveEmptyVerticalGroup.
Hard coded entry point for LilyPond. Cannot be tuned.
This context creates the following layout objects:
none.
This context sets the following properties:
Context Global can contain Score
This context is built from the following engravers:
A group of staffs, with a brace on the left side, grouping the staves together. The bar lines of the contained staves are connected vertically.
This context creates the following layout objects:
Arpeggio, SpanBar, SystemStartBar, SystemStartBrace and SystemStartBracket.
This context sets the following properties:
systemStartDelimiter
to 'SystemStartBrace
localKeySignature
to '()
Context GrandStaff can contain Staff
This context is built from the following engravers:
Engraver_group_engraver
System_start_delimiter_engraver
Properties (read)
systemStartDelimiter
(symbol)SystemStartBrace
,
SystemStartBracket
or SystemStartBar
.
Span_arpeggio_engraver
Properties (read)
connectArpeggios
(boolean)Span_bar_engraver
This engraver creates the following layout objects: SpanBar.
Handles clefs, bar lines, keys, accidentals. It can contain
Voice
contexts.
This context is also known as:
Staff
This context creates the following layout objects:
Accidental, BarLine, Clef, DotColumn, InstrumentName, KeySignature, NoteCollision, OctavateEight, OttavaBracket, RestCollision, SeparatingGroupSpanner, SeparationItem, SostenutoPedalLineSpanner, SostenutoPedal, StaffSpacing, StaffSymbol, SustainPedalLineSpanner, SustainPedal, TimeSignature, UnaCordaPedalLineSpanner, UnaCordaPedal, VerticalAxisGroup and VoltaBracket.
This context sets the following properties:
transparent
in BarLine to #t
instr
to '()
instrument
to '()
createSpacing
to #t
localKeySignature
to '()
verticalExtent
to #f
extraVerticalExtent
to #f
minimumVerticalExtent
to '(-6 . 6)
Context GregorianTranscriptionStaff can contain GregorianTranscriptionVoice
This context is built from the following engravers:
Engraver_group_engraver
String_number_engraver
Music types accepted:
Instrument_name_engraver
Staff.instrument
and Staff.instr
) at the left of the staff.
Properties (read)
instr
(markup)instrument
instrument
(markup)instrument
property labels the staff in the first system, and
the instr
property labels following lines.
Piano_pedal_engraver
Music types accepted:
Properties (read)
pedalUnaCordaStyle
(symbol)pedalSustainStyle
.
pedalSustainStyle
(symbol)text
, bracket
or mixed
(both).
pedalSostenutoStyle
(symbol)pedalSustainStyle
.
pedalUnaCordaStrings
(list)pedalSustainStrings
.
pedalSustainStrings
(list)pedalSostenutoStrings
(list)pedalSustainStrings
.
currentCommandColumn
(layout object)Accidental_engraver
Voice
level, so you can \override
them at Voice
.
Properties (read)
autoCautionaries
(list)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.
autoAccidentals
(list)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
-1
then the accidental is forget
immediately, and if laziness is #t
then the accidental
lasts forever.
extraNatural
(boolean)harmonicAccidentals
(boolean)localKeySignature
(list)localKeySignature
(list)Rest_collision_engraver
This engraver creates the following layout objects:
RestCollision.
Collision_engraver
This engraver creates the following layout objects:
NoteCollision.
Staff_symbol_engraver
This engraver creates the following layout objects:
StaffSymbol.
Time_signature_engraver
timeSignatureFraction
changes
This engraver creates the following layout objects:
TimeSignature.
Key_engraver
Music types accepted:
Properties (read)
keySignature
(list)keyAccidentalOrder
(list)createKeyOnClefChange
(boolean)explicitKeySignatureVisibility
(procedure)lastKeySignature
(list)printKeyCancellation
(boolean)keySignature
(list)keySignature
(list)tonic
(pitch)lastKeySignature
(list)Clef_engraver
Properties (read)
forceClef
(boolean)explicitClefVisibility
(procedure)clefOctavation
(integer)middleCPosition
(number)clefPosition
and
clefGlyph
.
clefGlyph
(string)clefPosition
(number)Ottava_spanner_engraver
Properties (read)
ottavation
(string)Dot_column_engraver
This engraver creates the following layout objects:
DotColumn.
Separating_line_group_engraver
Properties (read)
createSpacing
(boolean)breakableSeparationItem
(layout object)Volta_engraver
Properties (read)
stavesFound
(list of grobs)voltaSpannerDuration
(moment)\alternative
. This can be
used to shrink the length of brackets in the situation where one
alternative is very large.
repeatCommands
(list)(volta .
x)
, where x is a string or #f
Font_size_engraver
Properties (read)
fontSize
(number)Bar_engraver
whichBar
property. If it has no bar line to create, it will forbid a linebreak at this point
Properties (read)
whichBar
(string)Example:
\set Staff.whichBar = "|:"
This will create a start-repeat bar in this staff only. Valid values are described in bar-line-interface.
Output_property_engraver
Music types accepted:
Axis_group_engraver
Properties (read)
extraVerticalExtent
(pair of numbers)minimumVerticalExtent
(pair of numbers)verticalExtent
(pair of numbers)\set Staff.verticalExtent = #'(-5.0 . 5.0)
This does not work for Voice or any other context that doesn't form a vertical group.
Corresponds to a voice on a staff. This context handles the conversion of dynamic signs, stems, beams, super- and subscripts, slurs, ties, and rests.
You have to instantiate this explicitly if you want to have multiple voices on the same staff.
This context is also known as:
Voice
This context creates the following layout objects:
Arpeggio, Beam, BreathingSign, ClusterSpannerBeacon, ClusterSpanner, CombineTextScript, Dots, DoublePercentRepeat, DynamicLineSpanner, DynamicText, Fingering, Glissando, Hairpin, MultiMeasureRestNumber, MultiMeasureRestText, MultiMeasureRest, NoteColumn, NoteHead, NoteSpacing, PercentRepeat, PhrasingSlur, RepeatSlash, Rest, ScriptColumn, Script, Slur, StemTremolo, Stem, TextScript, TextSpanner, TieColumn, Tie, TupletBracket and VoiceFollower.
This context sets the following properties:
edge-text
in TextSpanner to '( . )
enclose-bounds
in TextSpanner to 1
padding
in TextSpanner to 0.5
edge-height
in TextSpanner to '(0 . 0)
style
in TextSpanner to 'line
autobeaming
to #f
padding
in Script to 0.5
transparent
in LigatureBracket to #t
localKeySignature
to '()
This context is a `bottom' context; it can not contain other contexts.
This context is built from the following engravers:
Engraver_group_engraver
Skip_event_swallow_translator
Music types accepted:
Tuplet_engraver
Music types accepted:
Properties (read)
tupletSpannerDuration
(moment)\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
.
tupletNumberFormatFunction
(procedure)Tie_engraver
Music types accepted:
Properties (read)
tieMelismaBusy
(boolean)Slur_engraver
Music types accepted:
Properties (read)
slurMelismaBusy
(boolean)Cluster_spanner_engraver
Music types accepted:
This engraver creates the following layout objects:
ClusterSpanner and ClusterSpannerBeacon.
Phrasing_slur_engraver
Music types accepted:
This engraver creates the following layout objects:
PhrasingSlur.
Rhythmic_column_engraver
This engraver creates the following layout objects:
NoteColumn and NoteSpacing.
Script_column_engraver
This engraver creates the following layout objects:
ScriptColumn.
Script_engraver
Music types accepted:
articulation-event and script-event
Properties (read)
scriptDefinitions
(list)Fingering_engraver
Music types accepted:
This engraver creates the following layout objects:
Fingering.
Dynamic_engraver
Music types accepted:
decrescendo-event, crescendo-event and absolute-dynamic-event
This engraver creates the following layout objects:
DynamicLineSpanner, DynamicText, Hairpin and TextSpanner.
Text_engraver
Music types accepted:
This engraver creates the following layout objects:
TextScript.
Part_combine_engraver
Music types accepted:
Properties (read)
soloADue
(boolean)Melisma_translator
melismaBusy
, and signals it to the ddlyrics
code.
Music types accepted:
melisma-span-event and melisma-playing-event
Properties (read)
beamMelismaBusy
(boolean)tieMelismaBusy
(boolean)slurMelismaBusy
(boolean)melismaBusyProperties
(list)#'(melismaBusy beamMelismaBusy)
, only manual melismata and
manual beams are considered. Possible values include
melismaBusy
, slurMelismaBusy
, tieMelismaBusy
, and
beamMelismaBusy
melismaBusy
(boolean)Slash_repeat_engraver
Music types accepted:
Properties (read)
measureLength
(moment)Percent_repeat_engraver
Music types accepted:
Properties (read)
currentCommandColumn
(layout object)measureLength
(moment)Chord_tremolo_engraver
Music types accepted:
This engraver creates the following layout objects:
Beam.
New_fingering_engraver
Properties (read)
fingeringOrientations
(list)Auto_beam_engraver
stemLeftBeamCount
and stemRightBeamCount
.
Music types accepted:
Properties (read)
subdivideBeams
(boolean)beatLength
(moment)autoBeamSettings
(list)autoBeaming
(boolean)Grace_beam_engraver
Music types accepted:
Properties (read)
subdivideBeams
(boolean)allowBeamBreak
(boolean)beatLength
(moment)beamMelismaBusy
(boolean)Beam_engraver
Music types accepted:
Properties (read)
subdivideBeams
(boolean)beatLength
(moment)beamMelismaBusy
(boolean)Stem_engraver
Music types accepted:
Properties (read)
stemRightBeamCount
(integer)stemLeftBeamCount
.
stemLeftBeamCount
(integer)tremoloFlags
(integer)Rest_engraver
Music types accepted:
Properties (read)
middleCPosition
(number)clefPosition
and
clefGlyph
.
Note_heads_engraver
Music types accepted:
busy-playing-event and note-event
Properties (read)
middleCPosition
(number)clefPosition
and
clefGlyph
.
Breathing_sign_engraver
Music types accepted:
This engraver creates the following layout objects:
BreathingSign.
Ligature_bracket_engraver
Music types accepted:
This engraver creates the following layout objects:
TupletBracket.
Glissando_engraver
Music types accepted:
Properties (read)
followVoice
(boolean)Note_head_line_engraver
Music types accepted:
Properties (read)
followVoice
(boolean)Forbid_line_break_engraver
Properties (read)
busyGrobs
(list)Grob_pq_engraver
Properties (read)
busyGrobs
(list)busyGrobs
(list)Text_spanner_engraver
Music types accepted:
This engraver creates the following layout objects:
TextSpanner.
Multi_measure_rest_engraver
R
. Reads measurePosition and currentBarNumber to determine what number to print over the MultiMeasureRest. Reads measureLength to determine if it should use a whole rest or a breve rest to represent 1 measure
Music types accepted:
multi-measure-text-event and multi-measure-rest-event
Properties (read)
measureLength
(moment)measurePosition
(moment)currentCommandColumn
(layout object)breakableSeparationItem
(layout object)restNumberThreshold
(number)currentBarNumber
(integer)Arpeggio_engraver
Music types accepted:
This engraver creates the following layout objects:
Arpeggio.
Output_property_engraver
Music types accepted:
Font_size_engraver
Properties (read)
fontSize
(number)(not documented)
This context creates the following layout objects:
SystemStartBar, SystemStartBrace and SystemStartBracket.
This context sets the following properties:
localKeySignature
to '()
systemStartDelimiter
to 'SystemStartBracket
Context InnerChoirStaff can contain ChordNames, Lyrics, PianoStaff, GrandStaff, RhythmicStaff, DrumStaff and Staff
This context is built from the following engravers:
Engraver_group_engraver
System_start_delimiter_engraver
Properties (read)
systemStartDelimiter
(symbol)SystemStartBrace
,
SystemStartBracket
or SystemStartBar
.
(not documented)
This context creates the following layout objects:
Arpeggio, SpanBar, SystemStartBar, SystemStartBrace and SystemStartBracket.
This context sets the following properties:
systemStartDelimiter
to 'SystemStartBracket
localKeySignature
to '()
Context InnerStaffGroup can contain ChordNames, Lyrics, TabStaff, PianoStaff, GrandStaff, DrumStaff, RhythmicStaff and Staff
This context is built from the following engravers:
Engraver_group_engraver
System_start_delimiter_engraver
Properties (read)
systemStartDelimiter
(symbol)SystemStartBrace
,
SystemStartBracket
or SystemStartBar
.
Output_property_engraver
Music types accepted:
Span_arpeggio_engraver
Properties (read)
connectArpeggios
(boolean)Span_bar_engraver
This engraver creates the following layout objects: SpanBar.
Corresponds to a voice with lyrics. Handles the printing of a single line of lyrics.
This context creates the following layout objects:
LyricExtender, LyricHyphen, LyricText, RemoveEmptyVerticalGroup, SeparatingGroupSpanner, SeparationItem, StaffSpacing, StanzaNumber and VocalName.
This context sets the following properties:
padding
in SeparationItem to 0.2
verticalExtent
to #f
extraVerticalExtent
to #f
minimumVerticalExtent
to '(-1.2 . 2.4)
This context is a `bottom' context; it can not contain other contexts.
This context is built from the following engravers:
Engraver_group_engraver
Font_size_engraver
Properties (read)
fontSize
(number)Skip_event_swallow_translator
Music types accepted:
Vocal_name_engraver
Staff.vocalName
and Staff.vocNam
) at the left of the staff.
Properties (read)
vocalName
(markup)vocNam
(markup)Stanza_number_engraver
Properties (read)
stanza
(markup)Hyphen_engraver
Music types accepted:
This engraver creates the following layout objects:
LyricHyphen.
Extender_engraver
Music types accepted:
This engraver creates the following layout objects:
LyricExtender.
Lyric_engraver
Music types accepted:
This engraver creates the following layout objects:
LyricText.
Separating_line_group_engraver
Properties (read)
createSpacing
(boolean)breakableSeparationItem
(layout object)Hara_kiri_engraver
This engraver creates the following layout objects: RemoveEmptyVerticalGroup.
(not documented)
This context creates the following layout objects:
NoteName, SeparatingGroupSpanner, SeparationItem, StaffSpacing, TieColumn, Tie and VerticalAxisGroup.
This context sets the following properties:
verticalExtent
to #f
extraVerticalExtent
to #f
minimumVerticalExtent
to #f
This context is a `bottom' context; it can not contain other contexts.
This context is built from the following engravers:
Engraver_group_engraver
Separating_line_group_engraver
Properties (read)
createSpacing
(boolean)breakableSeparationItem
(layout object)Note_name_engraver
Music types accepted:
Properties (read)
printOctaveNames
(boolean)Tie_engraver
Music types accepted:
Properties (read)
tieMelismaBusy
(boolean)Skip_event_swallow_translator
Music types accepted:
Rest_swallow_translator
Music types accepted:
Axis_group_engraver
Properties (read)
extraVerticalExtent
(pair of numbers)minimumVerticalExtent
(pair of numbers)verticalExtent
(pair of numbers)\set Staff.verticalExtent = #'(-5.0 . 5.0)
This does not work for Voice or any other context that doesn't form a vertical group.
Just like GrandStaff
but with a forced distance between
the staves, so cross staff beaming and slurring can be used.
This context is also known as:
GrandStaff
This context creates the following layout objects:
Arpeggio, InstrumentName, SpanBar, SystemStartBar, SystemStartBrace, SystemStartBracket and VerticalAlignment.
This context sets the following properties:
instr
to '()
instrument
to '()
self-alignment-Y
in VerticalAlignment to 0
forced-distance
in VerticalAlignment to 12
verticalAlignmentChildCallback
to Align_interface::fixed_distance_alignment_callback
systemStartDelimiter
to 'SystemStartBrace
localKeySignature
to '()
Context PianoStaff can contain Staff
This context is built from the following engravers:
Engraver_group_engraver
Instrument_name_engraver
Staff.instrument
and Staff.instr
) at the left of the staff.
Properties (read)
instr
(markup)instrument
instrument
(markup)instrument
property labels the staff in the first system, and
the instr
property labels following lines.
Vertical_align_engraver
This engraver creates the following layout objects:
VerticalAlignment.
System_start_delimiter_engraver
Properties (read)
systemStartDelimiter
(symbol)SystemStartBrace
,
SystemStartBracket
or SystemStartBar
.
Span_arpeggio_engraver
Properties (read)
connectArpeggios
(boolean)Span_bar_engraver
This engraver creates the following layout objects: SpanBar.
A context like Staff
but for printing rhythms. Pitches are
ignored; the notes are printed on one line.
This context is also known as:
Staff
This context creates the following layout objects:
BarLine, DotColumn, InstrumentName, SeparatingGroupSpanner, SeparationItem, StaffSpacing, StaffSymbol, TimeSignature, VerticalAxisGroup and VoltaBracket.
This context sets the following properties:
neutral-direction
in Beam to 1
neutral-direction
in Stem to 1
line-count
in StaffSymbol to 1
padding
in VoltaBracket to 5
minimum-space
in VoltaBracket to 15
bar-size
in BarLine to 4
squashedPosition
to 0
localKeySignature
to '()
verticalExtent
to #f
extraVerticalExtent
to #f
minimumVerticalExtent
to #f
Context RhythmicStaff can contain Voice
This context is built from the following engravers:
Engraver_group_engraver
Instrument_name_engraver
Staff.instrument
and Staff.instr
) at the left of the staff.
Properties (read)
instr
(markup)instrument
instrument
(markup)instrument
property labels the staff in the first system, and
the instr
property labels following lines.
Staff_symbol_engraver
This engraver creates the following layout objects:
StaffSymbol.
Time_signature_engraver
timeSignatureFraction
changes
This engraver creates the following layout objects:
TimeSignature.
Bar_engraver
whichBar
property. If it has no bar line to create, it will forbid a linebreak at this point
Properties (read)
whichBar
(string)Example:
\set Staff.whichBar = "|:"
This will create a start-repeat bar in this staff only. Valid values are described in bar-line-interface.
Volta_engraver
Properties (read)
stavesFound
(list of grobs)voltaSpannerDuration
(moment)\alternative
. This can be
used to shrink the length of brackets in the situation where one
alternative is very large.
repeatCommands
(list)(volta .
x)
, where x is a string or #f
Dot_column_engraver
This engraver creates the following layout objects:
DotColumn.
Separating_line_group_engraver
Properties (read)
createSpacing
(boolean)breakableSeparationItem
(layout object)Pitch_squash_engraver
squashedPosition
, if that property is set. This can be used to make a single line staff demonstrating the rhythm of a melody.
Properties (read)
squashedPosition
(integer)Output_property_engraver
Music types accepted:
Axis_group_engraver
Properties (read)
extraVerticalExtent
(pair of numbers)minimumVerticalExtent
(pair of numbers)verticalExtent
(pair of numbers)\set Staff.verticalExtent = #'(-5.0 . 5.0)
This does not work for Voice or any other context that doesn't form a vertical group.
This is the top level notation context. No
other context can contain a Score
context. This context
handles the administration of time signatures. It also makes sure
that items such as clefs, time signatures, and key-signatures are
aligned across staves.
You cannot explicitly instantiate a Score context (since it is
not contained in any other context). It is instantiated
automatically when an output definition (a \score
or
\paper
block) is processed.
This context creates the following layout objects:
Arpeggio, BarNumber, BreakAlignGroup, BreakAlignment, LeftEdge, MetronomeMark, NonMusicalPaperColumn, PaperColumn, RehearsalMark, SpacingSpanner, SystemStartBar, SystemStartBrace, SystemStartBracket, System and VerticalAlignment.
This context sets the following properties:
graceSettings
to '#((Voice Stem direction 1) (Voice Stem lengths (2.8 2.8 2.8 3.6 4.0)) (Voice Stem stem-shorten (0.4 0)) (Voice Stem font-size -3) (Voice NoteHead font-size -3) (Voice Dots font-size -3) (Voice Stem beamed-lengths (2.608)) (Voice Stem beamed-minimum-free-lengths (2.0 1.6 1.2)) (Voice Stem beamed-extreme-minimum-free-lengths (1.464 1.2)) (Voice Stem no-stem-extend #t) (Voice Beam thickness 0.384) (Voice Beam space-function #<procedure #f (beam mult)>) (Voice Accidental font-size -4) (Voice Slur direction -1))
metronomeMarkFormatter
to format-metronome-markup
bassFigureFormatFunction
to format-bass-figure
tablatureFormat
to fret-number-tablature-format
stringTunings
to '(4 -1 -5 -10 -15 -20)
highStringOne
to #t
stringOneTopmost
to #t
chordNameExceptionsPartial
to '(((#<Pitch c' > #<Pitch d' >) (#<procedure line-markup (paper props args)> ((#<procedure normal-size-super-markup (paper props arg)> (#<procedure simple-markup (paper props str)> 2))))) ((#<Pitch c' > #<Pitch ees' >) (#<procedure line-markup (paper props args)> ((#<procedure simple-markup (paper props str)> m)))) ((#<Pitch c' > #<Pitch f' >) (#<procedure line-markup (paper props args)> ((#<procedure normal-size-super-markup (paper props arg)> (#<procedure simple-markup (paper props str)> sus4))))) ((#<Pitch c' > #<Pitch g' >) (#<procedure line-markup (paper props args)> ((#<procedure normal-size-super-markup (paper props arg)> (#<procedure simple-markup (paper props str)> 5))))) ((#<Pitch c' > #<Pitch ees' > #<Pitch f' >) (#<procedure line-markup (paper props args)> ((#<procedure simple-markup (paper props str)> m))) (#<procedure line-markup (paper props args)> ((#<procedure normal-size-super-markup (paper props arg)> (#<procedure simple-markup (paper props str)> sus4))))) ((#<Pitch c' > #<Pitch d' > #<Pitch ees' >) (#<procedure line-markup (paper props args)> ((#<procedure simple-markup (paper props str)> m))) (#<procedure line-markup (paper props args)> ((#<procedure normal-size-super-markup (paper props arg)> (#<procedure simple-markup (paper props str)> sus2))))))
chordNameExceptionsFull
to '(((#<Pitch c' > #<Pitch e' > #<Pitch gis' >) (#<procedure line-markup (paper props args)> ((#<procedure simple-markup (paper props str)> +)))) ((#<Pitch c' > #<Pitch ees' > #<Pitch ges' >) (#<procedure line-markup (paper props args)> ((#<procedure super-markup (paper props arg)> (#<procedure simple-markup (paper props str)> o))))) ((#<Pitch c' > #<Pitch ees' > #<Pitch ges' > #<Pitch bes' >) (#<procedure line-markup (paper props args)> ((#<procedure super-markup (paper props arg)> (#<procedure combine-markup (paper props m1 m2)> (#<procedure simple-markup (paper props str)> o) (#<procedure simple-markup (paper props str)> /)))))) ((#<Pitch c' > #<Pitch ees' > #<Pitch ges' > #<Pitch beses' >) (#<procedure line-markup (paper props args)> ((#<procedure super-markup (paper props arg)> (#<procedure simple-markup (paper props str)> o7))))))
chordRootNamer
to note-name->markup
chordNoteNamer
to '()
chordNameExceptions
to '(((#<Pitch e' > #<Pitch gis' >) #<procedure line-markup (paper props args)> ((#<procedure simple-markup (paper props str)> +))) ((#<Pitch ees' > #<Pitch ges' >) #<procedure line-markup (paper props args)> ((#<procedure super-markup (paper props arg)> (#<procedure simple-markup (paper props str)> o)))) ((#<Pitch ees' > #<Pitch ges' > #<Pitch bes' >) #<procedure line-markup (paper props args)> ((#<procedure super-markup (paper props arg)> (#<procedure combine-markup (paper props m1 m2)> (#<procedure simple-markup (paper props str)> o) (#<procedure simple-markup (paper props str)> /))))) ((#<Pitch ees' > #<Pitch ges' > #<Pitch beses' >) #<procedure line-markup (paper props args)> ((#<procedure super-markup (paper props arg)> (#<procedure simple-markup (paper props str)> o7)))))
chordNameSeparator
to '(#<procedure simple-markup (paper props str)> /)
majorSevenSymbol
to '(#<procedure override-markup (paper props new-prop arg)> (font-encoding . math) (#<procedure simple-markup (paper props str)> M))
chordNameFunction
to ignatzek-chord-names
barCheckSynchronize
to #f
keyAccidentalOrder
to '((6 . -2) (2 . -2) (5 . -2) (1 . -2) (4 . -2) (0 . -2) (3 . -2) (3 . 2) (0 . 2) (4 . 2) (1 . 2) (5 . 2) (2 . 2) (6 . 2) (6 . -4) (2 . -4) (5 . -4) (1 . -4) (4 . -4) (0 . -4) (3 . -4) (3 . 4) (0 . 4) (4 . 4) (2 . 4) (5 . 4) (2 . 4) (6 . 4))
printKeyCancellation
to #t
autoCautionaries
to '()
autoAccidentals
to '(Staff (same-octave . 0))
extraNatural
to #t
allowBeamBreak
to #f
subdivideBeams
to #f
rehearsalMark
to 1
markFormatter
to format-mark-letters
tupletNumberFormatFunction
to denominator-tuplet-formatter
fingeringOrientations
to '(up down)
harmonicAccidentals
to #t
pedalSostenutoStyle
to 'mixed
pedalSostenutoStrings
to '(Sost. Ped. *Sost. Ped. *)
pedalUnaCordaStyle
to 'text
pedalUnaCordaStrings
to '(una corda tre corde)
pedalSustainStyle
to 'text
pedalSustainStrings
to '(Ped. *Ped. *)
verticalAlignmentChildCallback
to Align_interface::alignment_callback
scriptDefinitions
to '((thumb (script-stencil feta thumb . thumb) (direction . 1)) (accent (script-stencil feta sforzato . sforzato) (side-relative-direction . -1)) (marcato (script-stencil feta dmarcato . umarcato) (side-relative-direction . -1)) (staccatissimo (script-stencil feta dstaccatissimo . ustaccatissimo) (side-relative-direction . -1)) (portato (script-stencil feta dportato . uportato) (side-relative-direction . -1)) (accentus (script-stencil feta uaccentus . uaccentus) (side-relative-direction . -1) (follow-into-staff . #t) (priority . -100) (direction . 1)) (ictus (script-stencil feta ictus . ictus) (side-relative-direction . -1) (follow-into-staff . #t) (priority . -100) (direction . -1)) (semicirculus (script-stencil feta dsemicirculus . dsemicirculus) (side-relative-direction . -1) (follow-into-staff . #t) (priority . -100) (direction . 1)) (circulus (script-stencil feta circulus . circulus) (side-relative-direction . -1) (follow-into-staff . #t) (priority . -100) (direction . 1)) (signumcongruentiae (script-stencil feta dsignumcongruentiae . usignumcongruentiae) (direction . 1)) (fermata (script-stencil feta dfermata . ufermata) (direction . 1)) (shortfermata (script-stencil feta dshortfermata . ushortfermata) (direction . 1)) (longfermata (script-stencil feta dlongfermata . ulongfermata) (direction . 1)) (verylongfermata (script-stencil feta dverylongfermata . uverylongfermata) (direction . 1)) (stopped (script-stencil feta stopped . stopped) (direction . 1)) (staccato (script-stencil feta staccato . staccato) (side-relative-direction . -1) (follow-into-staff . #t) (priority . -100)) (tenuto (script-stencil feta tenuto . tenuto) (follow-into-staff . #t) (side-relative-direction . -1)) (comma (script-stencil feta lcomma . rcomma) (follow-into-staff . #t) (direction . 1)) (varcomma (script-stencil feta lvarcomma . rvarcomma) (follow-into-staff . #t) (direction . 1)) (upbow (script-stencil feta upbow . upbow) (direction . 1)) (downbow (script-stencil feta downbow . downbow) (direction . 1)) (lheel (script-stencil feta upedalheel . upedalheel) (direction . -1)) (rheel (script-stencil feta dpedalheel . dpedalheel) (direction . 1)) (ltoe (script-stencil feta upedaltoe . upedaltoe) (direction . -1)) (rtoe (script-stencil feta dpedaltoe . dpedaltoe) (direction . 1)) (turn (script-stencil feta turn . turn) (direction . 1)) (open (script-stencil feta open . open) (direction . 1)) (flageolet (script-stencil feta flageolet . flageolet) (direction . 1)) (reverseturn (script-stencil feta reverseturn . reverseturn) (direction . 1)) (trill (script-stencil feta trill . trill) (direction . 1) (priority . 2000)) (prall (script-stencil feta prall . prall) (direction . 1)) (mordent (script-stencil feta mordent . mordent) (direction . 1)) (prallprall (script-stencil feta prallprall . prallprall) (direction . 1)) (prallmordent (script-stencil feta prallmordent . prallmordent) (direction . 1)) (upprall (script-stencil feta upprall . upprall) (direction . 1)) (downprall (script-stencil feta downprall . downprall) (direction . 1)) (upmordent (script-stencil feta upmordent . upmordent) (direction . 1)) (downmordent (script-stencil feta downmordent . downmordent) (direction . 1)) (lineprall (script-stencil feta lineprall . lineprall) (direction . 1)) (pralldown (script-stencil feta pralldown . pralldown) (direction . 1)) (prallup (script-stencil feta prallup . prallup) (direction . 1)) (segno (script-stencil feta segno . segno) (direction . 1)) (coda (script-stencil feta coda . coda) (direction . 1)) (varcoda (script-stencil feta varcoda . varcoda) (direction . 1)))
autoBeaming
to #t
autoBeamSettings
to '(((end * * 3 2) . #<Mom 1/2>) ((end 1 16 3 2) . #<Mom 1/4>) ((end 1 32 3 2) . #<Mom 1/8>) ((begin 1 8 3 4) . #<Mom 1/4>) ((end * * 3 4) . #<Mom 3/4>) ((begin 1 16 3 4) . #<Mom 1/16>) ((end 1 16 3 4) . #<Mom 1/4>) ((end 1 32 3 4) . #<Mom 1/8>) ((begin 1 16 3 8) . #<Mom 1/8>) ((end * * 3 8) . #<Mom 3/8>) ((end * * 4 4) . #<Mom 1/2>) ((end 1 12 4 4) . #<Mom 1/4>) ((end 1 16 4 4) . #<Mom 1/4>) ((end 1 32 4 4) . #<Mom 1/8>) ((end * * 2 4) . #<Mom 1/4>) ((end 1 12 2 4) . #<Mom 1/4>) ((end 1 16 2 4) . #<Mom 1/4>) ((end 1 32 2 4) . #<Mom 1/8>) ((end * * 4 8) . #<Mom 1/4>) ((end 1 16 4 8) . #<Mom 1/4>) ((end 1 32 4 8) . #<Mom 1/8>) ((end * * 4 16) . #<Mom 1/8>) ((end * * 6 8) . #<Mom 3/8>) ((end 1 16 6 8) . #<Mom 3/8>) ((end 1 32 6 8) . #<Mom 1/8>) ((end * * 9 8) . #<Mom 3/8>) ((end 1 16 9 8) . #<Mom 3/8>) ((end 1 32 9 8) . #<Mom 1/8>) ((end * * 12 8) . #<Mom 3/8>) ((end 1 16 12 8) . #<Mom 3/8>) ((end 1 32 12 8) . #<Mom 1/8>))
explicitKeySignatureVisibility
to all-visible
explicitClefVisibility
to all-visible
automaticBars
to #t
barNumberVisibility
to default-bar-number-visibility
defaultBarType
to |
middleCPosition
to -6
clefPosition
to -2
clefGlyph
to clefs-G
melismaBusyProperties
to '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy)
drumStyleTable
to '#(((cowbell triangle #f 5)) ((closedhihat cross stopped 3)) ((hightom () #f 4)) ((sidestick cross #f 1)) ((lowtom () #f -1)) ((ridebell () #f 5)) ((handclap triangle #f 1)) ((himidtom () #f 2)) ((crashcymbalb cross #f 5) (acousticbassdrum () #f -3)) ((hihat cross #f 3)) ((ridecymbala cross #f 5)) () ((openhihat cross open 3)) () ((electricsnare () #f 1)) ((crashcymbala xcircle #f 5)) ((vibraslap diamond #f 4) (bassdrum () #f -3)) ((highfloortom () #f -2)) ((ridecymbal cross #f 5)) ((acousticsnare () #f 1)) ((halfopenhihat xcircle #f 3)) ((splashcymbal diamond #f 5)) ((lowfloortom () #f -4)) ((crashcymbal xcircle #f 5)) ((ridecymbalb cross #f 5)) ((pedalhihat cross #f -5)) ((chinesecymbal mensural #f 5)) ((snare () #f 1)) ((lowmidtom () #f 0)))
systemStartDelimiter
to 'SystemStartBar
soloADue
to #t
aDueText
to a2
soloIIText
to Solo II
soloText
to Solo
localKeySignature
to '()
Context Score can contain FiguredBass, NoteNames, Devnull, PianoStaff, ChoirStaff, GrandStaff, ChordNames, Lyrics, DrumStaff, RhythmicStaff, StaffGroup, GregorianTranscriptionStaff, VaticanaStaff, TabStaff and Staff
This context is built from the following engravers:
Score_engraver
This engraver decides whether a column is breakable. The default is that a column is always breakable. However, when every Bar_engraver that does not have a barline at a certain point will call Score_engraver::forbid_breaks to stop linebreaks. In practice, this means that you can make a breakpoint by creating a barline (assuming that there are no beams or notes that prevent a breakpoint.)
Music types accepted:
Properties (read)
currentCommandColumn
(layout object)currentMusicalColumn
(layout object)Span_arpeggio_engraver
Properties (read)
connectArpeggios
(boolean)Bar_number_engraver
stavesFound
, which is maintained by Staff_collecting_engraver
.
Properties (read)
barNumberVisibility
(procedure)stavesFound
(list of grobs)currentBarNumber
(integer)Stanza_number_align_engraver
Vertical_align_engraver
This engraver creates the following layout objects:
VerticalAlignment.
Spacing_engraver
This engraver creates the following layout objects:
SpacingSpanner.
Break_align_engraver
This engraver creates the following layout objects:
BreakAlignGroup, BreakAlignment and LeftEdge.
Metronome_mark_engraver
stavesFound
property, which is maintained by Staff_collecting_engraver
.
Music types accepted:
Properties (read)
metronomeMarkFormatter
(procedure)stavesFound
(list of grobs)Mark_engraver
stavesFound
). If moving this engraver to a different context, Staff_collecting_engraver must move along, otherwise all marksend up on the same Y-location
Music types accepted:
Properties (read)
stavesFound
(list of grobs)markFormatter
(procedure)rehearsalMark
(integer)System_start_delimiter_engraver
Properties (read)
systemStartDelimiter
(symbol)SystemStartBrace
,
SystemStartBracket
or SystemStartBar
.
Output_property_engraver
Music types accepted:
Timing_engraver
Score
. In order to create polyrhythmic music, this engraver should be removed from Score
and placed in Staff
.
This engraver adds the alias Timing
to its containing context.
Properties (read)
currentBarNumber
(integer)measurePosition
(moment)measureLength
(moment)timing
(boolean)skipBars
(boolean)@lilypond[fragment,verbatim,center] r1 r1*3 R1*3 \\property Score.skipBars= ##t r1*3 R1*3 @end lilypond
defaultBarType
(string)whichBar
for information on available bar types.
This variable is read by Timing_engraver at
Score level.
barAlways
(boolean)whichBar
(string)Example:
\set Staff.whichBar = "|:"
This will create a start-repeat bar in this staff only.
Valid values are described in bar-line-interface.
automaticBars
(boolean)\bar
command. Unlike the \cadenza
keyword, measures
are still counted. Bar generation will resume according to that count
if this property is unset.
timeSignatureFraction
(pair of numbers)#'(4 . 4)
is a 4/4 time signature.
Staff_collecting_engraver
Properties (read)
stavesFound
(list of grobs)stavesFound
(list of grobs)Repeat_acknowledge_engraver
Properties (read)
whichBar
(string)Example:
\set Staff.whichBar = "|:"
This will create a start-repeat bar in this staff only.
Valid values are described in bar-line-interface.
repeatCommands
(list)(volta .
x)
, where x is a string or #f
Handles clefs, bar lines, keys, accidentals. It can contain
Voice
contexts.
This context creates the following layout objects:
Accidental, BarLine, Clef, DotColumn, InstrumentName, KeySignature, NoteCollision, OctavateEight, OttavaBracket, RestCollision, SeparatingGroupSpanner, SeparationItem, SostenutoPedalLineSpanner, SostenutoPedal, StaffSpacing, StaffSymbol, SustainPedalLineSpanner, SustainPedal, TimeSignature, UnaCordaPedalLineSpanner, UnaCordaPedal, VerticalAxisGroup and VoltaBracket.
This context sets the following properties:
instr
to '()
instrument
to '()
createSpacing
to #t
localKeySignature
to '()
verticalExtent
to #f
extraVerticalExtent
to #f
minimumVerticalExtent
to '(-6 . 6)
Context Staff can contain Voice
This context is built from the following engravers:
Engraver_group_engraver
String_number_engraver
Music types accepted:
Instrument_name_engraver
Staff.instrument
and Staff.instr
) at the left of the staff.
Properties (read)
instr
(markup)instrument
instrument
(markup)instrument
property labels the staff in the first system, and
the instr
property labels following lines.
Piano_pedal_engraver
Music types accepted:
Properties (read)
pedalUnaCordaStyle
(symbol)pedalSustainStyle
.
pedalSustainStyle
(symbol)text
, bracket
or mixed
(both).
pedalSostenutoStyle
(symbol)pedalSustainStyle
.
pedalUnaCordaStrings
(list)pedalSustainStrings
.
pedalSustainStrings
(list)pedalSostenutoStrings
(list)pedalSustainStrings
.
currentCommandColumn
(layout object)Accidental_engraver
Voice
level, so you can \override
them at Voice
.
Properties (read)
autoCautionaries
(list)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.
autoAccidentals
(list)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
-1
then the accidental is forget
immediately, and if laziness is #t
then the accidental
lasts forever.
extraNatural
(boolean)harmonicAccidentals
(boolean)localKeySignature
(list)localKeySignature
(list)Rest_collision_engraver
This engraver creates the following layout objects:
RestCollision.
Collision_engraver
This engraver creates the following layout objects:
NoteCollision.
Staff_symbol_engraver
This engraver creates the following layout objects:
StaffSymbol.
Time_signature_engraver
timeSignatureFraction
changes
This engraver creates the following layout objects:
TimeSignature.
Key_engraver
Music types accepted:
Properties (read)
keySignature
(list)keyAccidentalOrder
(list)createKeyOnClefChange
(boolean)explicitKeySignatureVisibility
(procedure)lastKeySignature
(list)printKeyCancellation
(boolean)keySignature
(list)keySignature
(list)tonic
(pitch)lastKeySignature
(list)Clef_engraver
Properties (read)
forceClef
(boolean)explicitClefVisibility
(procedure)clefOctavation
(integer)middleCPosition
(number)clefPosition
and
clefGlyph
.
clefGlyph
(string)clefPosition
(number)Ottava_spanner_engraver
Properties (read)
ottavation
(string)Dot_column_engraver
This engraver creates the following layout objects:
DotColumn.
Separating_line_group_engraver
Properties (read)
createSpacing
(boolean)breakableSeparationItem
(layout object)Volta_engraver
Properties (read)
stavesFound
(list of grobs)voltaSpannerDuration
(moment)\alternative
. This can be
used to shrink the length of brackets in the situation where one
alternative is very large.
repeatCommands
(list)(volta .
x)
, where x is a string or #f
Font_size_engraver
Properties (read)
fontSize
(number)Bar_engraver
whichBar
property. If it has no bar line to create, it will forbid a linebreak at this point
Properties (read)
whichBar
(string)Example:
\set Staff.whichBar = "|:"
This will create a start-repeat bar in this staff only. Valid values are described in bar-line-interface.
Output_property_engraver
Music types accepted:
Axis_group_engraver
Properties (read)
extraVerticalExtent
(pair of numbers)minimumVerticalExtent
(pair of numbers)verticalExtent
(pair of numbers)\set Staff.verticalExtent = #'(-5.0 . 5.0)
This does not work for Voice or any other context that doesn't form a vertical group.
Groups staffs while adding a bracket on the left side, grouping the staves together. The bar lines of the contained staves are connected vertically.
This context creates the following layout objects:
Arpeggio, SpanBar, SystemStartBar, SystemStartBrace and SystemStartBracket.
This context sets the following properties:
systemStartDelimiter
to 'SystemStartBracket
localKeySignature
to '()
Context StaffGroup can contain FiguredBass, InnerStaffGroup, ChoirStaff, InnerChoirStaff, ChordNames, Lyrics, TabStaff, PianoStaff, GrandStaff, DrumStaff, RhythmicStaff and Staff
This context is built from the following engravers:
Engraver_group_engraver
System_start_delimiter_engraver
Properties (read)
systemStartDelimiter
(symbol)SystemStartBrace
,
SystemStartBracket
or SystemStartBar
.
Output_property_engraver
Music types accepted:
Span_arpeggio_engraver
Properties (read)
connectArpeggios
(boolean)Span_bar_engraver
This engraver creates the following layout objects: SpanBar.
Context for generating tablature. [DOCME]
This context is also known as:
Staff
This context creates the following layout objects:
BarLine, Clef, DotColumn, InstrumentName, NoteCollision, OctavateEight, OttavaBracket, RestCollision, SeparatingGroupSpanner, SeparationItem, SostenutoPedalLineSpanner, SostenutoPedal, StaffSpacing, StaffSymbol, SustainPedalLineSpanner, SustainPedal, TimeSignature, UnaCordaPedalLineSpanner, UnaCordaPedal, VerticalAxisGroup and VoltaBracket.
This context sets the following properties:
clefPosition
to 0
clefGlyph
to clefs-tab
avoid-note-head
in Stem to #t
staff-space
in StaffSymbol to 1.5
instr
to '()
instrument
to '()
createSpacing
to #t
localKeySignature
to '()
verticalExtent
to #f
extraVerticalExtent
to #f
minimumVerticalExtent
to '(-6 . 6)
Context TabStaff can contain TabVoice
This context is built from the following engravers:
Engraver_group_engraver
Tab_staff_symbol_engraver
Properties (read)
stringTunings
(list)Instrument_name_engraver
Staff.instrument
and Staff.instr
) at the left of the staff.
Properties (read)
instr
(markup)instrument
instrument
(markup)instrument
property labels the staff in the first system, and
the instr
property labels following lines.
Piano_pedal_engraver
Music types accepted:
Properties (read)
pedalUnaCordaStyle
(symbol)pedalSustainStyle
.
pedalSustainStyle
(symbol)text
, bracket
or mixed
(both).
pedalSostenutoStyle
(symbol)pedalSustainStyle
.
pedalUnaCordaStrings
(list)pedalSustainStrings
.
pedalSustainStrings
(list)pedalSostenutoStrings
(list)pedalSustainStrings
.
currentCommandColumn
(layout object)Rest_collision_engraver
This engraver creates the following layout objects:
RestCollision.
Collision_engraver
This engraver creates the following layout objects:
NoteCollision.
Time_signature_engraver
timeSignatureFraction
changes
This engraver creates the following layout objects:
TimeSignature.
Clef_engraver
Properties (read)
forceClef
(boolean)explicitClefVisibility
(procedure)clefOctavation
(integer)middleCPosition
(number)clefPosition
and
clefGlyph
.
clefGlyph
(string)clefPosition
(number)Ottava_spanner_engraver
Properties (read)
ottavation
(string)Dot_column_engraver
This engraver creates the following layout objects:
DotColumn.
Separating_line_group_engraver
Properties (read)
createSpacing
(boolean)breakableSeparationItem
(layout object)Volta_engraver
Properties (read)
stavesFound
(list of grobs)voltaSpannerDuration
(moment)\alternative
. This can be
used to shrink the length of brackets in the situation where one
alternative is very large.
repeatCommands
(list)(volta .
x)
, where x is a string or #f
Font_size_engraver
Properties (read)
fontSize
(number)Bar_engraver
whichBar
property. If it has no bar line to create, it will forbid a linebreak at this point
Properties (read)
whichBar
(string)Example:
\set Staff.whichBar = "|:"
This will create a start-repeat bar in this staff only. Valid values are described in bar-line-interface.
Output_property_engraver
Music types accepted:
Axis_group_engraver
Properties (read)
extraVerticalExtent
(pair of numbers)minimumVerticalExtent
(pair of numbers)verticalExtent
(pair of numbers)\set Staff.verticalExtent = #'(-5.0 . 5.0)
This does not work for Voice or any other context that doesn't form a vertical group.
Context for drawing notes in a Tab staff.
This context creates the following layout objects:
Arpeggio, Beam, BreathingSign, ClusterSpannerBeacon, ClusterSpanner, CombineTextScript, Dots, DoublePercentRepeat, DynamicLineSpanner, DynamicText, Glissando, Hairpin, MultiMeasureRestNumber, MultiMeasureRestText, MultiMeasureRest, NoteColumn, NoteSpacing, PercentRepeat, PhrasingSlur, RepeatSlash, Rest, ScriptColumn, Script, Slur, StemTremolo, Stem, TabNoteHead, TextScript, TextSpanner, TieColumn, Tie, TupletBracket and VoiceFollower.
This context sets the following properties:
direction
in Slur to -1
print-function
in Slur to hammer-print-function
font-family
in Slur to 'roman
localKeySignature
to '()
This context is a `bottom' context; it can not contain other contexts.
This context is built from the following engravers:
Engraver_group_engraver
Tab_note_heads_engraver
Music types accepted:
busy-playing-event, string-number-event and note-event
Properties (read)
stringOneTopmost
(boolean)highStringOne
(boolean)tablatureFormat
(procedure)minimumFret
(number)stringTunings
(list)middleCPosition
(number)clefPosition
and
clefGlyph
.
Skip_event_swallow_translator
Music types accepted:
Tuplet_engraver
Music types accepted:
Properties (read)
tupletSpannerDuration
(moment)\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
.
tupletNumberFormatFunction
(procedure)Tie_engraver
Music types accepted:
Properties (read)
tieMelismaBusy
(boolean)Slur_engraver
Music types accepted:
Properties (read)
slurMelismaBusy
(boolean)Cluster_spanner_engraver
Music types accepted:
This engraver creates the following layout objects:
ClusterSpanner and ClusterSpannerBeacon.
Phrasing_slur_engraver
Music types accepted:
This engraver creates the following layout objects:
PhrasingSlur.
Rhythmic_column_engraver
This engraver creates the following layout objects:
NoteColumn and NoteSpacing.
Script_column_engraver
This engraver creates the following layout objects:
ScriptColumn.
Script_engraver
Music types accepted:
articulation-event and script-event
Properties (read)
scriptDefinitions
(list)Dynamic_engraver
Music types accepted:
decrescendo-event, crescendo-event and absolute-dynamic-event
This engraver creates the following layout objects:
DynamicLineSpanner, DynamicText, Hairpin and TextSpanner.
Text_engraver
Music types accepted:
This engraver creates the following layout objects:
TextScript.
Part_combine_engraver
Music types accepted:
Properties (read)
soloADue
(boolean)Melisma_translator
melismaBusy
, and signals it to the ddlyrics
code.
Music types accepted:
melisma-span-event and melisma-playing-event
Properties (read)
beamMelismaBusy
(boolean)tieMelismaBusy
(boolean)slurMelismaBusy
(boolean)melismaBusyProperties
(list)#'(melismaBusy beamMelismaBusy)
, only manual melismata and
manual beams are considered. Possible values include
melismaBusy
, slurMelismaBusy
, tieMelismaBusy
, and
beamMelismaBusy
melismaBusy
(boolean)Slash_repeat_engraver
Music types accepted:
Properties (read)
measureLength
(moment)Percent_repeat_engraver
Music types accepted:
Properties (read)
currentCommandColumn
(layout object)measureLength
(moment)Chord_tremolo_engraver
Music types accepted:
This engraver creates the following layout objects:
Beam.
Auto_beam_engraver
stemLeftBeamCount
and stemRightBeamCount
.
Music types accepted:
Properties (read)
subdivideBeams
(boolean)beatLength
(moment)autoBeamSettings
(list)autoBeaming
(boolean)Grace_beam_engraver
Music types accepted:
Properties (read)
subdivideBeams
(boolean)allowBeamBreak
(boolean)beatLength
(moment)beamMelismaBusy
(boolean)Beam_engraver
Music types accepted:
Properties (read)
subdivideBeams
(boolean)beatLength
(moment)beamMelismaBusy
(boolean)Stem_engraver
Music types accepted:
Properties (read)
stemRightBeamCount
(integer)stemLeftBeamCount
.
stemLeftBeamCount
(integer)tremoloFlags
(integer)Rest_engraver
Music types accepted:
Properties (read)
middleCPosition
(number)clefPosition
and
clefGlyph
.
Breathing_sign_engraver
Music types accepted:
This engraver creates the following layout objects:
BreathingSign.
Ligature_bracket_engraver
Music types accepted:
This engraver creates the following layout objects:
TupletBracket.
Glissando_engraver
Music types accepted:
Properties (read)
followVoice
(boolean)Note_head_line_engraver
Music types accepted:
Properties (read)
followVoice
(boolean)Forbid_line_break_engraver
Properties (read)
busyGrobs
(list)Grob_pq_engraver
Properties (read)
busyGrobs
(list)busyGrobs
(list)Text_spanner_engraver
Music types accepted:
This engraver creates the following layout objects:
TextSpanner.
Multi_measure_rest_engraver
R
. Reads measurePosition and currentBarNumber to determine what number to print over the MultiMeasureRest. Reads measureLength to determine if it should use a whole rest or a breve rest to represent 1 measure
Music types accepted:
multi-measure-text-event and multi-measure-rest-event
Properties (read)
measureLength
(moment)measurePosition
(moment)currentCommandColumn
(layout object)breakableSeparationItem
(layout object)restNumberThreshold
(number)currentBarNumber
(integer)Arpeggio_engraver
Music types accepted:
This engraver creates the following layout objects:
Arpeggio.
Output_property_engraver
Music types accepted:
Font_size_engraver
Properties (read)
fontSize
(number)Same as Staff
context, except that it is accommodated for tyepsetting Gregorian Chant in the notational style of Editio Vaticana.
This context is also known as:
Staff
This context creates the following layout objects:
Accidental, BarLine, Clef, Custos, DotColumn, InstrumentName, KeySignature, NoteCollision, OctavateEight, OttavaBracket, RestCollision, SeparatingGroupSpanner, SeparationItem, SostenutoPedalLineSpanner, SostenutoPedal, StaffSpacing, StaffSymbol, SustainPedalLineSpanner, SustainPedal, UnaCordaPedalLineSpanner, UnaCordaPedal, VerticalAxisGroup and VoltaBracket.
This context sets the following properties:
neutral-direction
in Custos to -1
neutral-position
in Custos to 3
style
in Custos to 'vaticana
style
in Accidental to 'vaticana
style
in KeySignature to 'vaticana
clefOctavation
to 0
clefPosition
to 1
middleCPosition
to 1
clefGlyph
to clefs-vaticana_do
thickness
in StaffSymbol to 0.6
line-count
in StaffSymbol to 4
transparent
in BarLine to #t
instr
to '()
instrument
to '()
createSpacing
to #t
localKeySignature
to '()
verticalExtent
to #f
extraVerticalExtent
to #f
minimumVerticalExtent
to '(-6 . 6)
Context VaticanaStaff can contain VaticanaVoice
This context is built from the following engravers:
Engraver_group_engraver
Custos_engraver
This engraver creates the following layout objects:
Custos.
String_number_engraver
Music types accepted:
Instrument_name_engraver
Staff.instrument
and Staff.instr
) at the left of the staff.
Properties (read)
instr
(markup)instrument
instrument
(markup)instrument
property labels the staff in the first system, and
the instr
property labels following lines.
Piano_pedal_engraver
Music types accepted:
Properties (read)
pedalUnaCordaStyle
(symbol)pedalSustainStyle
.
pedalSustainStyle
(symbol)text
, bracket
or mixed
(both).
pedalSostenutoStyle
(symbol)pedalSustainStyle
.
pedalUnaCordaStrings
(list)pedalSustainStrings
.
pedalSustainStrings
(list)pedalSostenutoStrings
(list)pedalSustainStrings
.
currentCommandColumn
(layout object)Accidental_engraver
Voice
level, so you can \override
them at Voice
.
Properties (read)
autoCautionaries
(list)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.
autoAccidentals
(list)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
-1
then the accidental is forget
immediately, and if laziness is #t
then the accidental
lasts forever.
extraNatural
(boolean)harmonicAccidentals
(boolean)localKeySignature
(list)localKeySignature
(list)Rest_collision_engraver
This engraver creates the following layout objects:
RestCollision.
Collision_engraver
This engraver creates the following layout objects:
NoteCollision.
Staff_symbol_engraver
This engraver creates the following layout objects:
StaffSymbol.
Key_engraver
Music types accepted:
Properties (read)
keySignature
(list)keyAccidentalOrder
(list)createKeyOnClefChange
(boolean)explicitKeySignatureVisibility
(procedure)lastKeySignature
(list)printKeyCancellation
(boolean)keySignature
(list)keySignature
(list)tonic
(pitch)lastKeySignature
(list)Clef_engraver
Properties (read)
forceClef
(boolean)explicitClefVisibility
(procedure)clefOctavation
(integer)middleCPosition
(number)clefPosition
and
clefGlyph
.
clefGlyph
(string)clefPosition
(number)Ottava_spanner_engraver
Properties (read)
ottavation
(string)Dot_column_engraver
This engraver creates the following layout objects:
DotColumn.
Separating_line_group_engraver
Properties (read)
createSpacing
(boolean)breakableSeparationItem
(layout object)Volta_engraver
Properties (read)
stavesFound
(list of grobs)voltaSpannerDuration
(moment)\alternative
. This can be
used to shrink the length of brackets in the situation where one
alternative is very large.
repeatCommands
(list)(volta .
x)
, where x is a string or #f
Font_size_engraver
Properties (read)
fontSize
(number)Bar_engraver
whichBar
property. If it has no bar line to create, it will forbid a linebreak at this point
Properties (read)
whichBar
(string)Example:
\set Staff.whichBar = "|:"
This will create a start-repeat bar in this staff only. Valid values are described in bar-line-interface.
Output_property_engraver
Music types accepted:
Axis_group_engraver
Properties (read)
extraVerticalExtent
(pair of numbers)minimumVerticalExtent
(pair of numbers)verticalExtent
(pair of numbers)\set Staff.verticalExtent = #'(-5.0 . 5.0)
This does not work for Voice or any other context that doesn't form a vertical group.
Same as Voice
context, except that it is accommodated for tyepsetting Gregorian Chant in the notational style of Editio Vaticana.
This context is also known as:
Voice
This context creates the following layout objects:
Arpeggio, Beam, BreathingSign, ClusterSpannerBeacon, ClusterSpanner, CombineTextScript, Dots, DoublePercentRepeat, DynamicLineSpanner, DynamicText, Fingering, Glissando, Hairpin, MultiMeasureRestNumber, MultiMeasureRestText, MultiMeasureRest, NoteColumn, NoteHead, NoteSpacing, PercentRepeat, PhrasingSlur, RepeatSlash, Rest, ScriptColumn, Script, TextScript, TextSpanner, TieColumn, Tie, TupletBracket, VaticanaLigature and VoiceFollower.
This context sets the following properties:
edge-text
in TextSpanner to '( . )
enclose-bounds
in TextSpanner to 1
padding
in TextSpanner to 0.5
edge-height
in TextSpanner to '(0 . 0)
style
in TextSpanner to 'line
autobeaming
to #f
padding
in Script to 0.5
style
in NoteHead to 'vaticana_punctum
localKeySignature
to '()
This context is a `bottom' context; it can not contain other contexts.
This context is built from the following engravers:
Engraver_group_engraver
Vaticana_ligature_engraver
Music types accepted:
This engraver creates the following layout objects:
VaticanaLigature.
Skip_event_swallow_translator
Music types accepted:
Tuplet_engraver
Music types accepted:
Properties (read)
tupletSpannerDuration
(moment)\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
.
tupletNumberFormatFunction
(procedure)Tie_engraver
Music types accepted:
Properties (read)
tieMelismaBusy
(boolean)Cluster_spanner_engraver
Music types accepted:
This engraver creates the following layout objects:
ClusterSpanner and ClusterSpannerBeacon.
Phrasing_slur_engraver
Music types accepted:
This engraver creates the following layout objects:
PhrasingSlur.
Rhythmic_column_engraver
This engraver creates the following layout objects:
NoteColumn and NoteSpacing.
Script_column_engraver
This engraver creates the following layout objects:
ScriptColumn.
Script_engraver
Music types accepted:
articulation-event and script-event
Properties (read)
scriptDefinitions
(list)Fingering_engraver
Music types accepted:
This engraver creates the following layout objects:
Fingering.
Dynamic_engraver
Music types accepted:
decrescendo-event, crescendo-event and absolute-dynamic-event
This engraver creates the following layout objects:
DynamicLineSpanner, DynamicText, Hairpin and TextSpanner.
Text_engraver
Music types accepted:
This engraver creates the following layout objects:
TextScript.
Part_combine_engraver
Music types accepted:
Properties (read)
soloADue
(boolean)Melisma_translator
melismaBusy
, and signals it to the ddlyrics
code.
Music types accepted:
melisma-span-event and melisma-playing-event
Properties (read)
beamMelismaBusy
(boolean)tieMelismaBusy
(boolean)slurMelismaBusy
(boolean)melismaBusyProperties
(list)#'(melismaBusy beamMelismaBusy)
, only manual melismata and
manual beams are considered. Possible values include
melismaBusy
, slurMelismaBusy
, tieMelismaBusy
, and
beamMelismaBusy
melismaBusy
(boolean)Slash_repeat_engraver
Music types accepted:
Properties (read)
measureLength
(moment)Percent_repeat_engraver
Music types accepted:
Properties (read)
currentCommandColumn
(layout object)measureLength
(moment)Chord_tremolo_engraver
Music types accepted:
This engraver creates the following layout objects:
Beam.
New_fingering_engraver
Properties (read)
fingeringOrientations
(list)Auto_beam_engraver
stemLeftBeamCount
and stemRightBeamCount
.
Music types accepted:
Properties (read)
subdivideBeams
(boolean)beatLength
(moment)autoBeamSettings
(list)autoBeaming
(boolean)Grace_beam_engraver
Music types accepted:
Properties (read)
subdivideBeams
(boolean)allowBeamBreak
(boolean)beatLength
(moment)beamMelismaBusy
(boolean)Beam_engraver
Music types accepted:
Properties (read)
subdivideBeams
(boolean)beatLength
(moment)beamMelismaBusy
(boolean)Rest_engraver
Music types accepted:
Properties (read)
middleCPosition
(number)clefPosition
and
clefGlyph
.
Note_heads_engraver
Music types accepted:
busy-playing-event and note-event
Properties (read)
middleCPosition
(number)clefPosition
and
clefGlyph
.
Breathing_sign_engraver
Music types accepted:
This engraver creates the following layout objects:
BreathingSign.
Glissando_engraver
Music types accepted:
Properties (read)
followVoice
(boolean)Note_head_line_engraver
Music types accepted:
Properties (read)
followVoice
(boolean)Forbid_line_break_engraver
Properties (read)
busyGrobs
(list)Grob_pq_engraver
Properties (read)
busyGrobs
(list)busyGrobs
(list)Text_spanner_engraver
Music types accepted:
This engraver creates the following layout objects:
TextSpanner.
Multi_measure_rest_engraver
R
. Reads measurePosition and currentBarNumber to determine what number to print over the MultiMeasureRest. Reads measureLength to determine if it should use a whole rest or a breve rest to represent 1 measure
Music types accepted:
multi-measure-text-event and multi-measure-rest-event
Properties (read)
measureLength
(moment)measurePosition
(moment)currentCommandColumn
(layout object)breakableSeparationItem
(layout object)restNumberThreshold
(number)currentBarNumber
(integer)Arpeggio_engraver
Music types accepted:
This engraver creates the following layout objects:
Arpeggio.
Output_property_engraver
Music types accepted:
Font_size_engraver
Properties (read)
fontSize
(number)Corresponds to a voice on a staff. This context handles the conversion of dynamic signs, stems, beams, super- and subscripts, slurs, ties, and rests.
You have to instantiate this explicitly if you want to have multiple voices on the same staff.
This context creates the following layout objects:
Arpeggio, Beam, BreathingSign, ClusterSpannerBeacon, ClusterSpanner, CombineTextScript, Dots, DoublePercentRepeat, DynamicLineSpanner, DynamicText, Fingering, Glissando, Hairpin, MultiMeasureRestNumber, MultiMeasureRestText, MultiMeasureRest, NoteColumn, NoteHead, NoteSpacing, PercentRepeat, PhrasingSlur, RepeatSlash, Rest, ScriptColumn, Script, Slur, StemTremolo, Stem, TextScript, TextSpanner, TieColumn, Tie, TupletBracket and VoiceFollower.
This context sets the following properties:
localKeySignature
to '()
This context is a `bottom' context; it can not contain other contexts.
This context is built from the following engravers:
Engraver_group_engraver
Skip_event_swallow_translator
Music types accepted:
Tuplet_engraver
Music types accepted:
Properties (read)
tupletSpannerDuration
(moment)\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
.
tupletNumberFormatFunction
(procedure)Tie_engraver
Music types accepted:
Properties (read)
tieMelismaBusy
(boolean)Slur_engraver
Music types accepted:
Properties (read)
slurMelismaBusy
(boolean)Cluster_spanner_engraver
Music types accepted:
This engraver creates the following layout objects:
ClusterSpanner and ClusterSpannerBeacon.
Phrasing_slur_engraver
Music types accepted:
This engraver creates the following layout objects:
PhrasingSlur.
Rhythmic_column_engraver
This engraver creates the following layout objects:
NoteColumn and NoteSpacing.
Script_column_engraver
This engraver creates the following layout objects:
ScriptColumn.
Script_engraver
Music types accepted:
articulation-event and script-event
Properties (read)
scriptDefinitions
(list)Fingering_engraver
Music types accepted:
This engraver creates the following layout objects:
Fingering.
Dynamic_engraver
Music types accepted:
decrescendo-event, crescendo-event and absolute-dynamic-event
This engraver creates the following layout objects:
DynamicLineSpanner, DynamicText, Hairpin and TextSpanner.
Text_engraver
Music types accepted:
This engraver creates the following layout objects:
TextScript.
Part_combine_engraver
Music types accepted:
Properties (read)
soloADue
(boolean)Melisma_translator
melismaBusy
, and signals it to the ddlyrics
code.
Music types accepted:
melisma-span-event and melisma-playing-event
Properties (read)
beamMelismaBusy
(boolean)tieMelismaBusy
(boolean)slurMelismaBusy
(boolean)melismaBusyProperties
(list)#'(melismaBusy beamMelismaBusy)
, only manual melismata and
manual beams are considered. Possible values include
melismaBusy
, slurMelismaBusy
, tieMelismaBusy
, and
beamMelismaBusy
melismaBusy
(boolean)Slash_repeat_engraver
Music types accepted:
Properties (read)
measureLength
(moment)Percent_repeat_engraver
Music types accepted:
Properties (read)
currentCommandColumn
(layout object)measureLength
(moment)Chord_tremolo_engraver
Music types accepted:
This engraver creates the following layout objects:
Beam.
New_fingering_engraver
Properties (read)
fingeringOrientations
(list)Auto_beam_engraver
stemLeftBeamCount
and stemRightBeamCount
.
Music types accepted:
Properties (read)
subdivideBeams
(boolean)beatLength
(moment)autoBeamSettings
(list)autoBeaming
(boolean)Grace_beam_engraver
Music types accepted:
Properties (read)
subdivideBeams
(boolean)allowBeamBreak
(boolean)beatLength
(moment)beamMelismaBusy
(boolean)Beam_engraver
Music types accepted:
Properties (read)
subdivideBeams
(boolean)beatLength
(moment)beamMelismaBusy
(boolean)Stem_engraver
Music types accepted:
Properties (read)
stemRightBeamCount
(integer)stemLeftBeamCount
.
stemLeftBeamCount
(integer)tremoloFlags
(integer)Rest_engraver
Music types accepted:
Properties (read)
middleCPosition
(number)clefPosition
and
clefGlyph
.
Note_heads_engraver
Music types accepted:
busy-playing-event and note-event
Properties (read)
middleCPosition
(number)clefPosition
and
clefGlyph
.
Breathing_sign_engraver
Music types accepted:
This engraver creates the following layout objects:
BreathingSign.
Ligature_bracket_engraver
Music types accepted:
This engraver creates the following layout objects:
TupletBracket.
Glissando_engraver
Music types accepted:
Properties (read)
followVoice
(boolean)Note_head_line_engraver
Music types accepted:
Properties (read)
followVoice
(boolean)Forbid_line_break_engraver
Properties (read)
busyGrobs
(list)Grob_pq_engraver
Properties (read)
busyGrobs
(list)busyGrobs
(list)Text_spanner_engraver
Music types accepted:
This engraver creates the following layout objects:
TextSpanner.
Multi_measure_rest_engraver
R
. Reads measurePosition and currentBarNumber to determine what number to print over the MultiMeasureRest. Reads measureLength to determine if it should use a whole rest or a breve rest to represent 1 measure
Music types accepted:
multi-measure-text-event and multi-measure-rest-event
Properties (read)
measureLength
(moment)measurePosition
(moment)currentCommandColumn
(layout object)breakableSeparationItem
(layout object)restNumberThreshold
(number)currentBarNumber
(integer)Arpeggio_engraver
Music types accepted:
This engraver creates the following layout objects:
Arpeggio.
Output_property_engraver
Music types accepted:
Font_size_engraver
Properties (read)
fontSize
(number)Make accidentals. Catches note heads, ties and notices key-change events. This engraver usually lives at Staff level, but reads the settings for Accidental at Voice
level, so you can \override
them at Voice
.
Properties (read)
autoCautionaries
(list)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.
autoAccidentals
(list)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
-1
then the accidental is forget
immediately, and if laziness is #t
then the accidental
lasts forever.
extraNatural
(boolean)harmonicAccidentals
(boolean)localKeySignature
(list)localKeySignature
(list)Accidental_engraver
is part of contexts: GregorianTranscriptionStaff, Staff and VaticanaStaff
This engraver creates the following layout objects: Ambitus.
Ambitus_engraver
is part of contexts: none
Generate an Arpeggio from a Arpeggio_req
Music types accepted:
This engraver creates the following layout objects: Arpeggio.
Arpeggio_engraver
is part of contexts: GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Generate beams based on measure characteristics and observed Stems. Uses beatLength, measureLength and measurePosition to decide when to start and stop a beam. Overriding beaming is done through Stem_engraver properties stemLeftBeamCount
and stemRightBeamCount
.
Music types accepted:
Properties (read)
subdivideBeams
(boolean)beatLength
(moment)autoBeamSettings
(list)autoBeaming
(boolean)Auto_beam_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Group all objects created in this context in a VerticalAxisGroup spanner.
Properties (read)
extraVerticalExtent
(pair of numbers)minimumVerticalExtent
(pair of numbers)verticalExtent
(pair of numbers)\set Staff.verticalExtent = #'(-5.0 . 5.0)
This does not work for Voice or any other context that doesn't form a vertical group.
Axis_group_engraver
is part of contexts: DrumStaff, GregorianTranscriptionStaff, NoteNames, RhythmicStaff, Staff, TabStaff and VaticanaStaff
Create barlines. This engraver is controlled through the whichBar
property. If it has no bar line to create, it will forbid a linebreak at this point
Properties (read)
whichBar
(string)Example:
\set Staff.whichBar = "|:"
This will create a start-repeat bar in this staff only. Valid values are described in bar-line-interface.
Bar_engraver
is part of contexts: DrumStaff, GregorianTranscriptionStaff, RhythmicStaff, Staff, TabStaff and VaticanaStaff
A bar number is created whenever measurePosition is zero. It is
put on top of all staves, and appears only at left side of the staff. The staves are taken from stavesFound
, which is maintained by Staff_collecting_engraver
.
Properties (read)
barNumberVisibility
(procedure)stavesFound
(list of grobs)currentBarNumber
(integer)Bar_number_engraver
is part of contexts: Score
Handles Beam events by engraving Beams. If omitted, then notes will be printed with flags instead of beams.
Music types accepted:
Properties (read)
subdivideBeams
(boolean)beatLength
(moment)beamMelismaBusy
(boolean)Beam_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Music types accepted:
Beam_performer
is part of contexts: none
Align grobs with corresponding break-align-symbols into groups, and order the groups according to breakAlignOrder
This engraver creates the following layout objects: BreakAlignGroup, BreakAlignment and LeftEdge.
Break_align_engraver
is part of contexts: Score
Music types accepted:
This engraver creates the following layout objects: BreathingSign.
Breathing_sign_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Catch note-events and generate the appropriate chordname.
Music types accepted:
Properties (read)
majorSevenSymbol
(markup)chordNameExceptions
(list)chordRootNamer
(procedure)chordNoteNamer
(procedure)chordNameFunction
(procedure)chordNameExceptions
(list)chordChanges
(boolean)Chord_name_engraver
is part of contexts: ChordNames
Generates beams for tremolo repeats.
Music types accepted:
This engraver creates the following layout objects: Beam.
Chord_tremolo_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Determine and set reference point for pitches
Properties (read)
forceClef
(boolean)explicitClefVisibility
(procedure)clefOctavation
(integer)middleCPosition
(number)clefPosition
and
clefGlyph
.
clefGlyph
(string)clefPosition
(number)Clef_engraver
is part of contexts: DrumStaff, GregorianTranscriptionStaff, Staff, TabStaff and VaticanaStaff
Engraves a cluster using Spanner notation
Music types accepted:
This engraver creates the following layout objects: ClusterSpanner and ClusterSpannerBeacon.
Cluster_spanner_engraver
is part of contexts: GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
This is an abstract class. Subclasses such as Gregorian_ligature_engraver handle ligatures by glueing special ligature heads together.
Music types accepted:
Coherent_ligature_engraver
is part of contexts: none
This engraver creates the following layout objects: NoteCollision.
Collision_engraver
is part of contexts: DrumStaff, GregorianTranscriptionStaff, Staff, TabStaff and VaticanaStaff
This engraver replaces Note_heads_engraver
. It plays some trickery to break long notes and automatically tie them into the next measure.
Music types accepted:
note-event and busy-playing-event
Properties (read)
measureLength
(moment)measurePosition
(moment)middleCPosition
(number)clefPosition
and
clefGlyph
.
Completion_heads_engraver
is part of contexts: none
This engraver creates the following layout objects: Custos.
Custos_engraver
is part of contexts: VaticanaStaff
Engraves dots on dotted notes shifted to the right of the note. If omitted, then dots appear on top of the notes.
This engraver creates the following layout objects: DotColumn.
Dot_column_engraver
is part of contexts: DrumStaff, GregorianTranscriptionStaff, RhythmicStaff, Staff, TabStaff and VaticanaStaff
Play drum notes.
Music types accepted:
busy-playing-event and note-event
Drum_note_performer
is part of contexts: none
Generate noteheads.
Music types accepted:
busy-playing-event and note-event
Properties (read)
drumStyleTable
(hash table)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.
Drum_notes_engraver
is part of contexts: DrumVoice
This engraver creates hairpins, dynamic texts, and their vertical alignments. The symbols are collected onto a DynamicLineSpanner grob which takes care of vertical positioning.
Music types accepted:
decrescendo-event, crescendo-event and absolute-dynamic-event
This engraver creates the following layout objects: DynamicLineSpanner, DynamicText, Hairpin and TextSpanner.
Dynamic_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Music types accepted:
Properties (read)
instrumentEqualizer
(procedure)midiInstrument
(string)midiMinimumVolume
(number)midiMaximumVolume
(number)midiMinimumVolume
.
dynamicAbsoluteVolumeFunction
(procedure)Dynamic_performer
is part of contexts: none
Engraver
is part of contexts: none
A group of engravers taken together
Engraver_group_engraver
is part of contexts: ChoirStaff, ChordNames, Devnull, DrumStaff, DrumVoice, FiguredBass, GrandStaff, GregorianTranscriptionStaff, GregorianTranscriptionVoice, InnerChoirStaff, InnerStaffGroup, Lyrics, NoteNames, PianoStaff, RhythmicStaff, Staff, StaffGroup, TabStaff, TabVoice, VaticanaStaff, VaticanaVoice and Voice
Create lyric extenders
Music types accepted:
This engraver creates the following layout objects: LyricExtender.
Extender_engraver
is part of contexts: Lyrics
Make figured bass numbers.
Music types accepted:
bass-figure-event and rest-event
Properties (read)
bassFigureFormatFunction
(procedure)BassFigure
grob. It takes a
list of BassFigureEvent
s, a context, and the grob to format.
Figured_bass_engraver
is part of contexts: FiguredBass
Create fingering-scripts
Music types accepted:
This engraver creates the following layout objects: Fingering.
Fingering_engraver
is part of contexts: GregorianTranscriptionVoice, VaticanaVoice and Voice
Puts fontSize into font-relative-size grob property.
Properties (read)
fontSize
(number)Font_size_engraver
is part of contexts: DrumStaff, DrumVoice, GregorianTranscriptionStaff, GregorianTranscriptionVoice, Lyrics, Staff, TabStaff, TabVoice, VaticanaStaff, VaticanaVoice and Voice
Forbid line breaks when note heads are still playing at some point.
Properties (read)
busyGrobs
(list)Forbid_line_break_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Engrave a glissandi
Music types accepted:
Properties (read)
followVoice
(boolean)Glissando_engraver
is part of contexts: GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Handles Beam events by engraving Beams. If omitted, then notes will be printed with flags instead of beams. Only engraves beams when we are at grace points in time.
Music types accepted:
Properties (read)
subdivideBeams
(boolean)allowBeamBreak
(boolean)beatLength
(moment)beamMelismaBusy
(boolean)Grace_beam_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
This is an abstract class. Subclasses such as Vaticana_ligature_engraver handle ligatures by glueing special ligature heads together.
Music types accepted:
Gregorian_ligature_engraver
is part of contexts: none
Administrate when certain grobs (eg. note heads) stop playing; this engraver is a sort-of a failure, since it doesn't handle all sorts of borderline cases very well.
Properties (read)
busyGrobs
(list)busyGrobs
(list)Grob_pq_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Like Axis_group_engraver, but make a hara-kiri spanner, and add interesting items (ie. note heads, lyric syllables and normal rests)
This engraver creates the following layout objects: RemoveEmptyVerticalGroup.
Hara_kiri_engraver
is part of contexts: ChordNames, FiguredBass and Lyrics
Create horizontal brackets over notes for musical analysis purposes.
Music types accepted:
This engraver creates the following layout objects: HorizontalBracket.
Horizontal_bracket_engraver
is part of contexts: none
Create lyric hyphens
Music types accepted:
This engraver creates the following layout objects: LyricHyphen.
Hyphen_engraver
is part of contexts: Lyrics
Prints the name of the instrument (specified by Staff.instrument
and Staff.instr
) at the left of the staff.
Properties (read)
instr
(markup)instrument
instrument
(markup)instrument
property labels the staff in the first system, and
the instr
property labels following lines.
Instrument_name_engraver
is part of contexts: DrumStaff, GregorianTranscriptionStaff, PianoStaff, RhythmicStaff, Staff, TabStaff and VaticanaStaff
Music types accepted:
Properties (read)
keySignature
(list)keyAccidentalOrder
(list)createKeyOnClefChange
(boolean)explicitKeySignatureVisibility
(procedure)lastKeySignature
(list)printKeyCancellation
(boolean)keySignature
(list)keySignature
(list)tonic
(pitch)lastKeySignature
(list)Key_engraver
is part of contexts: GregorianTranscriptionStaff, Staff and VaticanaStaff
Music types accepted:
Key_performer
is part of contexts: none
Handles Ligature_events by engraving Ligature brackets.
Music types accepted:
This engraver creates the following layout objects: TupletBracket.
Ligature_bracket_engraver
is part of contexts: GregorianTranscriptionVoice, TabVoice and Voice
Abstract class; a concrete subclass handles Ligature_events by engraving Ligatures in a concrete style.
Music types accepted:
Ligature_engraver
is part of contexts: none
Music types accepted:
This engraver creates the following layout objects: LyricText.
Lyric_engraver
is part of contexts: Lyrics
Music types accepted:
Lyric_performer
is part of contexts: none
This engraver will create RehearsalMark objects. It puts them on top of all staves (which is taken from the property stavesFound
). If moving this engraver to a different context, Staff_collecting_engraver must move along, otherwise all marksend up on the same Y-location
Music types accepted:
Properties (read)
stavesFound
(list of grobs)markFormatter
(procedure)rehearsalMark
(integer)Mark_engraver
is part of contexts: Score
Creates Measure_grouping objects using beatGrouping property
Properties (read)
currentMusicalColumn
(layout object)measurePosition
(moment)beatLength
(moment)beatGrouping
(list)'(2
3)
.
Measure_grouping_engraver
is part of contexts: none
This translator collects melisma information about ties, beams, and user settings (melismaBusy
, and signals it to the ddlyrics
code.
Music types accepted:
melisma-span-event and melisma-playing-event
Properties (read)
beamMelismaBusy
(boolean)tieMelismaBusy
(boolean)slurMelismaBusy
(boolean)melismaBusyProperties
(list)#'(melismaBusy beamMelismaBusy)
, only manual melismata and
manual beams are considered. Possible values include
melismaBusy
, slurMelismaBusy
, tieMelismaBusy
, and
beamMelismaBusy
melismaBusy
(boolean)Melisma_translator
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Handles Mensural_ligature_events by glueing special ligature heads together.
Music types accepted:
This engraver creates the following layout objects: MensuralLigature.
Mensural_ligature_engraver
is part of contexts: none
Engrave metro nome marking. This delegates the formatting work to the function in the metronomeMarkFormatter property. The mark is put over all staves. The staves are taken from the stavesFound
property, which is maintained by Staff_collecting_engraver
.
Music types accepted:
Properties (read)
metronomeMarkFormatter
(procedure)stavesFound
(list of grobs)Metronome_mark_engraver
is part of contexts: Score
Engraves multi-measure rests that are produced with R
. Reads measurePosition and currentBarNumber to determine what number to print over the MultiMeasureRest. Reads measureLength to determine if it should use a whole rest or a breve rest to represent 1 measure
Music types accepted:
multi-measure-text-event and multi-measure-rest-event
Properties (read)
measureLength
(moment)measurePosition
(moment)currentCommandColumn
(layout object)breakableSeparationItem
(layout object)restNumberThreshold
(number)currentBarNumber
(integer)Multi_measure_rest_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Create fingering-scripts for notes in a new chord. This engraver is ill-named, since it also takes care of articulations and harmonic note heads
Properties (read)
fingeringOrientations
(list)New_fingering_engraver
is part of contexts: GregorianTranscriptionVoice, VaticanaVoice and Voice
Engrave a line between two note heads, for example a glissando. If followVoice is set, staff switches also generate a line.
Music types accepted:
Properties (read)
followVoice
(boolean)Note_head_line_engraver
is part of contexts: GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Generate noteheads.
Music types accepted:
busy-playing-event and note-event
Properties (read)
middleCPosition
(number)clefPosition
and
clefGlyph
.
Note_heads_engraver
is part of contexts: GregorianTranscriptionVoice, VaticanaVoice and Voice
Music types accepted:
Properties (read)
printOctaveNames
(boolean)Note_name_engraver
is part of contexts: NoteNames
Music types accepted:
busy-playing-event and note-event
Note_performer
is part of contexts: none
Swallow notes
Music types accepted:
Note_swallow_translator
is part of contexts: FiguredBass
Create a text spanner when the ottavation property changes..
Properties (read)
ottavation
(string)Ottava_spanner_engraver
is part of contexts: GregorianTranscriptionStaff, Staff, TabStaff and VaticanaStaff
Interpret Music of Output_property type, and apply a function to any Graphic objects that satisfies the predicate.
Music types accepted:
Output_property_engraver
is part of contexts: ChordNames, DrumStaff, DrumVoice, GregorianTranscriptionStaff, GregorianTranscriptionVoice, InnerStaffGroup, RhythmicStaff, Score, Staff, StaffGroup, TabStaff, TabVoice, VaticanaStaff, VaticanaVoice and Voice
Part combine engraver for orchestral scores: Print markings a2, Solo, Solo II, and unisono
Music types accepted:
Properties (read)
soloADue
(boolean)Part_combine_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Make whole bar and double bar repeats.
Music types accepted:
Properties (read)
currentCommandColumn
(layout object)measureLength
(moment)Percent_repeat_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Performer_group_performer
is part of contexts: none
Print phrasing slurs. Similar to Slur_engraver
Music types accepted:
This engraver creates the following layout objects: PhrasingSlur.
Phrasing_slur_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Engrave piano pedal symbols and brackets.
Music types accepted:
Properties (read)
pedalUnaCordaStyle
(symbol)pedalSustainStyle
.
pedalSustainStyle
(symbol)text
, bracket
or mixed
(both).
pedalSostenutoStyle
(symbol)pedalSustainStyle
.
pedalUnaCordaStrings
(list)pedalSustainStrings
.
pedalSustainStrings
(list)pedalSostenutoStrings
(list)pedalSustainStrings
.
currentCommandColumn
(layout object)Piano_pedal_engraver
is part of contexts: GregorianTranscriptionStaff, Staff, TabStaff and VaticanaStaff
Music types accepted:
Piano_pedal_performer
is part of contexts: none
Set the vertical position of noteheads to squashedPosition
, if that property is set. This can be used to make a single line staff demonstrating the rhythm of a melody.
Properties (read)
squashedPosition
(integer)Pitch_squash_engraver
is part of contexts: RhythmicStaff
Engraver_group_engraver that records all music events for this context. Calls the procedure in recordEventSequence
when finished.
Properties (read)
recordEventSequence
(procedure)Recording_group_engraver
is part of contexts: none
Acknowledge repeated music, and convert the contents of repeatCommands ainto an appropriate setting for whichBar.
Properties (read)
whichBar
(string)Example:
\set Staff.whichBar = "|:"
This will create a start-repeat bar in this staff only.
Valid values are described in bar-line-interface.
repeatCommands
(list)(volta .
x)
, where x is a string or #f
Repeat_acknowledge_engraver
is part of contexts: Score
Handles collisions of rests.
This engraver creates the following layout objects: RestCollision.
Rest_collision_engraver
is part of contexts: DrumStaff, GregorianTranscriptionStaff, Staff, TabStaff and VaticanaStaff
Music types accepted:
Properties (read)
middleCPosition
(number)clefPosition
and
clefGlyph
.
Rest_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Swallow rest
Music types accepted:
Rest_swallow_translator
is part of contexts: ChordNames, FiguredBass and NoteNames
Generates NoteColumn, an objects that groups stems, noteheads and rests.
This engraver creates the following layout objects: NoteColumn and NoteSpacing.
Rhythmic_column_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Top level engraver. Takes care of generating columns and the complete system (ie. System)
This engraver decides whether a column is breakable. The default is that a column is always breakable. However, when every Bar_engraver that does not have a barline at a certain point will call Score_engraver::forbid_breaks to stop linebreaks. In practice, this means that you can make a breakpoint by creating a barline (assuming that there are no beams or notes that prevent a breakpoint.)
Music types accepted:
Properties (read)
currentCommandColumn
(layout object)currentMusicalColumn
(layout object)Score_engraver
is part of contexts: Score
Score_performer
is part of contexts: none
This engraver creates the following layout objects: ScriptColumn.
Script_column_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Handles note scripted articulations.
Music types accepted:
articulation-event and script-event
Properties (read)
scriptDefinitions
(list)Script_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Generates objects for computing spacing parameters.
Properties (read)
createSpacing
(boolean)breakableSeparationItem
(layout object)Separating_line_group_engraver
is part of contexts: ChordNames, DrumStaff, FiguredBass, GregorianTranscriptionStaff, Lyrics, NoteNames, RhythmicStaff, Staff, TabStaff and VaticanaStaff
Swallow \skip.
Music types accepted:
Skip_event_swallow_translator
is part of contexts: ChordNames, DrumVoice, FiguredBass, GregorianTranscriptionVoice, Lyrics, NoteNames, TabVoice, VaticanaVoice and Voice
Make beat repeats.
Music types accepted:
Properties (read)
measureLength
(moment)Slash_repeat_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Build slurs from Slur_evs
Music types accepted:
Properties (read)
slurMelismaBusy
(boolean)Slur_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice and Voice
Music types accepted:
Slur_performer
is part of contexts: none
make a SpacingSpanner and do bookkeeping of shortest starting and playing notes
This engraver creates the following layout objects: SpacingSpanner.
Spacing_engraver
is part of contexts: Score
Properties (read)
connectArpeggios
(boolean)Span_arpeggio_engraver
is part of contexts: GrandStaff, InnerStaffGroup, PianoStaff, Score and StaffGroup
This engraver makes cross-staff barlines: It catches all normal bar lines, and draws a single span-bar across them.
This engraver creates the following layout objects: SpanBar.
Span_bar_engraver
is part of contexts: GrandStaff, InnerStaffGroup, PianoStaff and StaffGroup
Music types accepted:
decrescendo-event and crescendo-event
Span_dynamic_performer
is part of contexts: none
Maintain the stavesFound variable
Properties (read)
stavesFound
(list of grobs)stavesFound
(list of grobs)Staff_collecting_engraver
is part of contexts: Score
Staff_performer
is part of contexts: none
Create the constellation of five (default) staff lines.
This engraver creates the following layout objects: StaffSymbol.
Staff_symbol_engraver
is part of contexts: DrumStaff, GregorianTranscriptionStaff, RhythmicStaff, Staff and VaticanaStaff
This engraver ensures that stanza numbers are neatly aligned.
Stanza_number_align_engraver
is part of contexts: Score
Properties (read)
stanza
(markup)Stanza_number_engraver
is part of contexts: Lyrics
Create stems and single-stem tremolos. It also works together with the beam engraver for overriding beaming.
Music types accepted:
Properties (read)
stemRightBeamCount
(integer)stemLeftBeamCount
.
stemLeftBeamCount
(integer)tremoloFlags
(integer)Stem_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice and Voice
Swallow string-number-events - the purpose of this engraver is to process tab for normal notation. To provent warnings for unprocessed string-number-event to obscure real error messages, this engraver swallows them all.
Music types accepted:
String_number_engraver
is part of contexts: GregorianTranscriptionStaff, Staff and VaticanaStaff
This engraver swallows everything given to it silently. The purpose of this is to prevent spurious "event junked" warnings.
Music types accepted:
Swallow_engraver
is part of contexts: Devnull
Music types accepted:
Swallow_performer
is part of contexts: none
Creates a system start delimiter (ie. SystemStart{Bar,Brace,Bracket} spanner
Properties (read)
systemStartDelimiter
(symbol)SystemStartBrace
,
SystemStartBracket
or SystemStartBar
.
System_start_delimiter_engraver
is part of contexts: ChoirStaff, GrandStaff, InnerChoirStaff, InnerStaffGroup, PianoStaff, Score and StaffGroup
Generate one or more tablature noteheads from Music of type NoteEvent.
Music types accepted:
busy-playing-event, string-number-event and note-event
Properties (read)
stringOneTopmost
(boolean)highStringOne
(boolean)tablatureFormat
(procedure)minimumFret
(number)stringTunings
(list)middleCPosition
(number)clefPosition
and
clefGlyph
.
Tab_note_heads_engraver
is part of contexts: TabVoice
Create a staff-symbol, but look at stringTunings for the number of lines.staff lines.
Properties (read)
stringTunings
(list)Tab_staff_symbol_engraver
is part of contexts: TabStaff
Music types accepted:
Tempo_performer
is part of contexts: none
Create text-scripts
Music types accepted:
This engraver creates the following layout objects: TextScript.
Text_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Create text spanner from a Music.
Music types accepted:
This engraver creates the following layout objects: TextSpanner.
Text_spanner_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Generate ties between noteheads of equal pitch.
Music types accepted:
Properties (read)
tieMelismaBusy
(boolean)Tie_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, NoteNames, TabVoice, VaticanaVoice and Voice
Generate ties between noteheads of equal pitch.
Music types accepted:
Properties (read)
tieMelismaBusy
(boolean)Tie_performer
is part of contexts: none
Create a TimeSignature whenever timeSignatureFraction
changes
This engraver creates the following layout objects: TimeSignature.
Time_signature_engraver
is part of contexts: DrumStaff, GregorianTranscriptionStaff, RhythmicStaff, Staff and TabStaff
Time_signature_performer
is part of contexts: none
Responsible for synchronizing timing information from staves. Normally in Score
. In order to create polyrhythmic music, this engraver should be removed from Score
and placed in Staff
.
This engraver adds the alias Timing
to its containing context.
Properties (read)
currentBarNumber
(integer)measurePosition
(moment)measureLength
(moment)timing
(boolean)skipBars
(boolean)@lilypond[fragment,verbatim,center] r1 r1*3 R1*3 \\property Score.skipBars= ##t r1*3 R1*3 @end lilypond
defaultBarType
(string)whichBar
for information on available bar types.
This variable is read by Timing_engraver at
Score level.
barAlways
(boolean)whichBar
(string)Example:
\set Staff.whichBar = "|:"
This will create a start-repeat bar in this staff only.
Valid values are described in bar-line-interface.
automaticBars
(boolean)\bar
command. Unlike the \cadenza
keyword, measures
are still counted. Bar generation will resume according to that count
if this property is unset.
timeSignatureFraction
(pair of numbers)#'(4 . 4)
is a 4/4 time signature.
Timing_engraver
is part of contexts: Score
This engraver adds the alias Timing
to its containing context.
Timing_translator
is part of contexts: none
Catch Time_scaled_music and generate appropriate bracket
Music types accepted:
Properties (read)
tupletSpannerDuration
(moment)\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
.
tupletNumberFormatFunction
(procedure)Tuplet_engraver
is part of contexts: DrumVoice, GregorianTranscriptionVoice, TabVoice, VaticanaVoice and Voice
Handles ligatures by glueing special ligature heads together.
Music types accepted:
This engraver creates the following layout objects: VaticanaLigature.
Vaticana_ligature_engraver
is part of contexts: VaticanaVoice
Catch Vertical axis groups and stack them.
This engraver creates the following layout objects: VerticalAlignment.
Vertical_align_engraver
is part of contexts: PianoStaff and Score
Prints the name of the a lyric voice (specified by Staff.vocalName
and Staff.vocNam
) at the left of the staff.
Properties (read)
vocalName
(markup)vocNam
(markup)Vocal_name_engraver
is part of contexts: Lyrics
Make volta brackets
Properties (read)
stavesFound
(list of grobs)voltaSpannerDuration
(moment)\alternative
. This can be
used to shrink the length of brackets in the situation where one
alternative is very large.
repeatCommands
(list)(volta .
x)
, where x is a string or #f
Volta_engraver
is part of contexts: ChordNames, DrumStaff, GregorianTranscriptionStaff, RhythmicStaff, Staff, TabStaff and VaticanaStaff
aDueText
(string)alignBassFigureAccidentals
(boolean)allowBeamBreak
(boolean)associatedVoice
(string)Voice
that has the melody for this Lyrics
line.
autoAccidentals
(list)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
-1
then the accidental is forget
immediately, and if laziness is #t
then the accidental
lasts forever.
autoBeamSettings
(list)autoBeaming
(boolean)autoCautionaries
(list)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)\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)barCheckSynchronize
(boolean)measurePosition
when finding a barcheck.
barNumberVisibility
(procedure)bassFigureFormatFunction
(procedure)BassFigure
grob. It takes a
list of BassFigureEvent
s, a context, and the grob to format.
beatGrouping
(list)'(2
3)
.
beatLength
(moment)chordChanges
(boolean)chordNameExceptions
(list)chordNameExceptionsFull
(list)chordNameExceptionsPartial
(list)chordNameFunction
(procedure)chordNameSeparator
(markup)chordNoteNamer
(procedure)chordRootNamer
(procedure)clefGlyph
(string)clefOctavation
(integer)clefPosition
(number)connectArpeggios
(boolean)createKeyOnClefChange
(boolean)createSpacing
(boolean)crescendoSpanner
(symbol)crescendoText
(markup)currentBarNumber
(integer)decrescendoSpanner
(symbol)crescendoSpanner
.
decrescendoText
(markup)defaultBarType
(string)whichBar
for information on available bar types.
This variable is read by Timing_engraver at
Score level.
drumPitchTable
(hash table)drumStyleTable
(hash table)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)explicitKeySignatureVisibility
(procedure)extraNatural
(boolean)extraVerticalExtent
(pair of numbers)fingeringOrientations
(list)followVoice
(boolean)fontSize
(number)forceClef
(boolean)harmonicAccidentals
(boolean)highStringOne
(boolean)ignoreMelismata
(boolean)instr
(markup)instrument
instrument
(markup)instrument
property labels the staff in the first system, and
the instr
property labels following lines.
instrumentEqualizer
(procedure)instrumentTransposition
(pitch)\quote
s.
keyAccidentalOrder
(list)keySignature
(list)majorSevenSymbol
(markup)markFormatter
(procedure)measureLength
(moment)measurePosition
(moment)melismaBusyProperties
(list)#'(melismaBusy beamMelismaBusy)
, only manual melismata and
manual beams are considered. Possible values include
melismaBusy
, slurMelismaBusy
, tieMelismaBusy
, and
beamMelismaBusy
metronomeMarkFormatter
(procedure)middleCPosition
(number)clefPosition
and
clefGlyph
.
midiInstrument
(string)midiMaximumVolume
(number)midiMinimumVolume
.
midiMinimumVolume
(number)minimumFret
(number)minimumVerticalExtent
(pair of numbers)ottavation
(string)pedalSostenutoStrings
(list)pedalSustainStrings
.
pedalSostenutoStyle
(symbol)pedalSustainStyle
.
pedalSustainStrings
(list)pedalSustainStyle
(symbol)text
, bracket
or mixed
(both).
pedalUnaCordaStrings
(list)pedalSustainStrings
.
pedalUnaCordaStyle
(symbol)pedalSustainStyle
.
printKeyCancellation
(boolean)printOctaveNames
(boolean)recordEventSequence
(procedure)rehearsalMark
(integer)repeatCommands
(list)(volta .
x)
, where x is a string or #f
restNumberThreshold
(number)skipBars
(boolean)@lilypond[fragment,verbatim,center] r1 r1*3 R1*3 \\property Score.skipBars= ##t r1*3 R1*3 @end lilypond
skipTypesetting
(boolean)soloADue
(boolean)soloIIText
(string)soloText
(string)squashedPosition
(integer)stanza
(markup)stemLeftBeamCount
(integer)stemRightBeamCount
(integer)stemLeftBeamCount
.
stringOneTopmost
(boolean)stringTunings
(list)subdivideBeams
(boolean)systemStartDelimiter
(symbol)SystemStartBrace
,
SystemStartBracket
or SystemStartBar
.
tablatureFormat
(procedure)timeSignatureFraction
(pair of numbers)#'(4 . 4)
is a 4/4 time signature.
timing
(boolean)tonic
(pitch)tremoloFlags
(integer)tupletNumberFormatFunction
(procedure)tupletSpannerDuration
(moment)\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)verticalExtent
(pair of numbers)\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)vocalName
(markup)voltaOnThisStaff
(boolean)voltaSpannerDuration
(moment)\alternative
. This can be
used to shrink the length of brackets in the situation where one
alternative is very large.
whichBar
(string)Example:
\set Staff.whichBar = "|:"
This will create a start-repeat bar in this staff only. Valid values are described in bar-line-interface.
acceptHashTable
(hash table)acknowledgeHashTable
(hash table)associatedVoiceContext
(context)barCheckLastFail
(moment)beamMelismaBusy
(boolean)breakableSeparationItem
(layout object)busyGrobs
(list)currentCommandColumn
(layout object)currentMusicalColumn
(layout object)dynamicAbsoluteVolumeFunction
(procedure)finalizations
(list)graceSettings
(hash table)add-grace-property
function.
instrumentSupport
(list of grobs)lastKeySignature
(list)localKeySignature
(list)localKeySignatureChanges
(list)melismaBusy
(boolean)originalCentralCPosition
(integer)quotes
(hash table)scriptDefinitions
(list)slurMelismaBusy
(boolean)stavesFound
(list of grobs)tieMelismaBusy
(boolean)Accidental objects are created by: Accidental_engraver
Standard settings:
print-function
(procedure):Accidental_interface::print
Function taking grob as argument,
returning a Stencil
object.
font-family
(symbol):'music
The font family is the broadest category for selecting text fonts. Options include: sans
, roman
cautionary-style
(symbol):'parentheses
How to print cautionary
accidentals. Choices are smaller
or
parentheses
.
This object supports the following interfaces: font-interface, accidental-interface, item-interface and grob-interface
AccidentalPlacement objects are created by: none
Standard settings:
X-extent-callback
(procedure):Axis_group_interface::group_extent_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
left-padding
(dimension, in staff space):0.2
The amount of space that is put
left to a group of accidentals.
right-padding
(dimension, in staff space):0.15
Space to insert between note and accidentals.
This object supports the following interfaces: accidental-placement-interface, item-interface and grob-interface
Ambitus objects are created by: Ambitus_engraver
Standard settings:
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
break-align-symbol
(symbol):'ambitus
This key is used for aligning and
spacing breakable items.
print-function
(procedure):Ambitus::print
Function taking grob as argument,
returning a Stencil
object.
font-family
(symbol):'music
The font family is the broadest category for selecting text fonts. Options include: sans
, roman
break-visibility
(procedure):begin-of-line-visible
A function that takes the break
direction and returns a cons of booleans containing (transparent
. empty). The following variables are predefined:
all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
space-alist
(list):'((clef extra-space . 0.0) (key-signature extra-space . 0.0) (staff-bar extra-space . 0.0) (time-signature extra-space . 0.0) (first-note fixed-space . 0.0))
A table that specifies distances between
prefatory items, like clef and time-signature. The format is an alist
of spacing tuples: (
break-align-symbol type
.
distance)
, where type can be the symbols
minimum-space
or extra-space
.
This object supports the following interfaces: font-interface, item-interface, break-aligned-interface, staff-symbol-referencer-interface, ambitus-interface and grob-interface
Arpeggio objects are created by: Arpeggio_engraver and Span_arpeggio_engraver
Standard settings:
X-extent-callback
(procedure):Arpeggio::width_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
Y-extent-callback
(procedure):#f
see X-extent-callback
.
print-function
(procedure):Arpeggio::print
Function taking grob as argument,
returning a Stencil
object.
Y-offset-callbacks
(list):'(#<primitive-procedure Staff_symbol_referencer::callback>)
see X-offset-callbacks
.
X-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
direction
(direction):-1
Up or down, left or right?
padding
(dimension, in staff space):0.5
Add this much extra space between
objects that are next to each other.
staff-position
(number):0.0
Vertical position, measured in half staff spaces, counted from the middle line.
This object supports the following interfaces: font-interface, item-interface, side-position-interface, staff-symbol-referencer-interface, arpeggio-interface and grob-interface
BarLine objects are created by: Bar_engraver
Standard settings:
break-align-symbol
(symbol):'staff-bar
This key is used for aligning and
spacing breakable items.
glyph
(string):|
a string determining what (style) of glyph is
typeset. Valid choices depend on the function that is reading this
property.
break-glyph-function
(procedure):default-break-barline
This function determines the
appearance of a bar line at the line break. It takes a glyph and
break-direction and returns the glyph at a line break.
bar-size-procedure
(procedure):Bar_line::get_staff_bar_size
Procedure that computes the size of a bar line.
print-function
(procedure):Bar_line::print
Function taking grob as argument,
returning a Stencil
object.
break-visibility
(procedure):all-visible
A function that takes the break
direction and returns a cons of booleans containing (transparent
. empty). The following variables are predefined:
all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
before-line-breaking-callback
(procedure):Bar_line::before_line_breaking
This procedure is
called before line breaking, but after splitting breakable items at
potential line breaks.
space-alist
(list):'((time-signature extra-space . 0.75) (custos minimum-space . 2.0) (clef minimum-space . 1.0) (key-signature extra-space . 1.0) (first-note fixed-space . 1.3) (next-note semi-fixed-space . 1.3) (right-edge extra-space . 0.0))
A table that specifies distances between
prefatory items, like clef and time-signature. The format is an alist
of spacing tuples: (
break-align-symbol type
.
distance)
, where type can be the symbols
minimum-space
or extra-space
.
kern
(dimension, in staff space):3.0
Amount of extra white space to add. For
bar line, this is the amount of space after a thick line.
thin-kern
(number):3.0
The space after a hair-line in a bar line.
hair-thickness
(number):1.6
Thickness of the thin line in a bar line.
thick-thickness
(number):6.0
Bar line thickness, measured in
linethickness
.
This object supports the following interfaces: font-interface, break-aligned-interface, item-interface, bar-line-interface and grob-interface
BarNumber objects are created by: Bar_number_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
break-visibility
(procedure):begin-of-line-visible
A function that takes the break
direction and returns a cons of booleans containing (transparent
. empty). The following variables are predefined:
all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
padding
(dimension, in staff space):1.0
Add this much extra space between
objects that are next to each other.
direction
(direction):1
Up or down, left or right?
font-family
(symbol):'roman
The font family is the broadest category for selecting text fonts. Options include: sans
, roman
font-size
(number):-2
The font size, compared the `normal'
size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger.
Each step of 1 is approximately 12% larger, 6 steps are exactly a
factor 2 larger. Fractional values are allowed.
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
X-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
self-alignment-X
(number):1
Specify alignment of an object. The
value -1 means left aligned, 0 centered, and 1 right-aligned in X
direction. Values in between may also be specified.
extra-offset
(pair of numbers):'(1.3 . 0)
A pair representing an offset. This offset is added just before outputting the symbol, so the typesetting engine is completely oblivious to it.
This object supports the following interfaces: break-aligned-interface, item-interface, font-interface, self-alignment-interface, text-interface, side-position-interface and grob-interface
BassFigure objects are created by: Figured_bass_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
Y-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self>)
see X-offset-callbacks
.
direction
(direction):1
Up or down, left or right?
font-family
(symbol):'number
The font family is the broadest category for selecting text fonts. Options include: sans
, roman
font-size
(number):-4
The font size, compared the `normal'
size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger.
Each step of 1 is approximately 12% larger, 6 steps are exactly a
factor 2 larger. Fractional values are allowed.
kern
(dimension, in staff space):0.2
Amount of extra white space to add. For bar line, this is the amount of space after a thick line.
This object supports the following interfaces: font-interface, self-alignment-interface, item-interface, bass-figure-interface, rhythmic-grob-interface, text-interface and grob-interface
Beam objects are created by: Auto_beam_engraver, Beam_engraver, Chord_tremolo_engraver and Grace_beam_engraver
Standard settings:
print-function
(procedure):Beam::print
Function taking grob as argument,
returning a Stencil
object.
concaveness-gap
(dimension, in staff space):1.85
A beam is printed horizontally
if its concaveness-gap is larger than this value. The concaveness-gap
is the distance of an inner note head to the line between two outer
note heads.
concaveness-threshold
(number):0.26
A beam is printed horizontally if its concaveness is bigger than this threshold.
Concaveness is calculated as the sum of the vertical distances of
inner note heads that fall outside the interval of the two outer
note heads, to the vertically nearest outer note head, divided by the
square of the inner notes involved.
gap
(dimension, in staff space):0.8
Size of a gap in a variable symbol.
positions
(pair):'(#f . #f)
Pair of staff coordinates (
left
.
right)
, where both left and right are in the
staff-space unit of the current staff.
thickness
(number):0.48
Bar line thickness, measured in
linethickness
.
before-line-breaking-callback
(procedure):Beam::before_line_breaking
This procedure is
called before line breaking, but after splitting breakable items at
potential line breaks.
neutral-direction
(direction):-1
Which direction to take in the
center of the staff.
dir-function
(procedure):beam-dir-majority-median
The function to determine the direction of a beam. Choices include:
beam-dir-majority
beam-dir-mean
beam-dir-median.
beamed-stem-shorten
(list):'(1.0 0.5 0.25)
How much to shorten beamed stems,
when their direction is forced. It is a list, since the value is different
depending on the number flags/beams.
slope-limit
(number):0.2
Set slope to zero if slope is running away
steeper than this.
flag-width-function
(procedure):beam-flag-width-function
Procedure that computes the width of a half-beam (a non-connecting beam.).
damping
(integer):1
Amount of beam slope damping. 0: no, 1: yes,
100000: horizontal beams.
auto-knee-gap
(dimension, in staff space):5.5
If a gap is found between note heads
where a horizontal beam fits that is larger than this number, make a kneed beam.
font-family
(symbol):'roman
The font family is the broadest category for selecting text fonts. Options include: sans
, roman
space-function
(procedure):Beam::space_function
Calculate the vertical space between two beams. This function takes a beam grob and the maximum number of beams.
This object supports the following interfaces: spanner-interface, beam-interface, staff-symbol-referencer-interface and grob-interface
BreakAlignGroup objects are created by: Break_align_engraver
Standard settings:
axes
(list):'(0)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
X-offset-callbacks
(list):'(#<primitive-procedure Break_align_interface::alignment_callback>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
X-extent-callback
(procedure):Axis_group_interface::group_extent_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
This object supports the following interfaces: item-interface, axis-group-interface, item-interface, break-aligned-interface and grob-interface
BreakAlignment objects are created by: Break_align_engraver
Standard settings:
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
stacking-dir
(direction):1
Stack objects in which direction?
break-align-orders
(hash table):'#((instrument-name left-edge ambitus breathing-sign clef staff-bar key-signature time-signature custos) (instrument-name left-edge ambitus breathing-sign clef staff-bar key-signature staff time-signature custos) (instrument-name left-edge ambitus breathing-sign clef key-signature staff-bar time-signature custos))
Defines the order in which prefatory matter (clefs, key signatures) appears. The format is a vector of length 3, where each element is one order for end-of-line, middle of line, and start-of-line respectively. An order is a list of symbols.
For example, clefs are put after key signatures by setting
\override Score.BreakAlignment #'break-align-orders = #(make-vector 3 '(span-bar breathing-sign staff-bar key clef time-signature))
axes
(list):'(0)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
X-extent-callback
(procedure):Axis_group_interface::group_extent_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
This object supports the following interfaces: axis-group-interface, item-interface, break-alignment-interface and grob-interface
BreathingSign objects are created by: Breathing_sign_engraver
Standard settings:
break-align-symbol
(symbol):'breathing-sign
This key is used for aligning and
spacing breakable items.
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
space-alist
(list):'((ambitus extra-space . 2.0) (custos minimum-space . 1.0) (key-signature minimum-space . 1.5) (staff-bar minimum-space . 1.5) (clef minimum-space . 2.0) (first-note fixed-space . 1.0) (right-edge extra-space . 0.1))
A table that specifies distances between
prefatory items, like clef and time-signature. The format is an alist
of spacing tuples: (
break-align-symbol type
.
distance)
, where type can be the symbols
minimum-space
or extra-space
.
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
text
(markup):'(#<procedure musicglyph-markup (paper props glyph-name)> scripts-rcomma)
Text markup. See Text markup
.
Y-offset-callbacks
(list):'(#<primitive-procedure Breathing_sign::offset_callback>)
see X-offset-callbacks
.
break-visibility
(procedure):begin-of-line-invisible
A function that takes the break
direction and returns a cons of booleans containing (transparent
. empty). The following variables are predefined:
all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
This object supports the following interfaces: item-interface, font-interface, text-interface, breathing-sign-interface, break-aligned-interface and grob-interface
ChordName objects are created by: Chord_name_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
word-space
(dimension, in staff space):0.0
space to insert between lyrics or
words in texts.
font-family
(symbol):'sans
The font family is the broadest category for selecting text fonts. Options include: sans
, roman
font-size
(number):1.5
The font size, compared the `normal' size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger. Each step of 1 is approximately 12% larger, 6 steps are exactly a factor 2 larger. Fractional values are allowed.
This object supports the following interfaces: item-interface, chord-name-interface, text-interface, rhythmic-grob-interface, font-interface and grob-interface
Clef objects are created by: Clef_engraver
Standard settings:
print-function
(procedure):Clef::print
Function taking grob as argument,
returning a Stencil
object.
before-line-breaking-callback
(procedure):Clef::before_line_breaking
This procedure is
called before line breaking, but after splitting breakable items at
potential line breaks.
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
font-family
(symbol):'music
The font family is the broadest category for selecting text fonts. Options include: sans
, roman
break-align-symbol
(symbol):'clef
This key is used for aligning and
spacing breakable items.
break-visibility
(procedure):begin-of-line-visible
A function that takes the break
direction and returns a cons of booleans containing (transparent
. empty). The following variables are predefined:
all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
space-alist
(list):'((ambitus extra-space . 2.0) (staff-bar extra-space . 0.7) (key-signature minimum-space . 4.0) (time-signature minimum-space . 4.2) (first-note minimum-fixed-space . 5.0) (next-note extra-space . 0.5) (right-edge extra-space . 0.5))
A table that specifies distances between
prefatory items, like clef and time-signature. The format is an alist
of spacing tuples: (
break-align-symbol type
.
distance)
, where type can be the symbols
minimum-space
or extra-space
.
Y-offset-callbacks
(list):'(#<primitive-procedure Staff_symbol_referencer::callback>)
see X-offset-callbacks
.
This object supports the following interfaces: item-interface, break-aligned-interface, font-interface, staff-symbol-referencer-interface, clef-interface and grob-interface
ClusterSpanner objects are created by: Cluster_spanner_engraver
Standard settings:
print-function
(procedure):Cluster::print
Function taking grob as argument,
returning a Stencil
object.
spacing-procedure
(procedure):Spanner::set_spacing_rods
Procedure for calculating spacing
parameters. The routine is called after
before-line-breaking-callback
.
minimum-length
(dimension, in staff space):0.0
Try to make a spanner at least
this long. This requires an appropriate routine for the
spacing-procedure
property.
padding
(dimension, in staff space):0.25
Add this much extra space between
objects that are next to each other.
style
(symbol):'ramp
This setting determines in what style a grob is
typeset. Valid choices depend on the print-function
that is
reading this property.
This object supports the following interfaces: spanner-interface, cluster-interface and grob-interface
ClusterSpannerBeacon objects are created by: Cluster_spanner_engraver
Standard settings:
print-function
(procedure):#f
Function taking grob as argument,
returning a Stencil
object.
Y-extent-callback
(procedure):Cluster_beacon::height
see X-extent-callback
.
This object supports the following interfaces: item-interface, cluster-beacon-interface and grob-interface
CombineTextScript objects are created by: Part_combine_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
no-spacing-rods
(boolean):#t
Items with this property do not cause
spacing constraints.
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
X-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
direction
(direction):1
Up or down, left or right?
extra-offset
(pair of numbers):'(-1 . 0)
A pair representing an offset. This
offset is added just before outputting the symbol, so the typesetting
engine is completely oblivious to it.
padding
(dimension, in staff space):0.5
Add this much extra space between
objects that are next to each other.
staff-padding
(dimension, in staff space):0.5
Maintain this much space between reference points
and the staff. Its effect is to align objects of differing
sizes (like the dynamic p and f) on their baselines.
script-priority
(number):200
A sorting key that determines in what
order a script is within a stack of scripts.
baseline-skip
(dimension, in staff space):2
Distance between base lines of
multiple lines of text.
font-series
(symbol):'bold
Select the series of a font. Choices
include medium
, bold
, bold-narrow
, etc.
This object supports the following interfaces: item-interface, font-interface, side-position-interface, text-interface, text-script-interface and grob-interface
Custos objects are created by: Custos_engraver
Standard settings:
break-align-symbol
(symbol):'custos
This key is used for aligning and
spacing breakable items.
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
print-function
(procedure):Custos::print
Function taking grob as argument,
returning a Stencil
object.
break-visibility
(procedure):end-of-line-visible
A function that takes the break
direction and returns a cons of booleans containing (transparent
. empty). The following variables are predefined:
all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
style
(symbol):'vaticana
This setting determines in what style a grob is
typeset. Valid choices depend on the print-function
that is
reading this property.
neutral-direction
(direction):-1
Which direction to take in the
center of the staff.
Y-offset-callbacks
(list):'(#<primitive-procedure Staff_symbol_referencer::callback>)
see X-offset-callbacks
.
space-alist
(list):'((first-note minimum-fixed-space . 0.0) (right-edge extra-space . 0.1))
A table that specifies distances between
prefatory items, like clef and time-signature. The format is an alist
of spacing tuples: (
break-align-symbol type
.
distance)
, where type can be the symbols
minimum-space
or extra-space
.
This object supports the following interfaces: item-interface, break-aligned-interface, font-interface, staff-symbol-referencer-interface, custos-interface and grob-interface
DotColumn objects are created by: Dot_column_engraver
Standard settings:
axes
(list):'(0)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
direction
(direction):1
Up or down, left or right?
X-extent-callback
(procedure):Axis_group_interface::group_extent_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
X-offset-callbacks
(list):'(#<primitive-procedure Dot_column::side_position>)
A list of functions determining this objects' position relative to its parent. The last one in the list is called first. The functions take a grob and axis argument.
This object supports the following interfaces: item-interface, axis-group-interface, dot-column-interface and grob-interface
Dots objects are created by: Completion_heads_engraver, Drum_notes_engraver, Note_heads_engraver, Rest_engraver and Tab_note_heads_engraver
Standard settings:
print-function
(procedure):Dots::print
Function taking grob as argument,
returning a Stencil
object.
dot-count
(integer):1
The number of dots.
This object supports the following interfaces: item-interface, dots-interface, staff-symbol-referencer-interface, font-interface and grob-interface
DoublePercentRepeat objects are created by: Percent_repeat_engraver
Standard settings:
print-function
(procedure):Percent_repeat_item_interface::double_percent
Function taking grob as argument,
returning a Stencil
object.
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
slope
(number):1.0
The slope of this object.
font-encoding
(symbol):'music
The font encoding is the broadest category for selecting a font. Options include: music
, number
, text
,
math
, braces
, dynamic
width
(dimension, in staff space):2.0
The width of a grob measured in staff space.
thickness
(number):0.48
Bar line thickness, measured in
linethickness
.
break-align-symbol
(symbol):'staff-bar
This key is used for aligning and
spacing breakable items.
break-visibility
(procedure):begin-of-line-invisible
A function that takes the break
direction and returns a cons of booleans containing (transparent
. empty). The following variables are predefined:
all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
This object supports the following interfaces: item-interface, percent-repeat-interface, break-aligned-interface, font-interface and grob-interface
DynamicLineSpanner objects are created by: Dynamic_engraver
Standard settings:
axes
(list):'(1)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
Y-extent-callback
(procedure):Axis_group_interface::group_extent_callback
see X-extent-callback
.
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
staff-padding
(dimension, in staff space):0.1
Maintain this much space between reference points
and the staff. Its effect is to align objects of differing
sizes (like the dynamic p and f) on their baselines.
padding
(dimension, in staff space):0.6
Add this much extra space between
objects that are next to each other.
minimum-space
(dimension, in staff space):1.2
Minimum distance that the victim
should move (after padding).
direction
(direction):-1
Up or down, left or right?
This object supports the following interfaces: spanner-interface, side-position-interface, axis-group-interface, dynamic-interface and grob-interface
DynamicText objects are created by: Dynamic_engraver
Standard settings:
Y-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self>)
see X-offset-callbacks
.
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
X-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self> #<primitive-procedure Self_alignment_interface::centered_on_parent>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
self-alignment-X
(number):0
Specify alignment of an object. The
value -1 means left aligned, 0 centered, and 1 right-aligned in X
direction. Values in between may also be specified.
no-spacing-rods
(boolean):#t
Items with this property do not cause
spacing constraints.
script-priority
(number):100
A sorting key that determines in what
order a script is within a stack of scripts.
font-series
(symbol):'bold
Select the series of a font. Choices
include medium
, bold
, bold-narrow
, etc.
font-encoding
(symbol):'dynamic
The font encoding is the broadest category for selecting a font. Options include: music
, number
, text
,
math
, braces
, dynamic
font-shape
(symbol):'italic
Select the shape of a font. Choices include upright
,
italic
, caps
.
self-alignment-Y
(number):0
like self-alignment-X
but for
Y axis.
This object supports the following interfaces: item-interface, script-interface, dynamic-interface, self-alignment-interface, text-interface, font-interface and grob-interface
Fingering objects are created by: Fingering_engraver and New_fingering_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
padding
(dimension, in staff space):0.6
Add this much extra space between
objects that are next to each other.
staff-padding
(dimension, in staff space):0.6
Maintain this much space between reference points
and the staff. Its effect is to align objects of differing
sizes (like the dynamic p and f) on their baselines.
self-alignment-X
(number):0
Specify alignment of an object. The
value -1 means left aligned, 0 centered, and 1 right-aligned in X
direction. Values in between may also be specified.
self-alignment-Y
(number):0
like self-alignment-X
but for
Y axis.
script-priority
(number):100
A sorting key that determines in what
order a script is within a stack of scripts.
font-encoding
(symbol):'number
The font encoding is the broadest category for selecting a font. Options include: music
, number
, text
,
math
, braces
, dynamic
font-size
(number):-5
The font size, compared the `normal' size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger. Each step of 1 is approximately 12% larger, 6 steps are exactly a factor 2 larger. Fractional values are allowed.
This object supports the following interfaces: item-interface, self-alignment-interface, side-position-interface, text-interface, text-script-interface, font-interface, finger-interface and grob-interface
Glissando objects are created by: Glissando_engraver and Note_head_line_engraver
Standard settings:
style
(symbol):'line
This setting determines in what style a grob is
typeset. Valid choices depend on the print-function
that is
reading this property.
gap
(dimension, in staff space):0.5
Size of a gap in a variable symbol.
zigzag-width
(dimension, in staff space):0.75
The width of one
zigzag-squiggle. This number will be adjusted slightly so that the
glissando line can be constructed from a whole number of squiggles.
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
X-extent-callback
(procedure):#f
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
Y-extent-callback
(procedure):#f
see X-extent-callback
.
print-function
(procedure):Line_spanner::print
Function taking grob as argument,
returning a Stencil
object.
This object supports the following interfaces: spanner-interface, line-spanner-interface and grob-interface
Hairpin objects are created by: Dynamic_engraver
Standard settings:
print-function
(procedure):Hairpin::print
Function taking grob as argument,
returning a Stencil
object.
thickness
(number):1.0
Bar line thickness, measured in
linethickness
.
height
(dimension, in staff space):0.6666
Height of an object in staffspace.
spacing-procedure
(procedure):Spanner::set_spacing_rods
Procedure for calculating spacing
parameters. The routine is called after
before-line-breaking-callback
.
minimum-length
(dimension, in staff space):2.0
Try to make a spanner at least
this long. This requires an appropriate routine for the
spacing-procedure
property.
self-alignment-Y
(number):0
like self-alignment-X
but for
Y axis.
Y-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self>)
see X-offset-callbacks
.
This object supports the following interfaces: spanner-interface, dynamic-interface, self-alignment-interface, line-interface, hairpin-interface and grob-interface
HorizontalBracket objects are created by: Horizontal_bracket_engraver
Standard settings:
thickness
(number):1.0
Bar line thickness, measured in
linethickness
.
print-function
(procedure):Horizontal_bracket::print
Function taking grob as argument,
returning a Stencil
object.
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
padding
(dimension, in staff space):0.2
Add this much extra space between
objects that are next to each other.
direction
(direction):-1
Up or down, left or right?
This object supports the following interfaces: spanner-interface, side-position-interface, horizontal-bracket-interface and grob-interface
InstrumentName objects are created by: Instrument_name_engraver
Standard settings:
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
Y-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self> #<primitive-procedure Side_position_interface::aligned_on_support_refpoints>)
see X-offset-callbacks
.
direction
(direction):0
Up or down, left or right?
space-alist
(list):'((left-edge extra-space . 1.0))
A table that specifies distances between
prefatory items, like clef and time-signature. The format is an alist
of spacing tuples: (
break-align-symbol type
.
distance)
, where type can be the symbols
minimum-space
or extra-space
.
self-alignment-Y
(number):0
like self-alignment-X
but for
Y axis.
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
break-align-symbol
(symbol):'instrument-name
This key is used for aligning and
spacing breakable items.
break-visibility
(procedure):begin-of-line-visible
A function that takes the break
direction and returns a cons of booleans containing (transparent
. empty). The following variables are predefined:
all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
baseline-skip
(dimension, in staff space):2
Distance between base lines of multiple lines of text.
This object supports the following interfaces: item-interface, break-aligned-interface, text-interface, side-position-interface, self-alignment-interface, font-interface and grob-interface
KeySignature objects are created by: Key_engraver
Standard settings:
print-function
(procedure):Key_signature_interface::print
Function taking grob as argument,
returning a Stencil
object.
space-alist
(list):'((time-signature extra-space . 1.25) (staff-bar extra-space . 1.1) (right-edge extra-space . 0.5) (first-note fixed-space . 2.5))
A table that specifies distances between
prefatory items, like clef and time-signature. The format is an alist
of spacing tuples: (
break-align-symbol type
.
distance)
, where type can be the symbols
minimum-space
or extra-space
.
Y-offset-callbacks
(list):'(#<primitive-procedure Staff_symbol_referencer::callback>)
see X-offset-callbacks
.
break-align-symbol
(symbol):'key-signature
This key is used for aligning and
spacing breakable items.
break-visibility
(procedure):begin-of-line-visible
A function that takes the break
direction and returns a cons of booleans containing (transparent
. empty). The following variables are predefined:
all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
breakable
(boolean):#t
Can this object appear at a line break, like clefs and bar lines?
This object supports the following interfaces: item-interface, break-aligned-interface, font-interface, key-signature-interface and grob-interface
LeftEdge objects are created by: Break_align_engraver
Standard settings:
break-align-symbol
(symbol):'left-edge
This key is used for aligning and
spacing breakable items.
X-extent
(pair of numbers):'(0 . 0)
Hard coded extent in X direction.
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
space-alist
(list):'((custos extra-space . 0.0) (ambitus extra-space . 2.0) (time-signature extra-space . 0.0) (staff-bar extra-space . 0.0) (breathing-sign minimum-space . 0.0) (clef extra-space . 0.85) (first-note fixed-space . 1.0) (right-edge extra-space . 0.0) (key-signature extra-space . 0.0))
A table that specifies distances between
prefatory items, like clef and time-signature. The format is an alist
of spacing tuples: (
break-align-symbol type
.
distance)
, where type can be the symbols
minimum-space
or extra-space
.
This object supports the following interfaces: item-interface, break-aligned-interface and grob-interface
LigatureBracket objects are created by: none
Standard settings:
direction
(direction):1
Up or down, left or right?
gap
(dimension, in staff space):0.0
Size of a gap in a variable symbol.
padding
(dimension, in staff space):2.0
Add this much extra space between
objects that are next to each other.
thickness
(number):1.6
Bar line thickness, measured in
linethickness
.
edge-height
(pair):'(0.7 . 0.7)
A pair of number specifying the heights of
the vertical edges '(left-height . right-height).
shorten-pair
(pair of numbers):'(-0.2 . -0.2)
The lengths to shorten a
text-spanner on both sides, for example a pedal bracket
before-line-breaking-callback
(procedure):Tuplet_bracket::before_line_breaking
This procedure is
called before line breaking, but after splitting breakable items at
potential line breaks.
print-function
(procedure):Tuplet_bracket::print
Function taking grob as argument,
returning a Stencil
object.
This object supports the following interfaces: spanner-interface, tuplet-bracket-interface and grob-interface
LyricExtender objects are created by: Extender_engraver
Standard settings:
print-function
(procedure):Lyric_extender::print
Function taking grob as argument,
returning a Stencil
object.
thickness
(number):0.8
Bar line thickness, measured in
linethickness
.
minimum-length
(dimension, in staff space):1.5
Try to make a spanner at least
this long. This requires an appropriate routine for the
spacing-procedure
property.
Y-extent
(pair of numbers):'(0 . 0)
See X-extent
.
This object supports the following interfaces: spanner-interface, lyric-extender-interface, lyric-interface and grob-interface
LyricHyphen objects are created by: Hyphen_engraver
Standard settings:
thickness
(number):1.3
Bar line thickness, measured in
linethickness
.
height
(dimension, in staff space):0.42
Height of an object in staffspace.
dash-period
(number):10.0
the length of one dash + white space. If
negative, no line is drawn at all.
length
(dimension, in staff space):0.66
User override for the stem length of
unbeamed stems.
spacing-procedure
(procedure):Hyphen_spanner::set_spacing_rods
Procedure for calculating spacing
parameters. The routine is called after
before-line-breaking-callback
.
print-function
(procedure):Hyphen_spanner::print
Function taking grob as argument,
returning a Stencil
object.
Y-extent
(pair of numbers):'(0 . 0)
See X-extent
.
This object supports the following interfaces: spanner-interface, lyric-hyphen-interface, lyric-interface and grob-interface
LyricText objects are created by: Lyric_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
X-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_parent>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
self-alignment-X
(number):0
Specify alignment of an object. The
value -1 means left aligned, 0 centered, and 1 right-aligned in X
direction. Values in between may also be specified.
word-space
(dimension, in staff space):0.6
space to insert between lyrics or
words in texts.
font-series
(symbol):'bold-narrow
Select the series of a font. Choices
include medium
, bold
, bold-narrow
, etc.
font-size
(number):1.0
The font size, compared the `normal' size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger. Each step of 1 is approximately 12% larger, 6 steps are exactly a factor 2 larger. Fractional values are allowed.
This object supports the following interfaces: item-interface, font-interface, text-interface, self-alignment-interface, lyric-syllable-interface, rhythmic-grob-interface and grob-interface
MeasureGrouping objects are created by: Measure_grouping_engraver
Standard settings:
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
print-function
(procedure):Measure_grouping::print
Function taking grob as argument,
returning a Stencil
object.
padding
(dimension, in staff space):2
Add this much extra space between
objects that are next to each other.
direction
(direction):1
Up or down, left or right?
thickness
(number):1
Bar line thickness, measured in
linethickness
.
height
(dimension, in staff space):2.0
Height of an object in staffspace.
staff-padding
(dimension, in staff space):3
Maintain this much space between reference points and the staff. Its effect is to align objects of differing sizes (like the dynamic p and f) on their baselines.
This object supports the following interfaces: measure-grouping-interface, side-position-interface, spanner-interface and grob-interface
MensuralLigature objects are created by: Mensural_ligature_engraver
Standard settings:
thickness
(number):1.4
Bar line thickness, measured in
linethickness
.
print-function
(procedure):Mensural_ligature::print
Function taking grob as argument,
returning a Stencil
object.
This object supports the following interfaces: font-interface, mensural-ligature-interface and grob-interface
MetronomeMark objects are created by: Metronome_mark_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
direction
(direction):1
Up or down, left or right?
padding
(dimension, in staff space):0.8
Add this much extra space between objects that are next to each other.
This object supports the following interfaces: item-interface, metronome-mark-interface, font-interface, side-position-interface, text-interface and grob-interface
MultiMeasureRest objects are created by: Multi_measure_rest_engraver
Standard settings:
spacing-procedure
(procedure):Multi_measure_rest::set_spacing_rods
Procedure for calculating spacing
parameters. The routine is called after
before-line-breaking-callback
.
print-function
(procedure):Multi_measure_rest::print
Function taking grob as argument,
returning a Stencil
object.
Y-offset-callbacks
(list):'(#<primitive-procedure Staff_symbol_referencer::callback>)
see X-offset-callbacks
.
staff-position
(number):0
Vertical position, measured in half
staff spaces, counted from the middle line.
expand-limit
(integer):10
maximum number of measures expanded in church rests.
thick-thickness
(number):6.6
Bar line thickness, measured in
linethickness
.
hair-thickness
(number):2.0
Thickness of the thin line in a bar line.
padding
(dimension, in staff space):1
Add this much extra space between
objects that are next to each other.
font-encoding
(symbol):'music
The font encoding is the broadest category for selecting a font. Options include: music
, number
, text
,
math
, braces
, dynamic
This object supports the following interfaces: staff-symbol-referencer-interface, font-interface, rest-interface, multi-measure-interface, multi-measure-rest-interface and grob-interface
MultiMeasureRestNumber objects are created by: Multi_measure_rest_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
X-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self> #<primitive-procedure Self_alignment_interface::centered_on_other_axis_parent>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
self-alignment-X
(number):0
Specify alignment of an object. The
value -1 means left aligned, 0 centered, and 1 right-aligned in X
direction. Values in between may also be specified.
direction
(direction):1
Up or down, left or right?
padding
(dimension, in staff space):1.3
Add this much extra space between
objects that are next to each other.
staff-padding
(dimension, in staff space):1.3
Maintain this much space between reference points
and the staff. Its effect is to align objects of differing
sizes (like the dynamic p and f) on their baselines.
font-encoding
(symbol):'number
The font encoding is the broadest category for selecting a font. Options include: music
, number
, text
,
math
, braces
, dynamic
This object supports the following interfaces: text-interface, spanner-interface, font-interface, self-alignment-interface, multi-measure-interface, side-position-interface and grob-interface
MultiMeasureRestText objects are created by: Multi_measure_rest_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
X-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self> #<primitive-procedure Self_alignment_interface::centered_on_other_axis_parent>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
self-alignment-X
(number):0
Specify alignment of an object. The
value -1 means left aligned, 0 centered, and 1 right-aligned in X
direction. Values in between may also be specified.
direction
(direction):1
Up or down, left or right?
padding
(dimension, in staff space):1.5
Add this much extra space between
objects that are next to each other.
staff-padding
(dimension, in staff space):1.5
Maintain this much space between reference points and the staff. Its effect is to align objects of differing sizes (like the dynamic p and f) on their baselines.
This object supports the following interfaces: text-interface, spanner-interface, font-interface, self-alignment-interface, multi-measure-interface, side-position-interface and grob-interface
NonMusicalPaperColumn objects are created by: Score_engraver
Standard settings:
axes
(list):'(0)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
X-extent-callback
(procedure):Axis_group_interface::group_extent_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
before-line-breaking-callback
(procedure):Paper_column::before_line_breaking
This procedure is
called before line breaking, but after splitting breakable items at
potential line breaks.
breakable
(boolean):#t
Can this object appear at a line break, like clefs and bar lines?
This object supports the following interfaces: item-interface, spaceable-grob-interface, axis-group-interface, paper-column-interface and grob-interface
NoteCollision objects are created by: Collision_engraver
Standard settings:
axes
(list):'(0 1)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
X-extent-callback
(procedure):Axis_group_interface::group_extent_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
Y-extent-callback
(procedure):Axis_group_interface::group_extent_callback
see X-extent-callback
.
This object supports the following interfaces: item-interface, axis-group-interface, note-collision-interface and grob-interface
NoteColumn objects are created by: Rhythmic_column_engraver
Standard settings:
axes
(list):'(0 1)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
X-extent-callback
(procedure):Axis_group_interface::group_extent_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
Y-extent-callback
(procedure):Axis_group_interface::group_extent_callback
see X-extent-callback
.
This object supports the following interfaces: item-interface, note-column-interface, axis-group-interface and grob-interface
NoteHead objects are created by: Completion_heads_engraver, Drum_notes_engraver and Note_heads_engraver
Standard settings:
style
(symbol):'default
This setting determines in what style a grob is
typeset. Valid choices depend on the print-function
that is
reading this property.
print-function
(procedure):Note_head::print
Function taking grob as argument,
returning a Stencil
object.
glyph-name-procedure
(procedure):find-notehead-symbol
Return the name of a character
within font, to use for printing a symbol.
X-extent-callback
(procedure):Note_head::extent
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
Y-extent-callback
(procedure):Note_head::extent
see X-extent-callback
.
Y-offset-callbacks
(list):'(#<primitive-procedure Staff_symbol_referencer::callback>)
see X-offset-callbacks
.
stem-attachment-function
(procedure):note-head-style->attachment-coordinates
A function that calculates where a stem attaches to the note head? This is a fallback when this information is not specified in the font. The function takes a grob and axis argument, and returns a (x . y) pair, specifying location in terms of note head bounding box.
This object supports the following interfaces: item-interface, staff-symbol-referencer-interface, note-head-interface, font-interface, rhythmic-head-interface, rhythmic-grob-interface and grob-interface
NoteName objects are created by: Note_name_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
This object supports the following interfaces: item-interface, font-interface, text-interface, note-name-interface and grob-interface
NoteSpacing objects are created by: Rhythmic_column_engraver
Standard settings:
stem-spacing-correction
(number):0.5
Optical correction amount for
stems that are placed in tight configurations. For opposite
directions, this amount is the correction for two normal sized stems
that overlap completely.
knee-spacing-correction
(number):1.0
Factor for the optical correction amount for kneed beams. Set between 0 for no correction and 1 for full correction.
This object supports the following interfaces: item-interface, note-spacing-interface, spacing-interface and grob-interface
OctavateEight objects are created by: Clef_engraver
Standard settings:
self-alignment-X
(number):0
Specify alignment of an object. The
value -1 means left aligned, 0 centered, and 1 right-aligned in X
direction. Values in between may also be specified.
break-visibility
(procedure):begin-of-line-visible
A function that takes the break
direction and returns a cons of booleans containing (transparent
. empty). The following variables are predefined:
all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
X-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::centered_on_parent> #<primitive-procedure Self_alignment_interface::aligned_on_self>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
Y-extent
(pair of numbers):'(0 . 0)
See X-extent
.
font-shape
(symbol):'italic
Select the shape of a font. Choices include upright
,
italic
, caps
.
padding
(dimension, in staff space):0.6
Add this much extra space between
objects that are next to each other.
staff-padding
(dimension, in staff space):0.2
Maintain this much space between reference points
and the staff. Its effect is to align objects of differing
sizes (like the dynamic p and f) on their baselines.
font-size
(number):-4
The font size, compared the `normal' size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger. Each step of 1 is approximately 12% larger, 6 steps are exactly a factor 2 larger. Fractional values are allowed.
This object supports the following interfaces: item-interface, font-interface, side-position-interface, self-alignment-interface, text-interface and grob-interface
OttavaBracket objects are created by: Ottava_spanner_engraver
Standard settings:
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
print-function
(procedure):Ottava_bracket::print
Function taking grob as argument,
returning a Stencil
object.
font-shape
(symbol):'italic
Select the shape of a font. Choices include upright
,
italic
, caps
.
shorten-pair
(pair of numbers):'(0.0 . -0.6)
The lengths to shorten a
text-spanner on both sides, for example a pedal bracket
staff-padding
(dimension, in staff space):1.0
Maintain this much space between reference points
and the staff. Its effect is to align objects of differing
sizes (like the dynamic p and f) on their baselines.
padding
(dimension, in staff space):0.5
Add this much extra space between
objects that are next to each other.
minimum-length
(dimension, in staff space):1.0
Try to make a spanner at least
this long. This requires an appropriate routine for the
spacing-procedure
property.
dash-fraction
(number):0.3
Size of the dashes, relative to
dash-period. Should be between 0.0 (no line) and 1.0 (continuous
line).
edge-height
(pair):'(0 . 1.2)
A pair of number specifying the heights of
the vertical edges '(left-height . right-height).
direction
(direction):1
Up or down, left or right?
This object supports the following interfaces: spanner-interface, text-interface, font-interface, side-position-interface, line-interface, ottava-bracket-interface and grob-interface
PaperColumn objects are created by: Score_engraver
Standard settings:
axes
(list):'(0)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
before-line-breaking-callback
(procedure):Paper_column::before_line_breaking
This procedure is
called before line breaking, but after splitting breakable items at
potential line breaks.
X-extent-callback
(procedure):Axis_group_interface::group_extent_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
This object supports the following interfaces: item-interface, spaceable-grob-interface, axis-group-interface, paper-column-interface and grob-interface
PercentRepeat objects are created by: Percent_repeat_engraver
Standard settings:
spacing-procedure
(procedure):Multi_measure_rest::set_spacing_rods
Procedure for calculating spacing
parameters. The routine is called after
before-line-breaking-callback
.
print-function
(procedure):Multi_measure_rest::percent
Function taking grob as argument,
returning a Stencil
object.
slope
(number):1.0
The slope of this object.
thickness
(number):0.48
Bar line thickness, measured in
linethickness
.
font-encoding
(symbol):'music
The font encoding is the broadest category for selecting a font. Options include: music
, number
, text
,
math
, braces
, dynamic
This object supports the following interfaces: percent-repeat-interface, font-interface, spanner-interface, multi-measure-rest-interface and grob-interface
PhrasingSlur objects are created by: Phrasing_slur_engraver
Standard settings:
print-function
(procedure):Slur::print
Function taking grob as argument,
returning a Stencil
object.
thickness
(number):1.2
Bar line thickness, measured in
linethickness
.
spacing-procedure
(procedure):Spanner::set_spacing_rods
Procedure for calculating spacing
parameters. The routine is called after
before-line-breaking-callback
.
minimum-length
(dimension, in staff space):1.5
Try to make a spanner at least
this long. This requires an appropriate routine for the
spacing-procedure
property.
extremity-function
(procedure):calc-slur-extremity
A function that calculates the
attachment of a slur-end. The function takes a slur and direction argument and returns a symbol.
extremity-offset-alist
(list):'(((head 1 1) -0.25 . 1.25) ((head 1 -1) -0.25 . 1.25) ((head -1 1) -0.25 . 1.25) ((head -1 -1) -0.85 . 1.25) ((stem 1 1) -0.25 . 1.5) ((stem -1 -1) -0.25 . 1.5) ((loose-end 1 1) -0.4 . 0) ((loose-end 1 -1) -0.4 . 0) ((loose-end -1 -1) -4 . 0) ((loose-end -1 1) -4 . 0))
The offset adds to the centre of the note head, or stem.
Format: alist (attachment stem-dir*dir slur-dir*dir) -> offset.
Y-extent-callback
(procedure):Slur::height
see X-extent-callback
.
height-limit
(dimension, in staff space):2.0
Maximum slur height: the longer the
slur, the closer it is to this height.
ratio
(number):0.333
Parameter for slur shape. The higher this number, the
quicker the slur attains it height-limit
.
beautiful
(number):0.5
number that dictates when a slur should be de-uglyfied. It correlates with the enclosed area between noteheads and slurs. A value of 0.1 yields only undisturbed slurs, a value of 5 will tolerate quite high blown slurs.
y-free
(dimension, in staff space):0.75
The minimal vertical gap between slur and
note heads or stems.
attachment
(pair):'(#f . #f)
Pair of symbols
indicating how a slur should be attached at the ends. The format is
'(left-type . right-type), where both types are
symbols. The values of these symbols may be alongside-stem
,
stem
, head
or loose-end
.
attachment-offset
(pair):'((0 . 0) 0 . 0)
cons of offsets,
'(left-offset . right-offset). This offset is added to
the attachments to prevent ugly slurs. [fixme: we need more
documentation here].
slope-limit
(number):0.8
Set slope to zero if slope is running away steeper than this.
This object supports the following interfaces: spanner-interface, slur-interface and grob-interface
PianoPedalBracket objects are created by: none
Standard settings:
print-function
(procedure):Piano_pedal_bracket::print
Function taking grob as argument,
returning a Stencil
object.
style
(symbol):'line
This setting determines in what style a grob is
typeset. Valid choices depend on the print-function
that is
reading this property.
direction
(direction):-1
Up or down, left or right?
bracket-flare
(pair of numbers):'(0.5 . 0.5)
A pair of numbers specifying how
much edges of brackets should slant outward. Value 0.0 means straight
edges
edge-height
(pair):'(1.0 . 1.0)
A pair of number specifying the heights of
the vertical edges '(left-height . right-height).
shorten-pair
(pair of numbers):'(0.0 . 0.0)
The lengths to shorten a
text-spanner on both sides, for example a pedal bracket
thickness
(number):1.0
Bar line thickness, measured in
linethickness
.
This object supports the following interfaces: spanner-interface, piano-pedal-bracket-interface, piano-pedal-interface, line-interface and grob-interface
RehearsalMark objects are created by: Mark_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
X-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
self-alignment-X
(number):0
Specify alignment of an object. The
value -1 means left aligned, 0 centered, and 1 right-aligned in X
direction. Values in between may also be specified.
direction
(direction):1
Up or down, left or right?
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
font-size
(number):2
The font size, compared the `normal'
size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger.
Each step of 1 is approximately 12% larger, 6 steps are exactly a
factor 2 larger. Fractional values are allowed.
baseline-skip
(dimension, in staff space):2
Distance between base lines of
multiple lines of text.
break-visibility
(procedure):end-of-line-invisible
A function that takes the break
direction and returns a cons of booleans containing (transparent
. empty). The following variables are predefined:
all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
padding
(dimension, in staff space):0.8
Add this much extra space between objects that are next to each other.
This object supports the following interfaces: item-interface, self-alignment-interface, mark-interface, font-interface, side-position-interface, text-interface and grob-interface
RemoveEmptyVerticalGroup objects are created by: Hara_kiri_engraver
Standard settings:
Y-offset-callbacks
(list):'(#<primitive-procedure Hara_kiri_group_spanner::force_hara_kiri_callback>)
see X-offset-callbacks
.
Y-extent-callback
(procedure):Hara_kiri_group_spanner::y_extent
see X-extent-callback
.
remove-first
(boolean):#t
Remove the first staff of a orchestral score?
axes
(list):'(1)
list of axis numbers. In the case of alignment grobs, this should contain only one number.
This object supports the following interfaces: spanner-interface, item-interface, hara-kiri-group-interface, axis-group-interface and grob-interface
RepeatSlash objects are created by: Slash_repeat_engraver
Standard settings:
print-function
(procedure):Percent_repeat_item_interface::beat_slash
Function taking grob as argument,
returning a Stencil
object.
thickness
(number):0.48
Bar line thickness, measured in
linethickness
.
slope
(number):1.7
The slope of this object.
This object supports the following interfaces: item-interface, percent-repeat-interface and grob-interface
Rest objects are created by: Rest_engraver
Standard settings:
X-extent-callback
(procedure):Rest::extent_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
Y-extent-callback
(procedure):Rest::extent_callback
see X-extent-callback
.
print-function
(procedure):Rest::print
Function taking grob as argument,
returning a Stencil
object.
Y-offset-callbacks
(list):'(#<primitive-procedure Staff_symbol_referencer::callback> #<primitive-procedure Rest::polyphonic_offset_callback>)
see X-offset-callbacks
.
minimum-distance
(dimension, in staff space):0.25
Minimum distance between rest and notes or beam.
This object supports the following interfaces: item-interface, rest-interface, staff-symbol-referencer-interface, rhythmic-grob-interface, rhythmic-head-interface, font-interface and grob-interface
RestCollision objects are created by: Rest_collision_engraver
Standard settings:
minimum-distance
(dimension, in staff space):0.75
Minimum distance between rest and notes or beam.
This object supports the following interfaces: item-interface, rest-collision-interface and grob-interface
Script objects are created by: Drum_notes_engraver and Script_engraver
Standard settings:
print-function
(procedure):Script_interface::print
Function taking grob as argument,
returning a Stencil
object.
padding
(dimension, in staff space):0.2
Add this much extra space between
objects that are next to each other.
staff-padding
(dimension, in staff space):0.25
Maintain this much space between reference points
and the staff. Its effect is to align objects of differing
sizes (like the dynamic p and f) on their baselines.
X-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::centered_on_parent>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
before-line-breaking-callback
(procedure):Script_interface::before_line_breaking
This procedure is
called before line breaking, but after splitting breakable items at
potential line breaks.
font-encoding
(symbol):'music
The font encoding is the broadest category for selecting a font. Options include: music
, number
, text
,
math
, braces
, dynamic
This object supports the following interfaces: item-interface, font-interface, side-position-interface, script-interface and grob-interface
ScriptColumn objects are created by: Script_column_engraver
Standard settings:
before-line-breaking-callback
(procedure):Script_column::before_line_breaking
This procedure is called before line breaking, but after splitting breakable items at potential line breaks.
This object supports the following interfaces: item-interface, script-column-interface and grob-interface
SeparatingGroupSpanner objects are created by: Separating_line_group_engraver
Standard settings:
spacing-procedure
(procedure):Separating_group_spanner::set_spacing_rods
Procedure for calculating spacing
parameters. The routine is called after
before-line-breaking-callback
.
This object supports the following interfaces: spanner-interface, separation-spanner-interface, spacing-interface, only-prebreak-interface and grob-interface
SeparationItem objects are created by: Separating_line_group_engraver
Standard settings:
X-extent-callback
(procedure):#f
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
Y-extent-callback
(procedure):#f
see X-extent-callback
.
This object supports the following interfaces: item-interface, separation-item-interface, spacing-interface and grob-interface
Slur objects are created by: Slur_engraver
Standard settings:
print-function
(procedure):Slur::print
Function taking grob as argument,
returning a Stencil
object.
thickness
(number):1.2
Bar line thickness, measured in
linethickness
.
spacing-procedure
(procedure):Spanner::set_spacing_rods
Procedure for calculating spacing
parameters. The routine is called after
before-line-breaking-callback
.
minimum-length
(dimension, in staff space):1.5
Try to make a spanner at least
this long. This requires an appropriate routine for the
spacing-procedure
property.
extremity-function
(procedure):calc-slur-extremity
A function that calculates the
attachment of a slur-end. The function takes a slur and direction argument and returns a symbol.
extremity-offset-alist
(list):'(((head 1 1) -0.25 . 0.75) ((head 1 -1) -0.25 . 0.75) ((head -1 1) -0.25 . 0.75) ((head -1 -1) -0.85 . 0.75) ((stem 1 1) -0.125 . 0.5) ((stem -1 -1) -0.125 . 0.5) ((loose-end 1 1) -0.4 . 0) ((loose-end 1 -1) -0.4 . 0) ((loose-end -1 -1) -4 . 0) ((loose-end -1 1) -4 . 0))
The offset adds to the centre of the note head, or stem.
Format: alist (attachment stem-dir*dir slur-dir*dir) -> offset.
Y-extent-callback
(procedure):Slur::height
see X-extent-callback
.
height-limit
(dimension, in staff space):2.0
Maximum slur height: the longer the
slur, the closer it is to this height.
ratio
(number):0.333
Parameter for slur shape. The higher this number, the
quicker the slur attains it height-limit
.
beautiful
(number):0.5
number that dictates when a slur should be de-uglyfied. It correlates with the enclosed area between noteheads and slurs. A value of 0.1 yields only undisturbed slurs, a value of 5 will tolerate quite high blown slurs.
y-free
(dimension, in staff space):0.75
The minimal vertical gap between slur and
note heads or stems.
attachment
(pair):'(#f . #f)
Pair of symbols
indicating how a slur should be attached at the ends. The format is
'(left-type . right-type), where both types are
symbols. The values of these symbols may be alongside-stem
,
stem
, head
or loose-end
.
attachment-offset
(pair):'((0 . 0) 0 . 0)
cons of offsets,
'(left-offset . right-offset). This offset is added to
the attachments to prevent ugly slurs. [fixme: we need more
documentation here].
slope-limit
(number):0.8
Set slope to zero if slope is running away steeper than this.
This object supports the following interfaces: spanner-interface, slur-interface and grob-interface
SostenutoPedal objects are created by: Piano_pedal_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
direction
(direction):1
Up or down, left or right?
X-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
no-spacing-rods
(boolean):#t
Items with this property do not cause
spacing constraints.
padding
(dimension, in staff space):0.0
Add this much extra space between
objects that are next to each other.
font-shape
(symbol):'italic
Select the shape of a font. Choices include upright
,
italic
, caps
.
self-alignment-X
(number):0
Specify alignment of an object. The value -1 means left aligned, 0 centered, and 1 right-aligned in X direction. Values in between may also be specified.
This object supports the following interfaces: item-interface, font-interface, self-alignment-interface, text-interface and grob-interface
SostenutoPedalLineSpanner objects are created by: Piano_pedal_engraver
Standard settings:
axes
(list):'(1)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
Y-extent-callback
(procedure):Axis_group_interface::group_extent_callback
see X-extent-callback
.
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
padding
(dimension, in staff space):1.2
Add this much extra space between
objects that are next to each other.
minimum-space
(dimension, in staff space):1.0
Minimum distance that the victim
should move (after padding).
direction
(direction):-1
Up or down, left or right?
This object supports the following interfaces: spanner-interface, side-position-interface, axis-group-interface, piano-pedal-interface and grob-interface
SpacingSpanner objects are created by: Spacing_engraver
Standard settings:
spacing-procedure
(procedure):Spacing_spanner::set_springs
Procedure for calculating spacing
parameters. The routine is called after
before-line-breaking-callback
.
grace-space-factor
(number):0.6
Space grace notes at this fraction
of the spacing-increment
.
shortest-duration-space
(dimension, in staff space):2.0
Start with this much
space for the shortest duration. This is expressed in
spacing-increment
as unit. See also
spacing-spanner-interface.
spacing-increment
(number):1.2
Add this much space for a doubled
duration. Typically, the width of a note head. See also
spacing-spanner-interface.
base-shortest-duration
(moment):'#<Mom 1/8>
Spacing is based on the shortest notes in a piece. Normally, pieces are spaced as if notes at least as short as this are present.
This object supports the following interfaces: spanner-interface, spacing-spanner-interface, spacing-interface and grob-interface
SpanBar objects are created by: Span_bar_engraver
Standard settings:
break-align-symbol
(symbol):'staff-bar
This key is used for aligning and
spacing breakable items.
bar-size-procedure
(procedure):Span_bar::get_bar_size
Procedure that computes the size of a bar line.
print-function
(procedure):Span_bar::print
Function taking grob as argument,
returning a Stencil
object.
X-extent-callback
(procedure):Span_bar::width_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
Y-extent-callback
(procedure):'()
see X-extent-callback
.
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
before-line-breaking-callback
(procedure):Span_bar::before_line_breaking
This procedure is
called before line breaking, but after splitting breakable items at
potential line breaks.
kern
(dimension, in staff space):3.0
Amount of extra white space to add. For
bar line, this is the amount of space after a thick line.
thin-kern
(number):3.0
The space after a hair-line in a bar line.
hair-thickness
(number):1.6
Thickness of the thin line in a bar line.
thick-thickness
(number):6.0
Bar line thickness, measured in
linethickness
.
This object supports the following interfaces: item-interface, bar-line-interface, font-interface, span-bar-interface and grob-interface
StaffSpacing objects are created by: Separating_line_group_engraver
Standard settings:
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
stem-spacing-correction
(number):0.4
Optical correction amount for stems that are placed in tight configurations. For opposite directions, this amount is the correction for two normal sized stems that overlap completely.
This object supports the following interfaces: item-interface, staff-spacing-interface, spacing-interface and grob-interface
StaffSymbol objects are created by: Staff_symbol_engraver and Tab_staff_symbol_engraver
Standard settings:
print-function
(procedure):Staff_symbol::print
Function taking grob as argument,
returning a Stencil
object.
line-count
(integer):5
The number of staff lines.
ledger-line-thickness
(pair of numbers):'(1.0 . 0.1)
The thickness of ledger lines: it is the
sum of 2 numbers. The first is the factor for line thickness, and the
second for staff space. Both contributions are added.
layer
(number):0
The output layer [0..2]: layers define the order of printing objects. Objects in lower layers are overprinted by objects in higher layers.
This object supports the following interfaces: spanner-interface, staff-symbol-interface and grob-interface
StanzaNumber objects are created by: Stanza_number_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
font-series
(symbol):'bold
Select the series of a font. Choices
include medium
, bold
, bold-narrow
, etc.
padding
(dimension, in staff space):1.0
Add this much extra space between
objects that are next to each other.
X-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
direction
(direction):-1
Up or down, left or right?
This object supports the following interfaces: item-interface, font-interface, text-interface, stanza-number-interface, side-position-interface and grob-interface
Stem objects are created by: Stem_engraver
Standard settings:
before-line-breaking-callback
(procedure):Stem::before_line_breaking
This procedure is
called before line breaking, but after splitting breakable items at
potential line breaks.
print-function
(procedure):Stem::print
Function taking grob as argument,
returning a Stencil
object.
thickness
(number):1.3
Bar line thickness, measured in
linethickness
.
lengths
(list):'(3.5 3.5 3.5 4.5 5.0)
Default stem lengths. The list gives a length
for each flag-count.
stem-shorten
(list):'(1.0 0.5)
How much a stem in a forced direction
should be shortened. The list gives an amount depending on the number
of flags/beams.
neutral-direction
(direction):-1
Which direction to take in the
center of the staff.
beamed-lengths
(list):'(3.5 3.5 3.5 4.5 5.0)
list of stem lengths given beam multiplicity .
beamed-minimum-free-lengths
(list):'(1.83 1.5 1.25)
list of normal minimum free stem lengths (chord to beams) given beam multiplicity.
beamed-extreme-minimum-free-lengths
(list):'(2.0 1.25)
list of extreme minimum free stem lengths (chord to beams) given beam multiplicity.
X-offset-callbacks
(list):'(#<primitive-procedure Stem::off_callback>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
X-extent-callback
(procedure):Stem::dim_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
Y-extent-callback
(procedure):Stem::height
see X-extent-callback
.
Y-offset-callbacks
(list):'(#<primitive-procedure Staff_symbol_referencer::callback>)
see X-offset-callbacks
.
This object supports the following interfaces: item-interface, font-interface, stem-interface and grob-interface
StemTremolo objects are created by: Stem_engraver
Standard settings:
print-function
(procedure):Stem_tremolo::print
Function taking grob as argument,
returning a Stencil
object.
Y-extent-callback
(procedure):Stem_tremolo::height
see X-extent-callback
.
X-extent-callback
(procedure):#f
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
beam-width
(dimension, in staff space):1.6
width of the tremolo sign.
beam-thickness
(dimension, in staff space):0.48
thickness, measured in staffspace.
This object supports the following interfaces: item-interface, stem-tremolo-interface and grob-interface
SustainPedal objects are created by: Piano_pedal_engraver
Standard settings:
no-spacing-rods
(boolean):#t
Items with this property do not cause
spacing constraints.
print-function
(procedure):Sustain_pedal::print
Function taking grob as argument,
returning a Stencil
object.
self-alignment-X
(number):0
Specify alignment of an object. The
value -1 means left aligned, 0 centered, and 1 right-aligned in X
direction. Values in between may also be specified.
direction
(direction):1
Up or down, left or right?
padding
(dimension, in staff space):0.0
Add this much extra space between
objects that are next to each other.
X-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self>)
A list of functions determining this objects' position relative to its parent. The last one in the list is called first. The functions take a grob and axis argument.
This object supports the following interfaces: item-interface, font-interface, self-alignment-interface, text-interface, text-spanner-interface, piano-pedal-interface and grob-interface
SustainPedalLineSpanner objects are created by: Piano_pedal_engraver
Standard settings:
axes
(list):'(1)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
Y-extent-callback
(procedure):Axis_group_interface::group_extent_callback
see X-extent-callback
.
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
padding
(dimension, in staff space):1.2
Add this much extra space between
objects that are next to each other.
staff-padding
(dimension, in staff space):1.2
Maintain this much space between reference points
and the staff. Its effect is to align objects of differing
sizes (like the dynamic p and f) on their baselines.
minimum-space
(dimension, in staff space):1.0
Minimum distance that the victim
should move (after padding).
direction
(direction):-1
Up or down, left or right?
This object supports the following interfaces: spanner-interface, side-position-interface, axis-group-interface, piano-pedal-interface and grob-interface
System objects are created by: Score_engraver
Standard settings:
axes
(list):'(0 1)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
X-extent-callback
(procedure):Axis_group_interface::group_extent_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
Y-extent-callback
(procedure):Axis_group_interface::group_extent_callback
see X-extent-callback
.
This object supports the following interfaces: spanner-interface, axis-group-interface, system-interface and grob-interface
SystemStartBar objects are created by: System_start_delimiter_engraver
Standard settings:
Y-extent-callback
(procedure):#f
see X-extent-callback
.
print-function
(procedure):System_start_delimiter::print
Function taking grob as argument,
returning a Stencil
object.
glyph
(string):bar-line
a string determining what (style) of glyph is
typeset. Valid choices depend on the function that is reading this
property.
thickness
(number):1.6
Bar line thickness, measured in
linethickness
.
This object supports the following interfaces: spanner-interface, system-start-delimiter-interface and grob-interface
SystemStartBrace objects are created by: System_start_delimiter_engraver
Standard settings:
glyph
(string):brace
a string determining what (style) of glyph is
typeset. Valid choices depend on the function that is reading this
property.
print-function
(procedure):System_start_delimiter::print
Function taking grob as argument,
returning a Stencil
object.
collapse-height
(dimension, in staff space):5.0
Minimum height of system start delimiter. If equal or smaller, the bracket is removed.
font-encoding
(symbol):'braces
The font encoding is the broadest category for selecting a font. Options include: music
, number
, text
,
math
, braces
, dynamic
Y-extent-callback
(procedure):#f
see X-extent-callback
.
This object supports the following interfaces: font-interface, system-start-delimiter-interface and grob-interface
SystemStartBracket objects are created by: System_start_delimiter_engraver
Standard settings:
Y-extent-callback
(procedure):#f
see X-extent-callback
.
print-function
(procedure):System_start_delimiter::print
Function taking grob as argument,
returning a Stencil
object.
glyph
(string):bracket
a string determining what (style) of glyph is
typeset. Valid choices depend on the function that is reading this
property.
arch-height
(dimension, in staff space):1.5
Height of the hook of a system brace.
arch-angle
(number):50.0
Turning angle of the hook of a system brace
arch-thick
(number):0.25
Thickness of the hook of system brace.
arch-width
(dimension, in staff space):1.5
Width of the hook of a system brace.
collapse-height
(dimension, in staff space):1
Minimum height of system start delimiter. If equal or smaller, the bracket is removed.
thickness
(number):0.25
Bar line thickness, measured in
linethickness
.
This object supports the following interfaces: spanner-interface, system-start-delimiter-interface and grob-interface
TabNoteHead objects are created by: Tab_note_heads_engraver
Standard settings:
style
(symbol):'default
This setting determines in what style a grob is
typeset. Valid choices depend on the print-function
that is
reading this property.
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
Y-offset-callbacks
(list):'(#<primitive-procedure Staff_symbol_referencer::callback>)
see X-offset-callbacks
.
extra-offset
(pair of numbers):'(0 . -0.65)
A pair representing an offset. This
offset is added just before outputting the symbol, so the typesetting
engine is completely oblivious to it.
stem-attachment-function
(procedure):tablature-stem-attachment-function
A function that calculates where a stem attaches to the note head? This is a fallback when this information is not specified in the font. The function takes a grob and axis argument, and returns a (x . y) pair, specifying location in terms of note head bounding box.
This object supports the following interfaces: item-interface, text-interface, staff-symbol-referencer-interface, note-head-interface, font-interface, rhythmic-head-interface and grob-interface
TextScript objects are created by: Text_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
no-spacing-rods
(boolean):#t
Items with this property do not cause
spacing constraints.
X-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self>)
A list of functions determining this
objects' position relative to its parent. The last one in the list is
called first. The functions take a grob and axis argument.
direction
(direction):-1
Up or down, left or right?
padding
(dimension, in staff space):0.5
Add this much extra space between
objects that are next to each other.
staff-padding
(dimension, in staff space):0.5
Maintain this much space between reference points
and the staff. Its effect is to align objects of differing
sizes (like the dynamic p and f) on their baselines.
script-priority
(number):200
A sorting key that determines in what order a script is within a stack of scripts.
This object supports the following interfaces: item-interface, font-interface, side-position-interface, text-interface, text-script-interface and grob-interface
TextSpanner objects are created by: Dynamic_engraver and Text_spanner_engraver
Standard settings:
print-function
(procedure):Text_spanner::print
Function taking grob as argument,
returning a Stencil
object.
font-shape
(symbol):'italic
Select the shape of a font. Choices include upright
,
italic
, caps
.
style
(symbol):'dashed-line
This setting determines in what style a grob is
typeset. Valid choices depend on the print-function
that is
reading this property.
staff-padding
(dimension, in staff space):0.1
Maintain this much space between reference points
and the staff. Its effect is to align objects of differing
sizes (like the dynamic p and f) on their baselines.
dash-fraction
(number):0.2
Size of the dashes, relative to
dash-period. Should be between 0.0 (no line) and 1.0 (continuous
line).
dash-period
(number):3.0
the length of one dash + white space. If
negative, no line is drawn at all.
direction
(direction):1
Up or down, left or right?
This object supports the following interfaces: spanner-interface, font-interface, side-position-interface, text-spanner-interface and grob-interface
Tie objects are created by: Completion_heads_engraver and Tie_engraver
Standard settings:
print-function
(procedure):Tie::print
Function taking grob as argument,
returning a Stencil
object.
spacing-procedure
(procedure):Spanner::set_spacing_rods
Procedure for calculating spacing
parameters. The routine is called after
before-line-breaking-callback
.
staffline-clearance
(dimension, in staff space):0.35
How far away ties keep from
staff lines.
thickness
(number):1.2
Bar line thickness, measured in
linethickness
.
x-gap
(dimension, in staff space):-0.1
The horizontal gap between note head and tie.
y-offset
(dimension, in staff space):0.6
Extra vertical offset for ties away
from the center line.
minimum-length
(dimension, in staff space):2.5
Try to make a spanner at least
this long. This requires an appropriate routine for the
spacing-procedure
property.
This object supports the following interfaces: spanner-interface, tie-interface and grob-interface
TieColumn objects are created by: Tie_engraver
Standard settings:
X-extent-callback
(procedure):#f
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
Y-extent-callback
(procedure):#f
see X-extent-callback
.
This object supports the following interfaces: spanner-interface, tie-column-interface and grob-interface
TimeSignature objects are created by: Time_signature_engraver
Standard settings:
print-function
(procedure):Time_signature::print
Function taking grob as argument,
returning a Stencil
object.
break-align-symbol
(symbol):'time-signature
This key is used for aligning and
spacing breakable items.
break-visibility
(procedure):all-visible
A function that takes the break
direction and returns a cons of booleans containing (transparent
. empty). The following variables are predefined:
all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
space-alist
(list):'((first-note fixed-space . 2.0) (right-edge extra-space . 0.5) (staff-bar minimum-space . 2.0))
A table that specifies distances between
prefatory items, like clef and time-signature. The format is an alist
of spacing tuples: (
break-align-symbol type
.
distance)
, where type can be the symbols
minimum-space
or extra-space
.
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
style
(symbol):'C
This setting determines in what style a grob is
typeset. Valid choices depend on the print-function
that is
reading this property.
This object supports the following interfaces: item-interface, font-interface, break-aligned-interface, time-signature-interface and grob-interface
TupletBracket objects are created by: Ligature_bracket_engraver and Tuplet_engraver
Standard settings:
padding
(dimension, in staff space):1.1
Add this much extra space between
objects that are next to each other.
thickness
(number):1.6
Bar line thickness, measured in
linethickness
.
edge-height
(pair):'(0.7 . 0.7)
A pair of number specifying the heights of
the vertical edges '(left-height . right-height).
shorten-pair
(pair of numbers):'(-0.2 . -0.2)
The lengths to shorten a
text-spanner on both sides, for example a pedal bracket
before-line-breaking-callback
(procedure):Tuplet_bracket::before_line_breaking
This procedure is
called before line breaking, but after splitting breakable items at
potential line breaks.
print-function
(procedure):Tuplet_bracket::print
Function taking grob as argument,
returning a Stencil
object.
font-shape
(symbol):'italic
Select the shape of a font. Choices include upright
,
italic
, caps
.
font-series
(symbol):'bold
Select the series of a font. Choices
include medium
, bold
, bold-narrow
, etc.
font-size
(number):-2
The font size, compared the `normal' size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger. Each step of 1 is approximately 12% larger, 6 steps are exactly a factor 2 larger. Fractional values are allowed.
This object supports the following interfaces: spanner-interface, font-interface, tuplet-bracket-interface, line-interface, text-interface and grob-interface
UnaCordaPedal objects are created by: Piano_pedal_engraver
Standard settings:
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
font-shape
(symbol):'italic
Select the shape of a font. Choices include upright
,
italic
, caps
.
no-spacing-rods
(boolean):#t
Items with this property do not cause
spacing constraints.
self-alignment-X
(number):0
Specify alignment of an object. The
value -1 means left aligned, 0 centered, and 1 right-aligned in X
direction. Values in between may also be specified.
direction
(direction):1
Up or down, left or right?
padding
(dimension, in staff space):0.0
Add this much extra space between
objects that are next to each other.
X-offset-callbacks
(list):'(#<primitive-procedure Self_alignment_interface::aligned_on_self>)
A list of functions determining this objects' position relative to its parent. The last one in the list is called first. The functions take a grob and axis argument.
This object supports the following interfaces: item-interface, font-interface, self-alignment-interface, text-interface and grob-interface
UnaCordaPedalLineSpanner objects are created by: Piano_pedal_engraver
Standard settings:
axes
(list):'(1)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
Y-extent-callback
(procedure):Axis_group_interface::group_extent_callback
see X-extent-callback
.
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
padding
(dimension, in staff space):1.2
Add this much extra space between
objects that are next to each other.
staff-padding
(dimension, in staff space):1.2
Maintain this much space between reference points
and the staff. Its effect is to align objects of differing
sizes (like the dynamic p and f) on their baselines.
minimum-space
(dimension, in staff space):1.0
Minimum distance that the victim
should move (after padding).
direction
(direction):-1
Up or down, left or right?
This object supports the following interfaces: spanner-interface, side-position-interface, axis-group-interface, piano-pedal-interface and grob-interface
VaticanaLigature objects are created by: Vaticana_ligature_engraver
Standard settings:
thickness
(number):0.6
Bar line thickness, measured in
linethickness
.
print-function
(procedure):Vaticana_ligature::print
Function taking grob as argument,
returning a Stencil
object.
This object supports the following interfaces: font-interface, vaticana-ligature-interface and grob-interface
VerticalAlignment objects are created by: Vertical_align_engraver
Standard settings:
axes
(list):'(1)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
Y-extent-callback
(procedure):Axis_group_interface::group_extent_callback
see X-extent-callback
.
X-extent-callback
(procedure):Axis_group_interface::group_extent_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
stacking-dir
(direction):-1
Stack objects in which direction?
This object supports the following interfaces: spanner-interface, axis-group-interface, align-interface and grob-interface
VerticalAxisGroup objects are created by: Axis_group_engraver
Standard settings:
axes
(list):'(1)
list of axis numbers.
In the case of alignment grobs, this should contain only one number.
Y-extent-callback
(procedure):Axis_group_interface::group_extent_callback
see X-extent-callback
.
X-extent-callback
(procedure):Axis_group_interface::group_extent_callback
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
This object supports the following interfaces: spanner-interface, axis-group-interface and grob-interface
VocalName objects are created by: Vocal_name_engraver
Standard settings:
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_on_support_refpoints>)
see X-offset-callbacks
.
direction
(direction):0
Up or down, left or right?
space-alist
(list):'((left-edge extra-space . 1.0))
A table that specifies distances between
prefatory items, like clef and time-signature. The format is an alist
of spacing tuples: (
break-align-symbol type
.
distance)
, where type can be the symbols
minimum-space
or extra-space
.
break-align-symbol
(symbol):'instrument-name
This key is used for aligning and
spacing breakable items.
print-function
(procedure):Text_item::print
Function taking grob as argument,
returning a Stencil
object.
break-align-symbol
(symbol):'instrument-name
This key is used for aligning and
spacing breakable items.
break-visibility
(procedure):begin-of-line-visible
A function that takes the break
direction and returns a cons of booleans containing (transparent
. empty). The following variables are predefined:
all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
baseline-skip
(dimension, in staff space):2
Distance between base lines of multiple lines of text.
This object supports the following interfaces: item-interface, break-aligned-interface, text-interface, side-position-interface, self-alignment-interface, font-interface and grob-interface
VoiceFollower objects are created by: Note_head_line_engraver
Standard settings:
style
(symbol):'line
This setting determines in what style a grob is
typeset. Valid choices depend on the print-function
that is
reading this property.
gap
(dimension, in staff space):0.5
Size of a gap in a variable symbol.
breakable
(boolean):#t
Can this object appear at a line break,
like clefs and bar lines?
X-extent-callback
(procedure):#f
Procedure that calculates the
extent of this object. If this value is set to #f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
Y-extent-callback
(procedure):#f
see X-extent-callback
.
print-function
(procedure):Line_spanner::print
Function taking grob as argument,
returning a Stencil
object.
This object supports the following interfaces: spanner-interface, line-spanner-interface and grob-interface
VoltaBracket objects are created by: Volta_engraver
Standard settings:
print-function
(procedure):Volta_bracket_interface::print
Function taking grob as argument,
returning a Stencil
object.
direction
(direction):1
Up or down, left or right?
padding
(dimension, in staff space):1
Add this much extra space between
objects that are next to each other.
font-encoding
(symbol):'number
The font encoding is the broadest category for selecting a font. Options include: music
, number
, text
,
math
, braces
, dynamic
Y-offset-callbacks
(list):'(#<primitive-procedure Side_position_interface::aligned_side>)
see X-offset-callbacks
.
thickness
(number):1.6
Bar line thickness, measured in
linethickness
.
height
(dimension, in staff space):2.0
Height of an object in staffspace.
minimum-space
(dimension, in staff space):5
Minimum distance that the victim
should move (after padding).
font-size
(number):-4
The font size, compared the `normal' size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger. Each step of 1 is approximately 12% larger, 6 steps are exactly a factor 2 larger. Fractional values are allowed.
This object supports the following interfaces: spanner-interface, font-interface, side-position-interface, text-interface, line-interface, volta-bracket-interface and grob-interface
a single accidental
accidentals
(list)cautionary
(boolean)cautionary-style
(symbol)smaller
or
parentheses
.
style
(symbol)print-function
that is
reading this property.
tie
(layout object)This grob interface is used in the following graphical objects: Accidental
Resolve accidental collisions.
left-padding
(dimension, in staff space)padding
(dimension, in staff space)right-padding
(dimension, in staff space)accidental-grobs
(list)positioning-done
(boolean)This grob interface is used in the following graphical objects: AccidentalPlacement
Order grobs from top to bottom, left to right, right to left or bottomto top.
align-dir
(direction)-1
: left side,
0
: around center of width, 1
: right side.
axes
(list)forced-distance
(dimension, in staff space)stacking-dir
(direction)threshold
(pair of numbers)center-element
(layout object)elements
(list of grobs)positioning-done
(boolean)This grob interface is used in the following graphical objects: VerticalAlignment
An object that represents the pitch range of a voice.
accidentals
(list)c0-position
(integer)pitch-max
(pitch)pitch-min
(pitch)accidentals-style
(symbol)join-heads
(boolean)note-head-style
(string)This grob interface is used in the following graphical objects: Ambitus
Functions and settings for drawing an arpeggio symbol (a wavy line left to noteheads.
arpeggio-direction
(direction)stems
(list of grobs)This grob interface is used in the following graphical objects: Arpeggio
An object that groups other layout objects.
axes
(list)elements
(list of grobs)This grob interface is used in the following graphical objects: BreakAlignGroup, BreakAlignment, DotColumn, DynamicLineSpanner, NonMusicalPaperColumn, NoteCollision, NoteColumn, PaperColumn, RemoveEmptyVerticalGroup, SostenutoPedalLineSpanner, SustainPedalLineSpanner, System, UnaCordaPedalLineSpanner, VerticalAlignment and VerticalAxisGroup
Bar line.
Print a special bar symbol. It replaces the
regular bar symbol with a special
symbol. The argument bartype is a string which specifies the
kind of bar to print. Options are :|
,
|:
, :|:
,
||
, |.
,
.|
, and .|.
.
These produce, respectively, a right repeat, a left repeat, a double
repeat, a double bar, a start bar, an end bar, and a thick double bar.
If bartype is set to empty
then nothing is printed,
but a line break is allowed at that spot.
bar-size
(dimension, in staff space)bar-size-procedure
(procedure)break-glyph-function
(procedure)glyph
(string)hair-thickness
(number)kern
(dimension, in staff space)thick-thickness
(number)linethickness
.
thin-kern
(number)This grob interface is used in the following graphical objects: BarLine and SpanBar
A bass figure, including bracket
This grob interface is used in the following graphical objects: BassFigure
A beam.
The thickness
property is the weight of beams, and is measured in staffspace
auto-knee-gap
(dimension, in staff space)beamed-stem-shorten
(list)concaveness-gap
(dimension, in staff space)concaveness-threshold
(number)Concaveness is calculated as the sum of the vertical distances of
inner note heads that fall outside the interval of the two outer
note heads, to the vertically nearest outer note head, divided by the
square of the inner notes involved.
damping
(integer)dir-function
(procedure)beam-dir-majority
beam-dir-mean
beam-dir-median.
flag-width-function
(procedure)gap
(dimension, in staff space)gap-count
(integer)knee
(boolean)neutral-direction
(direction)positions
(pair)(
left
.
right)
, where both left and right are in the
staff-space unit of the current staff.
space-function
(procedure)thickness
(number)linethickness
.
chord-tremolo
(boolean)least-squares-dy
(number)position-callbacks
(list)positioning-done
(boolean)quant-score
(number)shorten
(dimension, in staff space)This grob interface is used in the following graphical objects: Beam
Items that are aligned in prefatory matter.
The spacing of these items is controlled by the space-alist
property. It contains a list break-align-symbol
s with a specification
of the associated space. The space specification can be
(minimum-space .
spc))
(fixed-space .
spc)
(semi-fixed-space .
spc)
(extra-space .
spc)
Special keys for the alist are first-note
and next-note
, signifying
the first note on a line, and the next note halfway a line.
Rules for this spacing are much more complicated than this. See [Wanske] page 126 – 134, [Ross] pg 143 – 147
break-align-symbol
(symbol)space-alist
(list)(
break-align-symbol type
.
distance)
, where type can be the symbols
minimum-space
or extra-space
.
This grob interface is used in the following graphical objects: Ambitus, BarLine, BarNumber, BreakAlignGroup, BreathingSign, Clef, Custos, DoublePercentRepeat, InstrumentName, KeySignature, LeftEdge, TimeSignature and VocalName
The object that performs break aligment. See break-aligned-interface.
break-align-orders
(hash table)For example, clefs are put after key signatures by setting
\override Score.BreakAlignment #'break-align-orders = #(make-vector 3 '(span-bar breathing-sign staff-bar key clef time-signature))
positioning-done
(boolean)This grob interface is used in the following graphical objects: BreakAlignment
A breathing sign.
direction
(direction)This grob interface is used in the following graphical objects: BreathingSign
A chord name.
begin-of-line-visible
(boolean)This grob interface is used in the following graphical objects: ChordName
A clef sign
full-size-change
(boolean)glyph-name
(string)non-default
(boolean)This grob interface is used in the following graphical objects: Clef
A place holder for the cluster spanner to determine the vertical extents of a cluster spanner at this X position.
positions
(pair)(
left
.
right)
, where both left and right are in the
staff-space unit of the current staff.
This grob interface is used in the following graphical objects: ClusterSpannerBeacon
A graphically drawn musical cluster.
padding
adds to the vertical extent of the shape (top and bottom).
The property style
controls the shape of cluster segments. Valid values include leftsided-stairs
, rightsided-stairs
, centered-stairs
, and ramp
.
padding
(dimension, in staff space)style
(symbol)print-function
that is
reading this property.
columns
(list of grobs)This grob interface is used in the following graphical objects: ClusterSpanner
A custos object.
neutral-direction
(direction)neutral-position
(number)style
(symbol)print-function
that is
reading this property.
This grob interface is used in the following graphical objects: Custos
Groups dot objects so they form a column, and position dots so they do not clash with staff lines
direction
(direction)positioning-done
(boolean)stem
(layout object)This grob interface is used in the following graphical objects: DotColumn
The dots to go with a notehead or rest.direction
sets the preferred direction to move in case of staff line collisions.
direction
(direction)dot-count
(integer)This grob interface is used in the following graphical objects: Dots
Any kind of loudness sign
This grob interface is used in the following graphical objects: DynamicLineSpanner, DynamicText and Hairpin
A fingering instruction
This grob interface is used in the following graphical objects: Fingering
Any symbol that is typeset through fixed sets of glyphs, (ie. fonts)
font-encoding
(symbol)music
, number
, text
,
math
, braces
, dynamic
font-family
(symbol)sans
, roman
font-magnification
(number)font-name
.
font-name
(string)font-family
, font-series
and font-shape
.
font-series
(symbol)medium
, bold
, bold-narrow
, etc.
font-shape
(symbol)upright
,
italic
, caps
.
font-size
(number)font
(font metric)This grob interface is used in the following graphical objects: Accidental, Ambitus, Arpeggio, BarLine, BarNumber, BassFigure, BreathingSign, ChordName, Clef, CombineTextScript, Custos, Dots, DoublePercentRepeat, DynamicText, Fingering, InstrumentName, KeySignature, LyricText, MensuralLigature, MetronomeMark, MultiMeasureRest, MultiMeasureRestNumber, MultiMeasureRestText, NoteHead, NoteName, OctavateEight, OttavaBracket, PercentRepeat, RehearsalMark, Rest, Script, SostenutoPedal, SpanBar, StanzaNumber, Stem, SustainPedal, SystemStartBrace, TabNoteHead, TextScript, TextSpanner, TimeSignature, TupletBracket, UnaCordaPedal, VaticanaLigature, VocalName and VoltaBracket
A gregorian ligature
ascendens
(boolean)auctum
(boolean)cavum
(boolean)context-info
(integer)deminutum
(boolean)descendens
(boolean)inclinatum
(boolean)linea
(boolean)oriscus
(boolean)pes-or-flexa
(boolean)prefix-set
(number)
quilisma
(boolean)stropha
(boolean)virga
(boolean)This grob interface is used in the following graphical objects: none
A grob represents a piece of music notation
All grobs have an X and Y-position on the page. These X and Y positions are stored in a relative format, so they can easily be combined by stacking them, hanging one grob to the side of another, and coupling them into a grouping objects.
Each grob has a reference point (a.k.a. parent): the position of a grob is stored relative to that reference point. For example the X-reference point of a staccato dot usually is the note head that it applies to. When the note head is moved, the staccato dot moves along automatically.
A grob is often associated with a symbol, but some grobs do not print any symbols. They take care of grouping objects. For example, there is a separate grob that stacks staves vertically. The NoteCollision is also an abstract grob: it only moves around chords, but doesn't print anything.
Grobs have a properties: Scheme variables, that can be read and set. They have two types. Immutable variables define the default style and behavior. They are shared between many objects. They can be changed using \override
and \revert
.
Mutable properties are variables that are specific to one grob. Typically, lists of other objects, or results from computations are stored inmutable properties: every call to set-grob-property (or its C++ equivalent) sets a mutable property.
X-extent
(pair of numbers)X-extent-callback
(procedure)#f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
X-offset-callbacks
(list)Y-extent
(pair of numbers)X-extent
.
Y-extent-callback
(procedure)X-extent-callback
.
Y-offset-callbacks
(list)X-offset-callbacks
.
before-line-breaking-callback
(procedure)extra-X-extent
(pair of numbers)extra-Y-extent
(pair of numbers)extra-Y-extent
.
extra-offset
(pair of numbers)layer
(number)minimum-X-extent
(pair of numbers)minimum-Y-extent
(pair of numbers)minimum-Y-extent
.
print-function
(procedure)Stencil
object.
spacing-procedure
(procedure)before-line-breaking-callback
.
transparent
(boolean)print-function
to #f
, but this retains the dimensions of
this grob, which means that grobs can be erased individually.
after-line-breaking-callback
(procedure)cause
(any type)dependencies
(list of grobs)interfaces
(list)meta
field.
meta
(list)name
and interfaces
.
staff-symbol
(layout object)stencil
(unknown)This grob interface is used in the following graphical objects: Accidental, AccidentalPlacement, Ambitus, Arpeggio, BarLine, BarNumber, BassFigure, Beam, BreakAlignGroup, BreakAlignment, BreathingSign, ChordName, Clef, ClusterSpanner, ClusterSpannerBeacon, CombineTextScript, Custos, DotColumn, Dots, DoublePercentRepeat, DynamicLineSpanner, DynamicText, Fingering, Glissando, Hairpin, HorizontalBracket, InstrumentName, KeySignature, LeftEdge, LigatureBracket, LyricExtender, LyricHyphen, LyricText, MeasureGrouping, MensuralLigature, MetronomeMark, MultiMeasureRest, MultiMeasureRestNumber, MultiMeasureRestText, NonMusicalPaperColumn, NoteCollision, NoteColumn, NoteHead, NoteName, NoteSpacing, OctavateEight, OttavaBracket, PaperColumn, PercentRepeat, PhrasingSlur, PianoPedalBracket, RehearsalMark, RemoveEmptyVerticalGroup, RepeatSlash, Rest, RestCollision, Script, ScriptColumn, SeparatingGroupSpanner, SeparationItem, Slur, SostenutoPedal, SostenutoPedalLineSpanner, SpacingSpanner, SpanBar, StaffSpacing, StaffSymbol, StanzaNumber, Stem, StemTremolo, SustainPedal, SustainPedalLineSpanner, System, SystemStartBar, SystemStartBrace, SystemStartBracket, TabNoteHead, TextScript, TextSpanner, Tie, TieColumn, TimeSignature, TupletBracket, UnaCordaPedal, UnaCordaPedalLineSpanner, VaticanaLigature, VerticalAlignment, VerticalAxisGroup, VocalName, VoiceFollower and VoltaBracket
A hairpin (de)crescendo.
grow-direction
(direction)height
(dimension, in staff space)if-text-padding
(number)This grob interface is used in the following graphical objects: Hairpin
A group spanner that keeps track of interesting items. If it doesn't contain any after linebreaking, then it will remove itself and all its children.
remove-first
(boolean)items-worth-living
(list of grobs)This grob interface is used in the following graphical objects: RemoveEmptyVerticalGroup
A horizontal bracket encompassing notes.
direction
(direction)thickness
(number)linethickness
.
columns
(list of grobs)This grob interface is used in the following graphical objects: HorizontalBracket
Grobs can be distinguished in their role in the horizontal spacing.
Many grobs define constraints on the spacing by their sizes. For
example, note heads, clefs, stems, and all other symbols with a fixed
shape. These grobs form a subtype called Item
.
Some items need special treatment for line breaking. For example, a clef is normally only printed at the start of a line (i.e. after a line break). To model this, `breakable' items (clef, key signature, bar lines, etc.) are copied twice. Then we have three versions of each breakable item: one version if there is no line break, one version that is printed before the line break (at the end of a system), one version that is printed after the line break.
Whether these versions are visible and take up space, is determined by
the outcome of the break-visibility
. This grob property is a
function taking a direction (-1, 0 or 1) as argument. It returns a
cons of booleans, signifying whether this grob should be transparent
and have no extent.
The following variables for break-visibility are predefined:
grob will show: before no after break break break all-invisible no no no begin-of-line-visible no no yes end-of-line-visible yes no no all-visible yes yes yes begin-of-line-invisible yes yes no end-of-line-invisible no yes yes
break-visibility
(procedure)all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
breakable
(boolean)no-spacing-rods
(boolean)This grob interface is used in the following graphical objects: Accidental, AccidentalPlacement, Ambitus, Arpeggio, BarLine, BarNumber, BassFigure, BreakAlignGroup, BreakAlignGroup, BreakAlignment, BreathingSign, ChordName, Clef, ClusterSpannerBeacon, CombineTextScript, Custos, DotColumn, Dots, DoublePercentRepeat, DynamicText, Fingering, InstrumentName, KeySignature, LeftEdge, LyricText, MetronomeMark, NonMusicalPaperColumn, NoteCollision, NoteColumn, NoteHead, NoteName, NoteSpacing, OctavateEight, PaperColumn, RehearsalMark, RemoveEmptyVerticalGroup, RepeatSlash, Rest, RestCollision, Script, ScriptColumn, SeparationItem, SostenutoPedal, SpanBar, StaffSpacing, StanzaNumber, Stem, StemTremolo, SustainPedal, TabNoteHead, TextScript, TimeSignature, UnaCordaPedal and VocalName
A group of accidentals, to be printed as signature sign.
c0-position
(integer)new-accidentals
(list)(
pitch
.
accidental)
pairs.
old-accidentals
(list)(
pitch .
accidental)
pairs.
This grob interface is used in the following graphical objects: KeySignature
A bracket indicating a ligature in the original edition
height
(dimension, in staff space)thickness
(number)linethickness
.
width
(dimension, in staff space)ligature-primitive-callback
(procedure)This grob interface is used in the following graphical objects: none
A ligature
This grob interface is used in the following graphical objects: none
Generic line objects. Any object using lines supports this. Normally,you get a straight line. If dash-period
is defined, a dashed line is produced; the length of the dashes is tuned with dash-fraction
. If the latter is set to 0, a dotted line is produced. If dash-fraction
is negative, the line is made transparent.
dash-fraction
(number)dash-period
(number)style
(symbol)print-function
that is
reading this property.
thickness
(number)linethickness
.
This grob interface is used in the following graphical objects: Hairpin, OttavaBracket, PianoPedalBracket, TupletBracket and VoltaBracket
Generic line drawn between two objects, e.g. for use with glissandi.
The property style
can be line
, dashed-line
, trill
,
dotted-line
or zigzag
.
gap
(dimension, in staff space)thickness
(number)linethickness
.
zigzag-length
(dimension, in staff space)zigzag-width
. A value of 1 gives 60-degree
zigzags.
zigzag-width
(dimension, in staff space)This grob interface is used in the following graphical objects: Glissando and VoiceFollower
The extender is a simple line at the baseline of the lyric that helps show the length of a melissima (tied/slurred note).
thickness
(number)linethickness
.
heads
(list of grobs)This grob interface is used in the following graphical objects: LyricExtender
A centred hyphen is a simple line between lyrics used to divide syllables
dash-period
(number)height
(dimension, in staff space)length
(dimension, in staff space)minimum-length
(dimension, in staff space)spacing-procedure
property.
thickness
(number)linethickness
.
This grob interface is used in the following graphical objects: LyricHyphen
Any object that is related to lyrics.
This grob interface is used in the following graphical objects: LyricExtender and LyricHyphen
a single piece of lyrics
This grob interface is used in the following graphical objects: LyricText
a rehearsal mark
This grob interface is used in the following graphical objects: RehearsalMark
This objectt indicates groups of beats. Valid choices for style
are bracket
and triangle
.
height
(dimension, in staff space)style
(symbol)print-function
that is
reading this property.
thickness
(number)linethickness
.
This grob interface is used in the following graphical objects: MeasureGrouping
A mensural ligature
thickness
(number)linethickness
.
delta-pitch
(number)flexa-width
(dimension, in staff space)head-width
(dimension, in staff space)join-left
(boolean)join-left-amount
(number)
ligature-primitive-callback
(procedure)primitive
(integer)This grob interface is used in the following graphical objects: MensuralLigature
a rehearsal mark
This grob interface is used in the following graphical objects: MetronomeMark
Multi measure rest, and the text or number that is printed over it.
This grob interface is used in the following graphical objects: MultiMeasureRest, MultiMeasureRestNumber and MultiMeasureRestText
A rest that spans a whole number of measures.
expand-limit
(integer)hair-thickness
(number)measure-count
(integer)minimum-length
(dimension, in staff space)spacing-procedure
property.
thick-thickness
(number)linethickness
.
use-breve-rest
(boolean)This grob interface is used in the following graphical objects: MultiMeasureRest and PercentRepeat
An object that handles collisions between notes with different stem directions and horizontal shifts. Most of the interesting properties are to be set in note-column-interface: these are force-hshift
and horizontal-shift
.
merge-differently-dotted
(boolean)merge-differently-headed
(boolean)positioning-done
(boolean)This grob interface is used in the following graphical objects: NoteCollision
Stem and noteheads combined
accidentals
(list)force-hshift
(number)horizontal-shift
(integer)arpeggio
(layout object)note-heads
(list of grobs)rest
(layout object)rest-collision
(layout object)stem
(layout object)This grob interface is used in the following graphical objects: NoteColumn
Note head
glyph-name-procedure
(procedure)note-names
(hash table)stem-attachment-function
(procedure)style
(symbol)print-function
that is
reading this property.
accidental-grob
(layout object)This grob interface is used in the following graphical objects: NoteHead and TabNoteHead
Note name
style
(symbol)print-function
that is
reading this property.
This grob interface is used in the following graphical objects: NoteName
This object calculates spacing wishes for individual voices.
knee-spacing-correction
(number)stem-spacing-correction
(number)left-items
(list of grobs)
right-items
(list of grobs)This grob interface is used in the following graphical objects: NoteSpacing
Kill this grob after the line breaking process.
This grob interface is used in the following graphical objects: SeparatingGroupSpanner
An ottava bracket
bracket-flare
(pair of numbers)edge-height
(pair)minimum-length
(dimension, in staff space)spacing-procedure
property.
shorten-pair
(pair of numbers)This grob interface is used in the following graphical objects: OttavaBracket
Paper_column
objects form the top-most X-parents for items. The are two types of columns: musical columns, where are attached to, and non-musical columns, where bar-lines, clefs etc. are attached to. The spacing engine determines the X-positions of these objects.
They are numbered, the first (leftmost) is column 0. Numbering happens before line-breaking, and columns are not renumbered after line breaking. Since many columns go unused, you should only use the rank field to get ordering information. Two adjacent columns may have non-adjacent numbers.
between-cols
(pair)between-system-string
(string)shortest-playing-duration
(moment)shortest-starter-duration
(moment)when
(moment)bounded-by-me
(list of grobs)This grob interface is used in the following graphical objects: NonMusicalPaperColumn and PaperColumn
Repeats that look like percent signs
slope
(number)thickness
(number)linethickness
.
This grob interface is used in the following graphical objects: DoublePercentRepeat, PercentRepeat and RepeatSlash
The bracket of the piano pedal. It can be tuned through the regular bracket properties.
bracket-flare
(pair of numbers)edge-height
(pair)shorten-pair
(pair of numbers)pedal-text
(layout object)This grob interface is used in the following graphical objects: PianoPedalBracket
A piano pedal sign
This grob interface is used in the following graphical objects: PianoPedalBracket, SostenutoPedalLineSpanner, SustainPedal, SustainPedalLineSpanner and UnaCordaPedalLineSpanner
Move around ordinary rests (not multi-measure-rests) to avoid conflicts.
minimum-distance
(dimension, in staff space)elements
(list of grobs)positioning-done
(boolean)This grob interface is used in the following graphical objects: RestCollision
A rest symbol.
minimum-distance
(dimension, in staff space)style
(symbol)print-function
that is
reading this property.
This grob interface is used in the following graphical objects: MultiMeasureRest and Rest
Any object with a rhythmic basis. Used to determine which grobs are interesting enough to maintain a hara-kiri staff.
This grob interface is used in the following graphical objects: BassFigure, ChordName, LyricText, NoteHead and Rest
Note head or rest
duration-log
(integer)dot
(layout object)stem
(layout object)This grob interface is used in the following graphical objects: NoteHead, Rest and TabNoteHead
An interface that sorts scripts according to their script-priority
This grob interface is used in the following graphical objects: ScriptColumn
An object that is put above or below a note
script-priority
(number)script-stencil
(pair)type
. arg
), which
acts as an index for looking up a Stencil object.
This grob interface is used in the following graphical objects: DynamicText and Script
Position this object on itself and/or on its parent. To this end, the following functions are provided:
Self_alignment_interface::aligned_on_self
self-alignment-X
and self-alignment-Y
.Self_alignment_interface::aligned_on_parent
Self_alignment_interface::centered_on_parent
Self_alignment_interface::centered_on_other_axis_parent
self-alignment-X
(number)self-alignment-Y
(number)self-alignment-X
but for
Y axis.
This grob interface is used in the following graphical objects: BarNumber, BassFigure, DynamicText, Fingering, Hairpin, InstrumentName, LyricText, MultiMeasureRestNumber, MultiMeasureRestText, OctavateEight, RehearsalMark, SostenutoPedal, SustainPedal, UnaCordaPedal and VocalName
Item that computes widths to generate spacing rods. This is done in concert with separation-spanner-interface.
X-extent
(pair of numbers)padding
(dimension, in staff space)conditional-elements
(list of grobs)elements
(list of grobs)This grob interface is used in the following graphical objects: SeparationItem
A spanner that calculates spacing constraints ("rods") using the separation-item-interface
grobs in elements
.
padding
(dimension, in staff space)elements
(list of grobs)This grob interface is used in the following graphical objects: SeparatingGroupSpanner
Position a victim object (this one) next to other objects (the support). The property direction
signifies where to put the victim object relative to the support (left or right, up or down?)
The routine also takes the size the staff into account if staff-padding
is set. If undefined, the staff symbol is ignored.
direction
(direction)minimum-space
(dimension, in staff space)padding
(dimension, in staff space)side-relative-direction
(direction)direction-source
with this to get the direction of this
object.
staff-padding
(dimension, in staff space)direction-source
(layout object)side-support-elements
(list of grobs)This grob interface is used in the following graphical objects: Arpeggio, BarNumber, CombineTextScript, DynamicLineSpanner, Fingering, HorizontalBracket, InstrumentName, MeasureGrouping, MetronomeMark, MultiMeasureRestNumber, MultiMeasureRestText, OctavateEight, OttavaBracket, RehearsalMark, Script, SostenutoPedalLineSpanner, StanzaNumber, SustainPedalLineSpanner, TextScript, TextSpanner, UnaCordaPedalLineSpanner, VocalName and VoltaBracket
A slur
attachment
(pair)alongside-stem
,
stem
, head
or loose-end
.
attachment-offset
(pair)beautiful
(number)control-points
(list)dashed
(number)direction
(direction)extremity-function
(procedure)extremity-offset-alist
(list)Format: alist (attachment stem-dir*dir slur-dir*dir) -> offset.
height-limit
(dimension, in staff space)ratio
(number)height-limit
.
slope-limit
(number)thickness
(number)linethickness
.
y-free
(dimension, in staff space)de-uglify-parameters
(list)details
(list)note-columns
(pair)This grob interface is used in the following graphical objects: PhrasingSlur and Slur
A layout object that takes part in the spacing problem.
measure-length
(moment)penalty
(number)ideal-distances
(list)left-neighbors
(list of grobs)The closest spacing-wishes determine the actual distances between the
columns.
minimum-distances
(list)right-neighbors
(list of grobs)spacing-wishes
(list of grobs)This grob interface is used in the following graphical objects: NonMusicalPaperColumn and PaperColumn
Something to do with line breaking and spacing. Kill this one after determining line breaks.
This grob interface is used in the following graphical objects: NoteSpacing, SeparatingGroupSpanner, SeparationItem, SpacingSpanner and StaffSpacing
The space taken by a note is dependent on its duration. Doubling a
duration adds spacing-increment to the space. The most common shortest
note gets shortest-duration-space
. Notes that are even shorter are
spaced proportonial to their duration.
Typically, the increment is the width of a black note head. In a piece with lots of 8th notes, and some 16th notes, the eighth note gets 2 note heads width (i.e. the space following a note is 1 note head width) A 16th note is followed by 0.5 note head width. The quarter note is followed by 3 NHW, the half by 4 NHW, etc.
base-shortest-duration
(moment)common-shortest-duration
(moment)grace-space-factor
(number)spacing-increment
.
shortest-duration-space
(dimension, in staff space)spacing-increment
as unit. See also
spacing-spanner-interface.
spacing-increment
(number)This grob interface is used in the following graphical objects: SpacingSpanner
A bar line that spanned between other barlines. This interface is used for bar lines that connect different staves.
elements
(list of grobs)This grob interface is used in the following graphical objects: SpanBar
Some objects are horizontally spanned between objects. For
example, slur, beam, tie, etc. These grobs form a subtype called
Spanner
. All spanners have two span-points (these must be
Item
objects), one on the left and one on the right. The left bound is
also the X-reference point of the spanner.
minimum-length
(dimension, in staff space)spacing-procedure
property.
This grob interface is used in the following graphical objects: Beam, ClusterSpanner, DynamicLineSpanner, Glissando, Hairpin, HorizontalBracket, LigatureBracket, LyricExtender, LyricHyphen, MeasureGrouping, MultiMeasureRestNumber, MultiMeasureRestText, OttavaBracket, PercentRepeat, PhrasingSlur, PianoPedalBracket, RemoveEmptyVerticalGroup, SeparatingGroupSpanner, Slur, SostenutoPedalLineSpanner, SpacingSpanner, StaffSymbol, SustainPedalLineSpanner, System, SystemStartBar, SystemStartBracket, TextSpanner, Tie, TieColumn, TupletBracket, UnaCordaPedalLineSpanner, VerticalAlignment, VerticalAxisGroup, VoiceFollower and VoltaBracket
This object calculates spacing details from a breakable symbol (left) to another object. For example, it takes care of optical spacing from a bar lines to a note.
stem-spacing-correction
(number)left-items
(list of grobs)
right-items
(list of grobs)This grob interface is used in the following graphical objects: StaffSpacing
This spanner draws the lines of a staff. A staff symbol definines a vertical unit, the staff space. Quantities that go by a half staff space are called positions The center (i.e. middle line or space) is position 0. The length of the symbol may be set by hand through the width
property.
ledger-line-thickness
(pair of numbers)line-count
(integer)staff-space
(dimension, in staff space)thickness
(number)linethickness
.
width
(dimension, in staff space)This grob interface is used in the following graphical objects: StaffSymbol
An object whose Y position is meant relative to a staff symbol. These usually have Staff_symbol_referencer::callback
in their Y-offset-callbacks
.
staff-position
(number)This grob interface is used in the following graphical objects: Ambitus, Arpeggio, Beam, Clef, Custos, Dots, MultiMeasureRest, NoteHead, Rest and TabNoteHead
A stanza number, to be put in from of a lyrics line
This grob interface is used in the following graphical objects: StanzaNumber
The stem represent the graphical stem. In addition, it internally connects note heads, beams, tremolos. Rests and whole notes have invisible stems.
avoid-note-head
(boolean)beamed-extreme-minimum-free-lengths
(list)beamed-lengths
(list)beamed-minimum-free-lengths
(list)beaming
(pair)direction
(direction)duration-log
(integer)flag-style
(symbol)()
and
mensural
. Additionally, "no-flag"
switches off the
flag.
french-beaming
(boolean)length
(dimension, in staff space)lengths
(list)neutral-direction
(direction)no-stem-extend
(boolean)stem-end-position
(number)stem-shorten
(list)stroke-style
(string)thickness
(number)linethickness
.
beam
(layout object)note-heads
(list of grobs)stem-info
(pair)tremolo-flag
(layout object)This grob interface is used in the following graphical objects: Stem
A beam slashing a stem to indicate a tremolo.
beam-thickness
(dimension, in staff space)beam-width
(dimension, in staff space)flag-count
(number)stem
(layout object)This grob interface is used in the following graphical objects: StemTremolo
This is the toplevel object: each object in a score ultimately has a System object as its X and Y parent.
between-system-string
(string)all-elements
(list of grobs)columns
(list of grobs)This grob interface is used in the following graphical objects: System
The brace, bracket or bar in front of the system. It is implemented as a spanner.
arch-angle
(number)arch-height
(dimension, in staff space)arch-thick
(number)arch-width
(dimension, in staff space)bracket-thick
(number)collapse-height
(dimension, in staff space)glyph
(string)thickness
(number)linethickness
.
This grob interface is used in the following graphical objects: SystemStartBar, SystemStartBrace and SystemStartBracket
An interface for any notes set in a tablature staff
This grob interface is used in the following graphical objects: none
A collection of routines to put text balloons around an object.
balloon-original-callback
(procedure)balloon-padding
(dimension, in staff space)balloon-text
(markup)balloon-text-offset
(pair of numbers)balloon-text-props
(list)This grob interface is used in the following graphical objects: none
A scheme markup text, see Text-markup .
baseline-skip
(dimension, in staff space)text
(markup)word-space
(dimension, in staff space)This grob interface is used in the following graphical objects: BarNumber, BassFigure, BreathingSign, ChordName, CombineTextScript, DynamicText, Fingering, InstrumentName, LyricText, MetronomeMark, MultiMeasureRestNumber, MultiMeasureRestText, NoteName, OctavateEight, OttavaBracket, RehearsalMark, SostenutoPedal, StanzaNumber, SustainPedal, TabNoteHead, TextScript, TupletBracket, UnaCordaPedal, VocalName and VoltaBracket
An object that is put above or below a note
script-priority
(number)This grob interface is used in the following graphical objects: CombineTextScript, Fingering and TextScript
generic text spanner
bracket-flare
(pair of numbers)dash-fraction
(number)dash-period
(number)edge-height
(pair)edge-text
(pair)enclose-bounds
(number)shorten-pair
(pair of numbers)style
(symbol)print-function
that is
reading this property.
thickness
(number)linethickness
.
if-text-padding
(number)This grob interface is used in the following graphical objects: SustainPedal and TextSpanner
Object that sets directions of multiple ties in a tied chord
direction
(direction)This grob interface is used in the following graphical objects: TieColumn
A tie connecting two noteheads.
control-points
(list)direction
(direction)minimum-length
(dimension, in staff space)spacing-procedure
property.
staffline-clearance
(dimension, in staff space)thickness
(number)linethickness
.
x-gap
(dimension, in staff space)y-offset
(dimension, in staff space)details
(list)head-pair
(pair)This grob interface is used in the following graphical objects: Tie
A time signature, in different styles. The following values for 'style are are recognized:
C
neo_mensural
mensural
1xxx
1
will do.)
See also the test-file input/test/time.ly.
fraction
(pair of numbers)style
(symbol)print-function
that is
reading this property.
This grob interface is used in the following graphical objects: TimeSignature
A bracket with a number in the middle, used for tuplets.
bracket-flare
(pair of numbers)bracket-visibility
(boolean or symbol)'if-no-beam
will make it print only if there is no beam associated with this
tuplet bracket.
direction
(direction)edge-height
(pair)left-position
(number)number-visibility
(boolean or symbol)bracket-visibility
, but for the number.
padding
(dimension, in staff space)right-position
(number)shorten-pair
(pair of numbers)thickness
(number)linethickness
.
note-columns
(pair)This grob interface is used in the following graphical objects: LigatureBracket and TupletBracket
A vaticana style gregorian ligature
glyph-name
(string)thickness
(number)linethickness
.
add-cauda
(boolean)add-join
(boolean)add-stem
(boolean)delta-pitch
(number)flexa-height
(dimension, in staff space)flexa-width
(dimension, in staff space)ligature-primitive-callback
(procedure)x-offset
(dimension, in staff space)This grob interface is used in the following graphical objects: VaticanaLigature
Volta bracket with number
height
(dimension, in staff space)thickness
(number)linethickness
.
bars
(list of grobs)This grob interface is used in the following graphical objects: VoltaBracket
X-extent
(pair of numbers)X-extent-callback
(procedure)#f
, the object
is empty in the X direction. The procedure takes a grob and axis
argument, and returns a number-pair.
X-offset-callbacks
(list)Y-extent
(pair of numbers)X-extent
.
Y-extent-callback
(procedure)X-extent-callback
.
Y-offset-callbacks
(list)X-offset-callbacks
.
accidentals
(list)align-dir
(direction)-1
: left side,
0
: around center of width, 1
: right side.
arch-angle
(number)arch-height
(dimension, in staff space)arch-thick
(number)arch-width
(dimension, in staff space)arpeggio-direction
(direction)attachment
(pair)alongside-stem
,
stem
, head
or loose-end
.
attachment-offset
(pair)auto-knee-gap
(dimension, in staff space)avoid-note-head
(boolean)axes
(list)balloon-original-callback
(procedure)balloon-padding
(dimension, in staff space)balloon-text
(markup)balloon-text-offset
(pair of numbers)balloon-text-props
(list)bar-size
(dimension, in staff space)bar-size-procedure
(procedure)base-shortest-duration
(moment)baseline-skip
(dimension, in staff space)beam-thickness
(dimension, in staff space)beam-width
(dimension, in staff space)beamed-extreme-minimum-free-lengths
(list)beamed-lengths
(list)beamed-minimum-free-lengths
(list)beamed-stem-shorten
(list)beaming
(pair)beautiful
(number)before-line-breaking-callback
(procedure)between-cols
(pair)between-system-string
(string)bracket-flare
(pair of numbers)bracket-thick
(number)bracket-visibility
(boolean or symbol)'if-no-beam
will make it print only if there is no beam associated with this
tuplet bracket.
break-align-orders
(hash table)For example, clefs are put after key signatures by setting
\override Score.BreakAlignment #'break-align-orders = #(make-vector 3 '(span-bar breathing-sign staff-bar key clef time-signature))
break-align-symbol
(symbol)break-glyph-function
(procedure)break-visibility
(procedure)all-visible
, begin-of-line-visible
,
end-of-line-visible
, begin-of-line-invisible
,
end-of-line-invisible
, all-invisible
.
breakable
(boolean)c0-position
(integer)cautionary
(boolean)cautionary-style
(symbol)smaller
or
parentheses
.
collapse-height
(dimension, in staff space)common-shortest-duration
(moment)concaveness-gap
(dimension, in staff space)concaveness-threshold
(number)Concaveness is calculated as the sum of the vertical distances of
inner note heads that fall outside the interval of the two outer
note heads, to the vertically nearest outer note head, divided by the
square of the inner notes involved.
control-points
(list)damping
(integer)dash-fraction
(number)dash-period
(number)dashed
(number)dir-function
(procedure)beam-dir-majority
beam-dir-mean
beam-dir-median.
direction
(direction)dot-count
(integer)duration-log
(integer)edge-height
(pair)edge-text
(pair)enclose-bounds
(number)expand-limit
(integer)extra-X-extent
(pair of numbers)extra-Y-extent
(pair of numbers)extra-Y-extent
.
extra-offset
(pair of numbers)extremity-function
(procedure)extremity-offset-alist
(list)Format: alist (attachment stem-dir*dir slur-dir*dir) -> offset.
flag-count
(number)flag-style
(symbol)()
and
mensural
. Additionally, "no-flag"
switches off the
flag.
flag-width-function
(procedure)font-encoding
(symbol)music
, number
, text
,
math
, braces
, dynamic
font-family
(symbol)sans
, roman
font-magnification
(number)font-name
.
font-name
(string)font-family
, font-series
and font-shape
.
font-series
(symbol)medium
, bold
, bold-narrow
, etc.
font-shape
(symbol)upright
,
italic
, caps
.
font-size
(number)force-hshift
(number)forced-distance
(dimension, in staff space)fraction
(pair of numbers)french-beaming
(boolean)full-size-change
(boolean)gap
(dimension, in staff space)gap-count
(integer)glyph
(string)glyph-name
(string)glyph-name-procedure
(procedure)grace-space-factor
(number)spacing-increment
.
grow-direction
(direction)hair-thickness
(number)height
(dimension, in staff space)height-limit
(dimension, in staff space)horizontal-shift
(integer)kern
(dimension, in staff space)knee
(boolean)knee-spacing-correction
(number)layer
(number)ledger-line-thickness
(pair of numbers)left-padding
(dimension, in staff space)left-position
(number)length
(dimension, in staff space)lengths
(list)line-count
(integer)measure-count
(integer)measure-length
(moment)merge-differently-dotted
(boolean)merge-differently-headed
(boolean)minimum-X-extent
(pair of numbers)minimum-Y-extent
(pair of numbers)minimum-Y-extent
.
minimum-distance
(dimension, in staff space)minimum-length
(dimension, in staff space)spacing-procedure
property.
minimum-space
(dimension, in staff space)neutral-direction
(direction)neutral-position
(number)new-accidentals
(list)(
pitch
.
accidental)
pairs.
no-spacing-rods
(boolean)no-stem-extend
(boolean)non-default
(boolean)note-names
(hash table)number-visibility
(boolean or symbol)bracket-visibility
, but for the number.
old-accidentals
(list)(
pitch .
accidental)
pairs.
padding
(dimension, in staff space)penalty
(number)pitch-max
(pitch)pitch-min
(pitch)positions
(pair)(
left
.
right)
, where both left and right are in the
staff-space unit of the current staff.
print-function
(procedure)Stencil
object.
ratio
(number)height-limit
.
remove-first
(boolean)right-padding
(dimension, in staff space)right-position
(number)script-priority
(number)self-alignment-X
(number)self-alignment-Y
(number)self-alignment-X
but for
Y axis.
shorten-pair
(pair of numbers)shortest-duration-space
(dimension, in staff space)spacing-increment
as unit. See also
spacing-spanner-interface.
shortest-playing-duration
(moment)shortest-starter-duration
(moment)side-relative-direction
(direction)direction-source
with this to get the direction of this
object.
slope
(number)slope-limit
(number)space-alist
(list)(
break-align-symbol type
.
distance)
, where type can be the symbols
minimum-space
or extra-space
.
space-function
(procedure)spacing-increment
(number)spacing-procedure
(procedure)before-line-breaking-callback
.
stacking-dir
(direction)staff-padding
(dimension, in staff space)staff-position
(number)staff-space
(dimension, in staff space)staffline-clearance
(dimension, in staff space)stem-attachment-function
(procedure)stem-end-position
(number)stem-shorten
(list)stem-spacing-correction
(number)stroke-style
(string)style
(symbol)print-function
that is
reading this property.
text
(markup)thick-thickness
(number)linethickness
.
thickness
(number)linethickness
.
thin-kern
(number)threshold
(pair of numbers)transparent
(boolean)print-function
to #f
, but this retains the dimensions of
this grob, which means that grobs can be erased individually.
when
(moment)width
(dimension, in staff space)word-space
(dimension, in staff space)x-gap
(dimension, in staff space)y-free
(dimension, in staff space)y-offset
(dimension, in staff space)zigzag-length
(dimension, in staff space)zigzag-width
. A value of 1 gives 60-degree
zigzags.
zigzag-width
(dimension, in staff space)accidental-grob
(layout object)accidental-grobs
(list)accidentals-style
(symbol)add-cauda
(boolean)add-join
(boolean)add-stem
(boolean)after-line-breaking-callback
(procedure)all-elements
(list of grobs)arpeggio
(layout object)ascendens
(boolean)auctum
(boolean)bars
(list of grobs)beam
(layout object)begin-of-line-visible
(boolean)bounded-by-me
(list of grobs)cause
(any type)cavum
(boolean)center-element
(layout object)chord-tremolo
(boolean)columns
(list of grobs)conditional-elements
(list of grobs)context-info
(integer)de-uglify-parameters
(list)delta-pitch
(number)deminutum
(boolean)dependencies
(list of grobs)descendens
(boolean)details
(list)direction-source
(layout object)dot
(layout object)elements
(list of grobs)flexa-height
(dimension, in staff space)flexa-width
(dimension, in staff space)font
(font metric)head-pair
(pair)head-width
(dimension, in staff space)heads
(list of grobs)ideal-distances
(list)if-text-padding
(number)inclinatum
(boolean)interfaces
(list)meta
field.
items-worth-living
(list of grobs)join-heads
(boolean)join-left
(boolean)join-left-amount
(number)
least-squares-dy
(number)left-items
(list of grobs)
left-neighbors
(list of grobs)The closest spacing-wishes determine the actual distances between the
columns.
ligature-primitive-callback
(procedure)linea
(boolean)meta
(list)name
and interfaces
.
minimum-distances
(list)note-columns
(pair)note-head-style
(string)note-heads
(list of grobs)oriscus
(boolean)pedal-text
(layout object)pes-or-flexa
(boolean)position-callbacks
(list)positioning-done
(boolean)prefix-set
(number)
primitive
(integer)quant-score
(number)quilisma
(boolean)rest
(layout object)rest-collision
(layout object)right-items
(list of grobs)
right-neighbors
(list of grobs)script-stencil
(pair)type
. arg
), which
acts as an index for looking up a Stencil object.
shorten
(dimension, in staff space)side-support-elements
(list of grobs)spacing-wishes
(list of grobs)staff-symbol
(layout object)stem
(layout object)stem-info
(pair)stems
(list of grobs)stencil
(unknown)stropha
(boolean)tie
(layout object)
tremolo-flag
(layout object)use-breve-rest
(boolean)virga
(boolean)x-offset
(dimension, in staff space)Make a bracket in direction a. The extent of the bracket is given by iv. The wings protude by an amount of p, which may be negative. The thickness is given by t.
Find a parent of context that has name or alias name. Return
#f
if not found.
Return the id string of context, i.e. for
\context Voice = one ..
return the stringone
.
Return the name of context, i.e. for
\context Voice = one ..
return the symbolVoice
.
Return the context above context where name is defined.
Do a single
\override
or\revert
operation in context. The grob definitiongrob
is extended witheltprop
(if val is specified) or reverted (if unspecified).
Set value of property name in context context to val.
Return d is a number. Used to distinguish length variables from normal numbers.
type predicate. A direction is
-1
,0
or1
, where-1
represents left or down and1
represents right or up.
This function retrieves a Stencil for the glyph named name in font. The font must be available as an AFM file. If the glyph is not found,
#f
is returned.
Given a Score context in its final state,process it and return the (rendered) result.
Get a hash table with all lilypond Scheme extension functions.
Return a list of all translator objects that may be instantiated.
This function retrieves a Stencil for the glyph numbered index in font.
Get a global option setting. Supported options include
old-relative-used
- Report whether old-relative compatibility mode is necessary
old-relative
- Report whether old-relative compatibility mode is used
verbose
- Report whether we are running in verbose mode
Get an alist chain for grob g, with global as the global default. If unspecified,
font-defaults
from the paper block is taken.
Get the extent in axis direction of grob relative to the grob refp
Get the parent of grob. axis is 0 for the X-axis, 1 for the Y-axis.
Return the value of a value in grob g of property sym. It will return
' ()
(end-of-list) if sym is undefined in g.
Compare two grobs by script priority. For internal use.
Read the file name, and return its contents in a string. The file is looked up using the search path.
Print msg as a GNU compliant error message, pointing to thelocation in sip.
The break status dir of item it.
-1
is end of line,0
unbroken, and1
begin of line.
Make a C++ music object of type type, initialize with props.
This function is for internal use, and is only called by
make-music
, which is the preferred interface for creating music objects.
length is the negative logarithm (base 2) of the duration: 1 is a half note, 2 is a quarter note, 3 is an eighth note, etc. The number of dots after the note is given by the optional argument dotcount.
The duration factor is optionally given by num and den.
A duration is a musical duration, i.e. a length of time described by a power of two (whole, half, quarter, etc.) and a number of augmentation dots.
Create the rational number with main timing n/d, and optional grace timin gn/gd.
Moment is a point in musical time. It is consists of a pair of rationals (m,g), where m is the timing for the main notes, and g the timing for grace notes. In absence of grace notes, g is zero.
octave is specified by an integer, zero for the octave containing middle C. note is a number from 0 to 6, with 0 corresponding to C and 6 corresponding to B. The alter is zero for a natural, negative for flats, or positive for sharps.
Stencils are a device independent output expressions.They carry two pieces of information:
1: a specification of how to print this object. This specification is processed by the output backends, for example scm/output-tex.scm.
2: the vertical and horizontal extents of the object.
Extract the duration field from mus, and return the length.
Get the length of music expression mus, and return as a
Moment
object.
Return an alist containing the mutable properties of mus. The immutable properties are not available, since they are constant and initialized by the
make-music
function.
Get the property sym of music expression mus. If sym is undefined, return
' ()
.
Return a font metric satisfying the font-qualifiers in the alist chain chain. (An alist chain is a list of alists, containing grob properties).
Return pitch delta such that
pitch
transposed by delta equals root
Transpose p by the amount delta, where delta is relative to middle C.
Return a vector with line numbers of page breaks.
Make a
Stencil
that prints a black box of dimensions xext, yext and roundness blot.
Process mus according to output_def. An interpretation context is set up, and mus is interpreted with it. The context is returned in its final state.
Set a global option value. Supported options include
help
- List all options.
midi-debug
- If set to true, generate human readable MIDI
internal-type-checking
- Set paranoia for property assignments
parse-protect
- If protection is switched on, errors in inline scheme are caught in the parser. If off, GUILE will halt on errors, and give a stack trace. Default is protected evaluation.
old-relative
- Relative for simultaneous music functions similar to chord syntax
new-relative
- Relative for simultaneous music functions similar to sequential music
This function is useful to call from the command line:
lilypond -e "(ly-set-option 'midi-debug #t)"
.
Set the options for Point-and-click source specials output. The argument is a symbol. Possible options are
none
(no source specials),line
andline-column
Get one of the bounds of spanner. dir is
-1
for left, and1
for right.
Align stil using its own extents. dir is a number -1, 1 are left and right respectively. Other values are interpolated (so 0 means the center.
Construct a stencil by putting second next to first. axis can be 0 (x-axis) or 1 (y-axis), direction can be -1 (left or down) or 1 (right or up). The stencils are juxtaposed with padding as extra space. If this puts the reference points closer than minimum, they are moved by the latter amount.
Return a pair of numbers signifying the extent of stil in axis direction (0 or 1 for x and y axis respectively).
Similar to
ly:stencil-combine-edge
, but returns second positioned to be next to first.
Set the extent of stil (extent must be a pair of numbers) in axis direction (0 or 1 for x- and y-axis respectively).
Return a stil, but translated by offset (a pair of numbers).
Return a copy of stil but translated by amount in axis direction.
Given the font metric in font and the string text, compute the extents of that text in that font. The return value is a pair of number-pairs.
Return the type name of the translator object trans. The name is a symbol.
ly:add-interface
: Scheme functionsly:add-moment
: Scheme functionsly:all-grob-interfaces
: Scheme functionsly:bracket
: Scheme functionsly:context-find
: Scheme functionsly:context-id
: Scheme functionsly:context-name
: Scheme functionsly:context-parent
: Scheme functionsly:context-property
: Scheme functionsly:context-property-where-defined
: Scheme functionsly:context-pushpop-property
: Scheme functionsly:context-set-property!
: Scheme functionsly:context-unset-property
: Scheme functionsly:context?
: Scheme functionsly:dimension?
: Scheme functionsly:dir?
: Scheme functionsly:div-moment
: Scheme functionsly:duration-dot-count
: Scheme functionsly:duration-factor
: Scheme functionsly:duration-log
: Scheme functionsly:duration<?
: Scheme functionsly:duration?
: Scheme functionsly:export
: Scheme functionsly:find-glyph-by-name
: Scheme functionsly:font-metric?
: Scheme functionsly:fontify-atom
: Scheme functionsly:format-output
: Scheme functionsly:get-all-function-documentation
: Scheme functionsly:get-all-translators
: Scheme functionsly:get-default-font
: Scheme functionsly:get-glyph
: Scheme functionsly:get-option
: Scheme functionsly:grob-alist-chain
: Scheme functionsly:grob-extent
: Scheme functionsly:grob-original
: Scheme functionsly:grob-paper
: Scheme functionsly:grob-parent
: Scheme functionsly:grob-pq-less?
: Scheme functionsly:grob-property
: Scheme functionsly:grob-script-priority-less
: Scheme functionsly:grob-set-property!
: Scheme functionsly:grob-staff-position
: Scheme functionsly:grob-suicide
: Scheme functionsly:grob-system
: Scheme functionsly:grob-translate-axis!
: Scheme functionsly:grob?
: Scheme functionsly:gulp-file
: Scheme functionsly:input-location
: Scheme functionsly:input-location?
: Scheme functionsly:input-message
: Scheme functionsly:intlog2
: Scheme functionsly:item-break-dir
: Scheme functionsly:item?
: Scheme functionsly:iterator?
: Scheme functionsly:make-bare-music
: Scheme functionsly:make-duration
: Scheme functionsly:make-moment
: Scheme functionsly:make-pitch
: Scheme functionsly:make-stencil
: Scheme functionsly:moment<?
: Scheme functionsly:moment?
: Scheme functionsly:mul-moment
: Scheme functionsly:music-compress
: Scheme functionsly:music-deep-copy
: Scheme functionsly:music-duration-compress
: Scheme functionsly:music-duration-length
: Scheme functionsly:music-length
: Scheme functionsly:music-list?
: Scheme functionsly:music-mutable-properties
: Scheme functionsly:music-name
: Scheme functionsly:music-property
: Scheme functionsly:music-set-property!
: Scheme functionsly:music-transpose
: Scheme functionsly:music?
: Scheme functionsly:number->string
: Scheme functionsly:option-usage
: Scheme functionsly:output-def-clone
: Scheme functionsly:output-def-scope
: Scheme functionsly:paper-book?
: Scheme functionsly:paper-def?
: Scheme functionsly:paper-get-font
: Scheme functionsly:paper-get-number
: Scheme functionsly:paper-line-break-score
: Scheme functionsly:paper-line-height
: Scheme functionsly:paper-line-number
: Scheme functionsly:paper-line?
: Scheme functionsly:paper-lookup
: Scheme functionsly:pitch-alteration
: Scheme functionsly:pitch-diff
: Scheme functionsly:pitch-notename
: Scheme functionsly:pitch-octave
: Scheme functionsly:pitch-quartertones
: Scheme functionsly:pitch-semitones
: Scheme functionsly:pitch-steps
: Scheme functionsly:pitch-transpose
: Scheme functionsly:pitch<?
: Scheme functionsly:pitch?
: Scheme functionsly:protects
: Scheme functionsly:ragged-page-breaks
: Scheme functionsly:round-filled-box
: Scheme functionsly:run-translator
: Scheme functionsly:set-option
: Scheme functionsly:set-point-and-click
: Scheme functionsly:spanner-broken-into
: Scheme functionsly:spanner-get-bound
: Scheme functionsly:spanner?
: Scheme functionsly:stencil-add
: Scheme functionsly:stencil-align-to!
: Scheme functionsly:stencil-combine-at-edge
: Scheme functionsly:stencil-extent
: Scheme functionsly:stencil-get-expr
: Scheme functionsly:stencil-moved-to-edge
: Scheme functionsly:stencil-set-extent!
: Scheme functionsly:stencil-translate
: Scheme functionsly:stencil-translate-axis
: Scheme functionsly:stencil?
: Scheme functionsly:text-dimension
: Scheme functionsly:translator-description
: Scheme functionsly:translator-name
: Scheme functionsly:translator?
: Scheme functionsly:transpose-key-alist
: Scheme functionsly:unit
: Scheme functionsly:version
: Scheme functionsly:warn
: Scheme functions
Read comments on this page, or
add one.
This page is for LilyPond-2.2.6 (stable-branch). |