LilyPond Internals Reference: 3.1.5 Ambitus

[ << Backend ]	[Top][Contents][Index][ ? ]			[ Scheme functions >> ]
[ < AccidentalSuggestion ]		[ Up : All layout objects ]	[ AmbitusAccidental > ]

3.1.5 Ambitus

Ambitus objects are created by: Ambitus_engraver.

Standard settings:

axes (list):
'(0 1)
List of axis numbers. In the case of alignment grobs, this should contain only one number.
break-align-symbol (symbol):

'ambitus

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

break-visibility (vector):
#(#f #f #t)
A vector of 3 booleans, #(end-of-line unbroken begin-of-line). #t means visible, #f means killed.
non-musical (boolean):

#t

True if the grob belongs to a NonMusicalPaperColumn.

space-alist (list):
'((cue-end-clef extra-space . 0.5)
  (clef extra-space . 0.5)
  (cue-clef extra-space . 0.5)
  (key-signature extra-space . 0.0)
  (staff-bar extra-space . 0.0)
  (time-signature extra-space . 0.0)
  (first-note fixed-space . 0.0))
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.
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.

Y-extent (pair of numbers):

#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >

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

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

[ << Backend ]	[Top][Contents][Index][ ? ]			[ Scheme functions >> ]
[ < AccidentalSuggestion ]		[ Up : All layout objects ]	[ AmbitusAccidental > ]

3.1.5 Ambitus

Internals Reference v2.21.0 (ramo di sviluppo).