[ << Backend ][Top][Contents][Index][ Scheme functions >> ]
[ < break-alignable-interface ][ Up : Graphical Object Interfaces ][]

3.2.19 break-aligned-interface

Breakable items.

User settable properties:

break-align-anchor (number)

Grobs aligned to this breakable item will have their X-offsets shifted by this number. In bar lines, for example, this is used to position grobs relative to the (visual) center of the bar line.

break-align-anchor-alignment (number)

Read by ly:break-aligned-interface::calc-extent-aligned-anchor for aligning an anchor to a grob’s extent.

break-align-symbol (symbol)

This key is used for aligning, ordering, and spacing breakable items. See break-alignment-interface.

space-alist (alist, with symbols as keys)

An alist that specifies distances from this grob to other breakable items, using the format: 

'((break-align-symbol . (spacing-style . space))
  (break-align-symbol . (spacing-style . space))
  ...)

Standard choices for break-align-symbol are listed in break-alignment-interface. Additionally, three special break-align symbols available to space-alist are:

first-note

used when the grob is just left of the first note on a line

next-note

used when the grob is just left of any other note; if not set, the value of first-note gets used

right-edge

used when the grob is the last item on the line (only compatible with the extra-space spacing style)

Choices for spacing-style are:

extra-space

Put this much space between the two grobs. The space is stretchable when paired with first-note or next-note; otherwise it is fixed.

minimum-space

Put at least this much space between the left sides of both grobs, without allowing them to collide. The space is stretchable when paired with first-note or next-note; otherwise it is fixed. Not compatible with right-edge.

fixed-space

Only compatible with first-note and next-note. Put this much fixed space between the grob and the note.

minimum-fixed-space

Only compatible with first-note and next-note. Put at least this much fixed space between the left side of the grob and the left side of the note, without allowing them to collide.

semi-fixed-space

Only compatible with first-note and next-note. Put this much space between the grob and the note, such that half of the space is fixed and half is stretchable.

Rules for this spacing are much more complicated than this. See [Wanske] page 126–134, [Ross] page 143–147.

This grob interface is used in the following graphical object(s): Ambitus, AmbitusAccidental, BarLine, BreakAlignGroup, BreathingSign, Clef, CueClef, CueEndClef, Custos, Divisio, DoublePercentRepeat, KeyCancellation, KeySignature, LeftEdge, SignumRepetitionis, SpanBar, StaffEllipsis and TimeSignature.

[ << Backend ][Top][Contents][Index][ Scheme functions >> ]
[ < break-alignable-interface ][ Up : Graphical Object Interfaces ][]

<< Back to Documentation Index

LilyPond – Internals Reference v2.24.4 (stable-branch).