LilyPond Internals Reference: 3.1.127 TextSpanner

### 3.1.127 TextSpanner

TextSpanner objects are created by: Text_spanner_engraver.

Standard settings:

> `bound-details` (list):

>       '((left (Y . 0) (padding . 0.25) (attach-dir . -1))
>         (left-broken (attach-dir . 1))
>         (right (Y . 0) (padding . 0.25)))

>   An alist of properties for determining attachments of spanners to edges.

> `dash-fraction` (number):

>   `0.2`

>   Size of the dashes, relative to `dash-period`. Should be between `0.1` and `1.0` (continuous line). If set to `0.0`, a dotted line is produced

> `dash-period` (number):

>   `3.0`

>   The length of one dash together with whitespace. If negative, no line is drawn at all.

> `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-shape` (symbol):

>   `'italic`

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

> `left-bound-info` (list):

>   `ly:line-spanner::calc-left-bound-info`

>   An alist of properties for determining attachments of spanners to edges.

> `outside-staff-priority` (number):

>   `350`

>   If set, the grob is positioned outside the staff in such a way as to avoid all collisions. In case of a potential collision, the grob with the smaller `outside-staff-priority` is closer to the staff.

> `right-bound-info` (list):

>   `ly:line-spanner::calc-right-bound-info`

>   An alist of properties for determining attachments of spanners to edges.

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

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

>   `0.8`

>   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:line-spanner::print`

>   The symbol to print.

> `style` (symbol):

>   `'dashed-line`

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

> `Y-offset` (number):

>   `#<unpure-pure-container #<primitive-procedure ly:side-position-interface::y-aligned-side> #<primitive-procedure ly:side-position-interface::pure-y-aligned-side> >`

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

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

#### Internals Reference v2.22.2 (stable-branch).