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

---

3.1.125 StaffHighlight

A colored span to highlight a music passage.

StaffHighlight objects are created by the following engraver(s): Staff_highlight_engraver.

Standard settings:

bound-prefatory-paddings (pair of numbers):

'(0.5 . 0.5)

For a highlight, the amount of padding to insert at a bound from a prefatory item that is not a bar line.

color (color):

#<procedure at lily/output-lib.scm:1645:0 (grob)>

The color of this grob.

layer (integer):

-1

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.

shorten-pair (pair of numbers):

'(0 . 0)

The lengths to shorten on both sides a hairpin or text-spanner such as a pedal bracket. Positive values shorten the hairpin or text-spanner, while negative values lengthen it.

stencil (stencil):

staff-highlight::print

The symbol to print.

X-extent (pair of numbers):

staff-highlight::width

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

Y-extent (pair of numbers):

staff-highlight::height

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

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

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