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

3.1.31 ClefModifier

A grob that draws the clef modifier (if present), in most cases the digit 8 below or above the clef. See also Clef, CueClef, and CueEndClef.

ClefModifier objects are created by: Clef_engraver and Cue_clef_engraver.

Standard settings:

break-visibility (vector):

#<procedure 55e918a26150 at /build/out/share/lilypond/current/scm/lily/output-lib.scm:1461:0 (grob)>

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

clef-alignments (alist, with symbols as keys):
'((G -0.2 . 0.1) (F -0.3 . -0.2) (C 0 . 0))

An alist of parent-alignments that should be used for clef modifiers with various clefs

color (color):

#<procedure 55e918a26120 at /build/out/share/lilypond/current/scm/lily/output-lib.scm:1461:0 (grob)>

The color of this grob.

font-shape (symbol):

'italic

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

font-size (number):

-4

The font size, compared to 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. If the context property fontSize is set, its value is added to this before the glyph is printed. Fractional values are allowed.

parent-alignment-X (number):

ly:clef-modifier::calc-parent-alignment

Specify on which point of the parent the object is aligned. The value -1 means aligned on parent’s left edge, 0 on center, and 1 right edge, in X direction. Other numerical values may also be specified - the unit is half the parent’s width. If unset, the value from self-alignment-X property will be used.

self-alignment-X (number):

0

Specify alignment of an object. The value -1 means left aligned, 0 centered, and 1 right-aligned in X direction. Other numerical values may also be specified - the unit is half the object width.

staff-padding (dimension, in staff space):

0.7

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

stencil (stencil):

ly:text-interface::print

The symbol to print.

transparent (boolean):

#<procedure 55e918a260f0 at /build/out/share/lilypond/current/scm/lily/output-lib.scm:1461:0 (grob)>

This makes the grob invisible.

vertical-skylines (pair of skylines):

#<unpure-pure-container #<procedure ly:grob::vertical-skylines-from-stencil (_)> >

Two skylines, one above and one below this grob.

X-offset (number):

ly:self-alignment-interface::aligned-on-x-parent

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

Y-extent (pair of numbers):

#<unpure-pure-container #<procedure ly:grob::stencil-height (_)> >

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

Y-offset (number):

#<unpure-pure-container #<procedure ly:side-position-interface::y-aligned-side (_ #:optional _)> #<procedure ly:side-position-interface::pure-y-aligned-side (_ _ _ #:optional _)> >

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

This object supports the following interface(s): clef-modifier-interface, font-interface, grob-interface, item-interface, outside-staff-interface, self-alignment-interface, side-position-interface and text-interface.

This object is of class Item (characterized by item-interface).

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

<< Back to Documentation Index

LilyPond – Internals Reference v2.23.82 (development-branch).