Music properties - LilyPond program-reference
Description: LilyPond program-reference

Previous: Music classes, Up: Music definitions

### Music properties

`absolute-octave` (integer)
  The absolute octave for a octave check note.
`alteration` (number)
  alteration for figured bass
`articulation-type` (string)
  key for script definitions alist.

  TODO: consider making type into symbol

`articulations` (list of music)
  Articulation events specifically for this note.
`associated-context` (string)
  Name of the Voice context associated with this \newaddlyrics section
`augmented` (boolean)
  This figure is for an augmented figured bass (with +) sign.
`bass` (boolean)
  Set if this note is a bass note in a chord
`bracket-start` (boolean)
  start a bracket here. TODO: use SpanEvents?
`bracket-stop` (boolean)
  stop a bracket here.
`cautionary` (boolean)
  If set, this alteration needs cautionary accidental
`change-to-id` (string)
  name of the context to change to
`change-to-type` (symbol)
  type of the context to change to.
`compress-procedure` (procedure)
  compress this music expression. Argument 1: the music, arg 2: factor
`context-id` (string)
  name of context
`context-type` (symbol)
  type of context
`create-new` (boolean)
  Create a fresh context.
`denominator` (integer)
  denominator in a time signature
`descend-only` (boolean)
  If set, this `\context` will only descend in the context tree.
`digit` (integer)
  digit for fingering
`diminished` (boolean)
  This bass figure should be slashed.
`direction` (direction)
  Print this up or down?
`drum-type` (symbol)
  Which percussion instrument to play this note on.
`duration` (duration)
  Duration of this note/lyric.
`element` (music)
  The single child of a Music_wrapper music object, or the body of a repeat.
`elements` (list of music)
  A list of elements for sequential of simultaneous music, or the alternatives of repeated music.
`error-found` (boolean)
  If true, a parsing error was found in this expression
`figure` (integer)
  a bass figure
`force-accidental` (boolean)
  If set, a cautionary accidental should always be printed on this note
`grob-property` (symbol)
  The symbol of the grob property to set.
`grob-property-path` (list)
  A list of symbols, locating a nested grob property, e.g. (beamed-lengths details).
`grob-value` (any type)
  The value of the grob property to set
`input-tag` (any type)
  Arbitrary marker to relate input and output
`inversion` (boolean)
  If set, this chord note is inverted.
`iterator-ctor` (procedure)
  Function to construct music-event-iterator object for this Music
`label` (markup)
  label of a mark.
`last-pitch` (pitch)
  The last pitch after relativization.
`length` (moment)
  The duration of this music
`length-callback` (procedure)
  How to compute the duration of this music. This property can only be defined as initializer in `define-music-types.scm`.
`metronome-count` (number)
  How many beats in a minute?
`name` (symbol)
  Name of this music object
`no-continuation` (boolean)
  If set, disallow continuation lines
`numerator` (integer)
  numerator of a time signature
`octavation` (integer)
  This pitch was octavated by how many octaves? For chord inversions, this is negative.
`once` (boolean)
  Apply this operation only during one time step?
`origin` (input location)
  where was this piece of music defined?
`page-penalty` (number)
  Penalty for page break hint.
`parenthesize` (boolean)
  Enclose resulting objects in parentheses?
`part-combine-status` (symbol)
  Change to what kind of state? Options are solo1, solo2 and unisono
`penalty` (number)
  Penalty for line break hint.
`pitch` (pitch)
  the pitch of this note
`pitch-alist` (list)
  list of pitches jointly forming the scale of a key signature
`pop-first` (boolean)
  Do a revert before we try to do a override on some grob property.
`procedure` (procedure)
  The function to run with \applycontext. It must take a single argument, being the context.
`property-operations` (list)
  Do these operations for instantiating the context.
`quoted-context-id` (string)
  The id of the context to direct quotes to, eg., `cue`.
`quoted-context-type` (symbol)
  The name of the context to direct quotes to, eg., `Voice`.
`quoted-events` (vector)
  A vector of with moment/event-list entries.
`quoted-music-name` (string)
  The name of the voice to quote.
`quoted-voice-direction` (direction)
  Should the quoted voice be up-stem or down-stem?
`repeat-count` (integer)
  do a `epeat` how ofen?
`span-direction` (direction)
  Does this start or stop a spanner?
`span-type` (string)
  What kind of spanner should be created?

  TODO: consider making type into symbol

`split-list` (list)
  splitting moments for part combiner.
`start-callback` (procedure)
  Function to compute the negative length of starting grace notes. This property can only be defined as initializer in `define-music-types.scm`.
`string-number` (integer)
  The number of the string in a StringNumberEvent
`symbol` (symbol)
  Grob name to perform an override/revert on.
`tags` (list)
  List of symbols that for denoting extra details, e.g. `\tag #'part ...` could tag a piece of music as only being active in a part.
`tempo-unit` (duration)
  The unit for the metronome count.
`text` (markup)
  markup expression to be printed
`text-type` (symbol)
  Particular type of text script (e.g. finger, dynamic).
`to-relative-callback` (procedure)
  How to transform a piece of music to relative pitches
`tonic` (pitch)
  Base of the scale
`tremolo-type` (integer)
`trill-pitch` (pitch)
  Pitch of other note of the trill.
`tweaks` (list)
  An alist of properties to override in the backend for the grob made of this event.
`type` (symbol)
  The type of this music object. Determines iteration in some cases.
`types` (list)
  The types of this music object; determines by what engraver this music expression is processed.
`untransposable` (boolean)
  If set, this music is not transposed.
`value` (any type)
  Assignment value for a translation property
`void` (boolean)
  If this property is #t, then the music expression is to be discarded by the toplevel music handler.
`what` (symbol)
  What to change for auto-change. FIXME, naming

This page is for LilyPond-2.8.8 (stable-branch).

Other languages: English.
Using automatic language selection.