3.1.23 BreakAlignment

An auxiliary grob that manages the horizontal ordering of BreakAlignGroup grobs within a NonMusicalPaperColumn grob (for example, whether the time signature follows or precedes a bar line).

BreakAlignment objects are created by the following engraver(s): Break_align_engraver.

Standard settings:

axes (list):
'(0)

List of axis numbers. In the case of alignment grobs, this should contain only one number.

break-align-orders (vector):
#((left-edge
    staff-ellipsis
    cue-end-clef
    ambitus
    breathing-sign
    signum-repetitionis
    clef
    cue-clef
    staff-bar
    key-cancellation
    key-signature
    time-signature
    custos)
  (left-edge
    staff-ellipsis
    cue-end-clef
    ambitus
    breathing-sign
    signum-repetitionis
    clef
    cue-clef
    staff-bar
    key-cancellation
    key-signature
    time-signature
    custos)
  (left-edge
    staff-ellipsis
    ambitus
    breathing-sign
    signum-repetitionis
    clef
    key-cancellation
    key-signature
    time-signature
    staff-bar
    cue-clef
    custos))

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 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))
non-musical (boolean):

#t

True if the grob belongs to a NonMusicalPaperColumn.

stacking-dir (direction):

1

Stack objects in which direction?

X-extent (pair of numbers):

ly:axis-group-interface::width

Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.

This object supports the following interface(s): axis-group-interface, break-alignment-interface, grob-interface and item-interface.

This object is of class Item (characterized by item-interface).


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