[ << Backend ]	[Top][Contents][Index]	[ Scheme functions >> ]
[ < Arpeggio ]	[ Up : All layout objects ]	[ BarLine > ]

---

3.1.10 BalloonText

A balloon text with a pointing line to visually mark and annotate another grob.

BalloonText objects are created by the following engraver(s): Balloon_engraver.

Standard settings:

after-line-breaking (boolean):

ly:balloon-interface::remove-irrelevant-spanner

Dummy property, used to trigger callback for after-line-breaking.

annotation-balloon (boolean):

#t

Print the balloon around an annotation.

annotation-line (boolean):

#t

Print the line from an annotation to the grob that it annotates.

break-visibility (vector):

#<procedure at lily/output-lib.scm:3284:0 (grob)>

A vector of 3 booleans, #(end-of-line unbroken begin-of-line). #t means visible, #f means killed.

extra-spacing-width (pair of numbers):

'(+inf.0 . -inf.0)

In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to (+inf.0 . -inf.0).

stencil (stencil):

ly:balloon-interface::print

The symbol to print.

text (markup):

#<procedure at lily/output-lib.scm:1645:0 (grob)>

Text markup. See Formatting text.

thickness (number):

1.0

For grobs made up of lines, this is the thickness of the line. For slurs and ties, this is the distance between the two arcs of the curve’s outline at its thickest point, not counting the diameter of the virtual “pen” that draws the arcs. This property is expressed as a multiple of the current staff-line thickness (i.e., the visual output is influenced by changes to Staff.StaffSymbol.thickness).

vertical-skylines (pair of skylines):

#<unpure-pure-container #<procedure ly:grob::vertical-skylines-from-stencil (_)> #<procedure ly:grob::pure-simple-vertical-skylines-from-extents (_ _ _)> >

Two skylines, one above and one below this grob.

X-extent (pair of numbers):

ly:balloon-interface::width

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

X-offset (number):

#<procedure at lily/output-lib.scm:1645:0 (grob)>

The horizontal amount that this object is moved relative to its X-parent.

Note that many objects have special positioning considerations, which cause any setting of X-offset to be ignored or modified, even though the object supports the self-alignment-interface.

Y-extent (pair of numbers):

#<unpure-pure-container #<procedure ly:grob::stencil-height (_)> #<procedure ly:balloon-interface::pure-height (_ _ _)> >

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

Y-offset (number):

#<procedure at lily/output-lib.scm:1645:0 (grob)>

The vertical amount that this object is moved relative to its Y-parent.

Note that many objects have special positioning considerations, which cause any setting of Y-offset to be ignored or modified, even though the object supports the self-alignment-interface.

This object supports the following interface(s): accidental-switch-interface, balloon-interface, font-interface, grob-interface, sticky-grob-interface and text-interface.

This object can be of either of the following classes: Item (characterized by item-interface) or Spanner (characterized by spanner-interface). It supports the following interfaces conditionally depending on the class: item-interface and spanner-interface.