Next: , Previous: separation-spanner-interface, Up: Graphical Object Interfaces



side-position-interface

Position a victim object (this one) next to other objects (the support). The property direction signifies where to put the victim object relative to the support (left or right, up or down?)

The routine also takes the size the staff into account if staff-padding is set. If undefined, the staff symbol is ignored.

User settable properties:
direction (direction)
Up or down, left or right?
minimum-space (dimension, in staff space)
Minimum distance that the victim should move (after padding).
padding (dimension, in staff space)
Add this much extra space between objects that are next to each other.
side-relative-direction (direction)
Multiply direction of direction-source with this to get the direction of this object.
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.
Internal properties:
direction-source (layout object)
in case side-relative-direction is set, which grob to get the direction from .
side-support-elements (list of grobs)
the support, a list of grobs.

This grob interface is used in the following graphical objects: Arpeggio, BarNumber, CombineTextScript, DynamicLineSpanner, Fingering, HorizontalBracket, InstrumentName, MeasureGrouping, MetronomeMark, MultiMeasureRestNumber, MultiMeasureRestText, OctavateEight, OttavaBracket, RehearsalMark, Script, SostenutoPedalLineSpanner, StanzaNumber, SustainPedalLineSpanner, TextScript, TextSpanner, UnaCordaPedalLineSpanner, VocalName and VoltaBracket

Read comments on this page, or add one.

This page is for LilyPond-2.2.6 (stable-branch).

Report errors to <bug-lilypond@gnu.org>.