User backend properties

X-extent (pair of numbers)

Hard coded extent in X direction.

X-offset (number)

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

Y-extent (pair of numbers)

See X-extent.

Y-offset (number)

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

accidentals (list)

List of alteration numbers

add-stem-support (boolean)

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

after-line-breaking (boolean)

Dummy property, used to trigger callback for after-line-breaking

align-dir (direction)

Which side to align? -1: left side, 0: around center of width, 1: right side.

allow-loose-spacing (boolean)

If set, column can be detached from main spacing.

alteration-alist (list)

List of (pitch . accidental) pairs for key signature.

arpeggio-direction (direction)

If set, put an arrow on the arpeggio squiggly line.

arrow (boolean)

Add an arrow to the line.

arrow-length (number)

Arrow length.

arrow-width (number)

Arrow width.

auto-knee-gap (dimension, in staff space)

If a gap is found between note heads where a horizontal beam fits that is larger than this number, make a kneed beam.

average-spacing-wishes (boolean)

If set, the spacing wishes are averaged over staves.

avoid-note-head (boolean)

If set, the stem of a chord does not pass through all note heads, but starts at the last note head.

avoid-slur (symbol)

Method of handling slur collisions. Choices are around, inside, outside. If unset, script and slur ignore eachother.

axes (list)

list of axis numbers. In the case of alignment grobs, this should contain only one number.

bar-size (dimension, in staff space)

size of a bar line.

barre-type (symbol)

Type of barre indication used in a fret diagram. Choices include curved and straight.

base-shortest-duration (moment)

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.

baseline-skip (dimension, in staff space)

Distance between base lines of multiple lines of text.

beam-thickness (dimension, in staff space)

thickness, measured in staff-space.

beam-width (dimension, in staff space)

width of the tremolo sign.

beamed-stem-shorten (list)

How much to shorten beamed stems, when their direction is forced. It is a list, since the value is different depending on the number flags/beams.

beaming (pair)

Pair of number lists. Each number list specifies which beams to make. 0 is the central beam, 1 is 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.

before-line-breaking (boolean)

Dummy property, used to trigger a callback function.

between-cols (pair)

Where to attach a loose column to

bound-padding (number)

The amount of padding to insert around spanner bounds.

bracket-flare (pair of numbers)

A pair of numbers specifying how much edges of brackets should slant outward. Value 0.0 means straight edges

bracket-visibility (boolean or symbol)

This controls the visibility of the tuplet bracket. Setting it to false will prevent printing of the bracket. Setting the property to 'if-no-beam will make it print only if there is no beam associated with this tuplet bracket.

break-align-orders (vector)

Defines the order in which prefatory matter (clefs, key signatures) appears. The format is a vector of length 3, where each element is one order for end-of-line, middle of line, and start-of-line respectively. An order is a list of symbols.

For example, clefs are put after key signatures by setting

          	\override Score.BreakAlignment #'break-align-orders = #(make-vector  3
          	  '(span-bar
          	  breathing-sign
          	  staff-bar
          	  key
          	  clef
          	  time-signature))
     

break-align-symbol (symbol)

This key is used for aligning and spacing breakable items.

break-overshoot (pair of numbers)

How much does a broken spanner stick out of its bounds?

break-visibility (vector)

A vector of 3 booleans, #(end-of-line unbroken begin-of-line). #t means visible, #f means killed.

c0-position (integer)

An integer indicating the position of middle C.

cautionary (boolean)

Is this a cautionary accidental?

cautionary-style (symbol)

How to print cautionary accidentals. Choices are smaller or parentheses.

clip-edges (boolean)

Allow outward pointing beamlets at the edges of beams?

collapse-height (dimension, in staff space)

Minimum height of system start delimiter. If equal or smaller, the bracket is removed.

color (list)

The color of this grob.

common-shortest-duration (moment)

The most common shortest note length. This is used in spacing. Enlarging this will set the score tighter.

concaveness (number)

A beam is concave when its inner stems are closer to the beam than the two outside stems. This number is a measure of the closeness of the inner stems. It is used for damping the slope of the beam.

connect-to-neighbor (pair)

Pair of booleans, indicating whether this grob looks as a continued break.

control-points (list)

List of offsets (number-pairs) that form control points for the tie/slur/bracket shape. For beziers, this should list the control points of a 3rd order bezier curve.

damping (number)

