GNU LilyPond

Welcome to the home of the GNU Music Typesetter

Node:PaperColumn, Next:PhrasingSlur, Previous:OctavateEight, Up:LilyPond backend

PaperColumn

PaperColumn grobs are created by: Score_engraver

spaceable-element-interface

An grob (generally a Paper_column) that takes part in the spacing problem.

minimum-distances (list):

list of rods (ie. (OBJ . DIST) pairs). Default value: (unset)

ideal-distances (list):

(OBJ . (DIST . STRENGTH)) pairs. Default value: (unset)

dir-list (list):

list of stem directions, needed for optical spacing correction. Default value: (unset)

axis-group-interface

a group of coupled grobs

axes (list):

list of axis numbers. In the case of alignment grobs, this should contain only one number. Default value: '(0)

paper-column-interface

column-space-strength (number):

relative strength of space following breakable columns (eg. prefatory matter). Default value: (unset)

before-musical-spacing-factor (number):

space before musical columns (eg. taken by accidentals) get this much stretched when they follow a musical column, in absence of grace notes. 0.0 means no extra space (accidentals are ignored). Default value: 0.4

stem-spacing-correction (number):

optical correction amount. Default value: (unset)

before-grace-spacing-factor (number):

stretch space this much if there are grace notes before the column. Default value: 1.2

when (moment):

when does this column happen?. Default value: (unset)

bounded-by-me (list):

list of spanners that have this column as start/begin point. Only columns that have grobs or act as bounds are spaced. Default value: (unset)

dir-list (list):

list of stem directions, needed for optical spacing correction. Default value: (unset)

shortest-playing-duration (moment):

duration of the shortest playing in that column. Default value: (unset)

shortest-starter-duration (moment):

duration of the shortest notes that starts exactly in this column. Default value: (unset)

contains-grace (boolean):

Used to widen entries for grace notes. Default value: (unset)

extra-space (pair of numbers):

pair of distances (cons LEFT RIGHT). Default value: (unset)

stretch-distance (pair of numbers):

pair of distances. Default value: (unset)

general-grob-interface

All grobs support this

X-offset-callbacks (list):

list of functions, each taking an grob and axis argument. The function determine the position relative to this grob's parent. The last one in the list is called first. Default value: (unset)

Y-offset-callbacks (list):

see X-offset-callbacks. Default value: (unset)

X-extent-callback (procedure):

procedure taking an grob and axis argument, returning a number-pair. The return value is the extent of the grob. Default value: (unset)

Y-extent-callback (procedure):

see X-extent-callback. Default value: (unset)

molecule-callback (procedure):

Function taking grob as argument, returning a Scheme encoded Molecule. Default value: (unset)

font-relative-size (number):

partial font definition: the relative size compared the `normal' size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger, -1 is smaller. Default value: (unset)

extra-offset (pair of numbers):

pair of reals (a cons) forcing an extra offset before outputting. extra-offset is added just before `printing' the grob, so the typesetting engine is completely oblivious to it.

Default value: (unset)

interfaces (list):

list of symbols indicating the interfaces supported by this object. Is initialized from the meta field. Default value: (unset)

dependencies (list):

list of score-grob pointers that indicate who to compute first for certain global passes. Default value: (unset)

no-spacing-rods (boolean):

read from grobs: boolean that makes Separation_item ignore this item (MOVE ME TO ITEM). Default value: (unset)

extra-extent-X (pair of numbers):

enlarge in X dimension by this much, measured in staff space. Default value: (unset)

extra-extent-Y (pair of numbers):

see extra-extent-Y. Default value: (unset)

minimum-extent-X (pair of numbers):

minimum size in X dimension, measured in staff space. Default value: (unset)

minimum-extent-Y (pair of numbers):

see minimum-extent-Y. Default value: (unset)

origin (input location):

location in input file of the definition. Default value: (unset)

transparent (boolean):

This is almost the same as setting molecule-callback to #f, but this retains the dimensions of this grob, which means that you can erase grobs individually. . Default value: (unset)

Please send GNU LilyPond questions and comments to lilypond-user@gnu.org.

Please send comments on these web pages to lilypond@packages.debian.org

Copyright (c) 1997--2001 Han-Wen Nienhuys and Jan Nieuwenhuizen.

Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.