ChordNames - LilyPond program-reference
Description: LilyPond program-reference

Next: CueVoice, Previous: ChoirStaff, Up: Contexts

#### ChordNames

Typesets chord names.

This context creates the following layout objects:

ChordName, SeparatingGroupSpanner, SeparationItem, StaffSpacing, VerticalAxisGroup and VoltaBracket.

This context sets the following properties:

- Set translator property `verticalExtent` to `#f`
- Set grob-property `remove-empty` in VerticalAxisGroup to `#t`.
- Set grob-property `remove-first` in VerticalAxisGroup to `#t`.
- Set grob-property `padding` in SeparatingGroupSpanner to `0.8`.
- Set translator property `extraVerticalExtent` to `#f`
- Set grob-property `minimum-Y-extent` in VerticalAxisGroup to `'(0 . 2.5)`.
- Set translator property `voltaOnThisStaff` to `#f`

This context is a `bottom' context; it can not contain other contexts.

This context is built from the following engravers:

`Hara_kiri_engraver`
  Like Axis_group_engraver, but make a hara-kiri spanner, and add interesting items (ie. note heads, lyric syllables and normal rests)

  Properties (read)

  `keepAliveInterfaces` (list)
    List of symbols, signifying grob interfaces that are worth keeping an staff with `remove-empty` set around for.
  This engraver creates the following layout objects: VerticalAxisGroup.
`Skip_event_swallow_translator`
  Swallow \skip.

  Music types accepted:

  skip-event

`Chord_name_engraver`
  Catch note-events and generate the appropriate chordname.

  Music types accepted:

  note-event

  Properties (read)

  `chordChanges` (boolean)
    Only show changes in chords scheme?
  `chordNameExceptions` (list)
    An alist of chord exceptions. Contains (chord . markup) entries.
  `chordNameFunction` (procedure)
    The function that converts lists of pitches to chord names.
  `chordNoteNamer` (procedure)
    Function that converts from a pitch object to a text markup. Used for single pitches.
  `chordRootNamer` (procedure)
    Function that converts from a pitch object to a text markup. Used for chords.
  `chordNameExceptions` (list)
    An alist of chord exceptions. Contains (chord . markup) entries.
  `majorSevenSymbol` (markup)
    How should the major 7th be formatted in a chord name?
  This engraver creates the following layout objects: ChordName.
`Separating_line_group_engraver`
  Generates objects for computing spacing parameters.

  Properties (read)

  `createSpacing` (boolean)
    Create `StaffSpacing` objects? Should be set for staves.
  Properties (write)
  `breakableSeparationItem` (layout object)
    The breakable items in this time step, for this staff.
  This engraver creates the following layout objects: SeparatingGroupSpanner, SeparationItem and StaffSpacing.
`Output_property_engraver`
  Apply a procedure to any grob acknowledged.

  Music types accepted:

  layout-instruction

`Rest_swallow_translator`
  Swallow rest

  Music types accepted:

  rest-event

`Volta_engraver`
  Make volta brackets.

  Properties (read)

  `repeatCommands` (list)
    This property is read to find any command of the form `(volta .` x`)`, where x is a string or `#f`
  `voltaSpannerDuration` (moment)
    This specifies the maximum duration to use for the brackets printed for `\alternative`. This can be used to shrink the length of brackets in the situation where one alternative is very large.
  `stavesFound` (list of grobs)
    list of all staff-symbols found.
  This engraver creates the following layout objects: VoltaBracket.

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

Other languages: English.
Using automatic language selection.