LilyPond Internals Reference: 3.2.159 tuplet-bracket-interface

### 3.2.159 `tuplet-bracket-interface`

A bracket with a number in the middle, used for tuplets. When the bracket spans a line break, the value of `break-overshoot` determines how far it extends beyond the staff. At a line break, the markups in the `edge-text` are printed at the edges.

#### User settable properties:

`avoid-scripts` (boolean)

  If set, a tuplet bracket avoids the scripts associated with the note heads it encompasses.

`bracket-flare` (pair of numbers)

  A pair of numbers specifying how much edges of brackets should slant outward. Value `0.0` means straight edges.

`bracket-visibility` (boolean or symbol)

  This controls the visibility of the tuplet bracket. Setting it to false prevents printing of the bracket. Setting the property to `if-no-beam` makes it print only if there is no beam associated with this tuplet bracket.

`break-overshoot` (pair of numbers)

  How much does a broken spanner stick out of its bounds?

`connect-to-neighbor` (pair)

  Pair of booleans, indicating whether this grob looks as a continued break.

`dashed-edge` (boolean)

  If set, the bracket edges are dashed like the rest of the bracket.

`direction` (direction)

  If `side-axis` is `0` (or `X`), then this property determines whether the object is placed `LEFT`, `CENTER` or `RIGHT` with respect to the other object. Otherwise, it determines whether the object is placed `UP`, `CENTER` or `DOWN`. Numerical values may also be used: `UP`=`1`, `DOWN`=`-1`, `LEFT`=`-1`, `RIGHT`=`1`, `CENTER`=`0`.

`edge-height` (pair)

  A pair of numbers specifying the heights of the vertical edges: `(left-height . right-height)`.

`edge-text` (pair)

  A pair specifying the texts to be set at the edges: `(left-text . right-text)`.

`full-length-padding` (number)

  How much padding to use at the right side of a full-length tuplet bracket.

`full-length-to-extent` (boolean)

  Run to the extent of the column for a full-length tuplet bracket.

`gap` (dimension, in staff space)

  Size of a gap in a variable symbol.

`padding` (dimension, in staff space)

  Add this much extra space between objects that are next to each other.

`positions` (pair of numbers)

  Pair of staff coordinates `(start . end)`, where start and end are vertical positions in `staff-space` units of the current staff. For slurs, this value selects which slur candidate to use; if extreme positions are requested, the closest one is taken.

`shorten-pair` (pair of numbers)

  The lengths to shorten on both sides a hairpin or text-spanner such as a pedal bracket. Positive values shorten the hairpin or text-spanner, while negative values lengthen it.

`staff-padding` (dimension, in staff space)

  Maintain this much space between reference points and the staff. Its effect is to align objects of differing sizes (like the dynamics p and f) on their baselines.

`thickness` (number)

  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`).

`tuplet-slur` (boolean)

  Draw a slur instead of a bracket for tuplets.

`visible-over-note-heads` (boolean)

  This prints a tuplet bracket when the bracket is set to be over the note heads. This option can be combined with the default tuplet bracket visibility style and with `#'if-no-beam`.

`X-positions` (pair of numbers)

  Pair of X staff coordinates of a spanner in the form `(left . right)`, where both left and right are in `staff-space` units of the current staff.

#### Internal properties:

`note-columns` (array of grobs)

  An array of `NoteColumn` grobs.

`scripts` (array of grobs)

  An array of `Script` objects.

`tuplet-number` (graphical (layout) object)

  The number for a bracket.

`tuplets` (array of grobs)

  An array of smaller tuplet brackets.

This grob interface is used in the following graphical object(s): `LigatureBracket` and `TupletBracket`.

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