3.2.23 break-alignment-interface

The object that performs break alignment.

Three interfaces deal specifically with break alignment:

  1. break-alignment-interface (this one),
  2. break-alignable-interface, and
  3. break-aligned-interface.

Each of these interfaces supports grob properties that use break-align symbols, which are Scheme symbols to specify the alignment, ordering, and spacing of certain notational elements (‘breakable’ items).

The break-align symbols used by the various grobs are listed in Grobs and their break-align symbols.

User-settable properties:

break-align-axis (procedure, no property callback)

A procedure that has to be wrapped into ly:make-no-callback, taking a break-aligned grob and returning an axis grob, or #f. Two BreakAlignGroups are kept apart as specified by their space-alist only if they contain grobs on the same axis, or grobs for which the procedure returns #f. Groups without such grobs may share horizontal space. If this property is set to #f, or the procedure only returns #f, all groups are placed one after the other.

A useful axis is the staff a grob belongs to, see break-align-axis::by-axis.

break-align-orders (vector)

This is a vector of 3 lists: #(end-of-line unbroken start-of-line). Each list contains break-align symbols that specify an order of breakable items (see Grobs and their break-align symbols and break-alignment-interface).

For example, this places time signatures before clefs:

\override Score.BreakAlignment.break-align-orders =
  #(make-vector 3 '(left-edge
                    cue-end-clef
                    ambitus
                    breathing-sign
                    time-signature
                    clef
                    cue-clef
                    staff-bar
                    key-cancellation
                    key-signature
                    custos))

The same result can be achieved more conveniently by:

\breakAlignInsert time-signature before clef

Internal properties:

positioning-done (boolean)

Used to signal that a positioning element did its job. This ensures that a positioning is only done once.

This grob interface is used in the following graphical object(s): BreakAlignment.


LilyPond Internals Reference v2.27.5 (development-branch).