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

3.1.21 BendSpanner

A string bending as used in tablature notation.

BendSpanner objects are created by: Bend_spanner_engraver.

Standard settings:

avoid-slur (symbol):

'ignore

Method of handling slur collisions. Choices are inside, outside, around, and ignore. inside adjusts the slur if needed to keep the grob inside the slur. outside moves the grob vertically to the outside of the slur. around moves the grob vertically to the outside of the slur only if there is a collision. ignore does not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.), outside and around behave like ignore.

baseline-skip (dimension, in staff space):

3

Distance between base lines of multiple lines of text.

before-line-breaking (boolean):

bend::target-cautionary

Dummy property, used to trigger a callback function.

details (alist, with symbols as keys):
'((arrow-stencil
    .
    #<procedure bend::arrow-head-stencil (thickness x-y-coords height width dir)>)
  (curvature-factor . 0.35)
  (bend-arrowhead-height . 1.25)
  (bend-arrowhead-width . 0.8)
  (bend-amount-strings
    (quarter . "¼")
    (half . "½")
    (three-quarter . "¾")
    (full . #f))
  (curve-x-padding-line-end . 0.5)
  (curve-y-padding-line-end . 1)
  (dashed-line-settings 0.4 0.4 0)
  (head-text-break-visibility . #(#f #t #t))
  (horizontal-left-padding . 0.1)
  (successive-level . 1)
  (target-visibility . #f)
  (vertical-padding . 0.2)
  (y-distance-from-tabstaff-to-arrow-tip . 2.75))

Alist of parameters for detailed grob behavior. More information on the allowed parameters for a grob can be found by looking at the top of the Internals Reference page for each interface having a details property.

direction (direction):

1

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.

font-encoding (symbol):

'latin1

The font encoding is the broadest category for selecting a font. Currently, only lilypond’s system fonts (Emmentaler) are using this property. Available values are fetaMusic (Emmentaler), fetaBraces, fetaText (Emmentaler).

font-shape (symbol):

'italic

Select the shape of a font. Choices include upright, italic, caps.

font-size (number):

-2

The font size, compared to the ‘normal’ size. 0 is style-sheet’s normal size, -1 is smaller, +1 is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context property fontSize is set, its value is added to this before the glyph is printed. Fractional values are allowed.

padding (dimension, in staff space):

0.15

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

side-axis (number):

1

If the value is X (or equivalently 0), the object is placed horizontally next to the other object. If the value is Y or 1, it is placed vertically.

spanner-id (index or symbol):

""

An identifier to distinguish concurrent spanners.

stencil (stencil):

bend-spanner::print

The symbol to print.

style (symbol):

'()

This setting determines in what style a grob is typeset. Valid choices depend on the stencil callback reading this property.

text (markup):

#f

Text markup. See Formatting text.

thickness (number):

1

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.

word-space (dimension, in staff space):

0.6

Space to insert between words in texts.

Y-offset (number):

0

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

This object supports the following interface(s): bend-interface, font-interface, grob-interface, line-spanner-interface, outside-staff-interface, spanner-interface, text-interface and text-script-interface.

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

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

<< Back to Documentation Index

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