1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;;; LilyPond is free software: you can redistribute it and/or modify
7 ;;;; it under the terms of the GNU General Public License as published by
8 ;;;; the Free Software Foundation, either version 3 of the License, or
9 ;;;; (at your option) any later version.
11 ;;;; LilyPond is distributed in the hope that it will be useful,
12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;;; GNU General Public License for more details.
16 ;;;; You should have received a copy of the GNU General Public License
17 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
19 (define (define-grob-property symbol type? description)
20 (if (not (equal? (object-property symbol 'backend-doc) #f))
21 (ly:error (_ "symbol ~S redefined") symbol))
23 (set-object-property! symbol 'backend-type? type?)
24 (set-object-property! symbol 'backend-doc description)
27 ;; put this in an alist?
28 (define-public all-user-grob-properties
31 (apply define-grob-property x))
37 (add-stem-support ,boolean? "If set, the @code{Stem} object is
38 included in this script's support.")
39 (after-line-breaking ,boolean? "Dummy property, used to trigger
40 callback for @code{after-line-breaking}.")
41 (align-dir ,ly:dir? "Which side to align? @w{@code{-1}}: left side,
42 @code{0}: around center of width, @code{1}: right side.")
43 (allow-loose-spacing ,boolean? "If set, column can be detached
45 (allow-span-bar ,boolean? "If false, no inter-staff bar line will
46 be created below this bar line.")
47 (alteration ,number? "Alteration numbers for accidental.")
48 (alteration-alist ,list? "List of @code{(@var{pitch}
49 . @var{accidental})} pairs for key signature.")
50 (annotation ,string? "Annotate a grob for debug purposes.")
51 (annotation-balloon ,boolean? "Print the balloon around an annotation.")
52 (annotation-line ,boolean? "Print the line from an annotation to the
53 grob that it annotates.")
54 (arpeggio-direction ,ly:dir? "If set, put an arrow on the
55 arpeggio squiggly line.")
56 (arrow-length ,number? "Arrow length.")
57 (arrow-width ,number? "Arrow width.")
58 (auto-knee-gap ,ly:dimension? "If a gap is found between note
59 heads where a horizontal beam fits that is larger than this number,
61 (automatically-numbered ,boolean? "Should a footnote be automatically
63 (average-spacing-wishes ,boolean? "If set, the spacing wishes are
64 averaged over staves.")
65 (avoid-note-head ,boolean? "If set, the stem of a chord does not
66 pass through all note heads, but starts at the last note head.")
67 (avoid-scripts ,boolean? "If set, a tuplet bracket avoids the
68 scripts associated with the note heads it encompasses.")
69 (avoid-slur ,symbol? "Method of handling slur collisions.
70 Choices are @code{inside}, @code{outside}, @code{around}, and
71 @code{ignore}. @code{inside} adjusts the slur if needed to keep the
72 grob inside the slur. @code{outside} moves the grob vertically to the
73 outside of the slur. @code{around} moves the grob vertically to the
74 outside of the slur only if there is a collision. @code{ignore} does
75 not move either. In grobs whose notational significance depends on
76 vertical position (such as accidentals, clefs, etc.), @code{outside}
77 and @code{around} behave like @code{ignore}.")
78 (axes ,list? "List of axis numbers. In the case of alignment
79 grobs, this should contain only one number.")
85 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
86 This may differ from @code{Y-extent} because it does not include the
87 dots in a repeat bar line.")
88 (base-shortest-duration ,ly:moment? "Spacing is based on the
89 shortest notes in a piece. Normally, pieces are spaced as if notes at
90 least as short as this are present.")
91 (baseline-skip ,ly:dimension? "Distance between base lines of
92 multiple lines of text.")
93 (beam-thickness ,ly:dimension? "Beam thickness, measured in
94 @code{staff-space} units.")
95 (beam-width ,ly:dimension? "Width of the tremolo sign.")
96 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
97 when their direction is forced. It is a list, since the value is
98 different depending on the number of flags and beams.")
99 (beaming ,pair? "Pair of number lists. Each number list
100 specifies which beams to make. @code{0}@tie{}is the central beam,
101 @code{1}@tie{}is the next beam toward the note, etc. This information
102 is used to determine how to connect the beaming patterns from stem to
103 stem inside a beam.")
104 (beamlet-default-length ,pair? "A pair of numbers. The first
105 number specifies the default length of a beamlet that sticks out of
106 the left hand side of this stem; the second number specifies the
107 default length of the beamlet to the right. The actual length of a
108 beamlet is determined by taking either the default length or the
109 length specified by @code{beamlet-max-length-proportion}, whichever is
111 (beamlet-max-length-proportion ,pair? "The maximum length of a
112 beamlet, as a proportion of the distance between two adjacent stems.")
113 (before-line-breaking ,boolean? "Dummy property, used to trigger
114 a callback function.")
115 (between-cols ,pair? "Where to attach a loose column to.")
116 (bound-details ,list? "An alist of properties for determining
117 attachments of spanners to edges.")
118 (bound-padding ,number? "The amount of padding to insert around
120 (bracket-flare ,number-pair? "A pair of numbers specifying how
121 much edges of brackets should slant outward. Value @code{0.0} means
123 (bracket-visibility ,boolean-or-symbol? "This controls the
124 visibility of the tuplet bracket. Setting it to false prevents
125 printing of the bracket. Setting the property to @code{if-no-beam}
126 makes it print only if there is no beam associated with this tuplet
128 (break-align-anchor ,number? "Grobs aligned to this breakable
129 item will have their X-offsets shifted by this number. In bar lines,
130 for example, this is used to position grobs relative to the (visual)
131 center of the bar line.")
132 (break-align-anchor-alignment ,number? "Read by
133 @code{ly:break-aligned-interface::calc-extent-aligned-anchor} for
134 aligning an anchor to a grob's extent.")
135 (break-align-orders ,vector? "This is a vector of 3@tie{}lists:
136 @w{@code{#(@var{end-of-line} @var{unbroken} @var{start-of-line}}}).
137 Each list contains @w{@emph{break-align symbols}} that specify an
138 order of breakable items (see @rinternals{break-alignment-interface}).
140 For example, this places time signatures before clefs:
143 \\override Score.BreakAlignment.break-align-orders =
144 #(make-vector 3 '(left-edge
156 (break-align-symbol ,symbol? "This key is used for aligning,
157 ordering, and spacing breakable items. See
158 @rinternals{break-alignment-interface}.")
159 (break-align-symbols ,list? "A list of
160 @w{@emph{break-align symbols}} that determines which breakable
161 items to align this to. If the grob selected by the first symbol
162 in the list is invisible due to @w{@code{break-visibility}}, we
163 will align to the next grob (and so on). Choices are listed in
164 @rinternals{break-alignment-interface}.")
165 (break-overshoot ,number-pair? "How much does a broken spanner
166 stick out of its bounds?")
167 (break-visibility ,vector? "A vector of 3@tie{}booleans,
168 @w{@code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}}.
169 @code{#t} means visible, @code{#f} means killed.")
170 (breakable ,boolean? "Allow breaks here.")
171 (broken-bound-padding ,number? "The amount of padding to insert
172 when a spanner is broken at a line break.")
177 (chord-dots-limit ,integer? "Limits the column of dots
178 on each chord to the height of the chord plus
179 @code{chord-dots-limit} staff-positions.")
180 (circled-tip ,boolean? "Put a circle at start/@/end of
181 hairpins (al/@/del niente).")
182 (clef-alignments ,list? "An alist of parent-alignments
183 that should be used for clef modifiers with various clefs")
184 (clip-edges ,boolean? "Allow outward pointing beamlets at the
186 (collapse-height ,ly:dimension? "Minimum height of system start
187 delimiter. If equal or smaller, the bracket/@/brace/@/line is removed.")
188 (collision-interfaces ,list? "A list of interfaces for which
189 automatic beam-collision resolution is run.")
190 (collision-voice-only ,boolean? "Does automatic beam collsion apply
191 only to the voice in which the beam was created?")
192 (color ,color? "The color of this grob.")
193 (common-shortest-duration ,ly:moment? "The most common shortest
194 note length. This is used in spacing. Enlarging this sets the score
196 (concaveness ,number? "A beam is concave if its inner stems are
197 closer to the beam than the two outside stems. This number is a
198 measure of the closeness of the inner stems. It is used for damping
199 the slope of the beam.")
200 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
201 this grob looks as a continued break.")
202 (control-points ,number-pair-list? "List of offsets (number pairs) that form
203 control points for the tie, slur, or bracket shape. For B@'eziers,
204 this should list the control points of a third-order B@'ezier curve.")
205 (count-from ,integer? "The first measure in a measure count
206 receives this number. The following measures are numbered in
207 increments from this initial value.")
212 (damping ,number? "Amount of beam slope damping.")
213 (dash-definition ,pair? "List of @code{dash-elements} defining the
214 dash structure. Each @code{dash-element} has a starting t value,
215 an ending t-value, a @code{dash-fraction}, and a @code{dash-period}.")
216 (dash-fraction ,number? "Size of the dashes, relative to
217 @code{dash-period}. Should be between @code{0.1} and
218 @code{1.0} (continuous line). If set to @code{0.0}, a dotted line is
220 (dash-period ,number? "The length of one dash together with
221 whitespace. If negative, no line is drawn at all.")
222 (default-direction ,ly:dir? "Direction determined by note head
224 (default-staff-staff-spacing ,list? "The settings to use for
225 @code{staff-staff-spacing} when it is unset, for ungrouped staves
226 and for grouped staves that do not have the relevant
227 @code{StaffGrouper} property set (@code{staff-staff-spacing} or
228 @code{staffgroup-staff-spacing}).")
229 (details ,list? "Alist of parameters for detailed grob behavior.
230 More information on the allowed parameters for a grob can be found by
231 looking at the top of the Internals Reference page for each interface
232 having a @code{details} property.")
233 (digit-names ,vector? "Names for string finger digits.")
234 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
235 @code{X}), then this property determines whether the object is placed
236 @code{LEFT}, @code{CENTER} or @code{RIGHT} with respect to the
237 other object. Otherwise, it determines whether the object is placed
238 @code{UP}, @code{CENTER} or @code{DOWN}. Numerical values may also
239 be used: @code{UP}=@code{1}, @code{DOWN}=@w{@code{-1}},
240 @code{LEFT}=@w{@code{-1}}, @code{RIGHT}=@code{1},
241 @code{CENTER}=@code{0}.")
242 (dot-count ,integer? "The number of dots.")
243 (dot-negative-kern ,number? "The space to remove between a dot
244 and a slash in percent repeat glyphs. Larger values bring the two
245 elements closer together.")
246 (dot-placement-list ,list? "List consisting of
247 @code{(@var{description} @var{string-number} @var{fret-number}
248 @var{finger-number})} entries used to define fret diagrams.")
249 (double-stem-separation ,number? "The distance between the two
250 stems of a half note in tablature when using @code{\\tabFullNotation},
251 not counting the width of the stems themselves, expressed as a multiple
252 of the default height of a staff-space in the traditional five-line
254 (duration-log ,integer? "The 2-log of the note head duration,
255 i.e., @code{0} = whole note, @code{1} = half note, etc.")
261 (eccentricity ,number? "How asymmetrical to make a slur.
262 Positive means move the center to the right.")
263 (edge-height ,pair? "A pair of numbers specifying the heights of
264 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
265 (edge-text ,pair? "A pair specifying the texts to be set at the
266 edges: @code{(@var{left-text} . @var{right-text})}.")
267 (round-up-exceptions ,list? "A list of pairs where car is the numerator
268 and cdr the denominator of a moment. Each pair in this list means that
269 the multi-measure rests of the corresponding length will be rounded up to
270 the longer rest. See @var{round-up-to-longer-rest}.")
271 (expand-limit ,integer? "Maximum number of measures expanded in
274 (extra-dy ,number? "Slope glissandi this much extra.")
275 (extra-offset ,number-pair? "A pair representing an offset. This
276 offset is added just before outputting the symbol, so the typesetting
277 engine is completely oblivious to it. The values are measured in
278 @code{staff-space} units of the staff's @code{StaffSymbol}.")
279 (extra-spacing-height ,number-pair? "In the horizontal spacing
280 problem, we increase the height of each item by this amount (by adding
281 the @q{car} to the bottom of the item and adding the @q{cdr} to the
282 top of the item). In order to make a grob infinitely high (to prevent
283 the horizontal spacing problem from placing any other grobs above or
284 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
285 (extra-spacing-width ,number-pair? "In the horizontal spacing
286 problem, we pad each item by this amount (by adding the @q{car} on the
287 left side of the item and adding the @q{cdr} on the right side of the
288 item). In order to make a grob take up no horizontal space at all,
289 set this to @code{(+inf.0 . -inf.0)}.")
295 (flag-count ,number? "The number of tremolo beams.")
296 (flag-style ,symbol? "The style of the flag to be used with
297 @code{MetronomeMark}. Available are @code{'modern-straight-flag},
298 @code{'old-straight-flag}, @code{flat-flag}, @code{mensural} and
300 (flat-positions ,list? "Flats in key signatures are placed
301 within the specified ranges of staff-positions. The general form
302 is a list of pairs, with one pair for each type of clef, in order
303 of the staff-position at which each clef places C:
304 @code{(alto treble tenor soprano baritone mezzosoprano bass)}.
305 If the list contains a single element it applies for all clefs.
306 A single number in place of a pair sets accidentals within the octave
307 ending at that staff-position.")
308 (font-encoding ,symbol? "The font encoding is the broadest
309 category for selecting a font. Currently, only lilypond's system
310 fonts (Emmentaler) are using this property. Available
311 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces},
312 @code{fetaText} (Emmentaler).")
313 (font-family ,symbol? "The font family is the broadest category
314 for selecting text fonts. Options include: @code{sans},
316 (font-name ,string? "Specifies a file name (without extension) of
317 the font to load. This setting overrides selection using
318 @code{font-family}, @code{font-series} and @code{font-shape}.")
319 (font-series ,symbol? "Select the series of a font. Choices
320 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
321 (font-shape ,symbol? "Select the shape of a font. Choices
322 include @code{upright}, @code{italic}, @code{caps}.")
323 (font-size ,number? "The font size, compared to the
324 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
325 @w{@code{-1}} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
326 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
327 larger. If the context property @code{fontSize} is set, its value is
328 added to this before the glyph is printed. Fractional values are
330 (footnote ,boolean? "Should this be a footnote or in-note?")
331 (footnote-music ,ly:music? "Music creating a footnote.")
332 (footnote-text ,markup? "A footnote for the grob.")
333 (force-hshift ,number? "This specifies a manual shift for notes
334 in collisions. The unit is the note head width of the first voice
335 note. This is used by @rinternals{note-collision-interface}.")
336 (forced-spacing ,number? "Spacing forced between grobs, used in
337 various ligature engravers.")
338 (fraction ,fraction? "Numerator and denominator of a time
340 (french-beaming ,boolean? "Use French beaming style for this
341 stem. The stem stops at the innermost beams.")
342 (fret-diagram-details ,list? "An alist of detailed grob
343 properties for fret diagrams. Each alist entry consists of a
344 @code{(@var{property} . @var{value})} pair. The properties which can
345 be included in @code{fret-diagram-details} include the following:
349 @code{barre-type} -- Type of barre indication used. Choices include
350 @code{curved}, @code{straight}, and @code{none}. Default
353 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
354 fret-space. Default value@tie{}0.5.
356 @code{dot-color} -- Color of dots. Options include @code{black} and
357 @code{white}. Default @code{black}.
359 @code{dot-label-font-mag} -- Magnification for font used to label fret
360 dots. Default value@tie{}1.
362 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
363 dots without labels, 0.95-@code{dot-radius} for dots with labels.
365 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
366 value 0.425 for labeled dots, 0.25 for unlabeled dots.
368 @code{finger-code} -- Code for the type of fingering indication used.
369 Options include @code{none}, @code{in-dot}, and @code{below-string}.
370 Default @code{none} for markup fret diagrams, @code{below-string} for
371 @code{FretBoards} fret diagrams.
373 @code{fret-count} -- The number of frets. Default@tie{}4.
375 @code{fret-label-custom-format} -- The format string to be used label
376 the lowest fret number, when @code{number-type} equals to
377 @code{custom}. Default@tie{}\"~a\".
379 @code{fret-label-font-mag} -- The magnification of the font used to
380 label the lowest fret number. Default@tie{}0.5.
382 @code{fret-label-vertical-offset} -- The offset of the fret label from
383 the center of the fret in direction parallel to strings.
386 @code{fret-label-horizontal-offset} -- The offset of the fret label from
387 the center of the fret in direction orthogonal to strings.
390 @code{paren-padding} -- The padding for the parenthesis.
393 @code{label-dir} -- Side to which the fret label is attached.
394 @w{@code{-1}}, @code{LEFT}, or @code{DOWN} for left or down; @code{1},
395 @code{RIGHT}, or @code{UP} for right or up. Default @code{RIGHT}.
397 @code{mute-string} -- Character string to be used to indicate muted
398 string. Default @code{\"x\"}.
400 @code{number-type} -- Type of numbers to use in fret label. Choices
401 include @code{roman-lower}, @code{roman-upper}, @code{arabic} and
402 @code{custom}. In the later case, the format string is supplied by
403 the @code{fret-label-custom-format} property.
404 Default @code{roman-lower}.
406 @code{open-string} -- Character string to be used to indicate open
407 string. Default @code{\"o\"}.
409 @code{orientation} -- Orientation of fret-diagram. Options include
410 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
411 Default @code{normal}.
413 @code{string-count} -- The number of strings. Default@tie{}6.
415 @code{string-label-font-mag} -- The magnification of the font used to
416 label fingerings at the string, rather than in the dot. Default value
417 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
418 @code{opposing-landscape}.
420 @code{string-thickness-factor} -- Factor for changing thickness of
421 each string in the fret diagram. Thickness of string @var{k} is given
423 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
426 @code{top-fret-thickness} -- The thickness of the top fret line, as a
427 multiple of the standard thickness. Default value@tie{}3.
429 @code{xo-font-magnification} -- Magnification used for mute and open
430 string indicators. Default value@tie{}0.5.
432 @code{xo-padding} -- Padding for open and mute indicators from top
433 fret. Default value 0.25.
435 ;; ugh: double, change.
436 (full-length-padding ,number? "How much padding to use at the
437 right side of a full-length tuplet bracket.")
438 (full-length-to-extent ,boolean? "Run to the extent of the column
439 for a full-length tuplet bracket.")
440 (full-measure-extra-space ,number? "Extra space that is allocated
441 at the beginning of a measure with only one note. This property is
442 read from the NonMusicalPaperColumn that begins the measure.")
443 (full-size-change ,boolean? "Don't make a change clef smaller.")
449 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
450 (gap-count ,integer? "Number of gapped beams for tremolo.")
451 (glissando-skip ,boolean? "Should this @code{NoteHead} be skipped
453 (glyph ,string? "A string determining what @q{style} of glyph is
454 typeset. Valid choices depend on the function that is reading this
457 In combination with (span) bar lines, it is a string resembling the
458 bar line appearance in ASCII form.")
459 (glyph-name ,string? "The glyph name within the font.
461 In the context of (span) bar lines, @var{glyph-name} represents
462 a processed form of @code{glyph}, where decisions about line breaking
463 etc. are already taken.")
464 (glyph-name-alist ,list? "An alist of key-string pairs.")
465 (graphical ,boolean? "Display in graphical (vs. text) form.")
466 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
472 (hair-thickness ,number? "Thickness of the thin line in a bar
473 line, expressed as a multiple of the default staff-line
474 thickness (i.e. the visual output is @emph{not} influenced by changes
475 to @code{@var{Staff}.StaffSymbol.thickness}).")
476 (harp-pedal-details ,list? "An alist of detailed grob properties
477 for harp pedal diagrams. Each alist entry consists of a
478 @code{(@var{property} . @var{value})} pair. The properties which can
479 be included in harp-pedal-details include the following:
483 @code{box-offset} -- Vertical shift of the center of flat/@/sharp pedal
484 boxes above/@/below the horizontal line. Default value@tie{}0.8.
486 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
488 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
490 @code{space-before-divider} -- Space between boxes before the first
491 divider (so that the diagram can be made symmetric). Default
494 @code{space-after-divider} -- Space between boxes after the first
495 divider. Default value@tie{}0.8.
497 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
498 of the ellipse around circled pedals. Default value@tie{}0.5.
500 @code{circle-x-padding} -- Padding in X direction of the ellipse
501 around circled pedals. Default value 0.15.
503 @code{circle-y-padding} -- Padding in Y direction of the ellipse
504 around circled pedals. Default value@tie{}0.2.
506 (head-direction ,ly:dir? "Are the note heads left or right in a
508 (height ,ly:dimension? "Height of an object in @code{staff-space}
510 (height-limit ,ly:dimension? "Maximum slur height: The longer the
511 slur, the closer it is to this height.")
512 (hide-tied-accidental-after-break ,boolean? "If set, an accidental
513 that appears on a tied note after a line break will not be displayed.")
514 (horizon-padding ,number? "The amount to pad the axis
515 along which a @code{Skyline} is built for the
516 @code{side-position-interface}.")
517 (horizontal-shift ,integer? "An integer that identifies ranking
518 of @code{NoteColumn}s for horizontal shifting. This is used by
519 @rinternals{note-collision-interface}.")
520 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
521 left and one to the right of this grob.")
527 (id ,string? "An id string for the grob.")
528 (ignore-ambitus ,boolean? "If set, don't consider this notehead
529 for ambitus calculation.")
530 (ignore-collision ,boolean? "If set, don't do note collision
531 resolution on this @code{NoteColumn}.")
532 (implicit ,boolean? "Is this an implicit bass figure?")
533 (inspect-index ,integer? "If debugging is set, set beam and slur
534 configuration to this index, and print the respective scores.")
535 (inspect-quants ,number-pair? "If debugging is set, set beam and
536 slur quants to this position, and print the respective scores.")
542 (keep-inside-line ,boolean? "If set, this column cannot have
543 objects sticking into the margin.")
544 (kern ,ly:dimension? "The space between individual elements
545 in any compound bar line, expressed as a multiple of the default
546 staff-line thickness (i.e. the visual output is @emph{not}
547 influenced by changes to
548 @code{@var{Staff}.StaffSymbol.thickness}).")
549 (knee ,boolean? "Is this beam kneed?")
550 (knee-spacing-correction ,number? "Factor for the optical
551 correction amount for kneed beams. Set between @code{0} for no
552 correction and @code{1} for full correction.")
553 (knee-to-beam ,boolean? "Determines whether a tuplet number
554 will be positioned next to a kneed beam.")
560 (labels ,list? "List of labels (symbols) placed on a column.")
561 (layer ,integer? "An integer which determines the order of printing
562 objects. Objects with the lowest value of layer are drawn first, then
563 objects with progressively higher values are drawn, so objects with
564 higher values overwrite objects with lower values. By default most
565 objects are assigned a layer value of 1.")
566 (ledger-extra ,ly:dimension? "Extra distance from staff line to draw ledger
568 (ledger-line-thickness ,number-pair? "The thickness of ledger
569 lines. It is the sum of 2@tie{}numbers: The first is the factor for
570 line thickness, and the second for staff space. Both contributions
572 (ledger-positions ,list? "Vertical positions of ledger lines.
573 When set on a @code{StaffSymbol} grob it defines a repeating
574 pattern of ledger lines and any parenthesized groups will always be
576 (ledger-positions-function ,scheme? "A quoted Scheme procedure that
577 takes a @code{StaffSymbol} grob and the vertical position of a note head
578 as arguments and returns a list of ledger line positions.")
579 (left-bound-info ,list? "An alist of properties for determining
580 attachments of spanners to edges.")
581 (left-padding ,ly:dimension? "The amount of space that is put
582 left to an object (e.g., a lyric extender).")
583 (length ,ly:dimension? "User override for the stem length of
585 (length-fraction ,number? "Multiplier for lengths. Used for
586 determining ledger lines and stem lengths.")
587 (line-break-penalty ,number? "Penalty for a line break at this
588 column. This affects the choices of the line breaker; it avoids a
589 line break at a column with a positive penalty and prefers a line
590 break at a column with a negative penalty.")
591 (line-break-permission ,symbol? "Instructs the line breaker on
592 whether to put a line break at this column. Can be @code{force} or
594 (line-break-system-details ,list? "An alist of properties to use
595 if this column is the start of a system.")
596 (line-count ,integer? "The number of staff lines.")
597 (line-positions ,list? "Vertical positions of staff lines.")
598 (line-thickness ,number? "For slurs and ties, this is the
599 diameter of the virtual @qq{pen} that draws the two arcs of the
600 curve's outline, which intersect at the endpoints. This property is
601 expressed as a multiple of the current staff-line thickness (i.e. the
602 visual output is influenced by changes to
603 @code{@var{Staff}.StaffSymbol.thickness}).")
604 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
610 (max-beam-connect ,integer? "Maximum number of beams to connect
611 to beams from this stem. Further beams are typeset as beamlets.")
612 (maximum-gap ,number? "Maximum value allowed for @code{gap}
614 (measure-count ,integer? "The number of measures for a
615 multi-measure rest.")
616 (measure-length ,ly:moment? "Length of a measure. Used in some
617 spacing situations.")
618 (merge-differently-dotted ,boolean? "Merge note heads in
619 collisions, even if they have a different number of dots. This is
620 normal notation for some types of polyphonic music.
622 @code{merge-differently-dotted} only applies to opposing stem
623 directions (i.e., voice 1 &@tie{}2).")
624 (merge-differently-headed ,boolean? "Merge note heads in
625 collisions, even if they have different note heads. The smaller of
626 the two heads is rendered invisible. This is used in polyphonic
627 guitar notation. The value of this setting is used by
628 @rinternals{note-collision-interface}.
630 @code{merge-differently-headed} only applies to opposing stem
631 directions (i.e., voice 1 &@tie{}2).")
632 (minimum-distance ,ly:dimension? "Minimum distance between rest
634 (minimum-length ,ly:dimension? "Try to make a spanner at least
635 this long, normally in the horizontal direction. This requires an
636 appropriate callback for the @code{springs-and-rods} property. If
637 added to a @code{Tie}, this sets the minimum distance between
639 (minimum-length-after-break ,ly:dimension? "If set, try to make
640 a broken spanner starting a line this long. This requires an
641 appropriate callback for the @code{springs-and-rods} property. If
642 added to a @code{Tie}, this sets the minimum distance to the
644 (minimum-length-fraction ,number? "Minimum length of ledger line
645 as fraction of note head size.")
646 (minimum-space ,ly:dimension? "Minimum distance that the victim
647 should move (after padding).")
648 (minimum-X-extent ,number-pair? "Minimum size of an object in
649 X@tie{}dimension, measured in @code{staff-space} units.")
650 (minimum-Y-extent ,number-pair? "Minimum size of an object in
651 Y@tie{}dimension, measured in @code{staff-space} units.")
657 (neutral-direction ,ly:dir? "Which direction to take in the
658 center of the staff.")
659 (neutral-position ,number? "Position (in half staff spaces) where
660 to flip the direction of custos stem.")
661 (next ,ly:grob? "Object that is next relation (e.g., the lyric
662 syllable following an extender).")
663 (no-alignment ,boolean? "If set, don't place this grob in a
664 @code{VerticalAlignment}; rather, place it using its own
665 @code{Y-offset} callback.")
666 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
668 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
669 get stems extending to the middle staff line.")
670 (non-break-align-symbols ,list? "A list of symbols that determine
671 which NON-break-aligned interfaces to align this to.")
672 (non-default ,boolean? "Set for manually specified clefs and keys.")
673 (non-musical ,boolean? "True if the grob belongs to a
674 @code{NonMusicalPaperColumn}.")
675 (nonstaff-nonstaff-spacing ,list? "The spacing alist
676 controlling the distance between the current non-staff line and
677 the next non-staff line in the direction of @code{staff-affinity},
678 if both are on the same side of the related staff, and
679 @code{staff-affinity} is either @code{UP} or @code{DOWN}. See
680 @code{staff-staff-spacing} for a description of the alist
682 (nonstaff-relatedstaff-spacing ,list? "The spacing alist
683 controlling the distance between the current non-staff line and
684 the nearest staff in the direction of @code{staff-affinity}, if
685 there are no non-staff lines between the two, and
686 @code{staff-affinity} is either @code{UP} or @code{DOWN}. If
687 @code{staff-affinity} is @code{CENTER}, then
688 @code{nonstaff-relatedstaff-spacing} is used for the nearest
689 staves on @emph{both} sides, even if other non-staff lines appear
690 between the current one and either of the staves. See
691 @code{staff-staff-spacing} for a description of the alist
693 (nonstaff-unrelatedstaff-spacing ,list? "The spacing alist
694 controlling the distance between the current non-staff line and
695 the nearest staff in the opposite direction from
696 @code{staff-affinity}, if there are no other non-staff lines
697 between the two, and @code{staff-affinity} is either @code{UP} or
698 @code{DOWN}. See @code{staff-staff-spacing} for a description of
699 the alist structure.")
700 (normalized-endpoints ,pair? "Represents left and right placement
701 over the total spanner, where the width of the spanner is normalized
703 (note-names ,vector? "Vector of strings containing names for
704 easy-notation note heads.")
705 (note-collision-threshold ,ly:dimension? "Simultaneous notes that
706 are this close or closer in units of @code{staff-space} will be
707 identified as vertically colliding. Used by @code{Stem} grobs for notes
708 in the same voice, and @code{NoteCollision} grobs for notes in
709 different voices. Default value@tie{}1.")
710 (number-type ,symbol? "Numbering style. Choices include
711 @code{roman-lower}, @code{roman-upper} and @code{arabic}.")
717 (output-attributes ,list? "An alist of attributes for the grob, to
718 be included in output files. When the SVG typesetting backend is used,
719 the attributes are assigned to a group (<g>) containing all of the
720 stencils that comprise a given grob. For example,
721 @code{'((id . 123) (class . foo) (data-whatever . @qq{bar}))} will produce
722 @code{<g id=@qq{123} class=@qq{foo} data-whatever=@qq{bar}> @dots{} </g>}.
723 In the Postscript backend, where there is no way to group items, the
724 setting of the output-attributes property will have no effect.")
725 (outside-staff-horizontal-padding ,number? "By default, an
726 outside-staff-object can be placed so that is it very close to another
727 grob horizontally. If this property is set, the outside-staff-object
728 is raised so that it is not so close to its neighbor.")
729 (outside-staff-padding ,number? "The padding to place between
730 grobs when spacing according to @code{outside-staff-priority}.
731 Two grobs with different @code{outside-staff-padding} values have
732 the larger value of padding between them.")
733 (outside-staff-placement-directive ,symbol? "One of four directives
734 telling how outside staff objects should be placed.
737 @code{left-to-right-greedy} -- Place each successive grob from left to
740 @code{left-to-right-polite} -- Place a grob from left to right only if
741 it does not potentially overlap with another grob that has been placed
742 on a pass through a grob array. If there is overlap, do another pass to
745 @code{right-to-left-greedy} -- Same as @code{left-to-right-greedy}, but
748 @code{right-to-left-polite} -- Same as @code{left-to-right-polite}, but
751 (outside-staff-priority ,number? "If set, the grob is positioned
752 outside the staff in such a way as to avoid all collisions. In case
753 of a potential collision, the grob with the smaller
754 @code{outside-staff-priority} is closer to the staff.")
760 (packed-spacing ,boolean? "If set, the notes are spaced as
761 tightly as possible.")
762 (padding ,ly:dimension? "Add this much extra space between
763 objects that are next to each other.")
764 (padding-pairs ,list? "An alist mapping @code{(@var{name}
765 . @var{name})} to distances.")
766 (page-break-penalty ,number? "Penalty for page break at this
767 column. This affects the choices of the page breaker; it avoids a
768 page break at a column with a positive penalty and prefers a page
769 break at a column with a negative penalty.")
770 (page-break-permission ,symbol? "Instructs the page breaker on
771 whether to put a page break at this column. Can be @code{force} or
773 (page-turn-penalty ,number? "Penalty for a page turn at this
774 column. This affects the choices of the page breaker; it avoids a
775 page turn at a column with a positive penalty and prefers a page turn
776 at a column with a negative penalty.")
777 (page-turn-permission ,symbol? "Instructs the page breaker on
778 whether to put a page turn at this column. Can be @code{force} or
780 (parent-alignment-X ,number? "Specify on which point
781 of the parent the object is aligned. The value @w{@code{-1}} means
782 aligned on parent's left edge, @code{0}@tie{}on@tie{}center, and
783 @code{1}@tie{}right edge, in X@tie{}direction. Other numerical
784 values may also be specified - the unit is half the parent's width.
785 If unset, the value from @code{self-alignment-X} property will be
787 (parent-alignment-Y ,number? "Like @code{parent-alignment-X}
788 but for the Y@tie{}axis.")
789 (parenthesis-friends ,list? "A list of Grob types, as symbols.
790 When parentheses enclose a Grob that has 'parenthesis-friends, the
791 parentheses widen to include any child Grobs with type among
792 'parenthesis-friends.")
793 (parenthesized ,boolean? "Parenthesize this grob.")
794 (positions ,number-pair? "Pair of staff coordinates
795 @code{(@var{left} . @var{right})}, where both @var{left} and
796 @var{right} are in @code{staff-space} units of the current staff. For
797 slurs, this value selects which slur candidate to use; if extreme
798 positions are requested, the closest one is taken.")
799 (prefer-dotted-right ,boolean? "For note collisions, prefer to
800 shift dotted up-note to the right, rather than shifting just the
802 (protrusion ,number? "In an arpeggio bracket, the length of the
808 (ratio ,number? "Parameter for slur shape. The higher this
809 number, the quicker the slur attains its @code{height-limit}.")
810 (remove-empty ,boolean? "If set, remove group if it contains no
812 (remove-first ,boolean? "Remove the first staff of an orchestral
814 (remove-layer ,key? "When set as a positive integer, the
815 @code{Keep_alive_together_engraver} removes all
816 @code{VerticalAxisGroup} grobs with a @code{remove-layer} larger than
817 the smallest retained @code{remove-layer}. Set to @code{#f} to make a
818 layer independent of the @code{Keep_alive_together_engraver}. Set to
819 @code{'()}, the layer does not participate in the layering decisions.
820 The property can also be set as a symbol for common behaviors:
821 @code{#'any} to keep the layer alive with any other layer in the
822 group; @code{#'above} or @code{#'below} to keep the layer alive with
823 the context immediately before or after it, respectively.")
824 (replacement-alist ,list? "Alist of strings.
825 The key is a string of the pattern to be replaced. The value is a
826 string of what should be displayed. Useful for ligatures.")
827 (restore-first ,boolean? "Print a natural before the
829 (rhythmic-location ,rhythmic-location? "Where (bar number,
830 measure position) in the score.")
831 (right-bound-info ,list? "An alist of properties for determining
832 attachments of spanners to edges.")
833 (right-padding ,ly:dimension? "Space to insert on the right side
834 of an object (e.g., between note and its accidentals).")
835 (rotation ,list? "Number of degrees to rotate this object, and
836 what point to rotate around. For example, @code{'(45 0 0)} rotates
837 by 45 degrees around the center of this object.")
838 (rounded ,boolean? "Decide whether lines should be drawn rounded or not.")
839 (round-up-to-longer-rest ,boolean? "Displays the longer multi-measure
840 rest when the length of a measure is between two values of
841 @code{usable-duration-logs}. For example, displays a breve instead of a whole
848 (same-direction-correction ,number? "Optical correction amount
849 for stems that are placed in tight configurations. This amount is
850 used for stems with the same direction to compensate for note head to
852 (script-priority ,number? "A key for determining the order of
853 scripts in a stack, by being added to the position of the script in
854 the user input, the sum being the overall priority. Smaller means
855 closer to the head.")
856 (segno-kern ,number? "The space between the two thin lines
857 of the segno bar line symbol, expressed as a multiple of the
858 default staff-line thickness (i.e. the visual output is @emph{not}
859 influenced by changes to
860 @code{@var{Staff}.StaffSymbol.thickness}).")
861 (self-alignment-X ,number? "Specify alignment of an object. The
862 value @w{@code{-1}} means left aligned, @code{0}@tie{}centered, and
863 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
864 values may also be specified - the unit is half the object width.")
865 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
867 (shape ,symbol? "This setting determines what shape a grob
868 has. Valid choices depend on the @code{stencil} callback reading
870 (sharp-positions ,list? "Sharps in key signatures are placed
871 within the specified ranges of staff-positions. The general form
872 is a list of pairs, with one pair for each type of clef, in order
873 of the staff-position at which each clef places C:
874 @code{(alto treble tenor soprano baritone mezzosoprano bass)}.
875 If the list contains a single element it applies for all clefs.
876 A single number in place of a pair sets accidentals within the octave
877 ending at that staff-position.")
878 (shorten-pair ,number-pair? "The lengths to shorten a
879 text-spanner on both sides, for example a pedal bracket. Positive
880 values shorten the text-spanner, while negative values lengthen it.")
881 (shortest-duration-space ,number? "Start with this multiple of
882 @code{spacing-increment} space for the shortest duration. See also
883 @rinternals{spacing-spanner-interface}.")
884 (shortest-playing-duration ,ly:moment? "The duration of the
885 shortest note playing here.")
886 (shortest-starter-duration ,ly:moment? "The duration of the
887 shortest note that starts here.")
888 (side-axis ,number? "If the value is @code{X} (or
889 equivalently@tie{}@code{0}), the object is placed horizontally next to
890 the other object. If the value is @code{Y} or@tie{}@code{1}, it is
892 (side-relative-direction ,ly:dir? "Multiply direction of
893 @code{direction-source} with this to get the direction of this
895 (simple-Y ,boolean? "Should the Y placement of a spanner
896 disregard changes in system heights?")
897 (size ,number? "The ratio of the size of the object to its default
899 (skip-quanting ,boolean? "Should beam quanting be skipped?")
900 (skyline-horizontal-padding ,number? "For determining the
901 vertical distance between two staves, it is possible to have a
902 configuration which would result in a tight interleaving of grobs from
903 the top staff and the bottom staff. The larger this parameter is, the
904 farther apart the staves are placed in such a configuration.")
905 (skyline-vertical-padding ,number? "The amount by which the left
906 and right skylines of a column are padded vertically, beyond the
907 @code{Y-extent}s and @code{extra-spacing-height}s of the constituent
908 grobs in the column. Increase this to prevent interleaving of grobs
909 from adjacent columns.")
910 (slash-negative-kern ,number? "The space to remove between
911 slashes in percent repeat glyphs. Larger values bring the two
912 elements closer together.")
913 (slope ,number? "The slope of this object.")
914 (slur-padding ,number? "Extra distance between slur and script.")
915 (snap-radius ,number? "The maximum distance between two objects that
916 will cause them to snap to alignment along an axis.")
917 (space-alist ,list? "An alist that specifies distances from this
918 grob to other breakable items, using the format:
921 '((@var{break-align-symbol} . (@var{spacing-style} . @var{space}))
922 (@var{break-align-symbol} . (@var{spacing-style} . @var{space}))
926 Standard choices for @w{@code{@var{break-align-symbol}}} are listed in
927 @rinternals{break-alignment-interface}. Additionally, three special
928 @w{break-align} symbols available to @w{@code{space-alist}} are:
933 used when the grob is just left of the first note on a line
936 used when the grob is just left of any other note;
937 if not set, the value of @code{first-note} gets used
940 used when the grob is the last item on the line (only compatible with
941 the @w{@code{extra-space}} spacing style)
945 Choices for @code{@var{spacing-style}} are:
950 Put this much space between the two grobs. The space is stretchable
951 when paired with @w{@code{first-note}} or @w{@code{next-note}};
952 otherwise it is fixed.
955 Put at least this much space between the left sides of both grobs,
956 without allowing them to collide. The space is stretchable when paired
957 with @w{@code{first-note}} or @w{@code{next-note}}; otherwise it
958 is fixed. Not compatible with @w{@code{right-edge}}.
961 Only compatible with @w{@code{first-note}} and
962 @w{@code{next-note}}. Put this much fixed space between the grob
965 @item minimum-fixed-space
966 Only compatible with @w{@code{first-note}} and
967 @w{@code{next-note}}. Put at least this much fixed space between
968 the left side of the grob and the left side of the note, without
969 allowing them to collide.
971 @item semi-fixed-space
972 Only compatible with @w{@code{first-note}} and
973 @w{@code{next-note}}. Put this much space between the grob and
974 the note, such that half of the space is fixed and half is
979 Rules for this spacing are much more complicated than this.
980 See [Wanske] page 126--134, [Ross] page 143--147.")
981 (space-to-barline ,boolean? "If set, the distance between a note
982 and the following non-musical column will be measured to the bar line
983 instead of to the beginning of the non-musical column. If there is a
984 clef change followed by a bar line, for example, this means that we
985 will try to space the non-musical column as though the clef is not
987 (spacing-increment ,ly:dimension? "The unit of length for
988 note-spacing. Typically, the width of a note head. See also
989 @rinternals{spacing-spanner-interface}.")
990 (spacing-pair ,pair? "A pair of alignment symbols which set an object's
991 spacing relative to its left and right @code{BreakAlignment}s.
993 For example, a @code{MultiMeasureRest} will ignore prefatory items at its
994 bounds (i.e., clefs, key signatures and time signatures) using the following
998 \\override MultiMeasureRest
999 #'spacing-pair = #'(staff-bar . staff-bar)
1001 (spanner-id ,key? "An identifier to distinguish concurrent spanners.")
1002 (springs-and-rods ,boolean? "Dummy variable for triggering
1004 (stacking-dir ,ly:dir? "Stack objects in which direction?")
1005 (staff-affinity ,ly:dir? "The direction of the staff to use
1006 for spacing the current non-staff line. Choices are @code{UP},
1007 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff
1008 line will be placed equidistant between the two nearest staves on
1009 either side, unless collisions or other spacing constraints
1010 prevent this. Setting @code{staff-affinity} for a staff causes it
1011 to be treated as a non-staff line. Setting @code{staff-affinity}
1012 to @code{#f} causes a non-staff line to be treated as a staff.")
1013 (staff-padding ,ly:dimension? "Maintain this much space between
1014 reference points and the staff. Its effect is to align objects of
1015 differing sizes (like the dynamics @b{p} and @b{f}) on their
1017 (staff-position ,number? "Vertical position, measured in half
1018 staff spaces, counted from the middle line.")
1019 (staff-space ,ly:dimension? "Amount of space between staff lines,
1020 expressed in global @code{staff-space}.")
1021 (staff-staff-spacing ,list? "When applied to a staff-group's
1022 @code{StaffGrouper} grob, this spacing alist controls the distance
1023 between consecutive staves within the staff-group. When applied
1024 to a staff's @code{VerticalAxisGroup} grob, it controls the
1025 distance between the staff and the nearest staff below it in the
1026 same system, replacing any settings inherited from the
1027 @code{StaffGrouper} grob of the containing staff-group, if there
1028 is one. This property remains in effect even when non-staff lines
1029 appear between staves. The alist can contain the following keys:
1034 @code{basic-distance} -- the vertical distance, measured in
1035 staff-spaces, between the reference points of the two items when
1036 no collisions would result, and no stretching or compressing is in
1040 @code{minimum-distance} -- the smallest allowable vertical
1041 distance, measured in staff-spaces, between the reference points
1042 of the two items, when compressing is in effect.
1045 @code{padding} -- the minimum required amount of unobstructed
1046 vertical whitespace between the bounding boxes (or skylines) of
1047 the two items, measured in staff-spaces.
1050 @code{stretchability} -- a unitless measure of the dimension's
1051 relative propensity to stretch. If zero, the distance will not
1052 stretch (unless collisions would result).
1055 (staffgroup-staff-spacing ,list? "The spacing alist
1056 controlling the distance between the last staff of the current
1057 staff-group and the staff just below it in the same system, even
1058 if one or more non-staff lines exist between the two staves. If
1059 the @code{staff-staff-spacing} property of the staff's
1060 @code{VerticalAxisGroup} grob is set, that is used instead. See
1061 @code{staff-staff-spacing} for a description of the alist
1063 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
1064 pair where the stem attaches to the notehead.")
1065 (stem-begin-position ,number? "User override for the
1066 begin position of a stem.")
1068 (stem-spacing-correction ,number? "Optical correction amount for
1069 stems that are placed in tight configurations. For opposite
1070 directions, this amount is the correction for two normal sized stems
1071 that overlap completely.")
1072 (stemlet-length ,number? "How long should be a stem over a
1074 (stencil ,ly:stencil? "The symbol to print.")
1075 (stencils ,list? "Multiple stencils, used as intermediate
1077 (strict-grace-spacing ,boolean? "If set, main notes are spaced
1078 normally, then grace notes are put left of the musical columns for the
1080 (strict-note-spacing ,boolean? "If set, unbroken columns with
1081 non-musical material (clefs, bar lines, etc.) are not spaced
1082 separately, but put before musical columns.")
1083 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
1085 (style ,symbol? "This setting determines in what style a grob is
1086 typeset. Valid choices depend on the @code{stencil} callback reading
1093 (text ,markup? "Text markup. See @ruser{Formatting text}.")
1094 ;;FIXME -- Should both be the same?
1095 (text-direction ,ly:dir? "This controls the ordering of the
1096 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
1097 should use @code{LEFT}.")
1098 (thick-thickness ,number? "Thickness of the thick line in a
1099 bar line, expressed as a multiple of the default staff-line
1100 thickness (i.e. the visual output is @emph{not} influenced by
1101 changes to @code{@var{Staff}.StaffSymbol.thickness}).")
1102 (thickness ,number? "For grobs made up of lines, this is the
1103 thickness of the line. For slurs and ties, this is the distance
1104 between the two arcs of the curve's outline at its thickest point,
1105 not counting the diameter of the virtual @qq{pen} that draws the
1106 arcs. This property is expressed as a multiple of the current
1107 staff-line thickness (i.e. the visual output is influenced by
1108 changes to @code{@var{Staff}.StaffSymbol.thickness}).")
1109 (tie-configuration ,list? "List of @code{(@var{position} .
1110 @var{dir})} pairs, indicating the desired tie configuration, where
1111 @var{position} is the offset from the center of the staff in staff
1112 space and @var{dir} indicates the direction of the tie (@code{1}=>up,
1113 @w{@code{-1}}=>down, @code{0}=>center). A non-pair entry
1114 in the list causes the corresponding tie to be formatted
1116 (to-barline ,boolean? "If true, the spanner will stop at the bar
1117 line just before it would otherwise stop.")
1118 (toward-stem-shift ,number? "Amount by which scripts are shifted
1119 toward the stem if their direction coincides with the stem direction.
1120 @code{0.0} means centered on the note head (the default position of
1121 most scripts); @code{1.0} means centered on the stem. Interpolated
1122 values are possible.")
1123 (toward-stem-shift-in-column ,number? "Amount by which a script
1124 is shifted toward the stem if its direction coincides with the stem
1125 direction and it is associated with a @code{ScriptColumn} object.
1126 @code{0.0} means centered on the note head (the default position of
1127 most scripts); @code{1.0} means centered on the stem. Interpolated
1128 values are possible.")
1129 (transparent ,boolean? "This makes the grob invisible.")
1135 (uniform-stretching ,boolean? "If set, items stretch
1136 proportionally to their natural separation based on durations.
1137 This looks better in complex polyphonic patterns.")
1138 (used ,boolean? "If set, this spacing column is kept in the
1140 (usable-duration-logs ,list? "List of @code{duration-log}s that
1141 can be used in typesetting the grob.")
1142 (use-skylines ,boolean? "Should skylines be used for side
1148 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
1149 one below this grob.")
1150 (voiced-position ,number? "The staff-position of a voiced
1151 @code{Rest}, negative if the rest has @code{direction} @code{DOWN}.")
1156 (when ,ly:moment? "Global time step associated with this column.")
1157 (whiteout ,boolean-or-number? "If a number or true, the grob is
1158 printed over a white background to white-out underlying material, if
1159 the grob is visible. A number indicates how far the white background
1160 extends beyond the bounding box of the grob as a multiple of the
1161 staff-line thickness. The shape of the background is determined by
1162 @code{whiteout-style}. Usually @code{#f} by default.")
1163 (whiteout-style ,symbol? "Determines the shape of the
1164 @code{whiteout} background. Available are @code{'outline},
1165 @code{'rounded-box}, and the default @code{'box}.")
1166 (width ,ly:dimension? "The width of a grob measured in staff
1168 (word-space ,ly:dimension? "Space to insert between words in
1175 (X-align-on-main-noteheads ,boolean? "If true, this grob will
1176 ignore suspended noteheads when aligning itself on NoteColumn.")
1177 (X-extent ,number-pair? "Extent (size) in the X@tie{}direction,
1178 measured in staff-space units, relative to object's reference point.")
1179 (X-offset ,number? "The horizontal amount that this object is
1180 moved relative to its X-parent.")
1181 (X-positions ,number-pair? "Pair of X staff coordinates of a spanner
1182 in the form @code{(@var{left} . @var{right})}, where both @var{left} and
1183 @var{right} are in @code{staff-space} units of the current staff.")
1189 (Y-extent ,number-pair? "Extent (size) in the Y@tie{}direction,
1190 measured in staff-space units, relative to object's reference point.")
1191 (Y-offset ,number? "The vertical amount that this object is moved
1192 relative to its Y-parent.")
1197 (zigzag-length ,ly:dimension? "The length of the lines of a
1198 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
1199 gives 60-degree zigzags.")
1200 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
1201 This number is adjusted slightly so that the glissando line can be
1202 constructed from a whole number of squiggles.")
1210 (define (define-internal-grob-property symbol type? description)
1211 (define-grob-property symbol type? description)
1212 (set-object-property! symbol 'backend-internal #t)
1217 (define-public all-internal-grob-properties
1220 (apply define-internal-grob-property x))
1224 ;; grobs & grob arrays. (alphabetical)
1225 (accidental-grob ,ly:grob? "The accidental for this note.")
1226 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
1227 @var{groblist})} entries.")
1228 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring
1230 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its
1231 function is to protect objects from being garbage collected.")
1232 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
1233 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
1235 (bars ,ly:grob-array? "An array of bar line pointers.")
1236 (beam ,ly:grob? "A pointer to the beam, if applicable.")
1237 (beam-segments ,list? "Internal representation of beam segments.")
1238 (bound-alignment-interfaces ,list "Interfaces to be used
1239 for positioning elements that align with a column.")
1240 (bounded-by-me ,ly:grob-array? "An array of spanners that have this
1241 column as start/@/begin point. Only columns that have grobs or act as
1242 bounds are spaced.")
1243 (bracket ,ly:grob? "The bracket for a number.")
1245 (c0-position ,integer? "An integer indicating the position of
1247 (columns ,ly:grob-array? "An array of grobs, typically containing
1248 @code{PaperColumn} or @code{NoteColumn} objects.")
1249 (concurrent-hairpins ,ly:grob-array? "All concurrent hairpins.")
1250 (conditional-elements ,ly:grob-array? "Internal use only.")
1251 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide
1254 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
1255 set, which grob to get the direction from.")
1256 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary grob?")
1257 (dot ,ly:grob? "A reference to a @code{Dots} object.")
1258 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
1260 (elements ,ly:grob-array? "An array of grobs; the type is depending on
1261 the grob where this is set in.")
1262 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
1263 in addition to notes and stems.")
1265 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
1266 (flag ,ly:grob? "A pointer to a @code{Flag} object.")
1267 (footnote-stencil ,ly:stencil? "The stencil of a system's footnotes.")
1268 (footnotes-before-line-breaking ,ly:grob-array? "Footnote grobs of
1270 (footnotes-after-line-breaking ,ly:grob-array? "Footnote grobs of
1273 (glissando-index ,integer? "The index of a glissando in its note
1275 (grace-spacing ,ly:grob? "A run of grace notes.")
1277 (has-span-bar ,pair? "A pair of grobs containing the span bars to
1278 be drawn below and above the staff. If no span bar is in a position,
1279 the respective element is set to @code{#f}.")
1280 (heads ,ly:grob-array? "An array of note heads.")
1282 (items-worth-living ,ly:grob-array? "An array of interesting items. If
1283 empty in a particular staff, then that staff is erased.")
1284 (in-note-direction ,ly:dir? "Direction to place in-notes above a system.")
1285 (in-note-padding ,number? "Padding between in-notes.")
1286 (in-note-stencil ,ly:stencil? "The stencil of a system's in-notes.")
1288 (keep-alive-with ,ly:grob-array? "An array of other
1289 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.")
1291 (left-items ,ly:grob-array? "Grobs organized on the left by a spacing
1293 (left-neighbor ,ly:grob? "The right-most column that has a spacing-wish
1296 (make-dead-when ,ly:grob-array? "An array of other
1297 @code{VerticalAxisGroup}s. If any of them are alive, then we will turn dead.")
1298 (melody-spanner ,ly:grob? "The @code{MelodyItem} object for a stem.")
1299 (minimum-translations-alist ,list? "An list of translations for a given
1300 start and end point.")
1302 (neighbors ,ly:grob-array? "The X-axis neighbors of a grob. Used by the
1303 pure-from-neighbor-interface to determine various grob heights.")
1305 (normal-stems ,ly:grob-array? "An array of visible stems.")
1306 (note-columns ,ly:grob-array? "An array of @code{NoteColumn} grobs.")
1307 (note-head ,ly:grob? "A single note head.")
1308 (note-heads ,ly:grob-array? "An array of note head grobs.")
1309 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
1311 (pure-relevant-grobs ,ly:grob-array? "All the grobs (items and spanners)
1312 that are relevant for finding the @code{pure-Y-extent}")
1313 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
1314 relevant for finding the @code{pure-Y-extent}.")
1315 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
1316 relevant for finding the @code{pure-Y-extent}.")
1317 (pure-Y-common ,ly:grob? "A cache of the
1318 @code{common_refpoint_of_array} of the @code{elements} grob set.")
1320 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
1321 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
1322 (rests ,ly:grob-array? "An array of rest objects.")
1323 (right-items ,ly:grob-array? "Grobs organized on the right by
1325 (right-neighbor ,ly:grob? "See @code{left-neighbor}.")
1327 (scripts ,ly:grob-array? "An array of @code{Script} objects.")
1328 (side-support-elements ,ly:grob-array? "The side support, an array of
1330 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
1331 (spacing ,ly:grob? "The spacing spanner governing this section.")
1332 (space-increment ,ly:dimension? "The amount by which the total duration
1333 of a multimeasure rest affects horizontal spacing. Each doubling of the
1334 duration adds @code{space-increment} to the length of the bar.")
1335 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing
1337 (span-start ,boolean? "Is the note head at the start of a spanner?")
1338 (spanner-broken ,boolean? "Indicates whether spanner
1339 alignment should be broken after the current spanner.")
1340 (spanner-placement ,ly:dir? "The place of an annotation on a spanner.
1341 @code{LEFT} is for the first spanner, and @code{RIGHT} is for the last.
1342 @code{CENTER} will place it on the broken spanner that falls closest to the
1343 center of the length of the entire spanner, although this behavior is
1344 unpredictable in situations with lots of rhythmic diversity. For predictable
1345 results, use @code{LEFT} and @code{RIGHT}.")
1346 (staff-grouper ,ly:grob? "The staff grouper we belong to.")
1347 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
1348 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
1349 (stems ,ly:grob-array? "An array of stem objects.")
1351 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
1352 (ties ,ly:grob-array? "A grob array of @code{Tie} objects.")
1353 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
1354 (tuplet-number ,ly:grob? "The number for a bracket.")
1355 (tuplet-start ,boolean? "Is stem at the start of a tuplet?")
1356 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.")
1358 (vertical-alignment ,ly:grob? "The VerticalAlignment in a System.")
1359 (vertical-skyline-elements ,ly:grob-array? "An array of grobs
1360 used to create vertical skylines.")
1362 (X-common ,ly:grob? "Common reference point for axis group.")
1363 (Y-common ,ly:grob? "See @code{X-common}.")
1367 (adjacent-pure-heights ,pair? "A pair of vectors. Used by a
1368 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
1371 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
1372 @code{FretBoard} be visible only at beginning of line or at
1375 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
1376 translator) that was the cause for this grob.")
1377 (cross-staff ,boolean? "True for grobs whose @code{Y-extent} depends on
1378 inter-staff spacing. The extent is measured relative to the grobs's parent
1379 staff (more generally, its @code{VerticalAxisGroup}) so this boolean flags
1380 grobs that are not rigidly fixed to their parent staff.
1381 Beams that join notes from two staves are @code{cross-staff}.
1382 Grobs that are positioned around such beams are also @code{cross-staff}.
1383 Grobs that are grouping objects, however, like @code{VerticalAxisGroups}
1384 will not in general be marked @code{cross-staff} when some of the members
1385 of the group are @code{cross-staff}.")
1387 (delta-position ,number? "The vertical position difference.")
1389 (font ,ly:font-metric? "A cached font metric object.")
1390 (forced ,boolean? "Manually forced accidental.")
1392 (head-width ,ly:dimension? "The width of this ligature head.")
1394 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
1395 @var{strength}))} pairs.")
1396 (important-column-ranks ,vector? "A cache of columns that contain
1397 @code{items-worth-living} data.")
1398 (interfaces ,list? "A list of symbols indicating the interfaces
1399 supported by this object. It is initialized from the @code{meta} field.")
1401 (least-squares-dy ,number? "The ideal beam slope, without damping.")
1403 (maybe-loose ,boolean? "Used to mark a breakable column that is
1404 loose if and only if it is in the middle of a line.")
1405 (meta ,list? "Provide meta information. It is an alist with the
1406 entries @code{name} and @code{interfaces}.")
1407 (minimum-distances ,list? "A list of rods that have the format
1408 @code{(@var{obj} . @var{dist})}.")
1410 (note-collision ,ly:grob? "The @code{NoteCollision} object of a
1412 (numbering-assertion-function ,scheme? "The function used to assert
1413 that footnotes are receiving correct automatic numbers.")
1415 (positioning-done ,boolean? "Used to signal that a positioning element
1416 did its job. This ensures that a positioning is only done once.")
1417 (pure-Y-extent ,number-pair? "The estimated height of a system.")
1418 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
1419 cyclic dependencies.")
1420 (quantize-position ,boolean? "If set, a vertical alignment is aligned
1421 to be within staff spaces.")
1422 (quantized-positions ,number-pair? "The beam positions after
1425 (script-column ,ly:grob? "A @code{ScriptColumn} associated with a
1426 @code{Script} object.")
1427 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
1428 acts as an index for looking up a @code{Stencil} object.")
1429 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
1430 Internally used to distribute beam shortening over stems.")
1431 (stem-info ,pair? "A cache of stem parameters.")
1432 (system-Y-offset ,number? "The Y-offset (relative to the bottom of the
1433 top-margin of the page) of the system to which this staff belongs.")
1440 ;; There are too many properties for ancient notation;
1441 ;; probably neume-types (a list of symbols) would also work.
1443 ;; However, such a list would consist of a couple of dozens of
1444 ;; entries, since head prefixes may be combined in many ways. If
1445 ;; the macros in `gregorian.ly' would directly set prefix-set,
1446 ;; all the head prefixes could be junked; however, such macros
1447 ;; would be quite numerous, I guess. --jr
1449 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1451 (add-join ,boolean? "Is this ligature head-joined with the next one
1452 by a vertical line?")
1453 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1454 an additional stem on the right side?")
1455 (ascendens ,boolean? "Is this neume of ascending type?")
1456 (auctum ,boolean? "Is this neume liquescentically augmented?")
1458 (cavum ,boolean? "Is this neume outlined?")
1459 (context-info ,integer? "Within a ligature, the final glyph or shape of
1460 a head may be affected by the left and/@/or right neighbour head.
1461 @code{context-info} holds for each head such information about the left and
1462 right neighbour, encoded as a bit mask.")
1464 (deminutum ,boolean? "Is this neume deminished?")
1465 (descendens ,boolean? "Is this neume of descendent type?")
1467 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1468 grob (in @code{staff-space} units).")
1469 (flexa-interval ,integer? "The interval spanned by the two notes of a
1470 flexa shape (1 is a second, 7 is an octave).")
1471 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1472 ligature grob in (in @code{staff-space} units).")
1473 (ligature-flexa ,boolean? "request joining note to the previous one
1476 (inclinatum ,boolean? "Is this neume an inclinatum?")
1479 (linea ,boolean? "Attach vertical lines to this neume?")
1481 (oriscus ,boolean? "Is this neume an oriscus?")
1483 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1485 (prefix-set ,number? "A bit mask that holds all Gregorian head
1486 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1487 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1488 similar to a note head that is part of a ligature.")
1490 (quilisma ,boolean? "Is this neume a quilisma?")
1492 (stropha ,boolean? "Is this neume a stropha?")
1494 (virga ,boolean? "Is this neume a virga?")
1496 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1500 (define-public all-backend-properties
1502 all-internal-grob-properties
1503 all-user-grob-properties))