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

---

3.1.128 StaffSymbol

A staff symbol, usually five horizontal lines.

StaffSymbol objects are created by the following engraver(s): 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 break-alignment-interface.

layer (integer):

0

An 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 two numbers: The first is the factor for line thickness, and the second for staff space. Both contributions are added.

line-count (integer):

5

The number of staff lines.

line-positions (list):

ly:staff-symbol::calc-line-positions

Vertical positions of staff lines.

stencil (stencil):

ly:staff-symbol::print

The symbol to print.

widened-extent (pair of numbers):

staff-symbol::calc-widened-extent

The vertical extent that a bar line on a certain staff symbol should have. If the staff symbol is small (e.g., has just one line, as in a RhythmicStaff, this is wider than the staff symbol’s Y extent.

Y-extent (pair of numbers):

#<unpure-pure-container ly:staff-symbol::height >

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

Remarks:

• For this grob, the ledger-positions property defines a repeating pattern of ledger lines. Positions put into sublists are always be shown together, and values identical to staff line positions are ignored.
• If the ledger-positions-function property is set, ledger-positions and ledger-extra are ignored.

This object supports the following interface(s): grob-interface, spanner-interface and staff-symbol-interface.

This object is of class Spanner (characterized by spanner-interface).