| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Accidental objects are created by: Accidental_engraver.
Standard settings:
after-line-breaking(boolean):
ly:accidental-interface::remove-tiedDummy property, used to trigger callback for
after-line-breaking.alteration(number):
accidental-interface::calc-alterationAlteration numbers for accidental.
avoid-slur(symbol):
'insideMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.extra-spacing-width(pair of numbers): '(-0.2 . 0.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).glyph-name(string):
accidental-interface::glyph-nameThe glyph name within the font.
In the context of (span) bar lines, glyph-name represents a processed form of
glyph, where decisions about line breaking etc. are already taken.glyph-name-alist(list): '((0 . "accidentals.natural") (-1/2 . "accidentals.flat") (1/2 . "accidentals.sharp") (1 . "accidentals.doublesharp") (-1 . "accidentals.flatflat") (3/4 . "accidentals.sharp.slashslash.stemstemstem") (1/4 . "accidentals.sharp.slashslash.stem") (-1/4 . "accidentals.mirroredflat") (-3/4 . "accidentals.mirroredflat.flat"))An alist of key-string pairs.
horizontal-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:accidental-interface::horizontal-skylines> >Two skylines, one to the left and one to the right of this grob.
stencil(stencil):
ly:accidental-interface::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
X-offset(number):
ly:grob::x-parent-positioningThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:accidental-interface::height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): accidental-interface, font-interface, grob-interface, inline-accidental-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AccidentalCautionary objects are created by: Accidental_engraver.
Standard settings:
after-line-breaking(boolean):
ly:accidental-interface::remove-tiedDummy property, used to trigger callback for
after-line-breaking.alteration(number):
accidental-interface::calc-alterationAlteration numbers for accidental.
avoid-slur(symbol):
'insideMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.glyph-name-alist(list): '((0 . "accidentals.natural") (-1/2 . "accidentals.flat") (1/2 . "accidentals.sharp") (1 . "accidentals.doublesharp") (-1 . "accidentals.flatflat") (3/4 . "accidentals.sharp.slashslash.stemstemstem") (1/4 . "accidentals.sharp.slashslash.stem") (-1/4 . "accidentals.mirroredflat") (-3/4 . "accidentals.mirroredflat.flat"))An alist of key-string pairs.
parenthesized(boolean):
#tParenthesize this grob.
stencil(stencil):
ly:accidental-interface::printThe symbol to print.
X-offset(number):
ly:grob::x-parent-positioningThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:accidental-interface::height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): accidental-interface, font-interface, grob-interface, inline-accidental-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AccidentalPlacement objects are created by: Accidental_engraver and Ambitus_engraver.
Standard settings:
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.right-padding(dimension, in staff space):
0.15Space to insert on the right side of an object (e.g., between note and its accidentals).
script-priority(number):
-100A key for determining the order of scripts in a stack, by being added to the position of the script in the user input, the sum being the overall priority. Smaller means closer to the head.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): accidental-placement-interface, grob-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AccidentalSuggestion objects are created by: Accidental_engraver.
Standard settings:
after-line-breaking(boolean):
ly:accidental-interface::remove-tiedDummy property, used to trigger callback for
after-line-breaking.alteration(number):
accidental-interface::calc-alterationAlteration numbers for accidental.
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-size(number):
-2The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.glyph-name-alist(list): '((0 . "accidentals.natural") (-1/2 . "accidentals.flat") (1/2 . "accidentals.sharp") (1 . "accidentals.doublesharp") (-1 . "accidentals.flatflat") (3/4 . "accidentals.sharp.slashslash.stemstemstem") (1/4 . "accidentals.sharp.slashslash.stem") (-1/4 . "accidentals.mirroredflat") (-3/4 . "accidentals.mirroredflat.flat"))An alist of key-string pairs.
outside-staff-priority(number):
0If 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-priorityis closer to the staff.parent-alignment-X(number):
0Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.script-priority(number):
0A key for determining the order of scripts in a stack, by being added to the position of the script in the user input, the sum being the overall priority. Smaller means closer to the head.
self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.staff-padding(dimension, in staff space):
0.25Maintain 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:accidental-interface::printThe symbol to print.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:accidental-interface::height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
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): accidental-interface, accidental-suggestion-interface, font-interface, grob-interface, item-interface, outside-staff-interface, script-interface, self-alignment-interface and side-position-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Ambitus objects are created by: Ambitus_engraver.
Standard settings:
axes(list): '(0 1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
break-align-symbol(symbol):
'ambitusThis key is used for aligning, ordering, and spacing breakable items. See (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.
break-visibility(vector): #(#f #f #t)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.space-alist(list): '((cue-end-clef extra-space . 0.5) (clef extra-space . 1.15) (cue-clef extra-space . 0.5) (key-signature extra-space . 1.15) (staff-bar extra-space . 1.15) (time-signature extra-space . 1.15) (right-edge extra-space . 0.5) (first-note extra-space . 1.15))An alist that specifies distances from this grob to other breakable items, using the format:
'((break-align-symbol . (spacing-style . space)) (break-align-symbol . (spacing-style . space)) ...)Standard choices for
break-align-symbolare listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference. Additionally, three special break-align symbols available tospace-alistare:
first-noteused when the grob is just left of the first note on a line
next-noteused when the grob is just left of any other note; if not set, the value of
first-notegets usedright-edgeused when the grob is the last item on the line (only compatible with the
extra-spacespacing style)Choices for
spacing-styleare:
extra-spacePut this much space between the two grobs. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed.minimum-spacePut at least this much space between the left sides of both grobs, without allowing them to collide. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed. Not compatible withright-edge.fixed-spaceOnly compatible with
first-noteandnext-note. Put this much fixed space between the grob and the note.minimum-fixed-spaceOnly compatible with
first-noteandnext-note. Put at least this much fixed space between the left side of the grob and the left side of the note, without allowing them to collide.semi-fixed-spaceOnly compatible with
first-noteandnext-note. Put this much space between the grob and the note, such that half of the space is fixed and half is stretchable.Rules for this spacing are much more complicated than this. See [Wanske] page 126–134, [Ross] page 143–147.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): ambitus-interface, axis-group-interface, break-aligned-interface, grob-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AmbitusAccidental objects are created by: Ambitus_engraver.
Standard settings:
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.glyph-name-alist(list): '((0 . "accidentals.natural") (-1/2 . "accidentals.flat") (1/2 . "accidentals.sharp") (1 . "accidentals.doublesharp") (-1 . "accidentals.flatflat") (3/4 . "accidentals.sharp.slashslash.stemstemstem") (1/4 . "accidentals.sharp.slashslash.stem") (-1/4 . "accidentals.mirroredflat") (-3/4 . "accidentals.mirroredflat.flat"))An alist of key-string pairs.
padding(dimension, in staff space):
0.5Add this much extra space between objects that are next to each other.
side-axis(number):
0If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.stencil(stencil):
ly:accidental-interface::printThe symbol to print.
X-offset(number):
ly:grob::x-parent-positioningThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:accidental-interface::height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): accidental-interface, break-aligned-interface, font-interface, grob-interface, item-interface and side-position-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AmbitusLine objects are created by: Ambitus_engraver.
Standard settings:
gap(dimension, in staff space):
ambitus-line::calc-gapSize of a gap in a variable symbol.
length-fraction(number):
0.7Multiplier for lengths. Used for determining ledger lines and stem lengths.
maximum-gap(number):
0.45Maximum value allowed for
gapproperty.stencil(stencil):
ambitus::printThe symbol to print.
thickness(number):
2For 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).X-offset(number):
ly:self-alignment-interface::centered-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
This object supports the following interface(s): ambitus-interface, font-interface, grob-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AmbitusNoteHead objects are created by: Ambitus_engraver.
Standard settings:
duration-log(integer):
2The 2-log of the note head duration, i.e.,
0= whole note,1= half note, etc.glyph-name(string):
note-head::calc-glyph-nameThe glyph name within the font.
In the context of (span) bar lines, glyph-name represents a processed form of
glyph, where decisions about line breaking etc. are already taken.ignore-ambitus(boolean):
#tIf set, don’t consider this notehead for ambitus calculation.
stencil(stencil):
ly:note-head::printThe symbol to print.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<primitive-procedure ly:staff-symbol-referencer::callback> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): ambitus-interface, font-interface, grob-interface, item-interface, ledgered-interface, note-head-interface, rhythmic-head-interface and staff-symbol-referencer-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Arpeggio objects are created by: Arpeggio_engraver and Span_arpeggio_engraver.
Standard settings:
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.line-thickness(number):
1For slurs and ties, this is the diameter of the virtual “pen” that draws the two arcs of the curve’s outline, which intersect at the endpoints. 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).padding(dimension, in staff space):
0.5Add this much extra space between objects that are next to each other.
positions(pair of numbers):
ly:arpeggio::calc-positionsPair of staff coordinates
(left . right), where both left and right are instaff-spaceunits of the current staff. For slurs, this value selects which slur candidate to use; if extreme positions are requested, the closest one is taken.protrusion(number):
0.4In an arpeggio bracket, the length of the horizontal edges.
script-priority(number):
0A key for determining the order of scripts in a stack, by being added to the position of the script in the user input, the sum being the overall priority. Smaller means closer to the head.
side-axis(number):
0If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.staff-position(number):
0.0Vertical position, measured in half staff spaces, counted from the middle line.
stencil(stencil):
ly:arpeggio::printThe symbol to print.
thickness(number):
1For 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).X-extent(pair of numbers):
ly:arpeggio::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
X-offset(number):
ly:side-position-interface::x-aligned-sideThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> #<primitive-procedure ly:arpeggio::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
Y-offset(number):
#<unpure-pure-container #<primitive-procedure ly:staff-symbol-referencer::callback> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): arpeggio-interface, font-interface, grob-interface, item-interface, side-position-interface and staff-symbol-referencer-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BalloonTextItem objects are created by: Balloon_engraver.
Standard settings:
annotation-balloon(boolean):
#tPrint the balloon around an annotation.
annotation-line(boolean):
#tPrint the line from an annotation to the grob that it annotates.
extra-spacing-width(pair of numbers): '(+inf.0 . -inf.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).stencil(stencil):
ly:balloon-interface::printThe symbol to print.
text(markup):
#<procedure #f (grob)>Text markup. See (notation)Formatting text section ‘Formatting text’ in Notation Reference.
X-offset(number):
#<procedure #f (grob)>The horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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):
#<procedure #f (grob)>The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): balloon-interface, font-interface, grob-interface, item-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BalloonTextSpanner objects are not created by any engraver.
Standard settings:
annotation-balloon(boolean):
#tPrint the balloon around an annotation.
annotation-line(boolean):
#tPrint the line from an annotation to the grob that it annotates.
extra-spacing-width(pair of numbers): '(+inf.0 . -inf.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).stencil(stencil):
ly:balloon-interface::print-spannerThe symbol to print.
text(markup):
#<procedure #f (grob)>Text markup. See (notation)Formatting text section ‘Formatting text’ in Notation Reference.
X-offset(number):
#<procedure #f (grob)>The horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> #<primitive-procedure ly:balloon-interface::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
Y-offset(number):
#<procedure #f (grob)>The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): balloon-interface, font-interface, grob-interface, spanner-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BarLine objects are created by: Bar_engraver.
Standard settings:
allow-span-bar(boolean):
#tIf false, no inter-staff bar line will be created below this bar line.
bar-extent(pair of numbers):
ly:bar-line::calc-bar-extentThe Y-extent of the actual bar line. This may differ from
Y-extentbecause it does not include the dots in a repeat bar line.break-align-anchor(number):
ly:bar-line::calc-anchorGrobs aligned to this breakable item will have their X-offsets shifted by this number. In bar lines, for example, this is used to position grobs relative to the (visual) center of the bar line.
break-align-symbol(symbol):
'staff-barThis key is used for aligning, ordering, and spacing breakable items. See (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.
break-visibility(vector):
bar-line::calc-break-visibilityA vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.extra-spacing-height(pair of numbers):
pure-from-neighbor-interface::account-for-span-barIn the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).gap(dimension, in staff space):
0.4Size of a gap in a variable symbol.
glyph(string):
"|"A string determining what ‘style’ of glyph is typeset. Valid choices depend on the function that is reading this property.
In combination with (span) bar lines, it is a string resembling the bar line appearance in ASCII form.
glyph-name(string):
bar-line::calc-glyph-nameThe glyph name within the font.
In the context of (span) bar lines, glyph-name represents a processed form of
glyph, where decisions about line breaking etc. are already taken.hair-thickness(number):
1.9Thickness of the thin line in a bar line, expressed as a multiple of the default staff-line thickness (i.e. the visual output is not influenced by changes to
Staff.StaffSymbol.thickness).kern(dimension, in staff space):
3.0The space between individual elements in any compound bar line, expressed as a multiple of the default staff-line thickness (i.e. the visual output is not influenced by changes to
Staff.StaffSymbol.thickness).layer(integer):
0An integer which determines the order of printing objects. Objects with the lowest value of layer are drawn first, then objects with progressively higher values are drawn, so objects with higher values overwrite objects with lower values. By default most objects are assigned a layer value of 1.
non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.rounded(boolean)Decide whether lines should be drawn rounded or not.
segno-kern(number):
3.0The space between the two thin lines of the segno bar line symbol, expressed as a multiple of the default staff-line thickness (i.e. the visual output is not influenced by changes to
Staff.StaffSymbol.thickness).space-alist(list): '((ambitus extra-space . 1.0) (time-signature extra-space . 0.75) (custos minimum-space . 2.0) (clef extra-space . 1.0) (key-signature extra-space . 1.0) (key-cancellation extra-space . 1.0) (first-note fixed-space . 1.3) (next-note semi-fixed-space . 0.9) (right-edge extra-space . 0.0))An alist that specifies distances from this grob to other breakable items, using the format:
'((break-align-symbol . (spacing-style . space)) (break-align-symbol . (spacing-style . space)) ...)Standard choices for
break-align-symbolare listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference. Additionally, three special break-align symbols available tospace-alistare:
first-noteused when the grob is just left of the first note on a line
next-noteused when the grob is just left of any other note; if not set, the value of
first-notegets usedright-edgeused when the grob is the last item on the line (only compatible with the
extra-spacespacing style)Choices for
spacing-styleare:
extra-spacePut this much space between the two grobs. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed.minimum-spacePut at least this much space between the left sides of both grobs, without allowing them to collide. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed. Not compatible withright-edge.fixed-spaceOnly compatible with
first-noteandnext-note. Put this much fixed space between the grob and the note.minimum-fixed-spaceOnly compatible with
first-noteandnext-note. Put at least this much fixed space between the left side of the grob and the left side of the note, without allowing them to collide.semi-fixed-spaceOnly compatible with
first-noteandnext-note. Put this much space between the grob and the note, such that half of the space is fixed and half is stretchable.Rules for this spacing are much more complicated than this. See [Wanske] page 126–134, [Ross] page 143–147.
stencil(stencil):
ly:bar-line::printThe symbol to print.
thick-thickness(number):
6.0Thickness of the thick line in a bar line, expressed as a multiple of the default staff-line thickness (i.e. the visual output is not influenced by changes to
Staff.StaffSymbol.thickness).Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): bar-line-interface, break-aligned-interface, font-interface, grob-interface, item-interface and pure-from-neighbor-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BarNumber objects are created by: Bar_number_engraver.
Standard settings:
after-line-breaking(boolean):
ly:side-position-interface::move-to-extremal-staffDummy property, used to trigger callback for
after-line-breaking.break-align-symbols(list): '(left-edge staff-bar)A list of break-align symbols that determines which breakable items to align this to. If the grob selected by the first symbol in the list is invisible due to
break-visibility, we will align to the next grob (and so on). Choices are listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.break-visibility(vector): #(#f #f #t)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.extra-spacing-width(pair of numbers): '(+inf.0 . -inf.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).font-family(symbol):
'romanThe font family is the broadest category for selecting text fonts. Options include:
sans,roman.font-size(number):
-2The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.horizon-padding(number):
0.05The amount to pad the axis along which a
Skylineis built for theside-position-interface.non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.outside-staff-priority(number):
100If 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-priorityis closer to the staff.padding(dimension, in staff space):
1.0Add this much extra space between objects that are next to each other.
self-alignment-X(number):
1Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.stencil(stencil):
ly:text-interface::printThe symbol to print.
X-offset(number):
self-alignment-interface::self-aligned-on-breakableThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<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): break-alignable-interface, font-interface, grob-interface, item-interface, outside-staff-interface, self-alignment-interface, side-position-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BassFigure objects are created by: Figured_bass_engraver.
Standard settings:
stencil(stencil):
ly:text-interface::printThe symbol to print.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): bass-figure-interface, font-interface, grob-interface, item-interface, rhythmic-grob-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BassFigureAlignment objects are created by: Figured_bass_engraver.
Standard settings:
axes(list): '(1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
padding(dimension, in staff space):
0.2Add this much extra space between objects that are next to each other.
stacking-dir(direction):
-1Stack objects in which direction?
vertical-skylines(pair of skylines):
ly:axis-group-interface::calc-skylinesTwo skylines, one above and one below this grob.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): align-interface, axis-group-interface, bass-figure-alignment-interface, grob-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BassFigureAlignmentPositioning objects are created by: Figured_bass_position_engraver.
Standard settings:
add-stem-support(boolean):
#tIf set, the
Stemobject is included in this script’s support.axes(list): '(1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.padding(dimension, in staff space):
0.5Add this much extra space between objects that are next to each other.
side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.staff-padding(dimension, in staff space):
1.0Maintain 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.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
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): axis-group-interface, grob-interface, outside-staff-interface, side-position-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BassFigureBracket objects are created by: Figured_bass_engraver.
Standard settings:
edge-height(pair): '(0.2 . 0.2)A pair of numbers specifying the heights of the vertical edges:
(left-height . right-height).stencil(stencil):
ly:enclosing-bracket::printThe symbol to print.
X-extent(pair of numbers):
ly:enclosing-bracket::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): enclosing-bracket-interface, grob-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BassFigureContinuation objects are created by: Figured_bass_engraver.
Standard settings:
stencil(stencil):
ly:figured-bass-continuation::printThe symbol to print.
Y-offset(number):
ly:figured-bass-continuation::center-on-figuresThe vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): figured-bass-continuation-interface, grob-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BassFigureLine objects are created by: Figured_bass_engraver.
Standard settings:
axes(list): '(1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
vertical-skylines(pair of skylines):
ly:axis-group-interface::calc-skylinesTwo skylines, one above and one below this grob.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): axis-group-interface, grob-interface, outside-staff-axis-group-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Beam objects are created by: Auto_beam_engraver, Beam_engraver, Chord_tremolo_engraver, Grace_auto_beam_engraver and Grace_beam_engraver.
Standard settings:
auto-knee-gap(dimension, in staff space):
5.5If a gap is found between note heads where a horizontal beam fits and it is larger than this number, make a kneed beam.
beam-thickness(dimension, in staff space):
0.48Beam thickness, measured in
staff-spaceunits.beamed-stem-shorten(list): '(1.0 0.5 0.25)How much to shorten beamed stems, when their direction is forced. It is a list, since the value is different depending on the number of flags and beams.
beaming(pair):
ly:beam::calc-beamingPair of number lists. Each number list specifies which beams to make.
0is the central beam,1is the next beam toward the note, etc. This information is used to determine how to connect the beaming patterns from stem to stem inside a beam.clip-edges(boolean):
#tAllow outward pointing beamlets at the edges of beams?
collision-interfaces(list): '(beam-interface clef-interface clef-modifier-interface flag-interface inline-accidental-interface key-signature-interface note-head-interface stem-interface time-signature-interface)A list of interfaces for which automatic beam-collision resolution is run.
damping(number):
1Amount of beam slope damping.
details(list): '((secondary-beam-demerit . 10) (stem-length-demerit-factor . 5) (region-size . 2) (beam-eps . 0.001) (stem-length-limit-penalty . 5000) (damping-direction-penalty . 800) (hint-direction-penalty . 20) (musical-direction-factor . 400) (ideal-slope-factor . 10) (collision-penalty . 500) (collision-padding . 0.35) (round-to-zero-slope . 0.02))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
detailsproperty.direction(direction):
ly:beam::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-family(symbol):
'romanThe font family is the broadest category for selecting text fonts. Options include:
sans,roman.gap(dimension, in staff space):
0.8Size of a gap in a variable symbol.
neutral-direction(direction):
-1Which direction to take in the center of the staff.
normalized-endpoints(pair):
ly:spanner::calc-normalized-endpointsRepresents left and right placement over the total spanner, where the width of the spanner is normalized between 0 and 1.
positions(pair of numbers):
beam::place-broken-parts-individuallyPair of staff coordinates
(left . right), where both left and right are instaff-spaceunits of the current staff. For slurs, this value selects which slur candidate to use; if extreme positions are requested, the closest one is taken.stencil(stencil):
ly:beam::printThe symbol to print.
transparent(boolean):
#<procedure #f (grob)>This makes the grob invisible.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
X-positions(pair of numbers):
ly:beam::calc-x-positionsPair of X staff coordinates of a spanner in the form
(left . right), where both left and right are instaff-spaceunits of the current staff.
This object supports the following interface(s): beam-interface, font-interface, grob-interface, spanner-interface, staff-symbol-referencer-interface and unbreakable-spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BendAfter objects are created by: Bend_engraver.
Standard settings:
minimum-length(dimension, in staff space):
0.5Try to make a spanner at least this long, normally in the horizontal direction. This requires an appropriate callback for the
springs-and-rodsproperty. If added to aTie, this sets the minimum distance between noteheads.stencil(stencil):
bend::printThe symbol to print.
thickness(number):
2.0For 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).
This object supports the following interface(s): bend-after-interface, grob-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BreakAlignGroup objects are created by: Break_align_engraver.
Standard settings:
axes(list): '(0)List of axis numbers. In the case of alignment grobs, this should contain only one number.
break-align-anchor(number):
ly:break-aligned-interface::calc-average-anchorGrobs aligned to this breakable item will have their X-offsets shifted by this number. In bar lines, for example, this is used to position grobs relative to the (visual) center of the bar line.
break-align-anchor-alignment(number):
ly:break-aligned-interface::calc-joint-anchor-alignmentRead by
ly:break-aligned-interface::calc-extent-aligned-anchorfor aligning an anchor to a grob’s extent.break-visibility(vector):
ly:break-aligned-interface::calc-break-visibilityA vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): axis-group-interface, break-aligned-interface, grob-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BreakAlignment objects are created by: Break_align_engraver.
Standard settings:
axes(list): '(0)List of axis numbers. In the case of alignment grobs, this should contain only one number.
break-align-orders(vector):#((left-edge cue-end-clef ambitus breathing-sign clef cue-clef staff-bar key-cancellation key-signature time-signature custos) (left-edge cue-end-clef ambitus breathing-sign clef cue-clef staff-bar key-cancellation key-signature time-signature custos) (left-edge ambitus breathing-sign clef key-cancellation key-signature time-signature staff-bar cue-clef custos))This is a vector of 3 lists:
#(end-of-line unbroken start-of-line). Each list contains break-align symbols that specify an order of breakable items (see (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference).For example, this places time signatures before clefs:
\override Score.BreakAlignment.break-align-orders = #(make-vector 3 '(left-edge cue-end-clef ambitus breathing-sign time-signature clef cue-clef staff-bar key-cancellation key-signature custos))non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.stacking-dir(direction):
1Stack objects in which direction?
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): axis-group-interface, break-alignment-interface, grob-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
BreathingSign objects are created by: Breathing_sign_engraver.
Standard settings:
break-align-symbol(symbol):
'breathing-signThis key is used for aligning, ordering, and spacing breakable items. See (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.
break-visibility(vector): #(#t #t #f)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.space-alist(list): '((ambitus extra-space . 2.0) (custos minimum-space . 1.0) (key-signature minimum-space . 1.5) (time-signature minimum-space . 1.5) (staff-bar minimum-space . 1.5) (clef minimum-space . 2.0) (cue-clef minimum-space . 2.0) (cue-end-clef minimum-space . 2.0) (first-note fixed-space . 1.0) (right-edge extra-space . 0.1))An alist that specifies distances from this grob to other breakable items, using the format:
'((break-align-symbol . (spacing-style . space)) (break-align-symbol . (spacing-style . space)) ...)Standard choices for
break-align-symbolare listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference. Additionally, three special break-align symbols available tospace-alistare:
first-noteused when the grob is just left of the first note on a line
next-noteused when the grob is just left of any other note; if not set, the value of
first-notegets usedright-edgeused when the grob is the last item on the line (only compatible with the
extra-spacespacing style)Choices for
spacing-styleare:
extra-spacePut this much space between the two grobs. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed.minimum-spacePut at least this much space between the left sides of both grobs, without allowing them to collide. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed. Not compatible withright-edge.fixed-spaceOnly compatible with
first-noteandnext-note. Put this much fixed space between the grob and the note.minimum-fixed-spaceOnly compatible with
first-noteandnext-note. Put at least this much fixed space between the left side of the grob and the left side of the note, without allowing them to collide.semi-fixed-spaceOnly compatible with
first-noteandnext-note. Put this much space between the grob and the note, such that half of the space is fixed and half is stretchable.Rules for this spacing are much more complicated than this. See [Wanske] page 126–134, [Ross] page 143–147.
stencil(stencil):
ly:text-interface::printThe symbol to print.
text(markup): '(#<procedure musicglyph-markup (layout props glyph-name)> "scripts.rcomma")Text markup. See (notation)Formatting text section ‘Formatting text’ in Notation Reference.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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):
ly:breathing-sign::offset-callbackThe vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): break-aligned-interface, breathing-sign-interface, font-interface, grob-interface, item-interface, outside-staff-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
ChordName objects are created by: Chord_name_engraver.
Standard settings:
after-line-breaking(boolean):
ly:chord-name::after-line-breakingDummy property, used to trigger callback for
after-line-breaking.extra-spacing-height(pair of numbers): '(0.2 . -0.2)In the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).extra-spacing-width(pair of numbers): '(-0.5 . 0.5)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).font-family(symbol):
'sansThe font family is the broadest category for selecting text fonts. Options include:
sans,roman.font-size(number):
1.5The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.stencil(stencil):
ly:text-interface::printThe symbol to print.
word-space(dimension, in staff space):
0.0Space to insert between words in texts.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): chord-name-interface, font-interface, grob-interface, item-interface, outside-staff-interface, rhythmic-grob-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Clef objects are created by: Clef_engraver.
Standard settings:
avoid-slur(symbol):
'insideMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.break-align-anchor(number):
ly:break-aligned-interface::calc-extent-aligned-anchorGrobs aligned to this breakable item will have their X-offsets shifted by this number. In bar lines, for example, this is used to position grobs relative to the (visual) center of the bar line.
break-align-anchor-alignment(number):
1Read by
ly:break-aligned-interface::calc-extent-aligned-anchorfor aligning an anchor to a grob’s extent.break-align-symbol(symbol):
'clefThis key is used for aligning, ordering, and spacing breakable items. See (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.
break-visibility(vector): #(#f #f #t)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.extra-spacing-height(pair of numbers):
pure-from-neighbor-interface::extra-spacing-height-at-beginning-of-lineIn the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).glyph-name(string):
ly:clef::calc-glyph-nameThe glyph name within the font.
In the context of (span) bar lines, glyph-name represents a processed form of
glyph, where decisions about line breaking etc. are already taken.non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.space-alist(list): '((cue-clef extra-space . 2.0) (staff-bar extra-space . 0.7) (ambitus extra-space . 1.15) (key-cancellation minimum-space . 3.5) (key-signature minimum-space . 3.5) (time-signature minimum-space . 4.2) (first-note minimum-fixed-space . 5.0) (next-note extra-space . 1.0) (right-edge extra-space . 0.5))An alist that specifies distances from this grob to other breakable items, using the format:
'((break-align-symbol . (spacing-style . space)) (break-align-symbol . (spacing-style . space)) ...)Standard choices for
break-align-symbolare listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference. Additionally, three special break-align symbols available tospace-alistare:
first-noteused when the grob is just left of the first note on a line
next-noteused when the grob is just left of any other note; if not set, the value of
first-notegets usedright-edgeused when the grob is the last item on the line (only compatible with the
extra-spacespacing style)Choices for
spacing-styleare:
extra-spacePut this much space between the two grobs. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed.minimum-spacePut at least this much space between the left sides of both grobs, without allowing them to collide. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed. Not compatible withright-edge.fixed-spaceOnly compatible with
first-noteandnext-note. Put this much fixed space between the grob and the note.minimum-fixed-spaceOnly compatible with
first-noteandnext-note. Put at least this much fixed space between the left side of the grob and the left side of the note, without allowing them to collide.semi-fixed-spaceOnly compatible with
first-noteandnext-note. Put this much space between the grob and the note, such that half of the space is fixed and half is stretchable.Rules for this spacing are much more complicated than this. See [Wanske] page 126–134, [Ross] page 143–147.
stencil(stencil):
ly:clef::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<primitive-procedure ly:staff-symbol-referencer::callback> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): break-aligned-interface, clef-interface, font-interface, grob-interface, item-interface, pure-from-neighbor-interface and staff-symbol-referencer-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
ClefModifier objects are created by: Clef_engraver and Cue_clef_engraver.
Standard settings:
break-visibility(vector):
#<procedure #f (grob)>A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.clef-alignments(list): '((G -0.2 . 0.1) (F -0.3 . -0.2) (C 0 . 0))An alist of parent-alignments that should be used for clef modifiers with various clefs
color(color):
#<procedure #f (grob)>The color of this grob.
font-shape(symbol):
'italicSelect the shape of a font. Choices include
upright,italic,caps.font-size(number):
-4The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.parent-alignment-X(number):
ly:clef-modifier::calc-parent-alignmentSpecify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.staff-padding(dimension, in staff space):
0.7Maintain 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:text-interface::printThe symbol to print.
transparent(boolean):
#<procedure #f (grob)>This makes the grob invisible.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<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): clef-modifier-interface, font-interface, grob-interface, item-interface, outside-staff-interface, self-alignment-interface, side-position-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
ClusterSpanner objects are created by: Cluster_spanner_engraver.
Standard settings:
minimum-length(dimension, in staff space):
0.0Try to make a spanner at least this long, normally in the horizontal direction. This requires an appropriate callback for the
springs-and-rodsproperty. If added to aTie, this sets the minimum distance between noteheads.padding(dimension, in staff space):
0.25Add this much extra space between objects that are next to each other.
springs-and-rods(boolean):
ly:spanner::set-spacing-rodsDummy variable for triggering spacing routines.
stencil(stencil):
ly:cluster::printThe symbol to print.
style(symbol):
'rampThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback reading this property.
This object supports the following interface(s): cluster-interface, grob-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
ClusterSpannerBeacon objects are created by: Cluster_spanner_engraver.
Standard settings:
Y-extent(pair of numbers):
ly:cluster-beacon::heightExtent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): cluster-beacon-interface, grob-interface, item-interface and rhythmic-grob-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
CombineTextScript objects are created by: Part_combine_engraver.
Standard settings:
avoid-slur(symbol):
'outsideMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.baseline-skip(dimension, in staff space):
2Distance between base lines of multiple lines of text.
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.extra-spacing-width(pair of numbers): '(+inf.0 . -inf.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).font-series(symbol):
'boldSelect the series of a font. Choices include
medium,bold,bold-narrow, etc.outside-staff-priority(number):
450If 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-priorityis closer to the staff.padding(dimension, in staff space):
0.5Add this much extra space between objects that are next to each other.
parent-alignment-X(number)Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.script-priority(number):
200A key for determining the order of scripts in a stack, by being added to the position of the script in the user input, the sum being the overall priority. Smaller means closer to the head.
self-alignment-X(number)Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.staff-padding(dimension, in staff space):
0.5Maintain 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:text-interface::printThe symbol to print.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<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, item-interface, outside-staff-interface, self-alignment-interface, side-position-interface, text-interface and text-script-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
CueClef objects are created by: Cue_clef_engraver.
Standard settings:
avoid-slur(symbol):
'insideMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.break-align-anchor(number):
ly:break-aligned-interface::calc-extent-aligned-anchorGrobs aligned to this breakable item will have their X-offsets shifted by this number. In bar lines, for example, this is used to position grobs relative to the (visual) center of the bar line.
break-align-symbol(symbol):
'cue-clefThis key is used for aligning, ordering, and spacing breakable items. See (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.
break-visibility(vector): #(#f #f #t)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.extra-spacing-height(pair of numbers):
pure-from-neighbor-interface::extra-spacing-height-at-beginning-of-lineIn the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).font-size(number):
-4The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.full-size-change(boolean):
#tDon’t make a change clef smaller.
glyph-name(string):
ly:clef::calc-glyph-nameThe glyph name within the font.
In the context of (span) bar lines, glyph-name represents a processed form of
glyph, where decisions about line breaking etc. are already taken.non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.space-alist(list): '((staff-bar minimum-space . 2.7) (key-cancellation minimum-space . 3.5) (key-signature minimum-space . 3.5) (time-signature minimum-space . 4.2) (custos minimum-space . 0.0) (first-note minimum-fixed-space . 3.0) (next-note extra-space . 1.0) (right-edge extra-space . 0.5))An alist that specifies distances from this grob to other breakable items, using the format:
'((break-align-symbol . (spacing-style . space)) (break-align-symbol . (spacing-style . space)) ...)Standard choices for
break-align-symbolare listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference. Additionally, three special break-align symbols available tospace-alistare:
first-noteused when the grob is just left of the first note on a line
next-noteused when the grob is just left of any other note; if not set, the value of
first-notegets usedright-edgeused when the grob is the last item on the line (only compatible with the
extra-spacespacing style)Choices for
spacing-styleare:
extra-spacePut this much space between the two grobs. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed.minimum-spacePut at least this much space between the left sides of both grobs, without allowing them to collide. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed. Not compatible withright-edge.fixed-spaceOnly compatible with
first-noteandnext-note. Put this much fixed space between the grob and the note.minimum-fixed-spaceOnly compatible with
first-noteandnext-note. Put at least this much fixed space between the left side of the grob and the left side of the note, without allowing them to collide.semi-fixed-spaceOnly compatible with
first-noteandnext-note. Put this much space between the grob and the note, such that half of the space is fixed and half is stretchable.Rules for this spacing are much more complicated than this. See [Wanske] page 126–134, [Ross] page 143–147.
stencil(stencil):
ly:clef::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<primitive-procedure ly:staff-symbol-referencer::callback> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): break-aligned-interface, clef-interface, font-interface, grob-interface, item-interface, pure-from-neighbor-interface and staff-symbol-referencer-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
CueEndClef objects are created by: Cue_clef_engraver.
Standard settings:
avoid-slur(symbol):
'insideMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.break-align-anchor(number):
ly:break-aligned-interface::calc-extent-aligned-anchorGrobs aligned to this breakable item will have their X-offsets shifted by this number. In bar lines, for example, this is used to position grobs relative to the (visual) center of the bar line.
break-align-symbol(symbol):
'cue-end-clefThis key is used for aligning, ordering, and spacing breakable items. See (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.
break-visibility(vector): #(#t #t #f)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.extra-spacing-height(pair of numbers):
pure-from-neighbor-interface::extra-spacing-height-at-beginning-of-lineIn the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).font-size(number):
-4The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.full-size-change(boolean):
#tDon’t make a change clef smaller.
glyph-name(string):
ly:clef::calc-glyph-nameThe glyph name within the font.
In the context of (span) bar lines, glyph-name represents a processed form of
glyph, where decisions about line breaking etc. are already taken.non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.space-alist(list): '((clef extra-space . 0.7) (cue-clef extra-space . 0.7) (staff-bar extra-space . 0.7) (key-cancellation minimum-space . 3.5) (key-signature minimum-space . 3.5) (time-signature minimum-space . 4.2) (first-note minimum-fixed-space . 5.0) (next-note extra-space . 1.0) (right-edge extra-space . 0.5))An alist that specifies distances from this grob to other breakable items, using the format:
'((break-align-symbol . (spacing-style . space)) (break-align-symbol . (spacing-style . space)) ...)Standard choices for
break-align-symbolare listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference. Additionally, three special break-align symbols available tospace-alistare:
first-noteused when the grob is just left of the first note on a line
next-noteused when the grob is just left of any other note; if not set, the value of
first-notegets usedright-edgeused when the grob is the last item on the line (only compatible with the
extra-spacespacing style)Choices for
spacing-styleare:
extra-spacePut this much space between the two grobs. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed.minimum-spacePut at least this much space between the left sides of both grobs, without allowing them to collide. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed. Not compatible withright-edge.fixed-spaceOnly compatible with
first-noteandnext-note. Put this much fixed space between the grob and the note.minimum-fixed-spaceOnly compatible with
first-noteandnext-note. Put at least this much fixed space between the left side of the grob and the left side of the note, without allowing them to collide.semi-fixed-spaceOnly compatible with
first-noteandnext-note. Put this much space between the grob and the note, such that half of the space is fixed and half is stretchable.Rules for this spacing are much more complicated than this. See [Wanske] page 126–134, [Ross] page 143–147.
stencil(stencil):
ly:clef::printThe symbol to print.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<primitive-procedure ly:staff-symbol-referencer::callback> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): break-aligned-interface, clef-interface, font-interface, grob-interface, item-interface, pure-from-neighbor-interface and staff-symbol-referencer-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Custos objects are created by: Custos_engraver.
Standard settings:
break-align-symbol(symbol):
'custosThis key is used for aligning, ordering, and spacing breakable items. See (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.
break-visibility(vector): #(#t #f #f)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.neutral-direction(direction):
-1Which direction to take in the center of the staff.
non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.space-alist(list): '((first-note minimum-fixed-space . 0.0) (right-edge extra-space . 0.1))An alist that specifies distances from this grob to other breakable items, using the format:
'((break-align-symbol . (spacing-style . space)) (break-align-symbol . (spacing-style . space)) ...)Standard choices for
break-align-symbolare listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference. Additionally, three special break-align symbols available tospace-alistare:
first-noteused when the grob is just left of the first note on a line
next-noteused when the grob is just left of any other note; if not set, the value of
first-notegets usedright-edgeused when the grob is the last item on the line (only compatible with the
extra-spacespacing style)Choices for
spacing-styleare:
extra-spacePut this much space between the two grobs. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed.minimum-spacePut at least this much space between the left sides of both grobs, without allowing them to collide. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed. Not compatible withright-edge.fixed-spaceOnly compatible with
first-noteandnext-note. Put this much fixed space between the grob and the note.minimum-fixed-spaceOnly compatible with
first-noteandnext-note. Put at least this much fixed space between the left side of the grob and the left side of the note, without allowing them to collide.semi-fixed-spaceOnly compatible with
first-noteandnext-note. Put this much space between the grob and the note, such that half of the space is fixed and half is stretchable.Rules for this spacing are much more complicated than this. See [Wanske] page 126–134, [Ross] page 143–147.
stencil(stencil):
ly:custos::printThe symbol to print.
style(symbol):
'vaticanaThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback reading this property.Y-offset(number):
#<unpure-pure-container #<primitive-procedure ly:staff-symbol-referencer::callback> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): break-aligned-interface, custos-interface, font-interface, grob-interface, item-interface and staff-symbol-referencer-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
DotColumn objects are created by: Dot_column_engraver and Vaticana_ligature_engraver.
Standard settings:
axes(list): '(0)List of axis numbers. In the case of alignment grobs, this should contain only one number.
chord-dots-limit(integer):
3Limits the column of dots on each chord to the height of the chord plus
chord-dots-limitstaff-positions.direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): axis-group-interface, dot-column-interface, grob-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Dots objects are created by: Dots_engraver.
Standard settings:
avoid-slur(symbol):
'insideMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.dot-count(integer):
dots::calc-dot-countThe number of dots.
extra-spacing-height(pair of numbers): '(-0.5 . 0.5)In the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).extra-spacing-width(pair of numbers): '(0.0 . 0.2)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).staff-position(number):
dots::calc-staff-positionVertical position, measured in half staff spaces, counted from the middle line.
stencil(stencil):
ly:dots::printThe symbol to print.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): dots-interface, font-interface, grob-interface, item-interface and staff-symbol-referencer-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
DoublePercentRepeat objects are created by: Double_percent_repeat_engraver.
Standard settings:
break-align-symbol(symbol):
'staff-barThis key is used for aligning, ordering, and spacing breakable items. See (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.
break-visibility(vector): #(#t #t #f)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.dot-negative-kern(number):
0.75The space to remove between a dot and a slash in percent repeat glyphs. Larger values bring the two elements closer together.
font-encoding(symbol):
'fetaMusicThe 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).non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.slash-negative-kern(number):
1.6The space to remove between slashes in percent repeat glyphs. Larger values bring the two elements closer together.
slope(number):
1.0The slope of this object.
stencil(stencil):
ly:percent-repeat-item-interface::double-percentThe symbol to print.
thickness(number):
0.48For 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).Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): break-aligned-interface, font-interface, grob-interface, item-interface, percent-repeat-interface and percent-repeat-item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
DoublePercentRepeatCounter objects are created by: Double_percent_repeat_engraver.
Standard settings:
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-encoding(symbol):
'fetaTextThe 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-size(number):
-2The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.padding(dimension, in staff space):
0.2Add this much extra space between objects that are next to each other.
parent-alignment-X(number):
0Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.staff-padding(dimension, in staff space):
0.25Maintain 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:text-interface::printThe symbol to print.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<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, item-interface, outside-staff-interface, percent-repeat-interface, percent-repeat-item-interface, self-alignment-interface, side-position-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
DoubleRepeatSlash objects are created by: Slash_repeat_engraver.
Standard settings:
dot-negative-kern(number):
0.75The space to remove between a dot and a slash in percent repeat glyphs. Larger values bring the two elements closer together.
font-encoding(symbol):
'fetaMusicThe 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).slash-negative-kern(number):
1.6The space to remove between slashes in percent repeat glyphs. Larger values bring the two elements closer together.
slope(number):
1.0The slope of this object.
stencil(stencil):
ly:percent-repeat-item-interface::beat-slashThe symbol to print.
thickness(number):
0.48For 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).Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): font-interface, grob-interface, item-interface, outside-staff-interface, percent-repeat-interface, percent-repeat-item-interface and rhythmic-grob-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
DynamicLineSpanner objects are created by: Dynamic_align_engraver.
Standard settings:
axes(list): '(1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.minimum-space(dimension, in staff space):
1.2Minimum distance that the victim should move (after padding).
outside-staff-priority(number):
250If 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-priorityis closer to the staff.padding(dimension, in staff space):
0.6Add this much extra space between objects that are next to each other.
side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.slur-padding(number):
0.3Extra distance between slur and script.
staff-padding(dimension, in staff space):
0.1Maintain 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.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-element-stencils> #<primitive-procedure ly:grob::pure-vertical-skylines-from-element-stencils> >Two skylines, one above and one below this grob.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
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): axis-group-interface, dynamic-interface, dynamic-line-spanner-interface, grob-interface, outside-staff-interface, side-position-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
DynamicText objects are created by: Dynamic_engraver.
Standard settings:
direction(direction):
ly:script-interface::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.extra-spacing-width(pair of numbers): '(+inf.0 . -inf.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).font-encoding(symbol):
'fetaTextThe 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-series(symbol):
'boldSelect the series of a font. Choices include
medium,bold,bold-narrow, etc.font-shape(symbol):
'italicSelect the shape of a font. Choices include
upright,italic,caps.parent-alignment-X(number):
0Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.right-padding(dimension, in staff space):
0.5Space to insert on the right side of an object (e.g., between note and its accidentals).
self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.stencil(stencil):
ly:text-interface::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
X-align-on-main-noteheads(boolean):
#tIf true, this grob will ignore suspended noteheads when aligning itself on NoteColumn.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #f (grob)> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): dynamic-interface, dynamic-text-interface, font-interface, grob-interface, item-interface, outside-staff-interface, script-interface, self-alignment-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
DynamicTextSpanner objects are created by: Dynamic_engraver.
Standard settings:
before-line-breaking(boolean):
dynamic-text-spanner::before-line-breakingDummy property, used to trigger a callback function.
bound-details(list):'((right (attach-dir . -1) (Y . 0) (padding . 0.75)) (right-broken (attach-dir . 1) (padding . 0.0)) (left (attach-dir . -1) (Y . 0) (stencil-offset -0.75 . -0.5) (padding . 0.75)) (left-broken (attach-dir . 1)))An alist of properties for determining attachments of spanners to edges.
dash-fraction(number):
0.2Size of the dashes, relative to
dash-period. Should be between0.1and1.0(continuous line). If set to0.0, a dotted line is produceddash-period(number):
3.0The length of one dash together with whitespace. If negative, no line is drawn at all.
font-shape(symbol):
'italicSelect the shape of a font. Choices include
upright,italic,caps.font-size(number):
1The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.left-bound-info(list):
ly:line-spanner::calc-left-bound-info-and-textAn alist of properties for determining attachments of spanners to edges.
minimum-length(dimension, in staff space):
2.0Try to make a spanner at least this long, normally in the horizontal direction. This requires an appropriate callback for the
springs-and-rodsproperty. If added to aTie, this sets the minimum distance between noteheads.minimum-Y-extent(pair of numbers): '(-1 . 1)Minimum size of an object in Y dimension, measured in
staff-spaceunits.right-bound-info(list):
ly:line-spanner::calc-right-bound-infoAn alist of properties for determining attachments of spanners to edges.
skyline-horizontal-padding(number):
0.2For determining the vertical distance between two staves, it is possible to have a configuration which would result in a tight interleaving of grobs from the top staff and the bottom staff. The larger this parameter is, the farther apart the staves are placed in such a configuration.
springs-and-rods(boolean):
ly:spanner::set-spacing-rodsDummy variable for triggering spacing routines.
stencil(stencil):
ly:line-spanner::printThe symbol to print.
style(symbol):
'dashed-lineThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback reading this property.vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
This object supports the following interface(s): dynamic-interface, dynamic-text-spanner-interface, font-interface, grob-interface, line-interface, line-spanner-interface, spanner-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Episema objects are created by: Episema_engraver.
Standard settings:
bound-details(list): '((left (Y . 0) (padding . 0) (attach-dir . -1)) (right (Y . 0) (padding . 0) (attach-dir . 1)))An alist of properties for determining attachments of spanners to edges.
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.left-bound-info(list):
ly:line-spanner::calc-left-bound-infoAn alist of properties for determining attachments of spanners to edges.
right-bound-info(list):
ly:line-spanner::calc-right-bound-infoAn alist of properties for determining attachments of spanners to edges.
side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.stencil(stencil):
ly:line-spanner::printThe symbol to print.
style(symbol):
'lineThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback 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): episema-interface, font-interface, grob-interface, line-interface, line-spanner-interface, side-position-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Fingering objects are created by: Fingering_engraver and New_fingering_engraver.
Standard settings:
add-stem-support(boolean):
only-if-beamedIf set, the
Stemobject is included in this script’s support.avoid-slur(symbol):
'aroundMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.direction(direction):
ly:script-interface::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-encoding(symbol):
'fetaTextThe 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-size(number):
-5The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.padding(dimension, in staff space):
0.5Add this much extra space between objects that are next to each other.
parent-alignment-X(number):
0Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.parent-alignment-Y(number):
0Like
parent-alignment-Xbut for the Y axis.script-priority(number):
100A key for determining the order of scripts in a stack, by being added to the position of the script in the user input, the sum being the overall priority. Smaller means closer to the head.
self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.self-alignment-Y(number):
0Like
self-alignment-Xbut for the Y axis.slur-padding(number):
0.2Extra distance between slur and script.
staff-padding(dimension, in staff space):
0.5Maintain 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:text-interface::printThe symbol to print.
text(markup):
fingering::calc-textText markup. See (notation)Formatting text section ‘Formatting text’ in Notation Reference.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): finger-interface, font-interface, grob-interface, item-interface, outside-staff-interface, self-alignment-interface, side-position-interface, text-interface and text-script-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
FingeringColumn objects are created by: Fingering_column_engraver.
Standard settings:
padding(dimension, in staff space):
0.2Add this much extra space between objects that are next to each other.
snap-radius(number):
0.3The maximum distance between two objects that will cause them to snap to alignment along an axis.
This object supports the following interface(s): fingering-column-interface, grob-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Flag objects are created by: Stem_engraver.
Standard settings:
color(color):
#<procedure #f (grob)>The color of this grob.
glyph-name(string):
ly:flag::glyph-nameThe glyph name within the font.
In the context of (span) bar lines, glyph-name represents a processed form of
glyph, where decisions about line breaking etc. are already taken.stencil(stencil):
ly:flag::printThe symbol to print.
transparent(boolean):
#<procedure #f (grob)>This makes the grob invisible.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
X-extent(pair of numbers):
ly:flag::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
X-offset(number):
ly:flag::calc-x-offsetThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<primitive-procedure ly:flag::calc-y-offset> #<primitive-procedure ly:flag::pure-calc-y-offset> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): flag-interface, font-interface, grob-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
FootnoteItem objects are created by: Footnote_engraver.
Standard settings:
annotation-balloon(boolean)Print the balloon around an annotation.
annotation-line(boolean):
#tPrint the line from an annotation to the grob that it annotates.
automatically-numbered(boolean):
#<procedure #f (grob)>If set, footnotes are automatically numbered.
break-visibility(vector):
#<procedure #f (grob)>A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.footnote(boolean):
#tShould this be a footnote or in-note?
footnote-text(markup):
#<procedure #f (grob)>A footnote for the grob.
stencil(stencil):
ly:balloon-interface::printThe symbol to print.
text(markup):
#<procedure #f (grob)>Text markup. See (notation)Formatting text section ‘Formatting text’ in Notation Reference.
X-extent(pair of numbers)Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
X-offset(number):
#<procedure #f (grob)>The horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
Y-offset(number):
#<procedure #f (grob)>The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): balloon-interface, font-interface, footnote-interface, grob-interface, item-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
FootnoteSpanner objects are created by: Footnote_engraver.
Standard settings:
annotation-balloon(boolean)Print the balloon around an annotation.
annotation-line(boolean):
#tPrint the line from an annotation to the grob that it annotates.
automatically-numbered(boolean):
#<procedure #f (grob)>If set, footnotes are automatically numbered.
footnote(boolean):
#tShould this be a footnote or in-note?
footnote-text(markup):
#<procedure #f (grob)>A footnote for the grob.
stencil(stencil):
ly:balloon-interface::print-spannerThe symbol to print.
text(markup):
#<procedure #f (grob)>Text markup. See (notation)Formatting text section ‘Formatting text’ in Notation Reference.
X-extent(pair of numbers)Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
X-offset(number):
#<procedure #f (grob)>The horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
Y-offset(number):
#<procedure #f (grob)>The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): balloon-interface, font-interface, footnote-interface, footnote-spanner-interface, grob-interface, spanner-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
FretBoard objects are created by: Fretboard_engraver.
Standard settings:
after-line-breaking(boolean):
ly:chord-name::after-line-breakingDummy property, used to trigger callback for
after-line-breaking.extra-spacing-height(pair of numbers): '(0.2 . -0.2)In the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).extra-spacing-width(pair of numbers): '(-0.5 . 0.5)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).fret-diagram-details(list): '((finger-code . below-string))An alist of detailed grob properties for fret diagrams. Each alist entry consists of a
(property . value)pair. The properties which can be included infret-diagram-detailsinclude the following:
barre-type– Type of barre indication used. Choices includecurved,straight, andnone. Defaultcurved.capo-thickness– Thickness of capo indicator, in multiples of fret-space. Default value 0.5.dot-color– Color of dots. Options includeblackandwhite. Defaultblack.dot-label-font-mag– Magnification for font used to label fret dots. Default value 1.dot-position– Location of dot in fret space. Default 0.6 for dots without labels, 0.95-dot-radiusfor dots with labels.dot-radius– Radius of dots, in terms of fret spaces. Default value 0.425 for labeled dots, 0.25 for unlabeled dots.finger-code– Code for the type of fingering indication used. Options includenone,in-dot, andbelow-string. Defaultnonefor markup fret diagrams,below-stringforFretBoardsfret diagrams.fret-count– The number of frets. Default 4.fret-distance– Multiplier to adjust the distance between frets. Default 1.0.fret-label-custom-format– The format string to be used label the lowest fret number, whennumber-typeequals tocustom. Default "~a".fret-label-font-mag– The magnification of the font used to label the lowest fret number. Default 0.5.fret-label-vertical-offset– The offset of the fret label from the center of the fret in direction parallel to strings. Default 0.fret-label-horizontal-offset– The offset of the fret label from the center of the fret in direction orthogonal to strings. Default 0.handedness– Print the fret-diagram left- or right-handed.-1,LEFTfor left ;1,RIGHTfor right. DefaultRIGHT.paren-padding– The padding for the parenthesis. Default 0.05.label-dir– Side to which the fret label is attached.-1,LEFT, orDOWNfor left or down;1,RIGHT, orUPfor right or up. DefaultRIGHT.mute-string– Character string to be used to indicate muted string. Default"x".number-type– Type of numbers to use in fret label. Choices includeroman-lower,roman-upper,arabicandcustom. In the later case, the format string is supplied by thefret-label-custom-formatproperty. Defaultroman-lower.open-string– Character string to be used to indicate open string. Default"o".orientation– Orientation of fret-diagram. Options includenormal,landscape, andopposing-landscape. Defaultnormal.string-count– The number of strings. Default 6.string-distance– Multiplier to adjust the distance between strings. Default 1.0.string-label-font-mag– The magnification of the font used to label fingerings at the string, rather than in the dot. Default value 0.6 fornormalorientation, 0.5 forlandscapeandopposing-landscape.string-thickness-factor– Factor for changing thickness of each string in the fret diagram. Thickness of string k is given bythickness* (1+string-thickness-factor) ^ (k-1). Default 0.top-fret-thickness– The thickness of the top fret line, as a multiple of the standard thickness. Default value 3.xo-font-magnification– Magnification used for mute and open string indicators. Default value 0.5.xo-padding– Padding for open and mute indicators from top fret. Default value 0.25.stencil(stencil):
fret-board::calc-stencilThe symbol to print.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): chord-name-interface, font-interface, fret-diagram-interface, grob-interface, item-interface, outside-staff-interface and rhythmic-grob-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Glissando objects are created by: Glissando_engraver.
Standard settings:
after-line-breaking(boolean):
ly:spanner::kill-zero-spanned-timeDummy property, used to trigger callback for
after-line-breaking.bound-details(list):'((right (attach-dir . -1) (end-on-accidental . #t) (padding . 0.5)) (left (attach-dir . 1) (padding . 0.5) (start-at-dot . #t)))An alist of properties for determining attachments of spanners to edges.
gap(dimension, in staff space):
0.5Size of a gap in a variable symbol.
left-bound-info(list):
ly:line-spanner::calc-left-bound-infoAn alist of properties for determining attachments of spanners to edges.
normalized-endpoints(pair):
ly:spanner::calc-normalized-endpointsRepresents left and right placement over the total spanner, where the width of the spanner is normalized between 0 and 1.
right-bound-info(list):
ly:line-spanner::calc-right-bound-infoAn alist of properties for determining attachments of spanners to edges.
simple-Y(boolean):
#tShould the Y placement of a spanner disregard changes in system heights?
stencil(stencil):
ly:line-spanner::printThe symbol to print.
style(symbol):
'lineThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback reading this property.vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
X-extent(pair of numbers)Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
zigzag-width(dimension, in staff space):
0.75The width of one zigzag squiggle. This number is adjusted slightly so that the glissando line can be constructed from a whole number of squiggles.
This object supports the following interface(s): glissando-interface, grob-interface, line-interface, line-spanner-interface, spanner-interface and unbreakable-spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
GraceSpacing objects are created by: Grace_spacing_engraver.
Standard settings:
common-shortest-duration(moment):
grace-spacing::calc-shortest-durationThe most common shortest note length. This is used in spacing. Enlarging this sets the score tighter.
shortest-duration-space(number):
1.6Start with this multiple of
spacing-incrementspace for the shortest duration. See also (internals)spacing-spanner-interface section ‘spacing-spanner-interface’ in Internals Reference.spacing-increment(dimension, in staff space):
0.8The unit of length for note-spacing. Typically, the width of a note head. See also (internals)spacing-spanner-interface section ‘spacing-spanner-interface’ in Internals Reference.
This object supports the following interface(s): grace-spacing-interface, grob-interface, spacing-options-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
GridLine objects are created by: Grid_line_span_engraver.
Standard settings:
layer(integer):
0An integer which determines the order of printing objects. Objects with the lowest value of layer are drawn first, then objects with progressively higher values are drawn, so objects with higher values overwrite objects with lower values. By default most objects are assigned a layer value of 1.
parent-alignment-X(number):
0Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.stencil(stencil):
ly:grid-line-interface::printThe symbol to print.
X-extent(pair of numbers):
ly:grid-line-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
This object supports the following interface(s): grid-line-interface, grob-interface, item-interface and self-alignment-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
GridPoint objects are created by: Grid_point_engraver.
Standard settings:
X-extent(pair of numbers): '(0 . 0)Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers): '(0 . 0)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grid-point-interface, grob-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Hairpin objects are created by: Dynamic_engraver.
Standard settings:
after-line-breaking(boolean):
ly:spanner::kill-zero-spanned-timeDummy property, used to trigger callback for
after-line-breaking.bound-padding(number):
1.0The amount of padding to insert around spanner bounds.
broken-bound-padding(number):
ly:hairpin::broken-bound-paddingThe amount of padding to insert when a spanner is broken at a line break.
circled-tip(boolean)Put a circle at start/end of hairpins (al/del niente).
grow-direction(direction):
hairpin::calc-grow-directionCrescendo or decrescendo?
height(dimension, in staff space):
0.6666Height of an object in
staff-spaceunits.minimum-length(dimension, in staff space):
2.0Try to make a spanner at least this long, normally in the horizontal direction. This requires an appropriate callback for the
springs-and-rodsproperty. If added to aTie, this sets the minimum distance between noteheads.self-alignment-Y(number):
0Like
self-alignment-Xbut for the Y axis.springs-and-rods(boolean):
ly:spanner::set-spacing-rodsDummy variable for triggering spacing routines.
stencil(stencil):
ly:hairpin::printThe symbol to print.
thickness(number):
1.0For 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).to-barline(boolean):
#tIf true, the spanner will stop at the bar line just before it would otherwise stop.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> #<primitive-procedure ly:hairpin::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
Y-offset(number):
#<unpure-pure-container #<primitive-procedure ly:self-alignment-interface::y-aligned-on-self> #<primitive-procedure ly:self-alignment-interface::pure-y-aligned-on-self> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): dynamic-interface, grob-interface, hairpin-interface, line-interface, outside-staff-interface, self-alignment-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
HorizontalBracket objects are created by: Horizontal_bracket_engraver.
Standard settings:
bracket-flare(pair of numbers): '(0.5 . 0.5)A pair of numbers specifying how much edges of brackets should slant outward. Value
0.0means straight edges.connect-to-neighbor(pair):
ly:tuplet-bracket::calc-connect-to-neighborsPair of booleans, indicating whether this grob looks as a continued break.
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.padding(dimension, in staff space):
0.2Add this much extra space between objects that are next to each other.
side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.staff-padding(dimension, in staff space):
0.2Maintain 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:horizontal-bracket::printThe symbol to print.
thickness(number):
1.0For 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).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): grob-interface, horizontal-bracket-interface, line-interface, outside-staff-interface, side-position-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
HorizontalBracketText objects are created by: Horizontal_bracket_engraver.
Standard settings:
direction(direction):
ly:horizontal-bracket-text::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-size(number):
-1The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.padding(dimension, in staff space):
0.5Add this much extra space between objects that are next to each other.
parent-alignment-X(number):
0Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.stencil(stencil):
ly:horizontal-bracket-text::printThe symbol to print.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
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, horizontal-bracket-text-interface, outside-staff-interface, self-alignment-interface, side-position-interface, spanner-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
InstrumentName objects are created by: Instrument_name_engraver.
Standard settings:
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.padding(dimension, in staff space):
0.3Add this much extra space between objects that are next to each other.
self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.self-alignment-Y(number):
0Like
self-alignment-Xbut for the Y axis.stencil(stencil):
system-start-text::printThe symbol to print.
X-offset(number):
system-start-text::calc-x-offsetThe horizontal amount that this object is moved relative to its X-parent.
Y-offset(number):
system-start-text::calc-y-offsetThe vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): font-interface, grob-interface, self-alignment-interface, side-position-interface, spanner-interface, system-start-text-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
InstrumentSwitch objects are created by: Instrument_switch_engraver.
Standard settings:
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.extra-spacing-width(pair of numbers): '(+inf.0 . -inf.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).outside-staff-priority(number):
500If 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-priorityis closer to the staff.padding(dimension, in staff space):
0.5Add this much extra space between objects that are next to each other.
parent-alignment-X(number)Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.self-alignment-X(number):
-1Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.staff-padding(dimension, in staff space):
0.5Maintain 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:text-interface::printThe symbol to print.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<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, item-interface, outside-staff-interface, self-alignment-interface, side-position-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
KeyCancellation objects are created by: Key_engraver.
Standard settings:
break-align-symbol(symbol):
'key-cancellationThis key is used for aligning, ordering, and spacing breakable items. See (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.
break-visibility(vector): #(#t #t #f)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.extra-spacing-height(pair of numbers):
pure-from-neighbor-interface::extra-spacing-height-including-staffIn the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).extra-spacing-width(pair of numbers): '(0.0 . 1.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).flat-positions(list): '(2 3 4 2 1 2 1)Flats in key signatures are placed within the specified ranges of staff-positions. The general form is a list of pairs, with one pair for each type of clef, in order of the staff-position at which each clef places C:
(alto treble tenor soprano baritone mezzosoprano bass). If the list contains a single element it applies for all clefs. A single number in place of a pair sets accidentals within the octave ending at that staff-position.glyph-name-alist(list): '((0 . "accidentals.natural"))An alist of key-string pairs.
non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.sharp-positions(list): '(4 5 4 2 3 2 3)Sharps in key signatures are placed within the specified ranges of staff-positions. The general form is a list of pairs, with one pair for each type of clef, in order of the staff-position at which each clef places C:
(alto treble tenor soprano baritone mezzosoprano bass). If the list contains a single element it applies for all clefs. A single number in place of a pair sets accidentals within the octave ending at that staff-position.space-alist(list): '((time-signature extra-space . 1.25) (staff-bar extra-space . 0.6) (key-signature extra-space . 0.5) (cue-clef extra-space . 0.5) (right-edge extra-space . 0.5) (first-note fixed-space . 2.5) (custos extra-space . 1.0))An alist that specifies distances from this grob to other breakable items, using the format:
'((break-align-symbol . (spacing-style . space)) (break-align-symbol . (spacing-style . space)) ...)Standard choices for
break-align-symbolare listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference. Additionally, three special break-align symbols available tospace-alistare:
first-noteused when the grob is just left of the first note on a line
next-noteused when the grob is just left of any other note; if not set, the value of
first-notegets usedright-edgeused when the grob is the last item on the line (only compatible with the
extra-spacespacing style)Choices for
spacing-styleare:
extra-spacePut this much space between the two grobs. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed.minimum-spacePut at least this much space between the left sides of both grobs, without allowing them to collide. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed. Not compatible withright-edge.fixed-spaceOnly compatible with
first-noteandnext-note. Put this much fixed space between the grob and the note.minimum-fixed-spaceOnly compatible with
first-noteandnext-note. Put at least this much fixed space between the left side of the grob and the left side of the note, without allowing them to collide.semi-fixed-spaceOnly compatible with
first-noteandnext-note. Put this much space between the grob and the note, such that half of the space is fixed and half is stretchable.Rules for this spacing are much more complicated than this. See [Wanske] page 126–134, [Ross] page 143–147.
stencil(stencil):
ly:key-signature-interface::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<primitive-procedure ly:staff-symbol-referencer::callback> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): break-aligned-interface, font-interface, grob-interface, item-interface, key-cancellation-interface, key-signature-interface, pure-from-neighbor-interface and staff-symbol-referencer-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
KeySignature objects are created by: Key_engraver.
Standard settings:
avoid-slur(symbol):
'insideMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.break-align-anchor(number):
ly:break-aligned-interface::calc-extent-aligned-anchorGrobs aligned to this breakable item will have their X-offsets shifted by this number. In bar lines, for example, this is used to position grobs relative to the (visual) center of the bar line.
break-align-anchor-alignment(number):
1Read by
ly:break-aligned-interface::calc-extent-aligned-anchorfor aligning an anchor to a grob’s extent.break-align-symbol(symbol):
'key-signatureThis key is used for aligning, ordering, and spacing breakable items. See (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.
break-visibility(vector): #(#f #f #t)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.extra-spacing-height(pair of numbers):
pure-from-neighbor-interface::extra-spacing-height-including-staffIn the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).extra-spacing-width(pair of numbers): '(0.0 . 1.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).flat-positions(list): '(2 3 4 2 1 2 1)Flats in key signatures are placed within the specified ranges of staff-positions. The general form is a list of pairs, with one pair for each type of clef, in order of the staff-position at which each clef places C:
(alto treble tenor soprano baritone mezzosoprano bass). If the list contains a single element it applies for all clefs. A single number in place of a pair sets accidentals within the octave ending at that staff-position.glyph-name-alist(list): '((0 . "accidentals.natural") (-1/2 . "accidentals.flat") (1/2 . "accidentals.sharp") (1 . "accidentals.doublesharp") (-1 . "accidentals.flatflat") (3/4 . "accidentals.sharp.slashslash.stemstemstem") (1/4 . "accidentals.sharp.slashslash.stem") (-1/4 . "accidentals.mirroredflat") (-3/4 . "accidentals.mirroredflat.flat"))An alist of key-string pairs.
non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.sharp-positions(list): '(4 5 4 2 3 2 3)Sharps in key signatures are placed within the specified ranges of staff-positions. The general form is a list of pairs, with one pair for each type of clef, in order of the staff-position at which each clef places C:
(alto treble tenor soprano baritone mezzosoprano bass). If the list contains a single element it applies for all clefs. A single number in place of a pair sets accidentals within the octave ending at that staff-position.space-alist(list): '((ambitus extra-space . 1.15) (time-signature extra-space . 1.15) (staff-bar extra-space . 1.1) (cue-clef extra-space . 0.5) (right-edge extra-space . 0.5) (first-note fixed-space . 2.5))An alist that specifies distances from this grob to other breakable items, using the format:
'((break-align-symbol . (spacing-style . space)) (break-align-symbol . (spacing-style . space)) ...)Standard choices for
break-align-symbolare listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference. Additionally, three special break-align symbols available tospace-alistare:
first-noteused when the grob is just left of the first note on a line
next-noteused when the grob is just left of any other note; if not set, the value of
first-notegets usedright-edgeused when the grob is the last item on the line (only compatible with the
extra-spacespacing style)Choices for
spacing-styleare:
extra-spacePut this much space between the two grobs. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed.minimum-spacePut at least this much space between the left sides of both grobs, without allowing them to collide. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed. Not compatible withright-edge.fixed-spaceOnly compatible with
first-noteandnext-note. Put this much fixed space between the grob and the note.minimum-fixed-spaceOnly compatible with
first-noteandnext-note. Put at least this much fixed space between the left side of the grob and the left side of the note, without allowing them to collide.semi-fixed-spaceOnly compatible with
first-noteandnext-note. Put this much space between the grob and the note, such that half of the space is fixed and half is stretchable.Rules for this spacing are much more complicated than this. See [Wanske] page 126–134, [Ross] page 143–147.
stencil(stencil):
ly:key-signature-interface::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<primitive-procedure ly:staff-symbol-referencer::callback> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): break-aligned-interface, font-interface, grob-interface, item-interface, key-signature-interface, pure-from-neighbor-interface and staff-symbol-referencer-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
KievanLigature objects are created by: Kievan_ligature_engraver.
Standard settings:
padding(dimension, in staff space):
0.5Add this much extra space between objects that are next to each other.
springs-and-rods(boolean):
ly:spanner::set-spacing-rodsDummy variable for triggering spacing routines.
stencil(stencil):
ly:kievan-ligature::printThe symbol to print.
This object supports the following interface(s): font-interface, grob-interface, kievan-ligature-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
LaissezVibrerTie objects are created by: Laissez_vibrer_engraver.
Standard settings:
control-points(list of number pairs):
ly:semi-tie::calc-control-pointsList of offsets (number pairs) that form control points for the tie, slur, or bracket shape. For Béziers, this should list the control points of a third-order Bézier curve.
details(list): '((ratio . 0.333) (height-limit . 1.0))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
detailsproperty.direction(direction):
ly:tie::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.extra-spacing-height(pair of numbers): '(-0.5 . 0.5)In the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).head-direction(direction):
-1Are the note heads left or right in a semitie?
stencil(stencil):
laissez-vibrer::printThe symbol to print.
thickness(number):
1.0For 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 #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, item-interface and semi-tie-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
LaissezVibrerTieColumn objects are created by: Laissez_vibrer_engraver.
Standard settings:
head-direction(direction):
ly:semi-tie-column::calc-head-directionAre the note heads left or right in a semitie?
X-extent(pair of numbers)Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, item-interface and semi-tie-column-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
LedgerLineSpanner objects are created by: Ledger_line_engraver.
Standard settings:
layer(integer):
0An integer which determines the order of printing objects. Objects with the lowest value of layer are drawn first, then objects with progressively higher values are drawn, so objects with higher values overwrite objects with lower values. By default most objects are assigned a layer value of 1.
length-fraction(number):
0.25Multiplier for lengths. Used for determining ledger lines and stem lengths.
minimum-length-fraction(number):
0.25Minimum length of ledger line as fraction of note head size.
springs-and-rods(boolean):
ly:ledger-line-spanner::set-spacing-rodsDummy variable for triggering spacing routines.
stencil(stencil):
ly:ledger-line-spanner::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
X-extent(pair of numbers)Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, ledger-line-spanner-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
LeftEdge objects are created by: Break_align_engraver.
Standard settings:
break-align-anchor(number):
ly:break-aligned-interface::calc-extent-aligned-anchorGrobs aligned to this breakable item will have their X-offsets shifted by this number. In bar lines, for example, this is used to position grobs relative to the (visual) center of the bar line.
break-align-symbol(symbol):
'left-edgeThis key is used for aligning, ordering, and spacing breakable items. See (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.
break-visibility(vector): #(#f #f #t)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.space-alist(list): '((ambitus extra-space . 1.15) (breathing-sign minimum-space . 0.0) (cue-end-clef extra-space . 0.8) (clef extra-space . 0.8) (cue-clef extra-space . 0.8) (staff-bar extra-space . 0.0) (key-cancellation extra-space . 0.0) (key-signature extra-space . 0.8) (time-signature extra-space . 1.0) (custos extra-space . 0.0) (first-note fixed-space . 2.0) (right-edge extra-space . 0.0))An alist that specifies distances from this grob to other breakable items, using the format:
'((break-align-symbol . (spacing-style . space)) (break-align-symbol . (spacing-style . space)) ...)Standard choices for
break-align-symbolare listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference. Additionally, three special break-align symbols available tospace-alistare:
first-noteused when the grob is just left of the first note on a line
next-noteused when the grob is just left of any other note; if not set, the value of
first-notegets usedright-edgeused when the grob is the last item on the line (only compatible with the
extra-spacespacing style)Choices for
spacing-styleare:
extra-spacePut this much space between the two grobs. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed.minimum-spacePut at least this much space between the left sides of both grobs, without allowing them to collide. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed. Not compatible withright-edge.fixed-spaceOnly compatible with
first-noteandnext-note. Put this much fixed space between the grob and the note.minimum-fixed-spaceOnly compatible with
first-noteandnext-note. Put at least this much fixed space between the left side of the grob and the left side of the note, without allowing them to collide.semi-fixed-spaceOnly compatible with
first-noteandnext-note. Put this much space between the grob and the note, such that half of the space is fixed and half is stretchable.Rules for this spacing are much more complicated than this. See [Wanske] page 126–134, [Ross] page 143–147.
X-extent(pair of numbers): '(0 . 0)Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers): '(0 . 0)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): break-aligned-interface, grob-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
LigatureBracket objects are created by: Ligature_bracket_engraver.
Standard settings:
bracket-visibility(boolean or symbol):
#tThis controls the visibility of the tuplet bracket. Setting it to false prevents printing of the bracket. Setting the property to
if-no-beammakes it print only if there is no beam associated with this tuplet bracket.connect-to-neighbor(pair):
ly:tuplet-bracket::calc-connect-to-neighborsPair of booleans, indicating whether this grob looks as a continued break.
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. 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).padding(dimension, in staff space):
2.0Add this much extra space between objects that are next to each other.
positions(pair of numbers):
ly:tuplet-bracket::calc-positionsPair of staff coordinates
(left . right), where both left and right are instaff-spaceunits 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.
staff-padding(dimension, in staff space):
0.25Maintain 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::printThe symbol to print.
thickness(number):
1.6For 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.
X-positions(pair of numbers):
ly:tuplet-bracket::calc-x-positionsPair of X staff coordinates of a spanner in the form
(left . right), where both left and right are instaff-spaceunits of the current staff.
This object supports the following interface(s): grob-interface, line-interface, spanner-interface and tuplet-bracket-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
LyricExtender objects are created by: Extender_engraver.
Standard settings:
minimum-length(dimension, in staff space):
1.5Try to make a spanner at least this long, normally in the horizontal direction. This requires an appropriate callback for the
springs-and-rodsproperty. If added to aTie, this sets the minimum distance between noteheads.stencil(stencil):
ly:lyric-extender::printThe symbol to print.
thickness(number):
0.8For 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).Y-extent(pair of numbers): '(0 . 0)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, lyric-extender-interface, lyric-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
LyricHyphen objects are created by: Hyphen_engraver.
Standard settings:
after-line-breaking(boolean):
ly:spanner::kill-zero-spanned-timeDummy property, used to trigger callback for
after-line-breaking.dash-period(number):
10.0The length of one dash together with whitespace. If negative, no line is drawn at all.
height(dimension, in staff space):
0.42Height of an object in
staff-spaceunits.length(dimension, in staff space):
0.66User override for the stem length of unbeamed stems (each unit represents half a
staff-space).minimum-distance(dimension, in staff space):
0.1Minimum distance between rest and notes or beam.
minimum-length(dimension, in staff space):
0.3Try to make a spanner at least this long, normally in the horizontal direction. This requires an appropriate callback for the
springs-and-rodsproperty. If added to aTie, this sets the minimum distance between noteheads.padding(dimension, in staff space):
0.07Add this much extra space between objects that are next to each other.
springs-and-rods(boolean):
ly:lyric-hyphen::set-spacing-rodsDummy variable for triggering spacing routines.
stencil(stencil):
ly:lyric-hyphen::printThe symbol to print.
thickness(number):
1.3For 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 #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
Y-extent(pair of numbers): '(0 . 0)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): font-interface, grob-interface, lyric-hyphen-interface, lyric-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
LyricSpace objects are created by: Hyphen_engraver.
Standard settings:
minimum-distance(dimension, in staff space):
0.45Minimum distance between rest and notes or beam.
padding(dimension, in staff space):
0.0Add this much extra space between objects that are next to each other.
springs-and-rods(boolean):
ly:lyric-hyphen::set-spacing-rodsDummy variable for triggering spacing routines.
X-extent(pair of numbers)Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, lyric-hyphen-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
LyricText objects are created by: Lyric_engraver.
Standard settings:
extra-spacing-height(pair of numbers): '(0.2 . -0.2)In the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).extra-spacing-width(pair of numbers): '(0.0 . 0.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).font-series(symbol):
'mediumSelect the series of a font. Choices include
medium,bold,bold-narrow, etc.font-size(number):
1.0The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.parent-alignment-X(number):
'()Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.skyline-horizontal-padding(number):
0.1For determining the vertical distance between two staves, it is possible to have a configuration which would result in a tight interleaving of grobs from the top staff and the bottom staff. The larger this parameter is, the farther apart the staves are placed in such a configuration.
stencil(stencil):
lyric-text::printThe symbol to print.
text(markup):
#<procedure #f (grob)>Text markup. See (notation)Formatting text section ‘Formatting text’ in Notation Reference.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
word-space(dimension, in staff space):
0.6Space to insert between words in texts.
X-align-on-main-noteheads(boolean):
#tIf true, this grob will ignore suspended noteheads when aligning itself on NoteColumn.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): font-interface, grob-interface, item-interface, lyric-syllable-interface, rhythmic-grob-interface, self-alignment-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
MeasureCounter objects are created by: Measure_counter_engraver.
Standard settings:
count-from(integer):
1The first measure in a measure count receives this number. The following measures are numbered in increments from this initial value.
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-encoding(symbol):
'fetaTextThe 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-size(number):
-2The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.outside-staff-horizontal-padding(number):
0.5By default, an outside-staff-object can be placed so that is it very close to another grob horizontally. If this property is set, the outside-staff-object is raised so that it is not so close to its neighbor.
outside-staff-priority(number):
750If 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-priorityis closer to the staff.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.spacing-pair(pair): '(break-alignment . break-alignment)A pair of alignment symbols which set an object’s spacing relative to its left and right
BreakAlignments.For example, a
MultiMeasureRestwill ignore prefatory items at its bounds (i.e., clefs, key signatures and time signatures) using the following override:
\override MultiMeasureRest.spacing-pair = #'(staff-bar . staff-bar)staff-padding(dimension, in staff space):
0.5Maintain 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):
measure-counter-stencilThe symbol to print.
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, measure-counter-interface, outside-staff-interface, self-alignment-interface, side-position-interface, spanner-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
MeasureGrouping objects are created by: Measure_grouping_engraver.
Standard settings:
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.height(dimension, in staff space):
2.0Height of an object in
staff-spaceunits.padding(dimension, in staff space):
2Add this much extra space between objects that are next to each other.
side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.staff-padding(dimension, in staff space):
3Maintain 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:measure-grouping::printThe symbol to print.
thickness(number):
1For 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).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): grob-interface, measure-grouping-interface, outside-staff-interface, side-position-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
MeasureSpanner objects are created by: Measure_spanner_engraver.
Standard settings:
connect-to-neighbor(pair):
ly:measure-spanner::calc-connect-to-neighborsPair of booleans, indicating whether this grob looks as a continued break.
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. 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).outside-staff-priority(number):
750If 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-priorityis closer to the staff.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.spacing-pair(pair): '(staff-bar . staff-bar)A pair of alignment symbols which set an object’s spacing relative to its left and right
BreakAlignments.For example, a
MultiMeasureRestwill ignore prefatory items at its bounds (i.e., clefs, key signatures and time signatures) using the following override:
\override MultiMeasureRest.spacing-pair = #'(staff-bar . staff-bar)staff-padding(dimension, in staff space):
0.5Maintain 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:measure-spanner::printThe symbol to print.
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, measure-spanner-interface, outside-staff-interface, self-alignment-interface, side-position-interface, spanner-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
MelodyItem objects are created by: Melody_engraver.
Standard settings:
neutral-direction(direction):
-1Which direction to take in the center of the staff.
This object supports the following interface(s): grob-interface, item-interface and melody-spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
MensuralLigature objects are created by: Mensural_ligature_engraver.
Standard settings:
springs-and-rods(boolean):
ly:spanner::set-spacing-rodsDummy variable for triggering spacing routines.
stencil(stencil):
ly:mensural-ligature::printThe symbol to print.
thickness(number):
1.3For 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).
This object supports the following interface(s): font-interface, grob-interface, mensural-ligature-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
MetronomeMark objects are created by: Metronome_mark_engraver.
Standard settings:
after-line-breaking(boolean):
ly:side-position-interface::move-to-extremal-staffDummy property, used to trigger callback for
after-line-breaking.break-align-symbols(list): '(time-signature)A list of break-align symbols that determines which breakable items to align this to. If the grob selected by the first symbol in the list is invisible due to
break-visibility, we will align to the next grob (and so on). Choices are listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.break-visibility(vector): #(#f #t #t)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.extra-spacing-width(pair of numbers): '(+inf.0 . -inf.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).flag-style(symbol):
'defaultThe style of the flag to be used with
MetronomeMark. Available are'modern-straight-flag,'old-straight-flag,flat-flag,mensuraland'defaultnon-break-align-symbols(list): '(paper-column-interface)A list of symbols that determine which NON-break-aligned interfaces to align this to.
outside-staff-horizontal-padding(number):
0.2By default, an outside-staff-object can be placed so that is it very close to another grob horizontally. If this property is set, the outside-staff-object is raised so that it is not so close to its neighbor.
outside-staff-priority(number):
1000If 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-priorityis closer to the staff.padding(dimension, in staff space):
0.8Add this much extra space between objects that are next to each other.
self-alignment-X(number):
-1Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.stencil(stencil):
ly:text-interface::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
X-offset(number):
self-alignment-interface::self-aligned-on-breakableThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<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): break-alignable-interface, font-interface, grob-interface, item-interface, metronome-mark-interface, outside-staff-interface, self-alignment-interface, side-position-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
MultiMeasureRest objects are created by: Multi_measure_rest_engraver.
Standard settings:
bound-padding(number):
0.5The amount of padding to insert around spanner bounds.
expand-limit(integer):
10Maximum number of measures expanded in church rests.
hair-thickness(number):
2.0Thickness of the thin line in a bar line, expressed as a multiple of the default staff-line thickness (i.e. the visual output is not influenced by changes to
Staff.StaffSymbol.thickness).max-symbol-separation(number):
8.0The maximum distance between symbols making up a church rest.
round-up-exceptions(list):
'()A list of pairs where car is the numerator and cdr the denominator of a moment. Each pair in this list means that the multi-measure rests of the corresponding length will be rounded up to the longer rest. See round-up-to-longer-rest.
spacing-pair(pair): '(break-alignment . break-alignment)A pair of alignment symbols which set an object’s spacing relative to its left and right
BreakAlignments.For example, a
MultiMeasureRestwill ignore prefatory items at its bounds (i.e., clefs, key signatures and time signatures) using the following override:
\override MultiMeasureRest.spacing-pair = #'(staff-bar . staff-bar)springs-and-rods(boolean):
ly:multi-measure-rest::set-spacing-rodsDummy variable for triggering spacing routines.
stencil(stencil):
ly:multi-measure-rest::printThe symbol to print.
thick-thickness(number):
6.6Thickness of the thick line in a bar line, expressed as a multiple of the default staff-line thickness (i.e. the visual output is not influenced by changes to
Staff.StaffSymbol.thickness).usable-duration-logs(list): '(-3 -2 -1 0)List of
duration-logs that can be used in typesetting the grob.voiced-position(number):
4The staff-position of a voiced
Rest, negative if the rest hasdirectionDOWN.Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:multi-measure-rest::height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
Y-offset(number):
#<unpure-pure-container #<primitive-procedure ly:staff-symbol-referencer::callback> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): font-interface, grob-interface, multi-measure-interface, multi-measure-rest-interface, outside-staff-interface, rest-interface, spanner-interface and staff-symbol-referencer-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
MultiMeasureRestNumber objects are created by: Multi_measure_rest_engraver.
Standard settings:
bound-padding(number):
1.0The amount of padding to insert around spanner bounds.
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-encoding(symbol):
'fetaTextThe 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).padding(dimension, in staff space):
0.4Add this much extra space between objects that are next to each other.
parent-alignment-X(number):
0Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.springs-and-rods(boolean):
ly:multi-measure-rest::set-text-rodsDummy variable for triggering spacing routines.
staff-padding(dimension, in staff space):
0.4Maintain 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:text-interface::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<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, multi-measure-interface, outside-staff-interface, self-alignment-interface, side-position-interface, spanner-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
MultiMeasureRestScript objects are created by: Multi_measure_rest_engraver.
Standard settings:
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.outside-staff-padding(number):
0The padding to place between grobs when spacing according to
outside-staff-priority. Two grobs with differentoutside-staff-paddingvalues have the larger value of padding between them.outside-staff-priority(number):
40If 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-priorityis closer to the staff.parent-alignment-X(number):
0Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.staff-padding(dimension, in staff space):
0.25Maintain 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::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<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, multi-measure-interface, outside-staff-interface, script-interface, self-alignment-interface, side-position-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
MultiMeasureRestText objects are created by: Multi_measure_rest_engraver.
Standard settings:
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.outside-staff-priority(number):
450If 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-priorityis closer to the staff.padding(dimension, in staff space):
0.2Add this much extra space between objects that are next to each other.
parent-alignment-X(number):
0Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.skyline-horizontal-padding(number):
0.2For determining the vertical distance between two staves, it is possible to have a configuration which would result in a tight interleaving of grobs from the top staff and the bottom staff. The larger this parameter is, the farther apart the staves are placed in such a configuration.
staff-padding(dimension, in staff space):
0.25Maintain 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:text-interface::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<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, multi-measure-interface, outside-staff-interface, self-alignment-interface, side-position-interface, spanner-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
NonMusicalPaperColumn objects are created by: Paper_column_engraver.
Standard settings:
allow-loose-spacing(boolean):
#tIf set, column can be detached from main spacing.
axes(list): '(0)List of axis numbers. In the case of alignment grobs, this should contain only one number.
before-line-breaking(boolean):
ly:paper-column::before-line-breakingDummy property, used to trigger a callback function.
font-size(number):
-7.5The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.full-measure-extra-space(number):
1.0Extra space that is allocated at the beginning of a measure with only one note. This property is read from the NonMusicalPaperColumn that begins the measure.
horizontal-skylines(pair of skylines):
ly:separation-item::calc-skylinesTwo skylines, one to the left and one to the right of this grob.
keep-inside-line(boolean):
#tIf set, this column cannot have objects sticking into the margin.
layer(integer):
1000An integer which determines the order of printing objects. Objects with the lowest value of layer are drawn first, then objects with progressively higher values are drawn, so objects with higher values overwrite objects with lower values. By default most objects are assigned a layer value of 1.
line-break-permission(symbol):
'allowInstructs the line breaker on whether to put a line break at this column. Can be
forceorallow.non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.page-break-permission(symbol):
'allowInstructs the page breaker on whether to put a page break at this column. Can be
forceorallow.X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): axis-group-interface, font-interface, grob-interface, item-interface, paper-column-interface, separation-item-interface and spaceable-grob-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
NoteCollision objects are created by: Collision_engraver.
Standard settings:
axes(list): '(0 1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
note-collision-threshold(dimension, in staff space):
1Simultaneous notes that are this close or closer in units of
staff-spacewill be identified as vertically colliding. Used byStemgrobs for notes in the same voice, andNoteCollisiongrobs for notes in different voices. Default value 1.prefer-dotted-right(boolean):
#tFor note collisions, prefer to shift dotted up-note to the right, rather than shifting just the dot.
vertical-skylines(pair of skylines):
ly:axis-group-interface::calc-skylinesTwo skylines, one above and one below this grob.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): axis-group-interface, grob-interface, item-interface and note-collision-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
NoteColumn objects are created by: Rhythmic_column_engraver.
Standard settings:
axes(list): '(0 1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
horizontal-skylines(pair of skylines):
ly:separation-item::calc-skylinesTwo skylines, one to the left and one to the right of this grob.
skyline-vertical-padding(number):
0.15The amount by which the left and right skylines of a column are padded vertically, beyond the
Y-extents andextra-spacing-heights of the constituent grobs in the column. Increase this to prevent interleaving of grobs from adjacent columns.vertical-skylines(pair of skylines):
ly:axis-group-interface::calc-skylinesTwo skylines, one above and one below this grob.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): axis-group-interface, grob-interface, item-interface, note-column-interface and separation-item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
NoteHead objects are created by: Completion_heads_engraver, Drum_notes_engraver and Note_heads_engraver.
Standard settings:
duration-log(integer):
note-head::calc-duration-logThe 2-log of the note head duration, i.e.,
0= whole note,1= half note, etc.extra-spacing-height(pair of numbers):
ly:note-head::include-ledger-line-heightIn the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).glyph-name(string):
note-head::calc-glyph-nameThe glyph name within the font.
In the context of (span) bar lines, glyph-name represents a processed form of
glyph, where decisions about line breaking etc. are already taken.parenthesis-friends(list): '(accidental-grob dot)A list of Grob types, as symbols. When parentheses enclose a Grob that has ’parenthesis-friends, the parentheses widen to include any child Grobs with type among ’parenthesis-friends.
stem-attachment(pair of numbers):
ly:note-head::calc-stem-attachmentAn
(x . y)pair where the stem attaches to the notehead.stencil(stencil):
ly:note-head::printThe symbol to print.
X-offset(number):
ly:note-head::stem-x-shiftThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<primitive-procedure ly:staff-symbol-referencer::callback> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): font-interface, gregorian-ligature-interface, grob-interface, item-interface, ledgered-interface, ligature-head-interface, mensural-ligature-interface, note-head-interface, rhythmic-grob-interface, rhythmic-head-interface, staff-symbol-referencer-interface and vaticana-ligature-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
NoteName objects are created by: Note_name_engraver.
Standard settings:
stencil(stencil):
ly:text-interface::printThe symbol to print.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): font-interface, grob-interface, item-interface, note-name-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
NoteSpacing objects are created by: Note_spacing_engraver.
Standard settings:
knee-spacing-correction(number):
1.0Factor for the optical correction amount for kneed beams. Set between
0for no correction and1for full correction.same-direction-correction(number):
0.25Optical correction amount for stems that are placed in tight configurations. This amount is used for stems with the same direction to compensate for note head to stem distance.
space-to-barline(boolean):
#tIf set, the distance between a note and the following non-musical column will be measured to the bar line instead of to the beginning of the non-musical column. If there is a clef change followed by a bar line, for example, this means that we will try to space the non-musical column as though the clef is not there.
stem-spacing-correction(number):
0.5Optical correction amount for stems that are placed in tight configurations. For opposite directions, this amount is the correction for two normal sized stems that overlap completely.
This object supports the following interface(s): grob-interface, item-interface, note-spacing-interface and spacing-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
OttavaBracket objects are created by: Ottava_spanner_engraver.
Standard settings:
dash-fraction(number):
0.3Size of the dashes, relative to
dash-period. Should be between0.1and1.0(continuous line). If set to0.0, a dotted line is produceddirection(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.edge-height(pair): '(0 . 0.8)A pair of numbers specifying the heights of the vertical edges:
(left-height . right-height).font-series(symbol):
'boldSelect the series of a font. Choices include
medium,bold,bold-narrow, etc.font-shape(symbol):
'italicSelect the shape of a font. Choices include
upright,italic,caps.minimum-length(dimension, in staff space):
0.3Try to make a spanner at least this long, normally in the horizontal direction. This requires an appropriate callback for the
springs-and-rodsproperty. If added to aTie, this sets the minimum distance between noteheads.outside-staff-priority(number):
400If 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-priorityis closer to the staff.padding(dimension, in staff space):
0.5Add this much extra space between objects that are next to each other.
shorten-pair(pair of numbers): '(-0.8 . -0.6)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):
2.0Maintain 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:ottava-bracket::printThe symbol to print.
style(symbol):
'dashed-lineThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback reading this property.vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
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, horizontal-bracket-interface, line-interface, ottava-bracket-interface, outside-staff-interface, side-position-interface, spanner-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
PaperColumn objects are created by: Paper_column_engraver.
Standard settings:
allow-loose-spacing(boolean):
#tIf set, column can be detached from main spacing.
axes(list): '(0)List of axis numbers. In the case of alignment grobs, this should contain only one number.
before-line-breaking(boolean):
ly:paper-column::before-line-breakingDummy property, used to trigger a callback function.
font-size(number):
-7.5The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.horizontal-skylines(pair of skylines):
ly:separation-item::calc-skylinesTwo skylines, one to the left and one to the right of this grob.
keep-inside-line(boolean):
#tIf set, this column cannot have objects sticking into the margin.
layer(integer):
1000An integer which determines the order of printing objects. Objects with the lowest value of layer are drawn first, then objects with progressively higher values are drawn, so objects with higher values overwrite objects with lower values. By default most objects are assigned a layer value of 1.
skyline-vertical-padding(number):
0.08The amount by which the left and right skylines of a column are padded vertically, beyond the
Y-extents andextra-spacing-heights of the constituent grobs in the column. Increase this to prevent interleaving of grobs from adjacent columns.X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): axis-group-interface, font-interface, grob-interface, item-interface, paper-column-interface, separation-item-interface and spaceable-grob-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
ParenthesesItem objects are created by: Parenthesis_engraver.
Standard settings:
font-size(number):
-6The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.padding(dimension, in staff space):
0.2Add this much extra space between objects that are next to each other.
stencil(stencil):
parentheses-item::printThe symbol to print.
stencils(list):
parentheses-item::calc-parenthesis-stencilsMultiple stencils, used as intermediate value.
X-extent(pair of numbers): '(0 . 0)Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
parentheses-item::y-extentExtent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): font-interface, grob-interface, item-interface and parentheses-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
PercentRepeat objects are created by: Percent_repeat_engraver.
Standard settings:
dot-negative-kern(number):
0.75The space to remove between a dot and a slash in percent repeat glyphs. Larger values bring the two elements closer together.
font-encoding(symbol):
'fetaMusicThe 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).slope(number):
1.0The slope of this object.
spacing-pair(pair): '(break-alignment . staff-bar)A pair of alignment symbols which set an object’s spacing relative to its left and right
BreakAlignments.For example, a
MultiMeasureRestwill ignore prefatory items at its bounds (i.e., clefs, key signatures and time signatures) using the following override:
\override MultiMeasureRest.spacing-pair = #'(staff-bar . staff-bar)springs-and-rods(boolean):
ly:multi-measure-rest::set-spacing-rodsDummy variable for triggering spacing routines.
stencil(stencil):
ly:multi-measure-rest::percentThe symbol to print.
thickness(number):
0.48For 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).
This object supports the following interface(s): font-interface, grob-interface, multi-measure-rest-interface, percent-repeat-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
PercentRepeatCounter objects are created by: Percent_repeat_engraver.
Standard settings:
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-encoding(symbol):
'fetaTextThe 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-size(number):
-2The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.padding(dimension, in staff space):
0.2Add this much extra space between objects that are next to each other.
parent-alignment-X(number):
0Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.staff-padding(dimension, in staff space):
0.25Maintain 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:text-interface::printThe symbol to print.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<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, outside-staff-interface, percent-repeat-interface, self-alignment-interface, side-position-interface, spanner-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
PhrasingSlur objects are created by: Phrasing_slur_engraver.
Standard settings:
control-points(list of number pairs):
ly:slur::calc-control-pointsList of offsets (number pairs) that form control points for the tie, slur, or bracket shape. For Béziers, this should list the control points of a third-order Bézier curve.
details(list): '((region-size . 4) (head-encompass-penalty . 1000.0) (stem-encompass-penalty . 30.0) (edge-attraction-factor . 4) (same-slope-penalty . 20) (steeper-slope-factor . 50) (non-horizontal-penalty . 15) (max-slope . 1.1) (max-slope-factor . 10) (free-head-distance . 0.3) (free-slur-distance . 0.8) (gap-to-staffline-inside . 0.2) (gap-to-staffline-outside . 0.1) (extra-object-collision-penalty . 50) (accidental-collision . 3) (extra-encompass-free-distance . 0.3) (extra-encompass-collision-distance . 0.8) (head-slur-distance-max-ratio . 3) (head-slur-distance-factor . 10) (absolute-closeness-measure . 0.3) (edge-slope-exponent . 1.7) (close-to-edge-length . 2.5) (encompass-object-range-overshoot . 0.5) (slur-tie-extrema-min-distance . 0.2) (slur-tie-extrema-min-distance-penalty . 2))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
detailsproperty.direction(direction):
ly:slur::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.height-limit(dimension, in staff space):
2.0Maximum slur height: The longer the slur, the closer it is to this height.
minimum-length(dimension, in staff space):
1.5Try to make a spanner at least this long, normally in the horizontal direction. This requires an appropriate callback for the
springs-and-rodsproperty. If added to aTie, this sets the minimum distance between noteheads.ratio(number):
0.333Parameter for slur shape. The higher this number, the quicker the slur attains its
height-limit.springs-and-rods(boolean):
ly:spanner::set-spacing-rodsDummy variable for triggering spacing routines.
stencil(stencil):
ly:slur::printThe symbol to print.
thickness(number):
1.1For 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 #<primitive-procedure ly:slur::vertical-skylines> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:slur::height> #<primitive-procedure ly:slur::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, outside-staff-interface, slur-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
PianoPedalBracket objects are created by: Piano_pedal_engraver.
Standard settings:
bound-padding(number):
1.0The amount of padding to insert around spanner bounds.
bracket-flare(pair of numbers): '(0.5 . 0.5)A pair of numbers specifying how much edges of brackets should slant outward. Value
0.0means straight edges.direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.edge-height(pair): '(1.0 . 1.0)A pair of numbers specifying the heights of the vertical edges:
(left-height . right-height).shorten-pair(pair of numbers): '(0.0 . 0.0)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.
stencil(stencil):
ly:piano-pedal-bracket::printThe symbol to print.
style(symbol):
'lineThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback reading this property.thickness(number):
1.0For 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 #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
This object supports the following interface(s): grob-interface, line-interface, piano-pedal-bracket-interface, piano-pedal-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
RehearsalMark objects are created by: Mark_engraver.
Standard settings:
after-line-breaking(boolean):
ly:side-position-interface::move-to-extremal-staffDummy property, used to trigger callback for
after-line-breaking.baseline-skip(dimension, in staff space):
2Distance between base lines of multiple lines of text.
break-align-symbols(list): '(staff-bar key-signature clef)A list of break-align symbols that determines which breakable items to align this to. If the grob selected by the first symbol in the list is invisible due to
break-visibility, we will align to the next grob (and so on). Choices are listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.break-visibility(vector): #(#f #t #t)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.extra-spacing-width(pair of numbers): '(+inf.0 . -inf.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).font-size(number):
2The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.outside-staff-horizontal-padding(number):
0.2By default, an outside-staff-object can be placed so that is it very close to another grob horizontally. If this property is set, the outside-staff-object is raised so that it is not so close to its neighbor.
outside-staff-priority(number):
1500If 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-priorityis closer to the staff.padding(dimension, in staff space):
0.8Add this much extra space between objects that are next to each other.
self-alignment-X(number):
break-alignable-interface::self-alignment-opposite-of-anchorSpecify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.stencil(stencil):
ly:text-interface::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
X-offset(number):
self-alignment-interface::self-aligned-on-breakableThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<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): break-alignable-interface, font-interface, grob-interface, item-interface, mark-interface, outside-staff-interface, self-alignment-interface, side-position-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
RepeatSlash objects are created by: Slash_repeat_engraver.
Standard settings:
slash-negative-kern(number):
0.85The space to remove between slashes in percent repeat glyphs. Larger values bring the two elements closer together.
slope(number):
1.7The slope of this object.
stencil(stencil):
ly:percent-repeat-item-interface::beat-slashThe symbol to print.
thickness(number):
0.48For 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).Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, item-interface, percent-repeat-interface, percent-repeat-item-interface and rhythmic-grob-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
RepeatTie objects are created by: Repeat_tie_engraver.
Standard settings:
control-points(list of number pairs):
ly:semi-tie::calc-control-pointsList of offsets (number pairs) that form control points for the tie, slur, or bracket shape. For Béziers, this should list the control points of a third-order Bézier curve.
details(list): '((ratio . 0.333) (height-limit . 1.0))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
detailsproperty.direction(direction):
ly:tie::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.extra-spacing-height(pair of numbers): '(-0.5 . 0.5)In the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).head-direction(direction):
1Are the note heads left or right in a semitie?
stencil(stencil):
ly:tie::printThe symbol to print.
thickness(number):
1.0For 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 #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, item-interface and semi-tie-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
RepeatTieColumn objects are created by: Repeat_tie_engraver.
Standard settings:
head-direction(direction):
ly:semi-tie-column::calc-head-directionAre the note heads left or right in a semitie?
X-extent(pair of numbers)Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, item-interface and semi-tie-column-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Rest objects are created by: Completion_rest_engraver and Rest_engraver.
Standard settings:
duration-log(integer):
stem::calc-duration-logThe 2-log of the note head duration, i.e.,
0= whole note,1= half note, etc.minimum-distance(dimension, in staff space):
0.25Minimum distance between rest and notes or beam.
parenthesis-friends(list): '(dot)A list of Grob types, as symbols. When parentheses enclose a Grob that has ’parenthesis-friends, the parentheses widen to include any child Grobs with type among ’parenthesis-friends.
stencil(stencil):
ly:rest::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
voiced-position(number):
4The staff-position of a voiced
Rest, negative if the rest hasdirectionDOWN.X-extent(pair of numbers):
ly:rest::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:rest::height> #<primitive-procedure ly:rest::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
Y-offset(number):
#<unpure-pure-container #<primitive-procedure ly:rest::y-offset-callback> >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, rest-interface, rhythmic-grob-interface, rhythmic-head-interface and staff-symbol-referencer-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
RestCollision objects are created by: Rest_collision_engraver.
Standard settings:
minimum-distance(dimension, in staff space):
0.75Minimum distance between rest and notes or beam.
This object supports the following interface(s): grob-interface, item-interface and rest-collision-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Script objects are created by: Drum_notes_engraver, New_fingering_engraver and Script_engraver.
Standard settings:
add-stem-support(boolean):
#tIf set, the
Stemobject is included in this script’s support.direction(direction):
ly:script-interface::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-encoding(symbol):
'fetaMusicThe 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.1The amount to pad the axis along which a
Skylineis built for theside-position-interface.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.slur-padding(number):
0.2Extra distance between slur and script.
staff-padding(dimension, in staff space):
0.25Maintain 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::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
X-offset(number):
script-interface::calc-x-offsetThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<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, item-interface, outside-staff-interface, script-interface, self-alignment-interface and side-position-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
ScriptColumn objects are created by: Script_column_engraver.
Standard settings:
before-line-breaking(boolean):
ly:script-column::before-line-breakingDummy property, used to trigger a callback function.
This object supports the following interface(s): grob-interface, item-interface and script-column-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
ScriptRow objects are created by: Script_row_engraver.
Standard settings:
before-line-breaking(boolean):
ly:script-column::row-before-line-breakingDummy property, used to trigger a callback function.
This object supports the following interface(s): grob-interface, item-interface and script-column-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Slur objects are created by: Slur_engraver.
Standard settings:
avoid-slur(symbol):
'insideMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.control-points(list of number pairs):
ly:slur::calc-control-pointsList of offsets (number pairs) that form control points for the tie, slur, or bracket shape. For Béziers, this should list the control points of a third-order Bézier curve.
details(list): '((region-size . 4) (head-encompass-penalty . 1000.0) (stem-encompass-penalty . 30.0) (edge-attraction-factor . 4) (same-slope-penalty . 20) (steeper-slope-factor . 50) (non-horizontal-penalty . 15) (max-slope . 1.1) (max-slope-factor . 10) (free-head-distance . 0.3) (free-slur-distance . 0.8) (gap-to-staffline-inside . 0.2) (gap-to-staffline-outside . 0.1) (extra-object-collision-penalty . 50) (accidental-collision . 3) (extra-encompass-free-distance . 0.3) (extra-encompass-collision-distance . 0.8) (head-slur-distance-max-ratio . 3) (head-slur-distance-factor . 10) (absolute-closeness-measure . 0.3) (edge-slope-exponent . 1.7) (close-to-edge-length . 2.5) (encompass-object-range-overshoot . 0.5) (slur-tie-extrema-min-distance . 0.2) (slur-tie-extrema-min-distance-penalty . 2))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
detailsproperty.direction(direction):
ly:slur::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.height-limit(dimension, in staff space):
2.0Maximum slur height: The longer the slur, the closer it is to this height.
line-thickness(number):
0.8For slurs and ties, this is the diameter of the virtual “pen” that draws the two arcs of the curve’s outline, which intersect at the endpoints. 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).minimum-length(dimension, in staff space):
1.5Try to make a spanner at least this long, normally in the horizontal direction. This requires an appropriate callback for the
springs-and-rodsproperty. If added to aTie, this sets the minimum distance between noteheads.ratio(number):
0.25Parameter for slur shape. The higher this number, the quicker the slur attains its
height-limit.springs-and-rods(boolean):
ly:spanner::set-spacing-rodsDummy variable for triggering spacing routines.
stencil(stencil):
ly:slur::printThe symbol to print.
thickness(number):
1.2For 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 #<primitive-procedure ly:slur::vertical-skylines> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:slur::height> #<primitive-procedure ly:slur::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, outside-staff-interface, slur-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
SostenutoPedal objects are created by: Piano_pedal_engraver.
Standard settings:
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.extra-spacing-width(pair of numbers): '(+inf.0 . -inf.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).font-shape(symbol):
'italicSelect the shape of a font. Choices include
upright,italic,caps.padding(dimension, in staff space):
0.0Add this much extra space between objects that are next to each other.
parent-alignment-X(number)Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.stencil(stencil):
ly:text-interface::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): font-interface, grob-interface, item-interface, piano-pedal-script-interface, self-alignment-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
SostenutoPedalLineSpanner objects are created by: Piano_pedal_align_engraver.
Standard settings:
axes(list): '(1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.minimum-space(dimension, in staff space):
1.0Minimum distance that the victim should move (after padding).
outside-staff-priority(number):
1000If 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-priorityis closer to the staff.padding(dimension, in staff space):
1.2Add this much extra space between objects that are next to each other.
side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.staff-padding(dimension, in staff space):
1.0Maintain 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.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-element-stencils> #<primitive-procedure ly:grob::pure-vertical-skylines-from-element-stencils> >Two skylines, one above and one below this grob.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
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): axis-group-interface, grob-interface, outside-staff-interface, piano-pedal-interface, side-position-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
SpacingSpanner objects are created by: Spacing_engraver.
Standard settings:
average-spacing-wishes(boolean):
#tIf set, the spacing wishes are averaged over staves.
base-shortest-duration(moment):
#<Mom 3/16>Spacing is based on the shortest notes in a piece. Normally, pieces are spaced as if notes at least as short as this are present.
common-shortest-duration(moment):
ly:spacing-spanner::calc-common-shortest-durationThe most common shortest note length. This is used in spacing. Enlarging this sets the score tighter.
shortest-duration-space(number):
2.0Start with this multiple of
spacing-incrementspace for the shortest duration. See also (internals)spacing-spanner-interface section ‘spacing-spanner-interface’ in Internals Reference.spacing-increment(dimension, in staff space):
1.2The unit of length for note-spacing. Typically, the width of a note head. See also (internals)spacing-spanner-interface section ‘spacing-spanner-interface’ in Internals Reference.
springs-and-rods(boolean):
ly:spacing-spanner::set-springsDummy variable for triggering spacing routines.
This object supports the following interface(s): grob-interface, spacing-options-interface, spacing-spanner-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
SpanBar objects are created by: Span_bar_engraver.
Standard settings:
allow-span-bar(boolean):
#tIf false, no inter-staff bar line will be created below this bar line.
bar-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >The Y-extent of the actual bar line. This may differ from
Y-extentbecause it does not include the dots in a repeat bar line.before-line-breaking(boolean):
ly:span-bar::before-line-breakingDummy property, used to trigger a callback function.
break-align-symbol(symbol):
'staff-barThis key is used for aligning, ordering, and spacing breakable items. See (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.
glyph-name(string):
ly:span-bar::calc-glyph-nameThe glyph name within the font.
In the context of (span) bar lines, glyph-name represents a processed form of
glyph, where decisions about line breaking etc. are already taken.layer(integer):
0An integer which determines the order of printing objects. Objects with the lowest value of layer are drawn first, then objects with progressively higher values are drawn, so objects with higher values overwrite objects with lower values. By default most objects are assigned a layer value of 1.
non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.stencil(stencil):
ly:span-bar::printThe symbol to print.
X-extent(pair of numbers):
ly:span-bar::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers): '(+inf.0 . -inf.0)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): bar-line-interface, font-interface, grob-interface, item-interface and span-bar-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
SpanBarStub objects are created by: Span_bar_stub_engraver.
Standard settings:
extra-spacing-height(pair of numbers):
pure-from-neighbor-interface::extra-spacing-heightIn the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).X-extent(pair of numbers):
#<procedure #f (grob)>Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #f #<procedure pure-from-neighbor-interface::pure-height (grob beg end)> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, item-interface and pure-from-neighbor-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
StaffGrouper objects are not created by any engraver.
Standard settings:
staff-staff-spacing(list): '((basic-distance . 9) (minimum-distance . 7) (padding . 1) (stretchability . 5))When applied to a staff-group’s
StaffGroupergrob, this spacing alist controls the distance between consecutive staves within the staff-group. When applied to a staff’sVerticalAxisGroupgrob, it controls the distance between the staff and the nearest staff below it in the same system, replacing any settings inherited from theStaffGroupergrob of the containing staff-group, if there is one. This property remains in effect even when non-staff lines appear between staves. The alist can contain the following keys:
basic-distance– the vertical distance, measured in staff-spaces, between the reference points of the two items when no collisions would result, and no stretching or compressing is in effect.minimum-distance– the smallest allowable vertical distance, measured in staff-spaces, between the reference points of the two items, when compressing is in effect.padding– the minimum required amount of unobstructed vertical whitespace between the bounding boxes (or skylines) of the two items, measured in staff-spaces.stretchability– a unitless measure of the dimension’s relative propensity to stretch. If zero, the distance will not stretch (unless collisions would result).staffgroup-staff-spacing(list): '((basic-distance . 10.5) (minimum-distance . 8) (padding . 1) (stretchability . 9))The spacing alist controlling the distance between the last staff of the current staff-group and the staff just below it in the same system, even if one or more non-staff lines exist between the two staves. If the
staff-staff-spacingproperty of the staff’sVerticalAxisGroupgrob is set, that is used instead. Seestaff-staff-spacingfor a description of the alist structure.
This object supports the following interface(s): grob-interface, spanner-interface and staff-grouper-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
StaffSpacing objects are created by: Separating_line_group_engraver.
Standard settings:
non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.stem-spacing-correction(number):
0.4Optical correction amount for stems that are placed in tight configurations. For opposite directions, this amount is the correction for two normal sized stems that overlap completely.
This object supports the following interface(s): grob-interface, item-interface, spacing-interface and staff-spacing-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
StaffSymbol objects are created by: Staff_symbol_engraver and Tab_staff_symbol_engraver.
Standard settings:
break-align-symbols(list): '(staff-bar break-alignment)A list of break-align symbols that determines which breakable items to align this to. If the grob selected by the first symbol in the list is invisible due to
break-visibility, we will align to the next grob (and so on). Choices are listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.layer(integer):
0An integer which determines the order of printing objects. Objects with the lowest value of layer are drawn first, then objects with progressively higher values are drawn, so objects with higher values overwrite objects with lower values. By default most objects are assigned a layer value of 1.
ledger-line-thickness(pair of numbers): '(1.0 . 0.1)The thickness of ledger lines. It is the sum of 2 numbers: The first is the factor for line thickness, and the second for staff space. Both contributions are added.
line-count(integer):
5The number of staff lines.
stencil(stencil):
ly:staff-symbol::printThe symbol to print.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:staff-symbol::height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, spanner-interface and staff-symbol-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
StanzaNumber objects are created by: Stanza_number_engraver.
Standard settings:
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-series(symbol):
'boldSelect the series of a font. Choices include
medium,bold,bold-narrow, etc.padding(dimension, in staff space):
1.0Add this much extra space between objects that are next to each other.
side-axis(number):
0If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.stencil(stencil):
ly:text-interface::printThe symbol to print.
X-offset(number):
ly:side-position-interface::x-aligned-sideThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): font-interface, grob-interface, item-interface, side-position-interface, stanza-number-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Stem objects are created by: Span_stem_engraver and Stem_engraver.
Standard settings:
beamlet-default-length(pair): '(1.1 . 1.1)A pair of numbers. The first number specifies the default length of a beamlet that sticks out of the left hand side of this stem; the second number specifies the default length of the beamlet to the right. The actual length of a beamlet is determined by taking either the default length or the length specified by
beamlet-max-length-proportion, whichever is smaller.beamlet-max-length-proportion(pair): '(0.75 . 0.75)The maximum length of a beamlet, as a proportion of the distance between two adjacent stems.
default-direction(direction):
ly:stem::calc-default-directionDirection determined by note head positions.
details(list): '((lengths 3.5 3.5 3.5 4.25 5.0 6.0 7.0 8.0 9.0) (beamed-lengths 3.26 3.5 3.6) (beamed-minimum-free-lengths 1.83 1.5 1.25) (beamed-extreme-minimum-free-lengths 2.0 1.25) (stem-shorten 1.0 0.5 0.25))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
detailsproperty.direction(direction):
ly:stem::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.double-stem-separation(number):
0.5The distance between the two stems of a half note in tablature when using
\tabFullNotation, not counting the width of the stems themselves, expressed as a multiple of the default height of a staff-space in the traditional five-line staff.duration-log(integer):
stem::calc-duration-logThe 2-log of the note head duration, i.e.,
0= whole note,1= half note, etc.length(dimension, in staff space):
#<unpure-pure-container #<primitive-procedure ly:stem::calc-length> #<primitive-procedure ly:stem::pure-calc-length> >User override for the stem length of unbeamed stems (each unit represents half a
staff-space).neutral-direction(direction):
-1Which direction to take in the center of the staff.
note-collision-threshold(dimension, in staff space):
1Simultaneous notes that are this close or closer in units of
staff-spacewill be identified as vertically colliding. Used byStemgrobs for notes in the same voice, andNoteCollisiongrobs for notes in different voices. Default value 1.stem-begin-position(number):
#<unpure-pure-container #<primitive-procedure ly:stem::calc-stem-begin-position> #<primitive-procedure ly:stem::pure-calc-stem-begin-position> >User override for the begin position of a stem.
stencil(stencil):
ly:stem::printThe symbol to print.
thickness(number):
1.3For 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).X-extent(pair of numbers):
ly:stem::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
X-offset(number):
ly:stem::offset-callbackThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:stem::height> #<primitive-procedure ly:stem::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
Y-offset(number):
#<unpure-pure-container #<primitive-procedure ly:staff-symbol-referencer::callback> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): grob-interface, item-interface and stem-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
StemStub objects are created by: Stem_engraver.
Standard settings:
extra-spacing-height(pair of numbers):
stem-stub::extra-spacing-heightIn the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).X-extent(pair of numbers):
stem-stub::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #f #<procedure stem-stub::pure-height (grob beg end)> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface and item-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
StemTremolo objects are created by: Stem_engraver.
Standard settings:
beam-thickness(dimension, in staff space):
0.48Beam thickness, measured in
staff-spaceunits.beam-width(dimension, in staff space):
ly:stem-tremolo::calc-widthWidth of the tremolo sign.
direction(direction):
ly:stem-tremolo::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.parent-alignment-X(number):
0Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.shape(symbol):
ly:stem-tremolo::calc-shapeThis setting determines what shape a grob has. Valid choices depend on the
stencilcallback reading this property.slope(number):
ly:stem-tremolo::calc-slopeThe slope of this object.
stencil(stencil):
ly:stem-tremolo::printThe symbol to print.
X-extent(pair of numbers):
ly:stem-tremolo::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> #<primitive-procedure ly:stem-tremolo::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
Y-offset(number):
#<unpure-pure-container #<primitive-procedure ly:stem-tremolo::calc-y-offset> #<primitive-procedure ly:stem-tremolo::pure-calc-y-offset> >The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): grob-interface, item-interface, self-alignment-interface and stem-tremolo-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
StringNumber objects are created by: New_fingering_engraver.
Standard settings:
add-stem-support(boolean):
only-if-beamedIf set, the
Stemobject is included in this script’s support.avoid-slur(symbol):
'aroundMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.font-encoding(symbol):
'fetaTextThe 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-size(number):
-5The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.number-type(symbol):
'arabicNumbering style. Choices include
roman-lower,roman-upperandarabic.padding(dimension, in staff space):
0.5Add this much extra space between objects that are next to each other.
parent-alignment-X(number):
0Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.script-priority(number):
100A key for determining the order of scripts in a stack, by being added to the position of the script in the user input, the sum being the overall priority. Smaller means closer to the head.
self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.self-alignment-Y(number):
0Like
self-alignment-Xbut for the Y axis.staff-padding(dimension, in staff space):
0.5Maintain 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):
print-circled-text-callbackThe symbol to print.
text(markup):
string-number::calc-textText markup. See (notation)Formatting text section ‘Formatting text’ in Notation Reference.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): font-interface, grob-interface, item-interface, number-interface, outside-staff-interface, self-alignment-interface, side-position-interface, string-number-interface, text-interface and text-script-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
StrokeFinger objects are created by: New_fingering_engraver.
Standard settings:
add-stem-support(boolean):
only-if-beamedIf set, the
Stemobject is included in this script’s support.digit-names(vector):#("p" "i" "m" "a" "x")Names for string finger digits.
font-shape(symbol):
'italicSelect the shape of a font. Choices include
upright,italic,caps.font-size(number):
-4The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.padding(dimension, in staff space):
0.5Add this much extra space between objects that are next to each other.
parent-alignment-X(number):
0Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.script-priority(number):
100A key for determining the order of scripts in a stack, by being added to the position of the script in the user input, the sum being the overall priority. Smaller means closer to the head.
self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.self-alignment-Y(number):
0Like
self-alignment-Xbut for the Y axis.staff-padding(dimension, in staff space):
0.5Maintain 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:text-interface::printThe symbol to print.
text(markup):
stroke-finger::calc-textText markup. See (notation)Formatting text section ‘Formatting text’ in Notation Reference.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): font-interface, grob-interface, item-interface, outside-staff-interface, self-alignment-interface, side-position-interface, stroke-finger-interface, text-interface and text-script-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
SustainPedal objects are created by: Piano_pedal_engraver.
Standard settings:
extra-spacing-width(pair of numbers): '(+inf.0 . -inf.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).padding(dimension, in staff space):
0.0Add this much extra space between objects that are next to each other.
parent-alignment-X(number)Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.stencil(stencil):
ly:sustain-pedal::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): font-interface, grob-interface, item-interface, piano-pedal-interface, piano-pedal-script-interface, self-alignment-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
SustainPedalLineSpanner objects are created by: Piano_pedal_align_engraver.
Standard settings:
axes(list): '(1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.minimum-space(dimension, in staff space):
1.0Minimum distance that the victim should move (after padding).
outside-staff-priority(number):
1000If 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-priorityis closer to the staff.padding(dimension, in staff space):
1.2Add this much extra space between objects that are next to each other.
side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.staff-padding(dimension, in staff space):
1.2Maintain 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.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-element-stencils> #<primitive-procedure ly:grob::pure-vertical-skylines-from-element-stencils> >Two skylines, one above and one below this grob.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
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): axis-group-interface, grob-interface, outside-staff-interface, piano-pedal-interface, side-position-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
System objects are not created by any engraver.
Standard settings:
axes(list): '(0 1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
outside-staff-placement-directive(symbol):
'left-to-right-politeOne of four directives telling how outside staff objects should be placed.
left-to-right-greedy– Place each successive grob from left to right.left-to-right-polite– Place a grob from left to right only if it does not potentially overlap with another grob that has been placed on a pass through a grob array. If there is overlap, do another pass to determine placement.right-to-left-greedy– Same asleft-to-right-greedy, but from right to left.right-to-left-polite– Same asleft-to-right-polite, but from right to left.skyline-horizontal-padding(number):
1.0For determining the vertical distance between two staves, it is possible to have a configuration which would result in a tight interleaving of grobs from the top staff and the bottom staff. The larger this parameter is, the farther apart the staves are placed in such a configuration.
vertical-skylines(pair of skylines):
ly:axis-group-interface::calc-skylinesTwo skylines, one above and one below this grob.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:system::height> #<primitive-procedure ly:system::calc-pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): axis-group-interface, grob-interface, outside-staff-axis-group-interface, spanner-interface and system-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
SystemStartBar objects are created by: System_start_delimiter_engraver.
Standard settings:
collapse-height(dimension, in staff space):
5.0Minimum height of system start delimiter. If equal or smaller, the bracket/brace/line is removed.
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.padding(dimension, in staff space):
-0.1Add this much extra space between objects that are next to each other.
stencil(stencil):
ly:system-start-delimiter::printThe symbol to print.
style(symbol):
'bar-lineThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback reading this property.thickness(number):
1.6For 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).X-offset(number):
ly:side-position-interface::x-aligned-sideThe horizontal amount that this object is moved relative to its X-parent.
This object supports the following interface(s): grob-interface, side-position-interface, spanner-interface and system-start-delimiter-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
SystemStartBrace objects are created by: System_start_delimiter_engraver.
Standard settings:
collapse-height(dimension, in staff space):
5.0Minimum height of system start delimiter. If equal or smaller, the bracket/brace/line is removed.
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-encoding(symbol):
'fetaBracesThe 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).padding(dimension, in staff space):
0.3Add this much extra space between objects that are next to each other.
stencil(stencil):
ly:system-start-delimiter::printThe symbol to print.
style(symbol):
'braceThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback reading this property.X-offset(number):
ly:side-position-interface::x-aligned-sideThe horizontal amount that this object is moved relative to its X-parent.
This object supports the following interface(s): font-interface, grob-interface, side-position-interface, spanner-interface and system-start-delimiter-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
SystemStartBracket objects are created by: System_start_delimiter_engraver.
Standard settings:
collapse-height(dimension, in staff space):
5.0Minimum height of system start delimiter. If equal or smaller, the bracket/brace/line is removed.
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.padding(dimension, in staff space):
0.8Add this much extra space between objects that are next to each other.
stencil(stencil):
ly:system-start-delimiter::printThe symbol to print.
style(symbol):
'bracketThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback reading this property.thickness(number):
0.45For 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).X-offset(number):
ly:side-position-interface::x-aligned-sideThe horizontal amount that this object is moved relative to its X-parent.
This object supports the following interface(s): font-interface, grob-interface, side-position-interface, spanner-interface and system-start-delimiter-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
SystemStartSquare objects are created by: System_start_delimiter_engraver.
Standard settings:
collapse-height(dimension, in staff space):
5.0Minimum height of system start delimiter. If equal or smaller, the bracket/brace/line is removed.
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.stencil(stencil):
ly:system-start-delimiter::printThe symbol to print.
style(symbol):
'line-bracketThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback reading this property.thickness(number):
1.0For 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).X-offset(number):
ly:side-position-interface::x-aligned-sideThe horizontal amount that this object is moved relative to its X-parent.
This object supports the following interface(s): font-interface, grob-interface, side-position-interface, spanner-interface and system-start-delimiter-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
TabNoteHead objects are created by: Tab_note_heads_engraver.
Standard settings:
details(list):'((cautionary-properties (angularity . 0.4) (half-thickness . 0.075) (padding . 0) (procedure . #<procedure parenthesize-stencil (stencil half-thickness width angularity padding)>) (width . 0.25)) (head-offset . 3/5) (harmonic-properties (angularity . 2) (half-thickness . 0.075) (padding . 0) (procedure . #<procedure parenthesize-stencil (stencil half-thickness width angularity padding)>) (width . 0.25)) (repeat-tied-properties (note-head-visible . #t) (parenthesize . #t)) (tied-properties (parenthesize . #t)))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
detailsproperty.direction(direction):
0If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.duration-log(integer):
note-head::calc-duration-logThe 2-log of the note head duration, i.e.,
0= whole note,1= half note, etc.font-series(symbol):
'boldSelect the series of a font. Choices include
medium,bold,bold-narrow, etc.font-size(number):
-2The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.parenthesis-friends(list): '(dot)A list of Grob types, as symbols. When parentheses enclose a Grob that has ’parenthesis-friends, the parentheses widen to include any child Grobs with type among ’parenthesis-friends.
stem-attachment(pair of numbers): '(0.0 . 1.35)An
(x . y)pair where the stem attaches to the notehead.stencil(stencil):
tab-note-head::printThe symbol to print.
whiteout(boolean-or-number):
#tIf a number or true, the grob is printed over a white background to white-out underlying material, if the grob is visible. A number indicates how far the white background extends beyond the bounding box of the grob as a multiple of the staff-line thickness. The
LyricHyphengrob uses a special implementation of whiteout: A positive number indicates how far the white background extends beyond the bounding box in multiples ofline-thickness. The shape of the background is determined bywhiteout-style. Usually#fby default.X-offset(number):
ly:self-alignment-interface::x-aligned-on-selfThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<primitive-procedure ly:staff-symbol-referencer::callback> >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, note-head-interface, rhythmic-grob-interface, rhythmic-head-interface, staff-symbol-referencer-interface, tab-note-head-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
TextScript objects are created by: Text_engraver.
Standard settings:
avoid-slur(symbol):
'aroundMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.extra-spacing-width(pair of numbers): '(+inf.0 . -inf.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).outside-staff-horizontal-padding(number):
0.2By default, an outside-staff-object can be placed so that is it very close to another grob horizontally. If this property is set, the outside-staff-object is raised so that it is not so close to its neighbor.
outside-staff-priority(number):
450If 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-priorityis closer to the staff.padding(dimension, in staff space):
0.3Add this much extra space between objects that are next to each other.
parent-alignment-X(number)Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.script-priority(number):
200A key for determining the order of scripts in a stack, by being added to the position of the script in the user input, the sum being the overall priority. Smaller means closer to the head.
self-alignment-X(number)Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.slur-padding(number):
0.5Extra distance between slur and script.
staff-padding(dimension, in staff space):
0.5Maintain 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:text-interface::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
X-align-on-main-noteheads(boolean):
#tIf true, this grob will ignore suspended noteheads when aligning itself on NoteColumn.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<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, instrument-specific-markup-interface, item-interface, outside-staff-interface, self-alignment-interface, side-position-interface, text-interface and text-script-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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.2Size of the dashes, relative to
dash-period. Should be between0.1and1.0(continuous line). If set to0.0, a dotted line is produceddash-period(number):
3.0The length of one dash together with whitespace. If negative, no line is drawn at all.
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-shape(symbol):
'italicSelect the shape of a font. Choices include
upright,italic,caps.left-bound-info(list):
ly:line-spanner::calc-left-bound-infoAn alist of properties for determining attachments of spanners to edges.
outside-staff-priority(number):
350If 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-priorityis closer to the staff.right-bound-info(list):
ly:line-spanner::calc-right-bound-infoAn alist of properties for determining attachments of spanners to edges.
side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.staff-padding(dimension, in staff space):
0.8Maintain 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::printThe symbol to print.
style(symbol):
'dashed-lineThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback 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.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Tie objects are created by: Completion_heads_engraver and Tie_engraver.
Standard settings:
avoid-slur(symbol):
'insideMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.control-points(list of number pairs):
ly:tie::calc-control-pointsList of offsets (number pairs) that form control points for the tie, slur, or bracket shape. For Béziers, this should list the control points of a third-order Bézier curve.
details(list):'((ratio . 0.333) (center-staff-line-clearance . 0.6) (tip-staff-line-clearance . 0.45) (note-head-gap . 0.2) (stem-gap . 0.35) (height-limit . 1.0) (horizontal-distance-penalty-factor . 10) (same-dir-as-stem-penalty . 8) (min-length-penalty-factor . 26) (tie-tie-collision-distance . 0.45) (tie-tie-collision-penalty . 25.0) (intra-space-threshold . 1.25) (outer-tie-vertical-distance-symmetry-penalty-factor . 10) (outer-tie-length-symmetry-penalty-factor . 10) (vertical-distance-penalty-factor . 7) (outer-tie-vertical-gap . 0.25) (multi-tie-region-size . 3) (single-tie-region-size . 4) (between-length-limit . 1.0))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
detailsproperty.direction(direction):
ly:tie::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-size(number):
-6The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.line-thickness(number):
0.8For slurs and ties, this is the diameter of the virtual “pen” that draws the two arcs of the curve’s outline, which intersect at the endpoints. 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).neutral-direction(direction):
1Which direction to take in the center of the staff.
springs-and-rods(boolean):
ly:spanner::set-spacing-rodsDummy variable for triggering spacing routines.
stencil(stencil):
ly:tie::printThe symbol to print.
thickness(number):
1.2For 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 #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
This object supports the following interface(s): grob-interface, spanner-interface and tie-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
TieColumn objects are created by: Completion_heads_engraver and Tie_engraver.
Standard settings:
before-line-breaking(boolean):
ly:tie-column::before-line-breakingDummy property, used to trigger a callback function.
X-extent(pair of numbers)Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, spanner-interface and tie-column-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
TimeSignature objects are created by: Time_signature_engraver.
Standard settings:
avoid-slur(symbol):
'insideMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.break-align-anchor(number):
ly:break-aligned-interface::calc-extent-aligned-anchorGrobs aligned to this breakable item will have their X-offsets shifted by this number. In bar lines, for example, this is used to position grobs relative to the (visual) center of the bar line.
break-align-anchor-alignment(number):
-1Read by
ly:break-aligned-interface::calc-extent-aligned-anchorfor aligning an anchor to a grob’s extent.break-align-symbol(symbol):
'time-signatureThis key is used for aligning, ordering, and spacing breakable items. See (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference.
break-visibility(vector): #(#t #t #t)A vector of 3 booleans,
#(end-of-line unbroken begin-of-line).#tmeans visible,#fmeans killed.extra-spacing-height(pair of numbers):
pure-from-neighbor-interface::extra-spacing-height-including-staffIn the horizontal spacing problem, we increase the height of each item by this amount (by adding the ‘car’ to the bottom of the item and adding the ‘cdr’ to the top of the item). In order to make a grob infinitely high (to prevent the horizontal spacing problem from placing any other grobs above or below this grob), set this to
(-inf.0 . +inf.0).extra-spacing-width(pair of numbers): '(0.0 . 0.8)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.space-alist(list): '((ambitus extra-space . 1.0) (cue-clef extra-space . 1.5) (first-note fixed-space . 2.0) (right-edge extra-space . 0.5) (staff-bar extra-space . 1.0))An alist that specifies distances from this grob to other breakable items, using the format:
'((break-align-symbol . (spacing-style . space)) (break-align-symbol . (spacing-style . space)) ...)Standard choices for
break-align-symbolare listed in (internals)break-alignment-interface section ‘break-alignment-interface’ in Internals Reference. Additionally, three special break-align symbols available tospace-alistare:
first-noteused when the grob is just left of the first note on a line
next-noteused when the grob is just left of any other note; if not set, the value of
first-notegets usedright-edgeused when the grob is the last item on the line (only compatible with the
extra-spacespacing style)Choices for
spacing-styleare:
extra-spacePut this much space between the two grobs. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed.minimum-spacePut at least this much space between the left sides of both grobs, without allowing them to collide. The space is stretchable when paired with
first-noteornext-note; otherwise it is fixed. Not compatible withright-edge.fixed-spaceOnly compatible with
first-noteandnext-note. Put this much fixed space between the grob and the note.minimum-fixed-spaceOnly compatible with
first-noteandnext-note. Put at least this much fixed space between the left side of the grob and the left side of the note, without allowing them to collide.semi-fixed-spaceOnly compatible with
first-noteandnext-note. Put this much space between the grob and the note, such that half of the space is fixed and half is stretchable.Rules for this spacing are much more complicated than this. See [Wanske] page 126–134, [Ross] page 143–147.
stencil(stencil):
ly:time-signature::printThe symbol to print.
style(symbol):
'CThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback reading this property.Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): break-aligned-interface, font-interface, grob-interface, item-interface, pure-from-neighbor-interface and time-signature-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
TrillPitchAccidental objects are created by: Pitched_trill_engraver.
Standard settings:
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-size(number):
-4The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.glyph-name-alist(list): '((0 . "accidentals.natural") (-1/2 . "accidentals.flat") (1/2 . "accidentals.sharp") (1 . "accidentals.doublesharp") (-1 . "accidentals.flatflat") (3/4 . "accidentals.sharp.slashslash.stemstemstem") (1/4 . "accidentals.sharp.slashslash.stem") (-1/4 . "accidentals.mirroredflat") (-3/4 . "accidentals.mirroredflat.flat"))An alist of key-string pairs.
padding(dimension, in staff space):
0.2Add this much extra space between objects that are next to each other.
side-axis(number):
0If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.stencil(stencil):
ly:accidental-interface::printThe symbol to print.
X-offset(number):
ly:side-position-interface::x-aligned-sideThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:accidental-interface::height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): accidental-interface, font-interface, grob-interface, inline-accidental-interface, item-interface, side-position-interface and trill-pitch-accidental-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
TrillPitchGroup objects are created by: Pitched_trill_engraver.
Standard settings:
axes(list): '(0)List of axis numbers. In the case of alignment grobs, this should contain only one number.
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-size(number):
-4The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.horizon-padding(number):
0.1The amount to pad the axis along which a
Skylineis built for theside-position-interface.minimum-space(dimension, in staff space):
2.5Minimum distance that the victim should move (after padding).
padding(dimension, in staff space):
0.3Add this much extra space between objects that are next to each other.
side-axis(number):
0If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.stencil(stencil):
parenthesize-elementsThe symbol to print.
stencils(list):
parentheses-item::calc-parenthesis-stencilsMultiple stencils, used as intermediate value.
X-offset(number):
ly:side-position-interface::x-aligned-sideThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): axis-group-interface, font-interface, grob-interface, item-interface, note-head-interface, parentheses-interface and side-position-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
TrillPitchHead objects are created by: Pitched_trill_engraver.
Standard settings:
duration-log(integer):
2The 2-log of the note head duration, i.e.,
0= whole note,1= half note, etc.font-size(number):
-4The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.stencil(stencil):
ly:note-head::printThe symbol to print.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-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 #<primitive-procedure ly:staff-symbol-referencer::callback> >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, ledgered-interface, pitched-trill-interface, rhythmic-head-interface and staff-symbol-referencer-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
TrillSpanner objects are created by: Trill_spanner_engraver.
Standard settings:
after-line-breaking(boolean):
ly:spanner::kill-zero-spanned-timeDummy property, used to trigger callback for
after-line-breaking.bound-details(list):'((left (text #<procedure musicglyph-markup (layout props glyph-name)> "scripts.trill") (Y . 0) (stencil-offset -0.5 . -1) (padding . 0.5) (attach-dir . 0)) (left-broken (end-on-note . #t)) (right (Y . 0)))An alist of properties for determining attachments of spanners to edges.
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.left-bound-info(list):
ly:line-spanner::calc-left-bound-infoAn alist of properties for determining attachments of spanners to edges.
outside-staff-priority(number):
50If 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-priorityis closer to the staff.padding(dimension, in staff space):
0.5Add this much extra space between objects that are next to each other.
right-bound-info(list):
ly:line-spanner::calc-right-bound-infoAn alist of properties for determining attachments of spanners to edges.
side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.staff-padding(dimension, in staff space):
1.0Maintain 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::printThe symbol to print.
style(symbol):
'trillThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback 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, spanner-interface and trill-spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
TupletBracket objects are created by: Tuplet_engraver.
Standard settings:
avoid-scripts(boolean):
#tIf set, a tuplet bracket avoids the scripts associated with the note heads it encompasses.
connect-to-neighbor(pair):
ly:tuplet-bracket::calc-connect-to-neighborsPair of booleans, indicating whether this grob looks as a continued break.
direction(direction):
ly:tuplet-bracket::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. 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):
#tRun to the extent of the column for a full-length tuplet bracket.
padding(dimension, in staff space):
1.1Add this much extra space between objects that are next to each other.
positions(pair of numbers):
ly:tuplet-bracket::calc-positionsPair of staff coordinates
(left . right), where both left and right are instaff-spaceunits 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.
staff-padding(dimension, in staff space):
0.25Maintain 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::printThe symbol to print.
thickness(number):
1.6For 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.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
X-positions(pair of numbers):
ly:tuplet-bracket::calc-x-positionsPair of X staff coordinates of a spanner in the form
(left . right), where both left and right are instaff-spaceunits of the current staff.
This object supports the following interface(s): grob-interface, line-interface, outside-staff-interface, spanner-interface and tuplet-bracket-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
TupletNumber objects are created by: Tuplet_engraver.
Standard settings:
avoid-slur(symbol):
'insideMethod of handling slur collisions. Choices are
inside,outside,around, andignore.insideadjusts the slur if needed to keep the grob inside the slur.outsidemoves the grob vertically to the outside of the slur.aroundmoves the grob vertically to the outside of the slur only if there is a collision.ignoredoes not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.),outsideandaroundbehave likeignore.direction(direction):
tuplet-number::calc-directionIf
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.font-shape(symbol):
'italicSelect the shape of a font. Choices include
upright,italic,caps.font-size(number):
-2The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.knee-to-beam(boolean):
#tDetermines whether a tuplet number will be positioned next to a kneed beam.
stencil(stencil):
ly:tuplet-number::printThe symbol to print.
text(markup):
tuplet-number::calc-denominator-textText markup. See (notation)Formatting text section ‘Formatting text’ in Notation Reference.
X-offset(number):
ly:tuplet-number::calc-x-offsetThe horizontal amount that this object is moved relative to its X-parent.
Y-offset(number):
ly:tuplet-number::calc-y-offsetThe vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): font-interface, grob-interface, outside-staff-interface, spanner-interface, text-interface and tuplet-number-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
UnaCordaPedal objects are created by: Piano_pedal_engraver.
Standard settings:
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.extra-spacing-width(pair of numbers): '(+inf.0 . -inf.0)In the horizontal spacing problem, we pad each item by this amount (by adding the ‘car’ on the left side of the item and adding the ‘cdr’ on the right side of the item). In order to make a grob take up no horizontal space at all, set this to
(+inf.0 . -inf.0).font-shape(symbol):
'italicSelect the shape of a font. Choices include
upright,italic,caps.padding(dimension, in staff space):
0.0Add this much extra space between objects that are next to each other.
parent-alignment-X(number)Specify on which point of the parent the object is aligned. The value
-1means aligned on parent’s left edge,0on center, and1right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value fromself-alignment-Xproperty will be used.self-alignment-X(number):
0Specify alignment of an object. The value
-1means left aligned,0centered, and1right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.stencil(stencil):
ly:text-interface::printThe symbol to print.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> >Two skylines, one above and one below this grob.
X-offset(number):
ly:self-alignment-interface::aligned-on-x-parentThe horizontal amount that this object is moved relative to its X-parent.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): font-interface, grob-interface, item-interface, piano-pedal-script-interface, self-alignment-interface and text-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
UnaCordaPedalLineSpanner objects are created by: Piano_pedal_align_engraver.
Standard settings:
axes(list): '(1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
direction(direction):
-1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.minimum-space(dimension, in staff space):
1.0Minimum distance that the victim should move (after padding).
outside-staff-priority(number):
1000If 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-priorityis closer to the staff.padding(dimension, in staff space):
1.2Add this much extra space between objects that are next to each other.
side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.staff-padding(dimension, in staff space):
1.2Maintain 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.
vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-element-stencils> #<primitive-procedure ly:grob::pure-vertical-skylines-from-element-stencils> >Two skylines, one above and one below this grob.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
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): axis-group-interface, grob-interface, outside-staff-interface, piano-pedal-interface, side-position-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
VaticanaLigature objects are created by: Vaticana_ligature_engraver.
Standard settings:
stencil(stencil):
ly:vaticana-ligature::printThe symbol to print.
thickness(number):
0.6For 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).
This object supports the following interface(s): font-interface, grob-interface, spanner-interface and vaticana-ligature-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
VerticalAlignment objects are created by: Vertical_align_engraver.
Standard settings:
axes(list): '(1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
stacking-dir(direction):
-1Stack objects in which direction?
vertical-skylines(pair of skylines):
ly:axis-group-interface::combine-skylinesTwo skylines, one above and one below this grob.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): align-interface, axis-group-interface, grob-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
VerticalAxisGroup objects are created by: Axis_group_engraver.
Standard settings:
axes(list): '(1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
default-staff-staff-spacing(list): '((basic-distance . 9) (minimum-distance . 8) (padding . 1))The settings to use for
staff-staff-spacingwhen it is unset, for ungrouped staves and for grouped staves that do not have the relevantStaffGrouperproperty set (staff-staff-spacingorstaffgroup-staff-spacing).nonstaff-unrelatedstaff-spacing(list): '((padding . 0.5))The spacing alist controlling the distance between the current non-staff line and the nearest staff in the opposite direction from
staff-affinity, if there are no other non-staff lines between the two, andstaff-affinityis eitherUPorDOWN. Seestaff-staff-spacingfor a description of the alist structure.outside-staff-placement-directive(symbol):
'left-to-right-politeOne of four directives telling how outside staff objects should be placed.
left-to-right-greedy– Place each successive grob from left to right.left-to-right-polite– Place a grob from left to right only if it does not potentially overlap with another grob that has been placed on a pass through a grob array. If there is overlap, do another pass to determine placement.right-to-left-greedy– Same asleft-to-right-greedy, but from right to left.right-to-left-polite– Same asleft-to-right-polite, but from right to left.skyline-horizontal-padding(number):
0.1For determining the vertical distance between two staves, it is possible to have a configuration which would result in a tight interleaving of grobs from the top staff and the bottom staff. The larger this parameter is, the farther apart the staves are placed in such a configuration.
staff-staff-spacing(list):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::calc-staff-staff-spacing> #<primitive-procedure ly:axis-group-interface::calc-pure-staff-staff-spacing> >When applied to a staff-group’s
StaffGroupergrob, this spacing alist controls the distance between consecutive staves within the staff-group. When applied to a staff’sVerticalAxisGroupgrob, it controls the distance between the staff and the nearest staff below it in the same system, replacing any settings inherited from theStaffGroupergrob of the containing staff-group, if there is one. This property remains in effect even when non-staff lines appear between staves. The alist can contain the following keys:
basic-distance– the vertical distance, measured in staff-spaces, between the reference points of the two items when no collisions would result, and no stretching or compressing is in effect.minimum-distance– the smallest allowable vertical distance, measured in staff-spaces, between the reference points of the two items, when compressing is in effect.padding– the minimum required amount of unobstructed vertical whitespace between the bounding boxes (or skylines) of the two items, measured in staff-spaces.stretchability– a unitless measure of the dimension’s relative propensity to stretch. If zero, the distance will not stretch (unless collisions would result).stencil(stencil):
ly:axis-group-interface::printThe symbol to print.
vertical-skylines(pair of skylines):
ly:hara-kiri-group-spanner::calc-skylinesTwo skylines, one above and one below this grob.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:hara-kiri-group-spanner::y-extent> #<primitive-procedure ly:hara-kiri-group-spanner::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
Y-offset(number):
ly:hara-kiri-group-spanner::force-hara-kiri-callbackThe vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): axis-group-interface, grob-interface, hara-kiri-group-spanner-interface, outside-staff-axis-group-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
VoiceFollower objects are created by: Note_head_line_engraver.
Standard settings:
after-line-breaking(boolean):
ly:spanner::kill-zero-spanned-timeDummy property, used to trigger callback for
after-line-breaking.bound-details(list): '((right (attach-dir . 0) (padding . 1.5)) (left (attach-dir . 0) (padding . 1.5)))An alist of properties for determining attachments of spanners to edges.
gap(dimension, in staff space):
0.5Size of a gap in a variable symbol.
left-bound-info(list):
ly:line-spanner::calc-left-bound-infoAn alist of properties for determining attachments of spanners to edges.
non-musical(boolean):
#tTrue if the grob belongs to a
NonMusicalPaperColumn.right-bound-info(list):
ly:line-spanner::calc-right-bound-infoAn alist of properties for determining attachments of spanners to edges.
stencil(stencil):
ly:line-spanner::printThe symbol to print.
style(symbol):
'lineThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback reading this property.X-extent(pair of numbers)Extent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers)Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): grob-interface, line-interface, line-spanner-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
VoltaBracket objects are created by: Volta_engraver.
Standard settings:
baseline-skip(dimension, in staff space):
1.7Distance between base lines of multiple lines of text.
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.edge-height(pair): '(2.0 . 2.0)A pair of numbers specifying the heights of the vertical edges:
(left-height . right-height).font-encoding(symbol):
'fetaTextThe 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-size(number):
-4The font size, compared to the ‘normal’ size.
0is style-sheet’s normal size,-1is smaller,+1is bigger. Each step of 1 is approximately 12% larger; 6 steps are exactly a factor 2 larger. If the context propertyfontSizeis set, its value is added to this before the glyph is printed. Fractional values are allowed.shorten-pair(pair of numbers):
ly:volta-bracket::calc-shorten-pairThe 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.
stencil(stencil):
ly:volta-bracket-interface::printThe symbol to print.
thickness(number):
1.6For 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 #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-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.6Space to insert between words in texts.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:grob::stencil-height> #<procedure volta-bracket-interface::pure-height (grob start end)> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
This object supports the following interface(s): font-interface, grob-interface, horizontal-bracket-interface, line-interface, side-position-interface, spanner-interface, text-interface, volta-bracket-interface and volta-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
VoltaBracketSpanner objects are created by: Volta_engraver.
Standard settings:
after-line-breaking(boolean):
ly:side-position-interface::move-to-extremal-staffDummy property, used to trigger callback for
after-line-breaking.axes(list): '(1)List of axis numbers. In the case of alignment grobs, this should contain only one number.
direction(direction):
1If
side-axisis0(orX), then this property determines whether the object is placedLEFT,CENTERorRIGHTwith respect to the other object. Otherwise, it determines whether the object is placedUP,CENTERorDOWN. Numerical values may also be used:UP=1,DOWN=-1,LEFT=-1,RIGHT=1,CENTER=0.no-alignment(boolean):
#tIf set, don’t place this grob in a
VerticalAlignment; rather, place it using its ownY-offsetcallback.outside-staff-priority(number):
600If 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-priorityis closer to the staff.padding(dimension, in staff space):
1Add this much extra space between objects that are next to each other.
side-axis(number):
1If the value is
X(or equivalently0), the object is placed horizontally next to the other object. If the value isYor1, it is placed vertically.vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-element-stencils> #<primitive-procedure ly:grob::pure-vertical-skylines-from-element-stencils> >Two skylines, one above and one below this grob.
X-extent(pair of numbers):
ly:axis-group-interface::widthExtent (size) in the X direction, measured in staff-space units, relative to object’s reference point.
Y-extent(pair of numbers):
#<unpure-pure-container #<primitive-procedure ly:axis-group-interface::height> #<primitive-procedure ly:axis-group-interface::pure-height> >Extent (size) in the Y direction, measured in staff-space units, relative to object’s reference point.
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): axis-group-interface, grob-interface, outside-staff-interface, side-position-interface, spanner-interface and volta-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
VowelTransition objects are created by: Hyphen_engraver.
Standard settings:
after-line-breaking(boolean):
ly:spanner::kill-zero-spanned-timeDummy property, used to trigger callback for
after-line-breaking.arrow-length(number):
0.5Arrow length.
arrow-width(number):
0.5Arrow width.
bound-details(list):'((left (Y . 0) (padding . 0.14) (attach-dir . 1)) (right-broken (padding . 0)) (left-broken (padding . 0)) (right (Y . 0) (padding . 0.14) (attach-dir . -1) (arrow . #t)))An alist of properties for determining attachments of spanners to edges.
left-bound-info(list):
ly:line-spanner::calc-left-bound-infoAn alist of properties for determining attachments of spanners to edges.
minimum-length(dimension, in staff space):
1.0Try to make a spanner at least this long, normally in the horizontal direction. This requires an appropriate callback for the
springs-and-rodsproperty. If added to aTie, this sets the minimum distance between noteheads.right-bound-info(list):
ly:line-spanner::calc-right-bound-infoAn alist of properties for determining attachments of spanners to edges.
springs-and-rods(boolean):
ly:vowel-transition::set-spacing-rodsDummy variable for triggering spacing routines.
stencil(stencil):
ly:line-spanner::printThe symbol to print.
style(symbol):
'lineThis setting determines in what style a grob is typeset. Valid choices depend on the
stencilcallback reading this property.vertical-skylines(pair of skylines):
#<unpure-pure-container #<primitive-procedure ly:grob::vertical-skylines-from-stencil> #<primitive-procedure ly:grob::pure-simple-vertical-skylines-from-extents> >Two skylines, one above and one below this grob.
Y-offset(number):
0.5The vertical amount that this object is moved relative to its Y-parent.
This object supports the following interface(s): grob-interface, line-interface, line-spanner-interface, lyric-interface and spanner-interface.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] |
This document was generated by gub on July 13, 2020 using texi2html 1.82.