[ << Backend ]	[Top][Contents][Index]	[ Scheme functions >> ]
[ < TrillSpanner ]	[ Up : All layout objects ]	[ TupletNumber > ]

---

3.1.153 TupletBracket

A tuplet bracket. See also TupletNumber.

TupletBracket objects are created by the following engraver(s): Tuplet_engraver.

Standard settings:

avoid-scripts (boolean):

#t

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

connect-to-neighbor (pair):

ly:spanner::calc-connect-to-neighbors

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

direction (direction):

ly:tuplet-bracket::calc-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):

'(0.7 . 0.7)

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

full-length-to-extent (boolean):

#t

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

max-slope-factor (non-negative number):

0.5

Factor for calculating the maximum tuplet bracket slope. Notice that there exists a homonymous property for slurs.

padding (dimension, in staff space):

1.1

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

positions (pair of numbers):

ly:tuplet-bracket::calc-positions

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):

'(-0.2 . -0.2)

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.

span-all-note-heads (boolean):

#f

If true, tuplet brackets are printed spanning horizontally from the first to the last note head instead of covering only the stems.

staff-padding (dimension, in staff space):

0.25

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.

stencil (stencil):

ly:tuplet-bracket::print

The symbol to print.

thickness (number):

1.6

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):

#f

Draw a slur instead of a bracket for tuplets.

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.

visible-over-note-heads (boolean):

#f

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):

ly:tuplet-bracket::calc-x-positions

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.

This object supports the following interface(s): grob-interface, line-interface, outside-staff-interface, spanner-interface and tuplet-bracket-interface.

This object is of class Spanner (characterized by spanner-interface).