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

3.1.111 Script

An articulation (staccato, accent, etc.). See also ScriptColumn, ScriptRow, and MultiMeasureRestScript.

Script objects are created by: Drum_notes_engraver, New_fingering_engraver and Script_engraver.

Standard settings:

add-stem-support (boolean):

#t

If set, the Stem object is included in this script’s support.

direction (direction):

ly:script-interface::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.

font-encoding (symbol):

'fetaMusic

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

horizon-padding (number):

0.1

The amount to pad the axis along which a Skyline is built for the side-position-interface.

self-alignment-X (number):

0

Specify alignment of an object. The value -1 means left aligned, 0 centered, and 1 right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.

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.

slur-padding (number):

0.2

Extra distance between slur and script.

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:script-interface::print

The symbol to print.

vertical-skylines (pair of skylines):

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

Two skylines, one above and one below this grob.

X-offset (number):

script-interface::calc-x-offset

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

Y-extent (pair of numbers):

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

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

Y-offset (number):

#<unpure-pure-container #<procedure ly:side-position-interface::y-aligned-side (_ #:optional _)> #<procedure ly:side-position-interface::pure-y-aligned-side (_ _ _ #:optional _)> >

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

This object supports the following interface(s): font-interface, grob-interface, item-interface, outside-staff-interface, script-interface, self-alignment-interface and side-position-interface.

This object is of class Item (characterized by item-interface).

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

<< Back to Documentation Index

LilyPond – Internals Reference v2.23.82 (development-branch).