Amount of beam slope damping.

dash-fraction (number)

Size of the dashes, relative to dash-period. Should be between 0.0 (no line) and 1.0 (continuous line).

dash-period (number)

the length of one dash + white space. If negative, no line is drawn at all.

default-direction (direction)

Direction determined by note head positions.

digit-names (unknown)

Names for string finger digits.

direction (direction)

If side-position is 1 (#X), then this property determines if the object is placed #LEFT, #CENTER or #RIGHT with respect to the other object. Otherwise, it determines if the object is placed #UP #CENTER or #DOWN. Numerical values may also be used. #UP=1, #DOWN=-1, #LEFT=-1, #RIGHT=1, CENTER=0 but also other numerical values are permitted.

dot-color (symbol)

Color of dots. Options include black and white.

dot-count (integer)

The number of dots.

dot-radius (number)

Radius of dots.

duration-log (integer)

The 2-log of the note head duration, i.e. 0=whole note, 1 = half note, etc.

eccentricity (number)

How asymmetrical to make a slur. Positive means move the center to the right.

edge-height (pair)

A pair of number specifying the heights of the vertical edges '(left-height . right-height).

edge-text (pair)

A pair specifying the texts to be set at the edges '(left-text . right-text).

enclose-bounds (number)

How much of the bound a spanner should enclose: +1 = completely, 0 = center, -1 not at all.

expand-limit (integer)

maximum number of measures expanded in church rests.

extra-X-extent (pair of numbers)

A grob is enlarged in X dimension by this much.

extra-Y-extent (pair of numbers)

See extra-X-extent.

extra-offset (pair of numbers)

A pair representing an offset. This offset is added just before outputting the symbol, so the typesetting engine is completely oblivious to it.

finger-code (symbol)

Code for the type of fingering indication in a fret diagram. Options include none, in-dot, and below-string.

flag-count (number)

The number of tremolo beams.

flag-style (symbol)

a string determining what style of flag-glyph is typeset on a Stem. Valid options include () and mensural. Additionally, "no-flag" switches off the flag.

font-encoding (symbol)

The font encoding is the broadest category for selecting a font. Options include: fetaMusic, fetaNumber, TeX-text, TeX-math, fetaBraces, fetaDynamic

font-family (symbol)

The font family is the broadest category for selecting text fonts. Options include: sans, roman

font-name (string)

Specifies a file name (without extension) of the font to load. This setting override selection using font-family, font-series and font-shape.

font-series (symbol)

Select the series of a font. Choices include medium, bold, bold-narrow, etc.

font-shape (symbol)

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

font-size (number)

The font size, compared the `normal' size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger. Each step of 1 is approximately 12% larger, 6 steps are exactly a factor 2 larger. Fractional values are allowed.

force-hshift (number)

This specifies a manual shift for notes in collisions. The unit is the note head width of the first voice note. This is used by note-collision-interface.

forced (boolean)

manually forced accidental

forced-distance (dimension, in staff space)

A fixed distance between object reference points in an alignment.

fraction (pair of numbers)

Numerator and denominator of a time signature object.

french-beaming (boolean)

Use French beaming style for this stem. The stem will stop at the innermost beams.

fret-count (integer)

The number of frets in a fret diagram.

full-size-change (boolean)

Don't make a change clef smaller.

gap (dimension, in staff space)

Size of a gap in a variable symbol.

gap-count (integer)

Number of gapped beams for tremolo.

glyph (string)

a string determining what (style) of glyph is typeset. Valid choices depend on the function that is reading this property.

grow-direction (direction)

Crescendo or decrescendo?

hair-thickness (number)

Thickness of the thin line in a bar line.

head-direction (direction)

Are the note heads left or right in a semitie?

height (dimension, in staff space)

Height of an object in staff-space.

height-limit (dimension, in staff space)

Maximum slur height: the longer the slur, the closer it is to this height.

horizontal-shift (integer)

An integer that identifies ranking of note-column for horizontal shifting. This is used by note-collision-interface.

implicit (boolean)

Is this an implicit bass figure?

inspect-index (integer)

If debugging is set, set beam/slur configuration to this index, and print the respective scores.

inspect-quants (pair of numbers)

If debugging is set, set beam/slur quant to this position, and print the respective scores.

keep-inside-line (boolean)

If set, this column cannot have things sticking into the margin.

kern (dimension, in staff space)

Amount of extra white space to add. For bar line, this is the amount of space after a thick line.

knee (boolean)

Is this beam kneed?

knee-spacing-correction (number)

Factor for the optical correction amount for kneed beams. Set between 0 for no correction and 1 for full correction.

label-dir (direction)

Side to which label is attached. -1 for left, 1 for right.

layer (number)

The output layer [0..2]: layers define the order of printing objects. Objects in lower layers are overprinted by objects in higher layers.

ledger-line-thickness (pair of numbers)

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.

left-padding (dimension, in staff space)

The amount of space that is put left to an object (eg. a group of accidentals).

length (dimension, in staff space)

User override for the stem length of unbeamed stems.

length-fraction (number)

Multiplier for lengths. Used for determining ledger lines and stem lengths.

line-break-penalty (number)

Penalty for a line break at this column. This affects the choices of the line breaker; it will avoid a line break at a column with a positive penalty and prefer a line break at a column with a negative penalty.

line-break-permission (symbol)

Instructs the line breaker on whether to put a line break at this column. Can be 'force, or 'allow.

line-break-system-details (list)

Alist of properties to use when this column is the start of a system.

line-count (integer)

The number of staff lines.

line-positions (list)

Vertical positions of staff lines.

line-thickness (number)

The thickness of the tie/slur contour.

long-text (markup)

Text markup. See Text markup .

max-beam-connect (integer)

Maximum number of beams to connect to beams from this stem. Further beams are typeset as beamlets.

measure-count (integer)

The number of measures for a multimeasure rest.

measure-length (moment)

Length of a measure. Used in some spacing situations.

merge-differently-dotted (boolean)

Merge note heads in collisions, even if they have a different number of dots. This normal notation for some types of polyphonic music.

merge-differently-headed (boolean)

Merge note heads in collisions, even if they have different note heads. The smaller of the two heads will be rendered invisible. This used polyphonic guitar notation. The value of this setting is used by note-collision-interface .

minimum-X-extent (pair of numbers)

Minimum size of an object in X dimension, measured in staff space.

minimum-Y-extent (pair of numbers)

See minimum-X-extent.

minimum-distance (dimension, in staff space)

Minimum distance between rest and notes or beam.

minimum-length (dimension, in staff space)

Try to make a spanner at least this long. This requires an appropriate callback for the springs-and-rods property.

minimum-length-fraction (number)

Minimum length of ledger line as fraction of note head size.

minimum-space (dimension, in staff space)

Minimum distance that the victim should move (after padding).

neutral-direction (direction)

Which direction to take in the center of the staff.

neutral-position (number)

Position (in half staff spaces) where to flip the direction of custos stem.

next (layout object)

Object that is next relation (eg. the lyric syllable following an extender.

no-ledgers (boolean)

If set, don't draw ledger lines on this object.

no-spacing-rods (boolean)

Items with this property do not cause spacing constraints.

no-stem-extend (boolean)

If set, notes with ledger lines do not get stems extending to the middle staff line.

non-default (boolean)

Set for manually specified clefs.

non-musical (boolean)

True if the grob belongs in a NonMusicalPaperColumn.

note-names (vector)

Vector of strings containing names for easy-notation note heads.

number-type (symbol)

Type of numbers to use in label. Choices include roman-lower, roman-upper, and arabic.

packed-spacing (boolean)

If set, the notes are spaced as tightly as possible.

padding (dimension, in staff space)

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

page-break-penalty (number)

Penalty for page break at this column. This affects the choices of the page breaker; it will avoid a page break at a column with a positive penalty and prefer a page break at a column with a negative penalty.

page-break-permission (symbol)

Instructs the page breaker on whether to put a page break at this column. Can be 'force, or 'allow.

page-turn-penalty (number)

Penalty for a page turn at this column. This affects the choices of the page breaker; it will avoid a page turn at a column with a positive penalty and prefer a page turn at a column with a negative penalty.

page-turn-permission (symbol)

Instructs the page breaker on whether to put a page turn at this column. Can be 'force, or 'allow.

positions (pair)

Pair of staff coordinates (left . right), where both left and right are in the staff-space unit of the current staff.

ratio (number)

Parameter for slur shape. The higher this number, the quicker the slur attains it height-limit.

remove-empty (boolean)

If set, remove group if it contains no interesting-items

remove-first (boolean)

Remove the first staff of a orchestral score?

rhythmic-location (rhythmic location)

Where (bar number, measure position) in the score.

right-padding (dimension, in staff space)

Space to insert on the right side of an object (eg. between note and its accidentals.)

rotation (list)

Number of degrees to rotate this object, and what point to rotate around. #'(45 0 0) means rotate 45 degrees around the center of this object.

same-direction-correction (number)

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

script-priority (number)

A sorting key that determines in what order a script is within a stack of scripts.

self-alignment-X (number)

Specify alignment of an object. The value -1 means left aligned, 0 centered, and 1 right-aligned in X direction. Values in between may also be specified.

self-alignment-Y (number)

like self-alignment-X but for Y axis.

shorten-pair (pair of numbers)

The lengths to shorten a text-spanner on both sides, for example a pedal bracket. Positive values shorten the text-spanner, while negative values lengthen it.

shortest-duration-space (dimension, in staff space)

Start with this much space for the shortest duration. This is expressed in spacing-increment as unit. See also spacing-spanner-interface.

shortest-playing-duration (moment)

The duration of the shortest playing here.

shortest-starter-duration (moment)

The duration of the shortest note that starts here.

side-axis (number)

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

side-relative-direction (direction)

Multiply direction of direction-source with this to get the direction of this object.

size (number)

Size of object, relative to standard size.

slope (number)

The slope of this object.

slur-padding (number)

Extra distance between slur and script.

space-alist (list)

A table that specifies distances between prefatory items, like clef and time-signature. The format is an alist of spacing tuples: (break-align-symbol type . distance), where type can be the symbols minimum-space or extra-space.

spacing-increment (number)

Add this much space for a doubled duration. Typically, the width of a note head. See also spacing-spanner-interface.

springs-and-rods (boolean)

Dummy variable for triggering spacing routines.

stacking-dir (direction)

Stack objects in which direction?

staff-padding (dimension, in staff space)

Maintain this much space between reference points and the staff. Its effect is to align objects of differing sizes (like the dynamic p and f) on their baselines.

staff-position (number)

Vertical position, measured in half staff spaces, counted from the middle line.

staff-space (dimension, in staff space)

Amount of space between staff lines, expressed in global staff-space.

stem-attachment (pair of numbers)

A (x . y) pair where the stem attaches to the notehead.

stem-end-position (number)

Where does the stem end (the end is opposite to the support-head.

stem-spacing-correction (number)

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

stemlet-length (number)

How long should a stem over a rest be?

stencil (unknown)

The symbol to print.

strict-grace-spacing (boolean)

If set, grace notes are not spaced separately, but put before musical columns.

strict-note-spacing (boolean)

If set, unbroken columns with non-musical material (clefs, barlines, etc.) are not spaced separately, but put before musical columns.

string-count (integer)

The number of strings in a fret diagram.

string-fret-finger-combinations (list)

List consisting of (string-number fret-number finger-number) entries.

stroke-style (string)

set to "grace" to turn stroke through flag on.

style (symbol)

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

text (markup)

Text markup. See Text markup .

text-direction (direction)

This controls the ordering of the words. The default RIGHT is for roman text. Arabic or hebrew should use LEFT.

thick-thickness (number)

Bar line thickness, measured in line-thickness.

thickness (number)

Line thickness, generally measured in line-thickness.

thin-kern (number)

The space after a hair-line in a bar line.

threshold (pair of numbers)

(min . max), where min and max are dimensions in staff space.

tie-configuration (list)

List of (position . dir) pairs, indicating the desired tie configuration. A non-pair entry in the list will cause said tie to be formatted automatically.

transparent (boolean)

This makes the grob invisible.

uniform-stretching (boolean)

If set, items stretch proportional to their durations. This looks better in complex polyphonic patterns

used (boolean)

If set, this spacing column is kept in the spacing problem

when (moment)

Global time step associated with this column happen?

width (dimension, in staff space)

The width of a grob measured in staff space.

word-space (dimension, in staff space)

space to insert between words in texts.

zigzag-length (dimension, in staff space)

The length of the lines of a zigzag, relative to zigzag-width. A value of 1 gives 60-degree zigzags.

zigzag-width (dimension, in staff space)

The width of one zigzag-squiggle. This number will be adjusted slightly so that the glissando line can be constructed from a whole number of squiggles.